]> git.vpit.fr Git - perl/modules/re-engine-Hooks.git/blob - src/5015009/orig/regcomp.c
Remove the 5.13 development branch
[perl/modules/re-engine-Hooks.git] / src / 5015009 / orig / 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 "INTERN.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 #ifndef PERL_IN_XSUB_RE
90 #  include "charclass_invlists.h"
91 #endif
92
93 #ifdef op
94 #undef op
95 #endif /* op */
96
97 #ifdef MSDOS
98 #  if defined(BUGGY_MSC6)
99  /* MSC 6.00A breaks on op/regexp.t test 85 unless we turn this off */
100 #    pragma optimize("a",off)
101  /* But MSC 6.00A is happy with 'w', for aliases only across function calls*/
102 #    pragma optimize("w",on )
103 #  endif /* BUGGY_MSC6 */
104 #endif /* MSDOS */
105
106 #ifndef STATIC
107 #define STATIC  static
108 #endif
109
110 typedef struct RExC_state_t {
111     U32         flags;                  /* are we folding, multilining? */
112     char        *precomp;               /* uncompiled string. */
113     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
114     regexp      *rx;                    /* perl core regexp structure */
115     regexp_internal     *rxi;           /* internal data for regexp object pprivate field */        
116     char        *start;                 /* Start of input for compile */
117     char        *end;                   /* End of input for compile */
118     char        *parse;                 /* Input-scan pointer. */
119     I32         whilem_seen;            /* number of WHILEM in this expr */
120     regnode     *emit_start;            /* Start of emitted-code area */
121     regnode     *emit_bound;            /* First regnode outside of the allocated space */
122     regnode     *emit;                  /* Code-emit pointer; &regdummy = don't = compiling */
123     I32         naughty;                /* How bad is this pattern? */
124     I32         sawback;                /* Did we see \1, ...? */
125     U32         seen;
126     I32         size;                   /* Code size. */
127     I32         npar;                   /* Capture buffer count, (OPEN). */
128     I32         cpar;                   /* Capture buffer count, (CLOSE). */
129     I32         nestroot;               /* root parens we are in - used by accept */
130     I32         extralen;
131     I32         seen_zerolen;
132     I32         seen_evals;
133     regnode     **open_parens;          /* pointers to open parens */
134     regnode     **close_parens;         /* pointers to close parens */
135     regnode     *opend;                 /* END node in program */
136     I32         utf8;           /* whether the pattern is utf8 or not */
137     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
138                                 /* XXX use this for future optimisation of case
139                                  * where pattern must be upgraded to utf8. */
140     I32         uni_semantics;  /* If a d charset modifier should use unicode
141                                    rules, even if the pattern is not in
142                                    utf8 */
143     HV          *paren_names;           /* Paren names */
144     
145     regnode     **recurse;              /* Recurse regops */
146     I32         recurse_count;          /* Number of recurse regops */
147     I32         in_lookbehind;
148     I32         contains_locale;
149     I32         override_recoding;
150 #if ADD_TO_REGEXEC
151     char        *starttry;              /* -Dr: where regtry was called. */
152 #define RExC_starttry   (pRExC_state->starttry)
153 #endif
154 #ifdef DEBUGGING
155     const char  *lastparse;
156     I32         lastnum;
157     AV          *paren_name_list;       /* idx -> name */
158 #define RExC_lastparse  (pRExC_state->lastparse)
159 #define RExC_lastnum    (pRExC_state->lastnum)
160 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
161 #endif
162 } RExC_state_t;
163
164 #define RExC_flags      (pRExC_state->flags)
165 #define RExC_precomp    (pRExC_state->precomp)
166 #define RExC_rx_sv      (pRExC_state->rx_sv)
167 #define RExC_rx         (pRExC_state->rx)
168 #define RExC_rxi        (pRExC_state->rxi)
169 #define RExC_start      (pRExC_state->start)
170 #define RExC_end        (pRExC_state->end)
171 #define RExC_parse      (pRExC_state->parse)
172 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
173 #ifdef RE_TRACK_PATTERN_OFFSETS
174 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the others */
175 #endif
176 #define RExC_emit       (pRExC_state->emit)
177 #define RExC_emit_start (pRExC_state->emit_start)
178 #define RExC_emit_bound (pRExC_state->emit_bound)
179 #define RExC_naughty    (pRExC_state->naughty)
180 #define RExC_sawback    (pRExC_state->sawback)
181 #define RExC_seen       (pRExC_state->seen)
182 #define RExC_size       (pRExC_state->size)
183 #define RExC_npar       (pRExC_state->npar)
184 #define RExC_nestroot   (pRExC_state->nestroot)
185 #define RExC_extralen   (pRExC_state->extralen)
186 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
187 #define RExC_seen_evals (pRExC_state->seen_evals)
188 #define RExC_utf8       (pRExC_state->utf8)
189 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
190 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
191 #define RExC_open_parens        (pRExC_state->open_parens)
192 #define RExC_close_parens       (pRExC_state->close_parens)
193 #define RExC_opend      (pRExC_state->opend)
194 #define RExC_paren_names        (pRExC_state->paren_names)
195 #define RExC_recurse    (pRExC_state->recurse)
196 #define RExC_recurse_count      (pRExC_state->recurse_count)
197 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
198 #define RExC_contains_locale    (pRExC_state->contains_locale)
199 #define RExC_override_recoding  (pRExC_state->override_recoding)
200
201
202 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
203 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
204         ((*s) == '{' && regcurly(s)))
205
206 #ifdef SPSTART
207 #undef SPSTART          /* dratted cpp namespace... */
208 #endif
209 /*
210  * Flags to be passed up and down.
211  */
212 #define WORST           0       /* Worst case. */
213 #define HASWIDTH        0x01    /* Known to match non-null strings. */
214
215 /* Simple enough to be STAR/PLUS operand, in an EXACT node must be a single
216  * character, and if utf8, must be invariant.  Note that this is not the same thing as REGNODE_SIMPLE */
217 #define SIMPLE          0x02
218 #define SPSTART         0x04    /* Starts with * or +. */
219 #define TRYAGAIN        0x08    /* Weeded out a declaration. */
220 #define POSTPONED       0x10    /* (?1),(?&name), (??{...}) or similar */
221
222 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
223
224 /* whether trie related optimizations are enabled */
225 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
226 #define TRIE_STUDY_OPT
227 #define FULL_TRIE_STUDY
228 #define TRIE_STCLASS
229 #endif
230
231
232
233 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
234 #define PBITVAL(paren) (1 << ((paren) & 7))
235 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
236 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
237 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
238
239 /* If not already in utf8, do a longjmp back to the beginning */
240 #define UTF8_LONGJMP 42 /* Choose a value not likely to ever conflict */
241 #define REQUIRE_UTF8    STMT_START {                                       \
242                                      if (! UTF) JMPENV_JUMP(UTF8_LONGJMP); \
243                         } STMT_END
244
245 /* About scan_data_t.
246
247   During optimisation we recurse through the regexp program performing
248   various inplace (keyhole style) optimisations. In addition study_chunk
249   and scan_commit populate this data structure with information about
250   what strings MUST appear in the pattern. We look for the longest 
251   string that must appear at a fixed location, and we look for the
252   longest string that may appear at a floating location. So for instance
253   in the pattern:
254   
255     /FOO[xX]A.*B[xX]BAR/
256     
257   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
258   strings (because they follow a .* construct). study_chunk will identify
259   both FOO and BAR as being the longest fixed and floating strings respectively.
260   
261   The strings can be composites, for instance
262   
263      /(f)(o)(o)/
264      
265   will result in a composite fixed substring 'foo'.
266   
267   For each string some basic information is maintained:
268   
269   - offset or min_offset
270     This is the position the string must appear at, or not before.
271     It also implicitly (when combined with minlenp) tells us how many
272     characters must match before the string we are searching for.
273     Likewise when combined with minlenp and the length of the string it
274     tells us how many characters must appear after the string we have 
275     found.
276   
277   - max_offset
278     Only used for floating strings. This is the rightmost point that
279     the string can appear at. If set to I32 max it indicates that the
280     string can occur infinitely far to the right.
281   
282   - minlenp
283     A pointer to the minimum length of the pattern that the string 
284     was found inside. This is important as in the case of positive 
285     lookahead or positive lookbehind we can have multiple patterns 
286     involved. Consider
287     
288     /(?=FOO).*F/
289     
290     The minimum length of the pattern overall is 3, the minimum length
291     of the lookahead part is 3, but the minimum length of the part that
292     will actually match is 1. So 'FOO's minimum length is 3, but the 
293     minimum length for the F is 1. This is important as the minimum length
294     is used to determine offsets in front of and behind the string being 
295     looked for.  Since strings can be composites this is the length of the
296     pattern at the time it was committed with a scan_commit. Note that
297     the length is calculated by study_chunk, so that the minimum lengths
298     are not known until the full pattern has been compiled, thus the 
299     pointer to the value.
300   
301   - lookbehind
302   
303     In the case of lookbehind the string being searched for can be
304     offset past the start point of the final matching string. 
305     If this value was just blithely removed from the min_offset it would
306     invalidate some of the calculations for how many chars must match
307     before or after (as they are derived from min_offset and minlen and
308     the length of the string being searched for). 
309     When the final pattern is compiled and the data is moved from the
310     scan_data_t structure into the regexp structure the information
311     about lookbehind is factored in, with the information that would 
312     have been lost precalculated in the end_shift field for the 
313     associated string.
314
315   The fields pos_min and pos_delta are used to store the minimum offset
316   and the delta to the maximum offset at the current point in the pattern.    
317
318 */
319
320 typedef struct scan_data_t {
321     /*I32 len_min;      unused */
322     /*I32 len_delta;    unused */
323     I32 pos_min;
324     I32 pos_delta;
325     SV *last_found;
326     I32 last_end;           /* min value, <0 unless valid. */
327     I32 last_start_min;
328     I32 last_start_max;
329     SV **longest;           /* Either &l_fixed, or &l_float. */
330     SV *longest_fixed;      /* longest fixed string found in pattern */
331     I32 offset_fixed;       /* offset where it starts */
332     I32 *minlen_fixed;      /* pointer to the minlen relevant to the string */
333     I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
334     SV *longest_float;      /* longest floating string found in pattern */
335     I32 offset_float_min;   /* earliest point in string it can appear */
336     I32 offset_float_max;   /* latest point in string it can appear */
337     I32 *minlen_float;      /* pointer to the minlen relevant to the string */
338     I32 lookbehind_float;   /* is the position of the string modified by LB */
339     I32 flags;
340     I32 whilem_c;
341     I32 *last_closep;
342     struct regnode_charclass_class *start_class;
343 } scan_data_t;
344
345 /*
346  * Forward declarations for pregcomp()'s friends.
347  */
348
349 static const scan_data_t zero_scan_data =
350   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
351
352 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
353 #define SF_BEFORE_SEOL          0x0001
354 #define SF_BEFORE_MEOL          0x0002
355 #define SF_FIX_BEFORE_EOL       (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
356 #define SF_FL_BEFORE_EOL        (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
357
358 #ifdef NO_UNARY_PLUS
359 #  define SF_FIX_SHIFT_EOL      (0+2)
360 #  define SF_FL_SHIFT_EOL               (0+4)
361 #else
362 #  define SF_FIX_SHIFT_EOL      (+2)
363 #  define SF_FL_SHIFT_EOL               (+4)
364 #endif
365
366 #define SF_FIX_BEFORE_SEOL      (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
367 #define SF_FIX_BEFORE_MEOL      (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
368
369 #define SF_FL_BEFORE_SEOL       (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
370 #define SF_FL_BEFORE_MEOL       (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
371 #define SF_IS_INF               0x0040
372 #define SF_HAS_PAR              0x0080
373 #define SF_IN_PAR               0x0100
374 #define SF_HAS_EVAL             0x0200
375 #define SCF_DO_SUBSTR           0x0400
376 #define SCF_DO_STCLASS_AND      0x0800
377 #define SCF_DO_STCLASS_OR       0x1000
378 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
379 #define SCF_WHILEM_VISITED_POS  0x2000
380
381 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
382 #define SCF_SEEN_ACCEPT         0x8000 
383
384 #define UTF cBOOL(RExC_utf8)
385
386 /* The enums for all these are ordered so things work out correctly */
387 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
388 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_DEPENDS_CHARSET)
389 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
390 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) >= REGEX_UNICODE_CHARSET)
391 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_RESTRICTED_CHARSET)
392 #define MORE_ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
393 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) >= REGEX_ASCII_RESTRICTED_CHARSET)
394
395 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
396
397 #define OOB_UNICODE             12345678
398 #define OOB_NAMEDCLASS          -1
399
400 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
401 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
402
403
404 /* length of regex to show in messages that don't mark a position within */
405 #define RegexLengthToShowInErrorMessages 127
406
407 /*
408  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
409  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
410  * op/pragma/warn/regcomp.
411  */
412 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
413 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
414
415 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
416
417 /*
418  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
419  * arg. Show regex, up to a maximum length. If it's too long, chop and add
420  * "...".
421  */
422 #define _FAIL(code) STMT_START {                                        \
423     const char *ellipses = "";                                          \
424     IV len = RExC_end - RExC_precomp;                                   \
425                                                                         \
426     if (!SIZE_ONLY)                                                     \
427         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);                   \
428     if (len > RegexLengthToShowInErrorMessages) {                       \
429         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
430         len = RegexLengthToShowInErrorMessages - 10;                    \
431         ellipses = "...";                                               \
432     }                                                                   \
433     code;                                                               \
434 } STMT_END
435
436 #define FAIL(msg) _FAIL(                            \
437     Perl_croak(aTHX_ "%s in regex m/%.*s%s/",       \
438             msg, (int)len, RExC_precomp, ellipses))
439
440 #define FAIL2(msg,arg) _FAIL(                       \
441     Perl_croak(aTHX_ msg " in regex m/%.*s%s/",     \
442             arg, (int)len, RExC_precomp, ellipses))
443
444 /*
445  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
446  */
447 #define Simple_vFAIL(m) STMT_START {                                    \
448     const IV offset = RExC_parse - RExC_precomp;                        \
449     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
450             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
451 } STMT_END
452
453 /*
454  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
455  */
456 #define vFAIL(m) STMT_START {                           \
457     if (!SIZE_ONLY)                                     \
458         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);   \
459     Simple_vFAIL(m);                                    \
460 } STMT_END
461
462 /*
463  * Like Simple_vFAIL(), but accepts two arguments.
464  */
465 #define Simple_vFAIL2(m,a1) STMT_START {                        \
466     const IV offset = RExC_parse - RExC_precomp;                        \
467     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1,                   \
468             (int)offset, RExC_precomp, RExC_precomp + offset);  \
469 } STMT_END
470
471 /*
472  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
473  */
474 #define vFAIL2(m,a1) STMT_START {                       \
475     if (!SIZE_ONLY)                                     \
476         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);   \
477     Simple_vFAIL2(m, a1);                               \
478 } STMT_END
479
480
481 /*
482  * Like Simple_vFAIL(), but accepts three arguments.
483  */
484 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
485     const IV offset = RExC_parse - RExC_precomp;                \
486     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2,               \
487             (int)offset, RExC_precomp, RExC_precomp + offset);  \
488 } STMT_END
489
490 /*
491  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
492  */
493 #define vFAIL3(m,a1,a2) STMT_START {                    \
494     if (!SIZE_ONLY)                                     \
495         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);   \
496     Simple_vFAIL3(m, a1, a2);                           \
497 } STMT_END
498
499 /*
500  * Like Simple_vFAIL(), but accepts four arguments.
501  */
502 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
503     const IV offset = RExC_parse - RExC_precomp;                \
504     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3,           \
505             (int)offset, RExC_precomp, RExC_precomp + offset);  \
506 } STMT_END
507
508 #define ckWARNreg(loc,m) STMT_START {                                   \
509     const IV offset = loc - RExC_precomp;                               \
510     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
511             (int)offset, RExC_precomp, RExC_precomp + offset);          \
512 } STMT_END
513
514 #define ckWARNregdep(loc,m) STMT_START {                                \
515     const IV offset = loc - RExC_precomp;                               \
516     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
517             m REPORT_LOCATION,                                          \
518             (int)offset, RExC_precomp, RExC_precomp + offset);          \
519 } STMT_END
520
521 #define ckWARN2regdep(loc,m, a1) STMT_START {                           \
522     const IV offset = loc - RExC_precomp;                               \
523     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
524             m REPORT_LOCATION,                                          \
525             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
526 } STMT_END
527
528 #define ckWARN2reg(loc, m, a1) STMT_START {                             \
529     const IV offset = loc - RExC_precomp;                               \
530     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
531             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
532 } STMT_END
533
534 #define vWARN3(loc, m, a1, a2) STMT_START {                             \
535     const IV offset = loc - RExC_precomp;                               \
536     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
537             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
538 } STMT_END
539
540 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                         \
541     const IV offset = loc - RExC_precomp;                               \
542     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
543             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
544 } STMT_END
545
546 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
547     const IV offset = loc - RExC_precomp;                               \
548     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
549             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
550 } STMT_END
551
552 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
553     const IV offset = loc - RExC_precomp;                               \
554     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
555             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
556 } STMT_END
557
558 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
559     const IV offset = loc - RExC_precomp;                               \
560     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
561             a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
562 } STMT_END
563
564
565 /* Allow for side effects in s */
566 #define REGC(c,s) STMT_START {                  \
567     if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
568 } STMT_END
569
570 /* Macros for recording node offsets.   20001227 mjd@plover.com 
571  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
572  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
573  * Element 0 holds the number n.
574  * Position is 1 indexed.
575  */
576 #ifndef RE_TRACK_PATTERN_OFFSETS
577 #define Set_Node_Offset_To_R(node,byte)
578 #define Set_Node_Offset(node,byte)
579 #define Set_Cur_Node_Offset
580 #define Set_Node_Length_To_R(node,len)
581 #define Set_Node_Length(node,len)
582 #define Set_Node_Cur_Length(node)
583 #define Node_Offset(n) 
584 #define Node_Length(n) 
585 #define Set_Node_Offset_Length(node,offset,len)
586 #define ProgLen(ri) ri->u.proglen
587 #define SetProgLen(ri,x) ri->u.proglen = x
588 #else
589 #define ProgLen(ri) ri->u.offsets[0]
590 #define SetProgLen(ri,x) ri->u.offsets[0] = x
591 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
592     if (! SIZE_ONLY) {                                                  \
593         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
594                     __LINE__, (int)(node), (int)(byte)));               \
595         if((node) < 0) {                                                \
596             Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
597         } else {                                                        \
598             RExC_offsets[2*(node)-1] = (byte);                          \
599         }                                                               \
600     }                                                                   \
601 } STMT_END
602
603 #define Set_Node_Offset(node,byte) \
604     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
605 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
606
607 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
608     if (! SIZE_ONLY) {                                                  \
609         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
610                 __LINE__, (int)(node), (int)(len)));                    \
611         if((node) < 0) {                                                \
612             Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
613         } else {                                                        \
614             RExC_offsets[2*(node)] = (len);                             \
615         }                                                               \
616     }                                                                   \
617 } STMT_END
618
619 #define Set_Node_Length(node,len) \
620     Set_Node_Length_To_R((node)-RExC_emit_start, len)
621 #define Set_Cur_Node_Length(len) Set_Node_Length(RExC_emit, len)
622 #define Set_Node_Cur_Length(node) \
623     Set_Node_Length(node, RExC_parse - parse_start)
624
625 /* Get offsets and lengths */
626 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
627 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
628
629 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
630     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
631     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
632 } STMT_END
633 #endif
634
635 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
636 #define EXPERIMENTAL_INPLACESCAN
637 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
638
639 #define DEBUG_STUDYDATA(str,data,depth)                              \
640 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
641     PerlIO_printf(Perl_debug_log,                                    \
642         "%*s" str "Pos:%"IVdf"/%"IVdf                                \
643         " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s",       \
644         (int)(depth)*2, "",                                          \
645         (IV)((data)->pos_min),                                       \
646         (IV)((data)->pos_delta),                                     \
647         (UV)((data)->flags),                                         \
648         (IV)((data)->whilem_c),                                      \
649         (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
650         is_inf ? "INF " : ""                                         \
651     );                                                               \
652     if ((data)->last_found)                                          \
653         PerlIO_printf(Perl_debug_log,                                \
654             "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
655             " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
656             SvPVX_const((data)->last_found),                         \
657             (IV)((data)->last_end),                                  \
658             (IV)((data)->last_start_min),                            \
659             (IV)((data)->last_start_max),                            \
660             ((data)->longest &&                                      \
661              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
662             SvPVX_const((data)->longest_fixed),                      \
663             (IV)((data)->offset_fixed),                              \
664             ((data)->longest &&                                      \
665              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
666             SvPVX_const((data)->longest_float),                      \
667             (IV)((data)->offset_float_min),                          \
668             (IV)((data)->offset_float_max)                           \
669         );                                                           \
670     PerlIO_printf(Perl_debug_log,"\n");                              \
671 });
672
673 static void clear_re(pTHX_ void *r);
674
675 /* Mark that we cannot extend a found fixed substring at this point.
676    Update the longest found anchored substring and the longest found
677    floating substrings if needed. */
678
679 STATIC void
680 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
681 {
682     const STRLEN l = CHR_SVLEN(data->last_found);
683     const STRLEN old_l = CHR_SVLEN(*data->longest);
684     GET_RE_DEBUG_FLAGS_DECL;
685
686     PERL_ARGS_ASSERT_SCAN_COMMIT;
687
688     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
689         SvSetMagicSV(*data->longest, data->last_found);
690         if (*data->longest == data->longest_fixed) {
691             data->offset_fixed = l ? data->last_start_min : data->pos_min;
692             if (data->flags & SF_BEFORE_EOL)
693                 data->flags
694                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
695             else
696                 data->flags &= ~SF_FIX_BEFORE_EOL;
697             data->minlen_fixed=minlenp;
698             data->lookbehind_fixed=0;
699         }
700         else { /* *data->longest == data->longest_float */
701             data->offset_float_min = l ? data->last_start_min : data->pos_min;
702             data->offset_float_max = (l
703                                       ? data->last_start_max
704                                       : data->pos_min + data->pos_delta);
705             if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
706                 data->offset_float_max = I32_MAX;
707             if (data->flags & SF_BEFORE_EOL)
708                 data->flags
709                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
710             else
711                 data->flags &= ~SF_FL_BEFORE_EOL;
712             data->minlen_float=minlenp;
713             data->lookbehind_float=0;
714         }
715     }
716     SvCUR_set(data->last_found, 0);
717     {
718         SV * const sv = data->last_found;
719         if (SvUTF8(sv) && SvMAGICAL(sv)) {
720             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
721             if (mg)
722                 mg->mg_len = 0;
723         }
724     }
725     data->last_end = -1;
726     data->flags &= ~SF_BEFORE_EOL;
727     DEBUG_STUDYDATA("commit: ",data,0);
728 }
729
730 /* Can match anything (initialization) */
731 STATIC void
732 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
733 {
734     PERL_ARGS_ASSERT_CL_ANYTHING;
735
736     ANYOF_BITMAP_SETALL(cl);
737     cl->flags = ANYOF_CLASS|ANYOF_EOS|ANYOF_UNICODE_ALL
738                 |ANYOF_LOC_NONBITMAP_FOLD|ANYOF_NON_UTF8_LATIN1_ALL;
739
740     /* If any portion of the regex is to operate under locale rules,
741      * initialization includes it.  The reason this isn't done for all regexes
742      * is that the optimizer was written under the assumption that locale was
743      * all-or-nothing.  Given the complexity and lack of documentation in the
744      * optimizer, and that there are inadequate test cases for locale, so many
745      * parts of it may not work properly, it is safest to avoid locale unless
746      * necessary. */
747     if (RExC_contains_locale) {
748         ANYOF_CLASS_SETALL(cl);     /* /l uses class */
749         cl->flags |= ANYOF_LOCALE;
750     }
751     else {
752         ANYOF_CLASS_ZERO(cl);       /* Only /l uses class now */
753     }
754 }
755
756 /* Can match anything (initialization) */
757 STATIC int
758 S_cl_is_anything(const struct regnode_charclass_class *cl)
759 {
760     int value;
761
762     PERL_ARGS_ASSERT_CL_IS_ANYTHING;
763
764     for (value = 0; value <= ANYOF_MAX; value += 2)
765         if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
766             return 1;
767     if (!(cl->flags & ANYOF_UNICODE_ALL))
768         return 0;
769     if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
770         return 0;
771     return 1;
772 }
773
774 /* Can match anything (initialization) */
775 STATIC void
776 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
777 {
778     PERL_ARGS_ASSERT_CL_INIT;
779
780     Zero(cl, 1, struct regnode_charclass_class);
781     cl->type = ANYOF;
782     cl_anything(pRExC_state, cl);
783     ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
784 }
785
786 /* These two functions currently do the exact same thing */
787 #define cl_init_zero            S_cl_init
788
789 /* 'AND' a given class with another one.  Can create false positives.  'cl'
790  * should not be inverted.  'and_with->flags & ANYOF_CLASS' should be 0 if
791  * 'and_with' is a regnode_charclass instead of a regnode_charclass_class. */
792 STATIC void
793 S_cl_and(struct regnode_charclass_class *cl,
794         const struct regnode_charclass_class *and_with)
795 {
796     PERL_ARGS_ASSERT_CL_AND;
797
798     assert(and_with->type == ANYOF);
799
800     /* I (khw) am not sure all these restrictions are necessary XXX */
801     if (!(ANYOF_CLASS_TEST_ANY_SET(and_with))
802         && !(ANYOF_CLASS_TEST_ANY_SET(cl))
803         && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
804         && !(and_with->flags & ANYOF_LOC_NONBITMAP_FOLD)
805         && !(cl->flags & ANYOF_LOC_NONBITMAP_FOLD)) {
806         int i;
807
808         if (and_with->flags & ANYOF_INVERT)
809             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
810                 cl->bitmap[i] &= ~and_with->bitmap[i];
811         else
812             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
813                 cl->bitmap[i] &= and_with->bitmap[i];
814     } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
815
816     if (and_with->flags & ANYOF_INVERT) {
817
818         /* Here, the and'ed node is inverted.  Get the AND of the flags that
819          * aren't affected by the inversion.  Those that are affected are
820          * handled individually below */
821         U8 affected_flags = cl->flags & ~INVERSION_UNAFFECTED_FLAGS;
822         cl->flags &= (and_with->flags & INVERSION_UNAFFECTED_FLAGS);
823         cl->flags |= affected_flags;
824
825         /* We currently don't know how to deal with things that aren't in the
826          * bitmap, but we know that the intersection is no greater than what
827          * is already in cl, so let there be false positives that get sorted
828          * out after the synthetic start class succeeds, and the node is
829          * matched for real. */
830
831         /* The inversion of these two flags indicate that the resulting
832          * intersection doesn't have them */
833         if (and_with->flags & ANYOF_UNICODE_ALL) {
834             cl->flags &= ~ANYOF_UNICODE_ALL;
835         }
836         if (and_with->flags & ANYOF_NON_UTF8_LATIN1_ALL) {
837             cl->flags &= ~ANYOF_NON_UTF8_LATIN1_ALL;
838         }
839     }
840     else {   /* and'd node is not inverted */
841         U8 outside_bitmap_but_not_utf8; /* Temp variable */
842
843         if (! ANYOF_NONBITMAP(and_with)) {
844
845             /* Here 'and_with' doesn't match anything outside the bitmap
846              * (except possibly ANYOF_UNICODE_ALL), which means the
847              * intersection can't either, except for ANYOF_UNICODE_ALL, in
848              * which case we don't know what the intersection is, but it's no
849              * greater than what cl already has, so can just leave it alone,
850              * with possible false positives */
851             if (! (and_with->flags & ANYOF_UNICODE_ALL)) {
852                 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
853                 cl->flags &= ~ANYOF_NONBITMAP_NON_UTF8;
854             }
855         }
856         else if (! ANYOF_NONBITMAP(cl)) {
857
858             /* Here, 'and_with' does match something outside the bitmap, and cl
859              * doesn't have a list of things to match outside the bitmap.  If
860              * cl can match all code points above 255, the intersection will
861              * be those above-255 code points that 'and_with' matches.  If cl
862              * can't match all Unicode code points, it means that it can't
863              * match anything outside the bitmap (since the 'if' that got us
864              * into this block tested for that), so we leave the bitmap empty.
865              */
866             if (cl->flags & ANYOF_UNICODE_ALL) {
867                 ARG_SET(cl, ARG(and_with));
868
869                 /* and_with's ARG may match things that don't require UTF8.
870                  * And now cl's will too, in spite of this being an 'and'.  See
871                  * the comments below about the kludge */
872                 cl->flags |= and_with->flags & ANYOF_NONBITMAP_NON_UTF8;
873             }
874         }
875         else {
876             /* Here, both 'and_with' and cl match something outside the
877              * bitmap.  Currently we do not do the intersection, so just match
878              * whatever cl had at the beginning.  */
879         }
880
881
882         /* Take the intersection of the two sets of flags.  However, the
883          * ANYOF_NONBITMAP_NON_UTF8 flag is treated as an 'or'.  This is a
884          * kludge around the fact that this flag is not treated like the others
885          * which are initialized in cl_anything().  The way the optimizer works
886          * is that the synthetic start class (SSC) is initialized to match
887          * anything, and then the first time a real node is encountered, its
888          * values are AND'd with the SSC's with the result being the values of
889          * the real node.  However, there are paths through the optimizer where
890          * the AND never gets called, so those initialized bits are set
891          * inappropriately, which is not usually a big deal, as they just cause
892          * false positives in the SSC, which will just mean a probably
893          * imperceptible slow down in execution.  However this bit has a
894          * higher false positive consequence in that it can cause utf8.pm,
895          * utf8_heavy.pl ... to be loaded when not necessary, which is a much
896          * bigger slowdown and also causes significant extra memory to be used.
897          * In order to prevent this, the code now takes a different tack.  The
898          * bit isn't set unless some part of the regular expression needs it,
899          * but once set it won't get cleared.  This means that these extra
900          * modules won't get loaded unless there was some path through the
901          * pattern that would have required them anyway, and  so any false
902          * positives that occur by not ANDing them out when they could be
903          * aren't as severe as they would be if we treated this bit like all
904          * the others */
905         outside_bitmap_but_not_utf8 = (cl->flags | and_with->flags)
906                                       & ANYOF_NONBITMAP_NON_UTF8;
907         cl->flags &= and_with->flags;
908         cl->flags |= outside_bitmap_but_not_utf8;
909     }
910 }
911
912 /* 'OR' a given class with another one.  Can create false positives.  'cl'
913  * should not be inverted.  'or_with->flags & ANYOF_CLASS' should be 0 if
914  * 'or_with' is a regnode_charclass instead of a regnode_charclass_class. */
915 STATIC void
916 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
917 {
918     PERL_ARGS_ASSERT_CL_OR;
919
920     if (or_with->flags & ANYOF_INVERT) {
921
922         /* Here, the or'd node is to be inverted.  This means we take the
923          * complement of everything not in the bitmap, but currently we don't
924          * know what that is, so give up and match anything */
925         if (ANYOF_NONBITMAP(or_with)) {
926             cl_anything(pRExC_state, cl);
927         }
928         /* We do not use
929          * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
930          *   <= (B1 | !B2) | (CL1 | !CL2)
931          * which is wasteful if CL2 is small, but we ignore CL2:
932          *   (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
933          * XXXX Can we handle case-fold?  Unclear:
934          *   (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
935          *   (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
936          */
937         else if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
938              && !(or_with->flags & ANYOF_LOC_NONBITMAP_FOLD)
939              && !(cl->flags & ANYOF_LOC_NONBITMAP_FOLD) ) {
940             int i;
941
942             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
943                 cl->bitmap[i] |= ~or_with->bitmap[i];
944         } /* XXXX: logic is complicated otherwise */
945         else {
946             cl_anything(pRExC_state, cl);
947         }
948
949         /* And, we can just take the union of the flags that aren't affected
950          * by the inversion */
951         cl->flags |= or_with->flags & INVERSION_UNAFFECTED_FLAGS;
952
953         /* For the remaining flags:
954             ANYOF_UNICODE_ALL and inverted means to not match anything above
955                     255, which means that the union with cl should just be
956                     what cl has in it, so can ignore this flag
957             ANYOF_NON_UTF8_LATIN1_ALL and inverted means if not utf8 and ord
958                     is 127-255 to match them, but then invert that, so the
959                     union with cl should just be what cl has in it, so can
960                     ignore this flag
961          */
962     } else {    /* 'or_with' is not inverted */
963         /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
964         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
965              && (!(or_with->flags & ANYOF_LOC_NONBITMAP_FOLD)
966                  || (cl->flags & ANYOF_LOC_NONBITMAP_FOLD)) ) {
967             int i;
968
969             /* OR char bitmap and class bitmap separately */
970             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
971                 cl->bitmap[i] |= or_with->bitmap[i];
972             if (ANYOF_CLASS_TEST_ANY_SET(or_with)) {
973                 for (i = 0; i < ANYOF_CLASSBITMAP_SIZE; i++)
974                     cl->classflags[i] |= or_with->classflags[i];
975                 cl->flags |= ANYOF_CLASS;
976             }
977         }
978         else { /* XXXX: logic is complicated, leave it along for a moment. */
979             cl_anything(pRExC_state, cl);
980         }
981
982         if (ANYOF_NONBITMAP(or_with)) {
983
984             /* Use the added node's outside-the-bit-map match if there isn't a
985              * conflict.  If there is a conflict (both nodes match something
986              * outside the bitmap, but what they match outside is not the same
987              * pointer, and hence not easily compared until XXX we extend
988              * inversion lists this far), give up and allow the start class to
989              * match everything outside the bitmap.  If that stuff is all above
990              * 255, can just set UNICODE_ALL, otherwise caould be anything. */
991             if (! ANYOF_NONBITMAP(cl)) {
992                 ARG_SET(cl, ARG(or_with));
993             }
994             else if (ARG(cl) != ARG(or_with)) {
995
996                 if ((or_with->flags & ANYOF_NONBITMAP_NON_UTF8)) {
997                     cl_anything(pRExC_state, cl);
998                 }
999                 else {
1000                     cl->flags |= ANYOF_UNICODE_ALL;
1001                 }
1002             }
1003         }
1004
1005         /* Take the union */
1006         cl->flags |= or_with->flags;
1007     }
1008 }
1009
1010 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1011 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1012 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1013 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
1014
1015
1016 #ifdef DEBUGGING
1017 /*
1018    dump_trie(trie,widecharmap,revcharmap)
1019    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1020    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1021
1022    These routines dump out a trie in a somewhat readable format.
1023    The _interim_ variants are used for debugging the interim
1024    tables that are used to generate the final compressed
1025    representation which is what dump_trie expects.
1026
1027    Part of the reason for their existence is to provide a form
1028    of documentation as to how the different representations function.
1029
1030 */
1031
1032 /*
1033   Dumps the final compressed table form of the trie to Perl_debug_log.
1034   Used for debugging make_trie().
1035 */
1036
1037 STATIC void
1038 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1039             AV *revcharmap, U32 depth)
1040 {
1041     U32 state;
1042     SV *sv=sv_newmortal();
1043     int colwidth= widecharmap ? 6 : 4;
1044     U16 word;
1045     GET_RE_DEBUG_FLAGS_DECL;
1046
1047     PERL_ARGS_ASSERT_DUMP_TRIE;
1048
1049     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1050         (int)depth * 2 + 2,"",
1051         "Match","Base","Ofs" );
1052
1053     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1054         SV ** const tmp = av_fetch( revcharmap, state, 0);
1055         if ( tmp ) {
1056             PerlIO_printf( Perl_debug_log, "%*s", 
1057                 colwidth,
1058                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1059                             PL_colors[0], PL_colors[1],
1060                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1061                             PERL_PV_ESCAPE_FIRSTCHAR 
1062                 ) 
1063             );
1064         }
1065     }
1066     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1067         (int)depth * 2 + 2,"");
1068
1069     for( state = 0 ; state < trie->uniquecharcount ; state++ )
1070         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1071     PerlIO_printf( Perl_debug_log, "\n");
1072
1073     for( state = 1 ; state < trie->statecount ; state++ ) {
1074         const U32 base = trie->states[ state ].trans.base;
1075
1076         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
1077
1078         if ( trie->states[ state ].wordnum ) {
1079             PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
1080         } else {
1081             PerlIO_printf( Perl_debug_log, "%6s", "" );
1082         }
1083
1084         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1085
1086         if ( base ) {
1087             U32 ofs = 0;
1088
1089             while( ( base + ofs  < trie->uniquecharcount ) ||
1090                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
1091                      && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
1092                     ofs++;
1093
1094             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1095
1096             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1097                 if ( ( base + ofs >= trie->uniquecharcount ) &&
1098                      ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1099                      trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1100                 {
1101                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
1102                     colwidth,
1103                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
1104                 } else {
1105                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
1106                 }
1107             }
1108
1109             PerlIO_printf( Perl_debug_log, "]");
1110
1111         }
1112         PerlIO_printf( Perl_debug_log, "\n" );
1113     }
1114     PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=", (int)depth*2, "");
1115     for (word=1; word <= trie->wordcount; word++) {
1116         PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1117             (int)word, (int)(trie->wordinfo[word].prev),
1118             (int)(trie->wordinfo[word].len));
1119     }
1120     PerlIO_printf(Perl_debug_log, "\n" );
1121 }    
1122 /*
1123   Dumps a fully constructed but uncompressed trie in list form.
1124   List tries normally only are used for construction when the number of 
1125   possible chars (trie->uniquecharcount) is very high.
1126   Used for debugging make_trie().
1127 */
1128 STATIC void
1129 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1130                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
1131                          U32 depth)
1132 {
1133     U32 state;
1134     SV *sv=sv_newmortal();
1135     int colwidth= widecharmap ? 6 : 4;
1136     GET_RE_DEBUG_FLAGS_DECL;
1137
1138     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1139
1140     /* print out the table precompression.  */
1141     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1142         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1143         "------:-----+-----------------\n" );
1144     
1145     for( state=1 ; state < next_alloc ; state ++ ) {
1146         U16 charid;
1147     
1148         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1149             (int)depth * 2 + 2,"", (UV)state  );
1150         if ( ! trie->states[ state ].wordnum ) {
1151             PerlIO_printf( Perl_debug_log, "%5s| ","");
1152         } else {
1153             PerlIO_printf( Perl_debug_log, "W%4x| ",
1154                 trie->states[ state ].wordnum
1155             );
1156         }
1157         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1158             SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
1159             if ( tmp ) {
1160                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1161                     colwidth,
1162                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1163                             PL_colors[0], PL_colors[1],
1164                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1165                             PERL_PV_ESCAPE_FIRSTCHAR 
1166                     ) ,
1167                     TRIE_LIST_ITEM(state,charid).forid,
1168                     (UV)TRIE_LIST_ITEM(state,charid).newstate
1169                 );
1170                 if (!(charid % 10)) 
1171                     PerlIO_printf(Perl_debug_log, "\n%*s| ",
1172                         (int)((depth * 2) + 14), "");
1173             }
1174         }
1175         PerlIO_printf( Perl_debug_log, "\n");
1176     }
1177 }    
1178
1179 /*
1180   Dumps a fully constructed but uncompressed trie in table form.
1181   This is the normal DFA style state transition table, with a few 
1182   twists to facilitate compression later. 
1183   Used for debugging make_trie().
1184 */
1185 STATIC void
1186 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1187                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
1188                           U32 depth)
1189 {
1190     U32 state;
1191     U16 charid;
1192     SV *sv=sv_newmortal();
1193     int colwidth= widecharmap ? 6 : 4;
1194     GET_RE_DEBUG_FLAGS_DECL;
1195
1196     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1197     
1198     /*
1199        print out the table precompression so that we can do a visual check
1200        that they are identical.
1201      */
1202     
1203     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1204
1205     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1206         SV ** const tmp = av_fetch( revcharmap, charid, 0);
1207         if ( tmp ) {
1208             PerlIO_printf( Perl_debug_log, "%*s", 
1209                 colwidth,
1210                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1211                             PL_colors[0], PL_colors[1],
1212                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1213                             PERL_PV_ESCAPE_FIRSTCHAR 
1214                 ) 
1215             );
1216         }
1217     }
1218
1219     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1220
1221     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1222         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1223     }
1224
1225     PerlIO_printf( Perl_debug_log, "\n" );
1226
1227     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1228
1229         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ", 
1230             (int)depth * 2 + 2,"",
1231             (UV)TRIE_NODENUM( state ) );
1232
1233         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1234             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1235             if (v)
1236                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1237             else
1238                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1239         }
1240         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1241             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1242         } else {
1243             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1244             trie->states[ TRIE_NODENUM( state ) ].wordnum );
1245         }
1246     }
1247 }
1248
1249 #endif
1250
1251
1252 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1253   startbranch: the first branch in the whole branch sequence
1254   first      : start branch of sequence of branch-exact nodes.
1255                May be the same as startbranch
1256   last       : Thing following the last branch.
1257                May be the same as tail.
1258   tail       : item following the branch sequence
1259   count      : words in the sequence
1260   flags      : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1261   depth      : indent depth
1262
1263 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1264
1265 A trie is an N'ary tree where the branches are determined by digital
1266 decomposition of the key. IE, at the root node you look up the 1st character and
1267 follow that branch repeat until you find the end of the branches. Nodes can be
1268 marked as "accepting" meaning they represent a complete word. Eg:
1269
1270   /he|she|his|hers/
1271
1272 would convert into the following structure. Numbers represent states, letters
1273 following numbers represent valid transitions on the letter from that state, if
1274 the number is in square brackets it represents an accepting state, otherwise it
1275 will be in parenthesis.
1276
1277       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1278       |    |
1279       |   (2)
1280       |    |
1281      (1)   +-i->(6)-+-s->[7]
1282       |
1283       +-s->(3)-+-h->(4)-+-e->[5]
1284
1285       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1286
1287 This shows that when matching against the string 'hers' we will begin at state 1
1288 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1289 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1290 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1291 single traverse. We store a mapping from accepting to state to which word was
1292 matched, and then when we have multiple possibilities we try to complete the
1293 rest of the regex in the order in which they occured in the alternation.
1294
1295 The only prior NFA like behaviour that would be changed by the TRIE support is
1296 the silent ignoring of duplicate alternations which are of the form:
1297
1298  / (DUPE|DUPE) X? (?{ ... }) Y /x
1299
1300 Thus EVAL blocks following a trie may be called a different number of times with
1301 and without the optimisation. With the optimisations dupes will be silently
1302 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1303 the following demonstrates:
1304
1305  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1306
1307 which prints out 'word' three times, but
1308
1309  'words'=~/(word|word|word)(?{ print $1 })S/
1310
1311 which doesnt print it out at all. This is due to other optimisations kicking in.
1312
1313 Example of what happens on a structural level:
1314
1315 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1316
1317    1: CURLYM[1] {1,32767}(18)
1318    5:   BRANCH(8)
1319    6:     EXACT <ac>(16)
1320    8:   BRANCH(11)
1321    9:     EXACT <ad>(16)
1322   11:   BRANCH(14)
1323   12:     EXACT <ab>(16)
1324   16:   SUCCEED(0)
1325   17:   NOTHING(18)
1326   18: END(0)
1327
1328 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1329 and should turn into:
1330
1331    1: CURLYM[1] {1,32767}(18)
1332    5:   TRIE(16)
1333         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1334           <ac>
1335           <ad>
1336           <ab>
1337   16:   SUCCEED(0)
1338   17:   NOTHING(18)
1339   18: END(0)
1340
1341 Cases where tail != last would be like /(?foo|bar)baz/:
1342
1343    1: BRANCH(4)
1344    2:   EXACT <foo>(8)
1345    4: BRANCH(7)
1346    5:   EXACT <bar>(8)
1347    7: TAIL(8)
1348    8: EXACT <baz>(10)
1349   10: END(0)
1350
1351 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1352 and would end up looking like:
1353
1354     1: TRIE(8)
1355       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1356         <foo>
1357         <bar>
1358    7: TAIL(8)
1359    8: EXACT <baz>(10)
1360   10: END(0)
1361
1362     d = uvuni_to_utf8_flags(d, uv, 0);
1363
1364 is the recommended Unicode-aware way of saying
1365
1366     *(d++) = uv;
1367 */
1368
1369 #define TRIE_STORE_REVCHAR(val)                                            \
1370     STMT_START {                                                           \
1371         if (UTF) {                                                         \
1372             SV *zlopp = newSV(7); /* XXX: optimize me */                   \
1373             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
1374             unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, val); \
1375             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
1376             SvPOK_on(zlopp);                                               \
1377             SvUTF8_on(zlopp);                                              \
1378             av_push(revcharmap, zlopp);                                    \
1379         } else {                                                           \
1380             char ooooff = (char)val;                                           \
1381             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
1382         }                                                                  \
1383         } STMT_END
1384
1385 #define TRIE_READ_CHAR STMT_START {                                                     \
1386     wordlen++;                                                                          \
1387     if ( UTF ) {                                                                        \
1388         /* if it is UTF then it is either already folded, or does not need folding */   \
1389         uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags);             \
1390     }                                                                                   \
1391     else if (folder == PL_fold_latin1) {                                                \
1392         /* if we use this folder we have to obey unicode rules on latin-1 data */       \
1393         if ( foldlen > 0 ) {                                                            \
1394            uvc = utf8n_to_uvuni( (const U8*) scan, UTF8_MAXLEN, &len, uniflags );       \
1395            foldlen -= len;                                                              \
1396            scan += len;                                                                 \
1397            len = 0;                                                                     \
1398         } else {                                                                        \
1399             len = 1;                                                                    \
1400             uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, 1);                     \
1401             skiplen = UNISKIP(uvc);                                                     \
1402             foldlen -= skiplen;                                                         \
1403             scan = foldbuf + skiplen;                                                   \
1404         }                                                                               \
1405     } else {                                                                            \
1406         /* raw data, will be folded later if needed */                                  \
1407         uvc = (U32)*uc;                                                                 \
1408         len = 1;                                                                        \
1409     }                                                                                   \
1410 } STMT_END
1411
1412
1413
1414 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
1415     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
1416         U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
1417         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1418     }                                                           \
1419     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
1420     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
1421     TRIE_LIST_CUR( state )++;                                   \
1422 } STMT_END
1423
1424 #define TRIE_LIST_NEW(state) STMT_START {                       \
1425     Newxz( trie->states[ state ].trans.list,               \
1426         4, reg_trie_trans_le );                                 \
1427      TRIE_LIST_CUR( state ) = 1;                                \
1428      TRIE_LIST_LEN( state ) = 4;                                \
1429 } STMT_END
1430
1431 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
1432     U16 dupe= trie->states[ state ].wordnum;                    \
1433     regnode * const noper_next = regnext( noper );              \
1434                                                                 \
1435     DEBUG_r({                                                   \
1436         /* store the word for dumping */                        \
1437         SV* tmp;                                                \
1438         if (OP(noper) != NOTHING)                               \
1439             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
1440         else                                                    \
1441             tmp = newSVpvn_utf8( "", 0, UTF );                  \
1442         av_push( trie_words, tmp );                             \
1443     });                                                         \
1444                                                                 \
1445     curword++;                                                  \
1446     trie->wordinfo[curword].prev   = 0;                         \
1447     trie->wordinfo[curword].len    = wordlen;                   \
1448     trie->wordinfo[curword].accept = state;                     \
1449                                                                 \
1450     if ( noper_next < tail ) {                                  \
1451         if (!trie->jump)                                        \
1452             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
1453         trie->jump[curword] = (U16)(noper_next - convert);      \
1454         if (!jumper)                                            \
1455             jumper = noper_next;                                \
1456         if (!nextbranch)                                        \
1457             nextbranch= regnext(cur);                           \
1458     }                                                           \
1459                                                                 \
1460     if ( dupe ) {                                               \
1461         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
1462         /* chain, so that when the bits of chain are later    */\
1463         /* linked together, the dups appear in the chain      */\
1464         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1465         trie->wordinfo[dupe].prev = curword;                    \
1466     } else {                                                    \
1467         /* we haven't inserted this word yet.                */ \
1468         trie->states[ state ].wordnum = curword;                \
1469     }                                                           \
1470 } STMT_END
1471
1472
1473 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
1474      ( ( base + charid >=  ucharcount                                   \
1475          && base + charid < ubound                                      \
1476          && state == trie->trans[ base - ucharcount + charid ].check    \
1477          && trie->trans[ base - ucharcount + charid ].next )            \
1478            ? trie->trans[ base - ucharcount + charid ].next             \
1479            : ( state==1 ? special : 0 )                                 \
1480       )
1481
1482 #define MADE_TRIE       1
1483 #define MADE_JUMP_TRIE  2
1484 #define MADE_EXACT_TRIE 4
1485
1486 STATIC I32
1487 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1488 {
1489     dVAR;
1490     /* first pass, loop through and scan words */
1491     reg_trie_data *trie;
1492     HV *widecharmap = NULL;
1493     AV *revcharmap = newAV();
1494     regnode *cur;
1495     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1496     STRLEN len = 0;
1497     UV uvc = 0;
1498     U16 curword = 0;
1499     U32 next_alloc = 0;
1500     regnode *jumper = NULL;
1501     regnode *nextbranch = NULL;
1502     regnode *convert = NULL;
1503     U32 *prev_states; /* temp array mapping each state to previous one */
1504     /* we just use folder as a flag in utf8 */
1505     const U8 * folder = NULL;
1506
1507 #ifdef DEBUGGING
1508     const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1509     AV *trie_words = NULL;
1510     /* along with revcharmap, this only used during construction but both are
1511      * useful during debugging so we store them in the struct when debugging.
1512      */
1513 #else
1514     const U32 data_slot = add_data( pRExC_state, 2, "tu" );
1515     STRLEN trie_charcount=0;
1516 #endif
1517     SV *re_trie_maxbuff;
1518     GET_RE_DEBUG_FLAGS_DECL;
1519
1520     PERL_ARGS_ASSERT_MAKE_TRIE;
1521 #ifndef DEBUGGING
1522     PERL_UNUSED_ARG(depth);
1523 #endif
1524
1525     switch (flags) {
1526         case EXACT: break;
1527         case EXACTFA:
1528         case EXACTFU_SS:
1529         case EXACTFU_TRICKYFOLD:
1530         case EXACTFU: folder = PL_fold_latin1; break;
1531         case EXACTF:  folder = PL_fold; break;
1532         case EXACTFL: folder = PL_fold_locale; break;
1533         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1534     }
1535
1536     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1537     trie->refcount = 1;
1538     trie->startstate = 1;
1539     trie->wordcount = word_count;
1540     RExC_rxi->data->data[ data_slot ] = (void*)trie;
1541     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1542     if (flags == EXACT)
1543         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1544     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
1545                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
1546
1547     DEBUG_r({
1548         trie_words = newAV();
1549     });
1550
1551     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1552     if (!SvIOK(re_trie_maxbuff)) {
1553         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1554     }
1555     DEBUG_OPTIMISE_r({
1556                 PerlIO_printf( Perl_debug_log,
1557                   "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1558                   (int)depth * 2 + 2, "", 
1559                   REG_NODE_NUM(startbranch),REG_NODE_NUM(first), 
1560                   REG_NODE_NUM(last), REG_NODE_NUM(tail),
1561                   (int)depth);
1562     });
1563    
1564    /* Find the node we are going to overwrite */
1565     if ( first == startbranch && OP( last ) != BRANCH ) {
1566         /* whole branch chain */
1567         convert = first;
1568     } else {
1569         /* branch sub-chain */
1570         convert = NEXTOPER( first );
1571     }
1572         
1573     /*  -- First loop and Setup --
1574
1575        We first traverse the branches and scan each word to determine if it
1576        contains widechars, and how many unique chars there are, this is
1577        important as we have to build a table with at least as many columns as we
1578        have unique chars.
1579
1580        We use an array of integers to represent the character codes 0..255
1581        (trie->charmap) and we use a an HV* to store Unicode characters. We use the
1582        native representation of the character value as the key and IV's for the
1583        coded index.
1584
1585        *TODO* If we keep track of how many times each character is used we can
1586        remap the columns so that the table compression later on is more
1587        efficient in terms of memory by ensuring the most common value is in the
1588        middle and the least common are on the outside.  IMO this would be better
1589        than a most to least common mapping as theres a decent chance the most
1590        common letter will share a node with the least common, meaning the node
1591        will not be compressible. With a middle is most common approach the worst
1592        case is when we have the least common nodes twice.
1593
1594      */
1595
1596     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1597         regnode * const noper = NEXTOPER( cur );
1598         const U8 *uc = (U8*)STRING( noper );
1599         const U8 * const e  = uc + STR_LEN( noper );
1600         STRLEN foldlen = 0;
1601         U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1602         STRLEN skiplen = 0;
1603         const U8 *scan = (U8*)NULL;
1604         U32 wordlen      = 0;         /* required init */
1605         STRLEN chars = 0;
1606         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
1607
1608         if (OP(noper) == NOTHING) {
1609             trie->minlen= 0;
1610             continue;
1611         }
1612         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
1613             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1614                                           regardless of encoding */
1615             if (OP( noper ) == EXACTFU_SS) {
1616                 /* false positives are ok, so just set this */
1617                 TRIE_BITMAP_SET(trie,0xDF);
1618             }
1619         }
1620         for ( ; uc < e ; uc += len ) {
1621             TRIE_CHARCOUNT(trie)++;
1622             TRIE_READ_CHAR;
1623             chars++;
1624             if ( uvc < 256 ) {
1625                 if ( folder ) {
1626                     U8 folded= folder[ (U8) uvc ];
1627                     if ( !trie->charmap[ folded ] ) {
1628                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
1629                         TRIE_STORE_REVCHAR( folded );
1630                     }
1631                 }
1632                 if ( !trie->charmap[ uvc ] ) {
1633                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1634                     TRIE_STORE_REVCHAR( uvc );
1635                 }
1636                 if ( set_bit ) {
1637                     /* store the codepoint in the bitmap, and its folded
1638                      * equivalent. */
1639                     TRIE_BITMAP_SET(trie, uvc);
1640
1641                     /* store the folded codepoint */
1642                     if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
1643
1644                     if ( !UTF ) {
1645                         /* store first byte of utf8 representation of
1646                            variant codepoints */
1647                         if (! UNI_IS_INVARIANT(uvc)) {
1648                             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
1649                         }
1650                     }
1651                     set_bit = 0; /* We've done our bit :-) */
1652                 }
1653             } else {
1654                 SV** svpp;
1655                 if ( !widecharmap )
1656                     widecharmap = newHV();
1657
1658                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1659
1660                 if ( !svpp )
1661                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1662
1663                 if ( !SvTRUE( *svpp ) ) {
1664                     sv_setiv( *svpp, ++trie->uniquecharcount );
1665                     TRIE_STORE_REVCHAR(uvc);
1666                 }
1667             }
1668         }
1669         if( cur == first ) {
1670             trie->minlen = chars;
1671             trie->maxlen = chars;
1672         } else if (chars < trie->minlen) {
1673             trie->minlen = chars;
1674         } else if (chars > trie->maxlen) {
1675             trie->maxlen = chars;
1676         }
1677         if (OP( noper ) == EXACTFU_SS) {
1678             /* XXX: workaround - 'ss' could match "\x{DF}" so minlen could be 1 and not 2*/
1679             if (trie->minlen > 1)
1680                 trie->minlen= 1;
1681         }
1682         if (OP( noper ) == EXACTFU_TRICKYFOLD) {
1683             /* XXX: workround - things like "\x{1FBE}\x{0308}\x{0301}" can match "\x{0390}" 
1684              *                - We assume that any such sequence might match a 2 byte string */
1685             if (trie->minlen > 2 )
1686                 trie->minlen= 2;
1687         }
1688
1689     } /* end first pass */
1690     DEBUG_TRIE_COMPILE_r(
1691         PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1692                 (int)depth * 2 + 2,"",
1693                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1694                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1695                 (int)trie->minlen, (int)trie->maxlen )
1696     );
1697
1698     /*
1699         We now know what we are dealing with in terms of unique chars and
1700         string sizes so we can calculate how much memory a naive
1701         representation using a flat table  will take. If it's over a reasonable
1702         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1703         conservative but potentially much slower representation using an array
1704         of lists.
1705
1706         At the end we convert both representations into the same compressed
1707         form that will be used in regexec.c for matching with. The latter
1708         is a form that cannot be used to construct with but has memory
1709         properties similar to the list form and access properties similar
1710         to the table form making it both suitable for fast searches and
1711         small enough that its feasable to store for the duration of a program.
1712
1713         See the comment in the code where the compressed table is produced
1714         inplace from the flat tabe representation for an explanation of how
1715         the compression works.
1716
1717     */
1718
1719
1720     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
1721     prev_states[1] = 0;
1722
1723     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1724         /*
1725             Second Pass -- Array Of Lists Representation
1726
1727             Each state will be represented by a list of charid:state records
1728             (reg_trie_trans_le) the first such element holds the CUR and LEN
1729             points of the allocated array. (See defines above).
1730
1731             We build the initial structure using the lists, and then convert
1732             it into the compressed table form which allows faster lookups
1733             (but cant be modified once converted).
1734         */
1735
1736         STRLEN transcount = 1;
1737
1738         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1739             "%*sCompiling trie using list compiler\n",
1740             (int)depth * 2 + 2, ""));
1741
1742         trie->states = (reg_trie_state *)
1743             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1744                                   sizeof(reg_trie_state) );
1745         TRIE_LIST_NEW(1);
1746         next_alloc = 2;
1747
1748         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1749
1750             regnode * const noper = NEXTOPER( cur );
1751             U8 *uc           = (U8*)STRING( noper );
1752             const U8 * const e = uc + STR_LEN( noper );
1753             U32 state        = 1;         /* required init */
1754             U16 charid       = 0;         /* sanity init */
1755             U8 *scan         = (U8*)NULL; /* sanity init */
1756             STRLEN foldlen   = 0;         /* required init */
1757             U32 wordlen      = 0;         /* required init */
1758             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1759             STRLEN skiplen   = 0;
1760
1761             if (OP(noper) != NOTHING) {
1762                 for ( ; uc < e ; uc += len ) {
1763
1764                     TRIE_READ_CHAR;
1765
1766                     if ( uvc < 256 ) {
1767                         charid = trie->charmap[ uvc ];
1768                     } else {
1769                         SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1770                         if ( !svpp ) {
1771                             charid = 0;
1772                         } else {
1773                             charid=(U16)SvIV( *svpp );
1774                         }
1775                     }
1776                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1777                     if ( charid ) {
1778
1779                         U16 check;
1780                         U32 newstate = 0;
1781
1782                         charid--;
1783                         if ( !trie->states[ state ].trans.list ) {
1784                             TRIE_LIST_NEW( state );
1785                         }
1786                         for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1787                             if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1788                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1789                                 break;
1790                             }
1791                         }
1792                         if ( ! newstate ) {
1793                             newstate = next_alloc++;
1794                             prev_states[newstate] = state;
1795                             TRIE_LIST_PUSH( state, charid, newstate );
1796                             transcount++;
1797                         }
1798                         state = newstate;
1799                     } else {
1800                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1801                     }
1802                 }
1803             }
1804             TRIE_HANDLE_WORD(state);
1805
1806         } /* end second pass */
1807
1808         /* next alloc is the NEXT state to be allocated */
1809         trie->statecount = next_alloc; 
1810         trie->states = (reg_trie_state *)
1811             PerlMemShared_realloc( trie->states,
1812                                    next_alloc
1813                                    * sizeof(reg_trie_state) );
1814
1815         /* and now dump it out before we compress it */
1816         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1817                                                          revcharmap, next_alloc,
1818                                                          depth+1)
1819         );
1820
1821         trie->trans = (reg_trie_trans *)
1822             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
1823         {
1824             U32 state;
1825             U32 tp = 0;
1826             U32 zp = 0;
1827
1828
1829             for( state=1 ; state < next_alloc ; state ++ ) {
1830                 U32 base=0;
1831
1832                 /*
1833                 DEBUG_TRIE_COMPILE_MORE_r(
1834                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1835                 );
1836                 */
1837
1838                 if (trie->states[state].trans.list) {
1839                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1840                     U16 maxid=minid;
1841                     U16 idx;
1842
1843                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1844                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1845                         if ( forid < minid ) {
1846                             minid=forid;
1847                         } else if ( forid > maxid ) {
1848                             maxid=forid;
1849                         }
1850                     }
1851                     if ( transcount < tp + maxid - minid + 1) {
1852                         transcount *= 2;
1853                         trie->trans = (reg_trie_trans *)
1854                             PerlMemShared_realloc( trie->trans,
1855                                                      transcount
1856                                                      * sizeof(reg_trie_trans) );
1857                         Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1858                     }
1859                     base = trie->uniquecharcount + tp - minid;
1860                     if ( maxid == minid ) {
1861                         U32 set = 0;
1862                         for ( ; zp < tp ; zp++ ) {
1863                             if ( ! trie->trans[ zp ].next ) {
1864                                 base = trie->uniquecharcount + zp - minid;
1865                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1866                                 trie->trans[ zp ].check = state;
1867                                 set = 1;
1868                                 break;
1869                             }
1870                         }
1871                         if ( !set ) {
1872                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1873                             trie->trans[ tp ].check = state;
1874                             tp++;
1875                             zp = tp;
1876                         }
1877                     } else {
1878                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1879                             const U32 tid = base -  trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1880                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1881                             trie->trans[ tid ].check = state;
1882                         }
1883                         tp += ( maxid - minid + 1 );
1884                     }
1885                     Safefree(trie->states[ state ].trans.list);
1886                 }
1887                 /*
1888                 DEBUG_TRIE_COMPILE_MORE_r(
1889                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1890                 );
1891                 */
1892                 trie->states[ state ].trans.base=base;
1893             }
1894             trie->lasttrans = tp + 1;
1895         }
1896     } else {
1897         /*
1898            Second Pass -- Flat Table Representation.
1899
1900            we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1901            We know that we will need Charcount+1 trans at most to store the data
1902            (one row per char at worst case) So we preallocate both structures
1903            assuming worst case.
1904
1905            We then construct the trie using only the .next slots of the entry
1906            structs.
1907
1908            We use the .check field of the first entry of the node temporarily to
1909            make compression both faster and easier by keeping track of how many non
1910            zero fields are in the node.
1911
1912            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1913            transition.
1914
1915            There are two terms at use here: state as a TRIE_NODEIDX() which is a
1916            number representing the first entry of the node, and state as a
1917            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1918            TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1919            are 2 entrys per node. eg:
1920
1921              A B       A B
1922           1. 2 4    1. 3 7
1923           2. 0 3    3. 0 5
1924           3. 0 0    5. 0 0
1925           4. 0 0    7. 0 0
1926
1927            The table is internally in the right hand, idx form. However as we also
1928            have to deal with the states array which is indexed by nodenum we have to
1929            use TRIE_NODENUM() to convert.
1930
1931         */
1932         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1933             "%*sCompiling trie using table compiler\n",
1934             (int)depth * 2 + 2, ""));
1935
1936         trie->trans = (reg_trie_trans *)
1937             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
1938                                   * trie->uniquecharcount + 1,
1939                                   sizeof(reg_trie_trans) );
1940         trie->states = (reg_trie_state *)
1941             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1942                                   sizeof(reg_trie_state) );
1943         next_alloc = trie->uniquecharcount + 1;
1944
1945
1946         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1947
1948             regnode * const noper   = NEXTOPER( cur );
1949             const U8 *uc     = (U8*)STRING( noper );
1950             const U8 * const e = uc + STR_LEN( noper );
1951
1952             U32 state        = 1;         /* required init */
1953
1954             U16 charid       = 0;         /* sanity init */
1955             U32 accept_state = 0;         /* sanity init */
1956             U8 *scan         = (U8*)NULL; /* sanity init */
1957
1958             STRLEN foldlen   = 0;         /* required init */
1959             U32 wordlen      = 0;         /* required init */
1960             STRLEN skiplen   = 0;
1961             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1962
1963
1964             if ( OP(noper) != NOTHING ) {
1965                 for ( ; uc < e ; uc += len ) {
1966
1967                     TRIE_READ_CHAR;
1968
1969                     if ( uvc < 256 ) {
1970                         charid = trie->charmap[ uvc ];
1971                     } else {
1972                         SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1973                         charid = svpp ? (U16)SvIV(*svpp) : 0;
1974                     }
1975                     if ( charid ) {
1976                         charid--;
1977                         if ( !trie->trans[ state + charid ].next ) {
1978                             trie->trans[ state + charid ].next = next_alloc;
1979                             trie->trans[ state ].check++;
1980                             prev_states[TRIE_NODENUM(next_alloc)]
1981                                     = TRIE_NODENUM(state);
1982                             next_alloc += trie->uniquecharcount;
1983                         }
1984                         state = trie->trans[ state + charid ].next;
1985                     } else {
1986                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1987                     }
1988                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1989                 }
1990             }
1991             accept_state = TRIE_NODENUM( state );
1992             TRIE_HANDLE_WORD(accept_state);
1993
1994         } /* end second pass */
1995
1996         /* and now dump it out before we compress it */
1997         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
1998                                                           revcharmap,
1999                                                           next_alloc, depth+1));
2000
2001         {
2002         /*
2003            * Inplace compress the table.*
2004
2005            For sparse data sets the table constructed by the trie algorithm will
2006            be mostly 0/FAIL transitions or to put it another way mostly empty.
2007            (Note that leaf nodes will not contain any transitions.)
2008
2009            This algorithm compresses the tables by eliminating most such
2010            transitions, at the cost of a modest bit of extra work during lookup:
2011
2012            - Each states[] entry contains a .base field which indicates the
2013            index in the state[] array wheres its transition data is stored.
2014
2015            - If .base is 0 there are no valid transitions from that node.
2016
2017            - If .base is nonzero then charid is added to it to find an entry in
2018            the trans array.
2019
2020            -If trans[states[state].base+charid].check!=state then the
2021            transition is taken to be a 0/Fail transition. Thus if there are fail
2022            transitions at the front of the node then the .base offset will point
2023            somewhere inside the previous nodes data (or maybe even into a node
2024            even earlier), but the .check field determines if the transition is
2025            valid.
2026
2027            XXX - wrong maybe?
2028            The following process inplace converts the table to the compressed
2029            table: We first do not compress the root node 1,and mark all its
2030            .check pointers as 1 and set its .base pointer as 1 as well. This
2031            allows us to do a DFA construction from the compressed table later,
2032            and ensures that any .base pointers we calculate later are greater
2033            than 0.
2034
2035            - We set 'pos' to indicate the first entry of the second node.
2036
2037            - We then iterate over the columns of the node, finding the first and
2038            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2039            and set the .check pointers accordingly, and advance pos
2040            appropriately and repreat for the next node. Note that when we copy
2041            the next pointers we have to convert them from the original
2042            NODEIDX form to NODENUM form as the former is not valid post
2043            compression.
2044
2045            - If a node has no transitions used we mark its base as 0 and do not
2046            advance the pos pointer.
2047
2048            - If a node only has one transition we use a second pointer into the
2049            structure to fill in allocated fail transitions from other states.
2050            This pointer is independent of the main pointer and scans forward
2051            looking for null transitions that are allocated to a state. When it
2052            finds one it writes the single transition into the "hole".  If the
2053            pointer doesnt find one the single transition is appended as normal.
2054
2055            - Once compressed we can Renew/realloc the structures to release the
2056            excess space.
2057
2058            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2059            specifically Fig 3.47 and the associated pseudocode.
2060
2061            demq
2062         */
2063         const U32 laststate = TRIE_NODENUM( next_alloc );
2064         U32 state, charid;
2065         U32 pos = 0, zp=0;
2066         trie->statecount = laststate;
2067
2068         for ( state = 1 ; state < laststate ; state++ ) {
2069             U8 flag = 0;
2070             const U32 stateidx = TRIE_NODEIDX( state );
2071             const U32 o_used = trie->trans[ stateidx ].check;
2072             U32 used = trie->trans[ stateidx ].check;
2073             trie->trans[ stateidx ].check = 0;
2074
2075             for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
2076                 if ( flag || trie->trans[ stateidx + charid ].next ) {
2077                     if ( trie->trans[ stateidx + charid ].next ) {
2078                         if (o_used == 1) {
2079                             for ( ; zp < pos ; zp++ ) {
2080                                 if ( ! trie->trans[ zp ].next ) {
2081                                     break;
2082                                 }
2083                             }
2084                             trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
2085                             trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2086                             trie->trans[ zp ].check = state;
2087                             if ( ++zp > pos ) pos = zp;
2088                             break;
2089                         }
2090                         used--;
2091                     }
2092                     if ( !flag ) {
2093                         flag = 1;
2094                         trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
2095                     }
2096                     trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2097                     trie->trans[ pos ].check = state;
2098                     pos++;
2099                 }
2100             }
2101         }
2102         trie->lasttrans = pos + 1;
2103         trie->states = (reg_trie_state *)
2104             PerlMemShared_realloc( trie->states, laststate
2105                                    * sizeof(reg_trie_state) );
2106         DEBUG_TRIE_COMPILE_MORE_r(
2107                 PerlIO_printf( Perl_debug_log,
2108                     "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2109                     (int)depth * 2 + 2,"",
2110                     (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
2111                     (IV)next_alloc,
2112                     (IV)pos,
2113                     ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2114             );
2115
2116         } /* end table compress */
2117     }
2118     DEBUG_TRIE_COMPILE_MORE_r(
2119             PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2120                 (int)depth * 2 + 2, "",
2121                 (UV)trie->statecount,
2122                 (UV)trie->lasttrans)
2123     );
2124     /* resize the trans array to remove unused space */
2125     trie->trans = (reg_trie_trans *)
2126         PerlMemShared_realloc( trie->trans, trie->lasttrans
2127                                * sizeof(reg_trie_trans) );
2128
2129     {   /* Modify the program and insert the new TRIE node */ 
2130         U8 nodetype =(U8)(flags & 0xFF);
2131         char *str=NULL;
2132         
2133 #ifdef DEBUGGING
2134         regnode *optimize = NULL;
2135 #ifdef RE_TRACK_PATTERN_OFFSETS
2136
2137         U32 mjd_offset = 0;
2138         U32 mjd_nodelen = 0;
2139 #endif /* RE_TRACK_PATTERN_OFFSETS */
2140 #endif /* DEBUGGING */
2141         /*
2142            This means we convert either the first branch or the first Exact,
2143            depending on whether the thing following (in 'last') is a branch
2144            or not and whther first is the startbranch (ie is it a sub part of
2145            the alternation or is it the whole thing.)
2146            Assuming its a sub part we convert the EXACT otherwise we convert
2147            the whole branch sequence, including the first.
2148          */
2149         /* Find the node we are going to overwrite */
2150         if ( first != startbranch || OP( last ) == BRANCH ) {
2151             /* branch sub-chain */
2152             NEXT_OFF( first ) = (U16)(last - first);
2153 #ifdef RE_TRACK_PATTERN_OFFSETS
2154             DEBUG_r({
2155                 mjd_offset= Node_Offset((convert));
2156                 mjd_nodelen= Node_Length((convert));
2157             });
2158 #endif
2159             /* whole branch chain */
2160         }
2161 #ifdef RE_TRACK_PATTERN_OFFSETS
2162         else {
2163             DEBUG_r({
2164                 const  regnode *nop = NEXTOPER( convert );
2165                 mjd_offset= Node_Offset((nop));
2166                 mjd_nodelen= Node_Length((nop));
2167             });
2168         }
2169         DEBUG_OPTIMISE_r(
2170             PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2171                 (int)depth * 2 + 2, "",
2172                 (UV)mjd_offset, (UV)mjd_nodelen)
2173         );
2174 #endif
2175         /* But first we check to see if there is a common prefix we can 
2176            split out as an EXACT and put in front of the TRIE node.  */
2177         trie->startstate= 1;
2178         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
2179             U32 state;
2180             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2181                 U32 ofs = 0;
2182                 I32 idx = -1;
2183                 U32 count = 0;
2184                 const U32 base = trie->states[ state ].trans.base;
2185
2186                 if ( trie->states[state].wordnum )
2187                         count = 1;
2188
2189                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2190                     if ( ( base + ofs >= trie->uniquecharcount ) &&
2191                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2192                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2193                     {
2194                         if ( ++count > 1 ) {
2195                             SV **tmp = av_fetch( revcharmap, ofs, 0);
2196                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2197                             if ( state == 1 ) break;
2198                             if ( count == 2 ) {
2199                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2200                                 DEBUG_OPTIMISE_r(
2201                                     PerlIO_printf(Perl_debug_log,
2202                                         "%*sNew Start State=%"UVuf" Class: [",
2203                                         (int)depth * 2 + 2, "",
2204                                         (UV)state));
2205                                 if (idx >= 0) {
2206                                     SV ** const tmp = av_fetch( revcharmap, idx, 0);
2207                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2208
2209                                     TRIE_BITMAP_SET(trie,*ch);
2210                                     if ( folder )
2211                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
2212                                     DEBUG_OPTIMISE_r(
2213                                         PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2214                                     );
2215                                 }
2216                             }
2217                             TRIE_BITMAP_SET(trie,*ch);
2218                             if ( folder )
2219                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2220                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2221                         }
2222                         idx = ofs;
2223                     }
2224                 }
2225                 if ( count == 1 ) {
2226                     SV **tmp = av_fetch( revcharmap, idx, 0);
2227                     STRLEN len;
2228                     char *ch = SvPV( *tmp, len );
2229                     DEBUG_OPTIMISE_r({
2230                         SV *sv=sv_newmortal();
2231                         PerlIO_printf( Perl_debug_log,
2232                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2233                             (int)depth * 2 + 2, "",
2234                             (UV)state, (UV)idx, 
2235                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6, 
2236                                 PL_colors[0], PL_colors[1],
2237                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2238                                 PERL_PV_ESCAPE_FIRSTCHAR 
2239                             )
2240                         );
2241                     });
2242                     if ( state==1 ) {
2243                         OP( convert ) = nodetype;
2244                         str=STRING(convert);
2245                         STR_LEN(convert)=0;
2246                     }
2247                     STR_LEN(convert) += len;
2248                     while (len--)
2249                         *str++ = *ch++;
2250                 } else {
2251 #ifdef DEBUGGING            
2252                     if (state>1)
2253                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2254 #endif
2255                     break;
2256                 }
2257             }
2258             trie->prefixlen = (state-1);
2259             if (str) {
2260                 regnode *n = convert+NODE_SZ_STR(convert);
2261                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2262                 trie->startstate = state;
2263                 trie->minlen -= (state - 1);
2264                 trie->maxlen -= (state - 1);
2265 #ifdef DEBUGGING
2266                /* At least the UNICOS C compiler choked on this
2267                 * being argument to DEBUG_r(), so let's just have
2268                 * it right here. */
2269                if (
2270 #ifdef PERL_EXT_RE_BUILD
2271                    1
2272 #else
2273                    DEBUG_r_TEST
2274 #endif
2275                    ) {
2276                    regnode *fix = convert;
2277                    U32 word = trie->wordcount;
2278                    mjd_nodelen++;
2279                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2280                    while( ++fix < n ) {
2281                        Set_Node_Offset_Length(fix, 0, 0);
2282                    }
2283                    while (word--) {
2284                        SV ** const tmp = av_fetch( trie_words, word, 0 );
2285                        if (tmp) {
2286                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
2287                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2288                            else
2289                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2290                        }
2291                    }
2292                }
2293 #endif
2294                 if (trie->maxlen) {
2295                     convert = n;
2296                 } else {
2297                     NEXT_OFF(convert) = (U16)(tail - convert);
2298                     DEBUG_r(optimize= n);
2299                 }
2300             }
2301         }
2302         if (!jumper) 
2303             jumper = last; 
2304         if ( trie->maxlen ) {
2305             NEXT_OFF( convert ) = (U16)(tail - convert);
2306             ARG_SET( convert, data_slot );
2307             /* Store the offset to the first unabsorbed branch in 
2308                jump[0], which is otherwise unused by the jump logic. 
2309                We use this when dumping a trie and during optimisation. */
2310             if (trie->jump) 
2311                 trie->jump[0] = (U16)(nextbranch - convert);
2312             
2313             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2314              *   and there is a bitmap
2315              *   and the first "jump target" node we found leaves enough room
2316              * then convert the TRIE node into a TRIEC node, with the bitmap
2317              * embedded inline in the opcode - this is hypothetically faster.
2318              */
2319             if ( !trie->states[trie->startstate].wordnum
2320                  && trie->bitmap
2321                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2322             {
2323                 OP( convert ) = TRIEC;
2324                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2325                 PerlMemShared_free(trie->bitmap);
2326                 trie->bitmap= NULL;
2327             } else 
2328                 OP( convert ) = TRIE;
2329
2330             /* store the type in the flags */
2331             convert->flags = nodetype;
2332             DEBUG_r({
2333             optimize = convert 
2334                       + NODE_STEP_REGNODE 
2335                       + regarglen[ OP( convert ) ];
2336             });
2337             /* XXX We really should free up the resource in trie now, 
2338                    as we won't use them - (which resources?) dmq */
2339         }
2340         /* needed for dumping*/
2341         DEBUG_r(if (optimize) {
2342             regnode *opt = convert;
2343
2344             while ( ++opt < optimize) {
2345                 Set_Node_Offset_Length(opt,0,0);
2346             }
2347             /* 
2348                 Try to clean up some of the debris left after the 
2349                 optimisation.
2350              */
2351             while( optimize < jumper ) {
2352                 mjd_nodelen += Node_Length((optimize));
2353                 OP( optimize ) = OPTIMIZED;
2354                 Set_Node_Offset_Length(optimize,0,0);
2355                 optimize++;
2356             }
2357             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2358         });
2359     } /* end node insert */
2360
2361     /*  Finish populating the prev field of the wordinfo array.  Walk back
2362      *  from each accept state until we find another accept state, and if
2363      *  so, point the first word's .prev field at the second word. If the
2364      *  second already has a .prev field set, stop now. This will be the
2365      *  case either if we've already processed that word's accept state,
2366      *  or that state had multiple words, and the overspill words were
2367      *  already linked up earlier.
2368      */
2369     {
2370         U16 word;
2371         U32 state;
2372         U16 prev;
2373
2374         for (word=1; word <= trie->wordcount; word++) {
2375             prev = 0;
2376             if (trie->wordinfo[word].prev)
2377                 continue;
2378             state = trie->wordinfo[word].accept;
2379             while (state) {
2380                 state = prev_states[state];
2381                 if (!state)
2382                     break;
2383                 prev = trie->states[state].wordnum;
2384                 if (prev)
2385                     break;
2386             }
2387             trie->wordinfo[word].prev = prev;
2388         }
2389         Safefree(prev_states);
2390     }
2391
2392
2393     /* and now dump out the compressed format */
2394     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2395
2396     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2397 #ifdef DEBUGGING
2398     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2399     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2400 #else
2401     SvREFCNT_dec(revcharmap);
2402 #endif
2403     return trie->jump 
2404            ? MADE_JUMP_TRIE 
2405            : trie->startstate>1 
2406              ? MADE_EXACT_TRIE 
2407              : MADE_TRIE;
2408 }
2409
2410 STATIC void
2411 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
2412 {
2413 /* The Trie is constructed and compressed now so we can build a fail array if it's needed
2414
2415    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2416    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2417    ISBN 0-201-10088-6
2418
2419    We find the fail state for each state in the trie, this state is the longest proper
2420    suffix of the current state's 'word' that is also a proper prefix of another word in our
2421    trie. State 1 represents the word '' and is thus the default fail state. This allows
2422    the DFA not to have to restart after its tried and failed a word at a given point, it
2423    simply continues as though it had been matching the other word in the first place.
2424    Consider
2425       'abcdgu'=~/abcdefg|cdgu/
2426    When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2427    fail, which would bring us to the state representing 'd' in the second word where we would
2428    try 'g' and succeed, proceeding to match 'cdgu'.
2429  */
2430  /* add a fail transition */
2431     const U32 trie_offset = ARG(source);
2432     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2433     U32 *q;
2434     const U32 ucharcount = trie->uniquecharcount;
2435     const U32 numstates = trie->statecount;
2436     const U32 ubound = trie->lasttrans + ucharcount;
2437     U32 q_read = 0;
2438     U32 q_write = 0;
2439     U32 charid;
2440     U32 base = trie->states[ 1 ].trans.base;
2441     U32 *fail;
2442     reg_ac_data *aho;
2443     const U32 data_slot = add_data( pRExC_state, 1, "T" );
2444     GET_RE_DEBUG_FLAGS_DECL;
2445
2446     PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2447 #ifndef DEBUGGING
2448     PERL_UNUSED_ARG(depth);
2449 #endif
2450
2451
2452     ARG_SET( stclass, data_slot );
2453     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2454     RExC_rxi->data->data[ data_slot ] = (void*)aho;
2455     aho->trie=trie_offset;
2456     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2457     Copy( trie->states, aho->states, numstates, reg_trie_state );
2458     Newxz( q, numstates, U32);
2459     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2460     aho->refcount = 1;
2461     fail = aho->fail;
2462     /* initialize fail[0..1] to be 1 so that we always have
2463        a valid final fail state */
2464     fail[ 0 ] = fail[ 1 ] = 1;
2465
2466     for ( charid = 0; charid < ucharcount ; charid++ ) {
2467         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2468         if ( newstate ) {
2469             q[ q_write ] = newstate;
2470             /* set to point at the root */
2471             fail[ q[ q_write++ ] ]=1;
2472         }
2473     }
2474     while ( q_read < q_write) {
2475         const U32 cur = q[ q_read++ % numstates ];
2476         base = trie->states[ cur ].trans.base;
2477
2478         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2479             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2480             if (ch_state) {
2481                 U32 fail_state = cur;
2482                 U32 fail_base;
2483                 do {
2484                     fail_state = fail[ fail_state ];
2485                     fail_base = aho->states[ fail_state ].trans.base;
2486                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2487
2488                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2489                 fail[ ch_state ] = fail_state;
2490                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2491                 {
2492                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
2493                 }
2494                 q[ q_write++ % numstates] = ch_state;
2495             }
2496         }
2497     }
2498     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2499        when we fail in state 1, this allows us to use the
2500        charclass scan to find a valid start char. This is based on the principle
2501        that theres a good chance the string being searched contains lots of stuff
2502        that cant be a start char.
2503      */
2504     fail[ 0 ] = fail[ 1 ] = 0;
2505     DEBUG_TRIE_COMPILE_r({
2506         PerlIO_printf(Perl_debug_log,
2507                       "%*sStclass Failtable (%"UVuf" states): 0", 
2508                       (int)(depth * 2), "", (UV)numstates
2509         );
2510         for( q_read=1; q_read<numstates; q_read++ ) {
2511             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2512         }
2513         PerlIO_printf(Perl_debug_log, "\n");
2514     });
2515     Safefree(q);
2516     /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2517 }
2518
2519
2520 /*
2521  * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2522  * These need to be revisited when a newer toolchain becomes available.
2523  */
2524 #if defined(__sparc64__) && defined(__GNUC__)
2525 #   if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2526 #       undef  SPARC64_GCC_WORKAROUND
2527 #       define SPARC64_GCC_WORKAROUND 1
2528 #   endif
2529 #endif
2530
2531 #define DEBUG_PEEP(str,scan,depth) \
2532     DEBUG_OPTIMISE_r({if (scan){ \
2533        SV * const mysv=sv_newmortal(); \
2534        regnode *Next = regnext(scan); \
2535        regprop(RExC_rx, mysv, scan); \
2536        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2537        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2538        Next ? (REG_NODE_NUM(Next)) : 0 ); \
2539    }});
2540
2541
2542 /* The below joins as many adjacent EXACTish nodes as possible into a single
2543  * one, and looks for problematic sequences of characters whose folds vs.
2544  * non-folds have sufficiently different lengths, that the optimizer would be
2545  * fooled into rejecting legitimate matches of them, and the trie construction
2546  * code can't cope with them.  The joining is only done if:
2547  * 1) there is room in the current conglomerated node to entirely contain the
2548  *    next one.
2549  * 2) they are the exact same node type
2550  *
2551  * The adjacent nodes actually may be separated by NOTHING kind nodes, and
2552  * these get optimized out
2553  *
2554  * If there are problematic code sequences, *min_subtract is set to the delta
2555  * that the minimum size of the node can be less than its actual size.  And,
2556  * the node type of the result is changed to reflect that it contains these
2557  * sequences.
2558  *
2559  * And *has_exactf_sharp_s is set to indicate whether or not the node is EXACTF
2560  * and contains LATIN SMALL LETTER SHARP S
2561  *
2562  * This is as good a place as any to discuss the design of handling these
2563  * problematic sequences.  It's been wrong in Perl for a very long time.  There
2564  * are three code points in Unicode whose folded lengths differ so much from
2565  * the un-folded lengths that it causes problems for the optimizer and trie
2566  * construction.  Why only these are problematic, and not others where lengths
2567  * also differ is something I (khw) do not understand.  New versions of Unicode
2568  * might add more such code points.  Hopefully the logic in fold_grind.t that
2569  * figures out what to test (in part by verifying that each size-combination
2570  * gets tested) will catch any that do come along, so they can be added to the
2571  * special handling below.  The chances of new ones are actually rather small,
2572  * as most, if not all, of the world's scripts that have casefolding have
2573  * already been encoded by Unicode.  Also, a number of Unicode's decisions were
2574  * made to allow compatibility with pre-existing standards, and almost all of
2575  * those have already been dealt with.  These would otherwise be the most
2576  * likely candidates for generating further tricky sequences.  In other words,
2577  * Unicode by itself is unlikely to add new ones unless it is for compatibility
2578  * with pre-existing standards, and there aren't many of those left.
2579  *
2580  * The previous designs for dealing with these involved assigning a special
2581  * node for them.  This approach doesn't work, as evidenced by this example:
2582  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
2583  * Both these fold to "sss", but if the pattern is parsed to create a node of
2584  * that would match just the \xDF, it won't be able to handle the case where a
2585  * successful match would have to cross the node's boundary.  The new approach
2586  * that hopefully generally solves the problem generates an EXACTFU_SS node
2587  * that is "sss".
2588  *
2589  * There are a number of components to the approach (a lot of work for just
2590  * three code points!):
2591  * 1)   This routine examines each EXACTFish node that could contain the
2592  *      problematic sequences.  It returns in *min_subtract how much to
2593  *      subtract from the the actual length of the string to get a real minimum
2594  *      for one that could match it.  This number is usually 0 except for the
2595  *      problematic sequences.  This delta is used by the caller to adjust the
2596  *      min length of the match, and the delta between min and max, so that the
2597  *      optimizer doesn't reject these possibilities based on size constraints.
2598  * 2)   These sequences are not currently correctly handled by the trie code
2599  *      either, so it changes the joined node type to ops that are not handled
2600  *      by trie's, those new ops being EXACTFU_SS and EXACTFU_TRICKYFOLD.
2601  * 3)   This is sufficient for the two Greek sequences (described below), but
2602  *      the one involving the Sharp s (\xDF) needs more.  The node type
2603  *      EXACTFU_SS is used for an EXACTFU node that contains at least one "ss"
2604  *      sequence in it.  For non-UTF-8 patterns and strings, this is the only
2605  *      case where there is a possible fold length change.  That means that a
2606  *      regular EXACTFU node without UTF-8 involvement doesn't have to concern
2607  *      itself with length changes, and so can be processed faster.  regexec.c
2608  *      takes advantage of this.  Generally, an EXACTFish node that is in UTF-8
2609  *      is pre-folded by regcomp.c.  This saves effort in regex matching.
2610  *      However, probably mostly for historical reasons, the pre-folding isn't
2611  *      done for non-UTF8 patterns (and it can't be for EXACTF and EXACTFL
2612  *      nodes, as what they fold to isn't known until runtime.)  The fold
2613  *      possibilities for the non-UTF8 patterns are quite simple, except for
2614  *      the sharp s.  All the ones that don't involve a UTF-8 target string
2615  *      are members of a fold-pair, and arrays are set up for all of them
2616  *      that quickly find the other member of the pair.  It might actually
2617  *      be faster to pre-fold these, but it isn't currently done, except for
2618  *      the sharp s.  Code elsewhere in this file makes sure that it gets
2619  *      folded to 'ss', even if the pattern isn't UTF-8.  This avoids the
2620  *      issues described in the next item.
2621  * 4)   A problem remains for the sharp s in EXACTF nodes.  Whether it matches
2622  *      'ss' or not is not knowable at compile time.  It will match iff the
2623  *      target string is in UTF-8, unlike the EXACTFU nodes, where it always
2624  *      matches; and the EXACTFL and EXACTFA nodes where it never does.  Thus
2625  *      it can't be folded to "ss" at compile time, unlike EXACTFU does as
2626  *      described in item 3).  An assumption that the optimizer part of
2627  *      regexec.c (probably unwittingly) makes is that a character in the
2628  *      pattern corresponds to at most a single character in the target string.
2629  *      (And I do mean character, and not byte here, unlike other parts of the
2630  *      documentation that have never been updated to account for multibyte
2631  *      Unicode.)  This assumption is wrong only in this case, as all other
2632  *      cases are either 1-1 folds when no UTF-8 is involved; or is true by
2633  *      virtue of having this file pre-fold UTF-8 patterns.   I'm
2634  *      reluctant to try to change this assumption, so instead the code punts.
2635  *      This routine examines EXACTF nodes for the sharp s, and returns a
2636  *      boolean indicating whether or not the node is an EXACTF node that
2637  *      contains a sharp s.  When it is true, the caller sets a flag that later
2638  *      causes the optimizer in this file to not set values for the floating
2639  *      and fixed string lengths, and thus avoids the optimizer code in
2640  *      regexec.c that makes the invalid assumption.  Thus, there is no
2641  *      optimization based on string lengths for EXACTF nodes that contain the
2642  *      sharp s.  This only happens for /id rules (which means the pattern
2643  *      isn't in UTF-8).
2644  */
2645
2646 #define JOIN_EXACT(scan,min_subtract,has_exactf_sharp_s, flags) \
2647     if (PL_regkind[OP(scan)] == EXACT) \
2648         join_exact(pRExC_state,(scan),(min_subtract),has_exactf_sharp_s, (flags),NULL,depth+1)
2649
2650 STATIC U32
2651 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan, UV *min_subtract, bool *has_exactf_sharp_s, U32 flags,regnode *val, U32 depth) {
2652     /* Merge several consecutive EXACTish nodes into one. */
2653     regnode *n = regnext(scan);
2654     U32 stringok = 1;
2655     regnode *next = scan + NODE_SZ_STR(scan);
2656     U32 merged = 0;
2657     U32 stopnow = 0;
2658 #ifdef DEBUGGING
2659     regnode *stop = scan;
2660     GET_RE_DEBUG_FLAGS_DECL;
2661 #else
2662     PERL_UNUSED_ARG(depth);
2663 #endif
2664
2665     PERL_ARGS_ASSERT_JOIN_EXACT;
2666 #ifndef EXPERIMENTAL_INPLACESCAN
2667     PERL_UNUSED_ARG(flags);
2668     PERL_UNUSED_ARG(val);
2669 #endif
2670     DEBUG_PEEP("join",scan,depth);
2671
2672     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
2673      * EXACT ones that are mergeable to the current one. */
2674     while (n
2675            && (PL_regkind[OP(n)] == NOTHING
2676                || (stringok && OP(n) == OP(scan)))
2677            && NEXT_OFF(n)
2678            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
2679     {
2680         
2681         if (OP(n) == TAIL || n > next)
2682             stringok = 0;
2683         if (PL_regkind[OP(n)] == NOTHING) {
2684             DEBUG_PEEP("skip:",n,depth);
2685             NEXT_OFF(scan) += NEXT_OFF(n);
2686             next = n + NODE_STEP_REGNODE;
2687 #ifdef DEBUGGING
2688             if (stringok)
2689                 stop = n;
2690 #endif
2691             n = regnext(n);
2692         }
2693         else if (stringok) {
2694             const unsigned int oldl = STR_LEN(scan);
2695             regnode * const nnext = regnext(n);
2696
2697             if (oldl + STR_LEN(n) > U8_MAX)
2698                 break;
2699             
2700             DEBUG_PEEP("merg",n,depth);
2701             merged++;
2702
2703             NEXT_OFF(scan) += NEXT_OFF(n);
2704             STR_LEN(scan) += STR_LEN(n);
2705             next = n + NODE_SZ_STR(n);
2706             /* Now we can overwrite *n : */
2707             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2708 #ifdef DEBUGGING
2709             stop = next - 1;
2710 #endif
2711             n = nnext;
2712             if (stopnow) break;
2713         }
2714
2715 #ifdef EXPERIMENTAL_INPLACESCAN
2716         if (flags && !NEXT_OFF(n)) {
2717             DEBUG_PEEP("atch", val, depth);
2718             if (reg_off_by_arg[OP(n)]) {
2719                 ARG_SET(n, val - n);
2720             }
2721             else {
2722                 NEXT_OFF(n) = val - n;
2723             }
2724             stopnow = 1;
2725         }
2726 #endif
2727     }
2728
2729     *min_subtract = 0;
2730     *has_exactf_sharp_s = FALSE;
2731
2732     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
2733      * can now analyze for sequences of problematic code points.  (Prior to
2734      * this final joining, sequences could have been split over boundaries, and
2735      * hence missed).  The sequences only happen in folding, hence for any
2736      * non-EXACT EXACTish node */
2737     if (OP(scan) != EXACT) {
2738         U8 *s;
2739         U8 * s0 = (U8*) STRING(scan);
2740         U8 * const s_end = s0 + STR_LEN(scan);
2741
2742         /* The below is perhaps overboard, but this allows us to save a test
2743          * each time through the loop at the expense of a mask.  This is
2744          * because on both EBCDIC and ASCII machines, 'S' and 's' differ by a
2745          * single bit.  On ASCII they are 32 apart; on EBCDIC, they are 64.
2746          * This uses an exclusive 'or' to find that bit and then inverts it to
2747          * form a mask, with just a single 0, in the bit position where 'S' and
2748          * 's' differ. */
2749         const U8 S_or_s_mask = (U8) ~ ('S' ^ 's');
2750         const U8 s_masked = 's' & S_or_s_mask;
2751
2752         /* One pass is made over the node's string looking for all the
2753          * possibilities.  to avoid some tests in the loop, there are two main
2754          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
2755          * non-UTF-8 */
2756         if (UTF) {
2757
2758             /* There are two problematic Greek code points in Unicode
2759              * casefolding
2760              *
2761              * U+0390 - GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS
2762              * U+03B0 - GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS
2763              *
2764              * which casefold to
2765              *
2766              * Unicode                      UTF-8
2767              *
2768              * U+03B9 U+0308 U+0301         0xCE 0xB9 0xCC 0x88 0xCC 0x81
2769              * U+03C5 U+0308 U+0301         0xCF 0x85 0xCC 0x88 0xCC 0x81
2770              *
2771              * This means that in case-insensitive matching (or "loose
2772              * matching", as Unicode calls it), an EXACTF of length six (the
2773              * UTF-8 encoded byte length of the above casefolded versions) can
2774              * match a target string of length two (the byte length of UTF-8
2775              * encoded U+0390 or U+03B0).  This would rather mess up the
2776              * minimum length computation.  (there are other code points that
2777              * also fold to these two sequences, but the delta is smaller)
2778              *
2779              * If these sequences are found, the minimum length is decreased by
2780              * four (six minus two).
2781              *
2782              * Similarly, 'ss' may match the single char and byte LATIN SMALL
2783              * LETTER SHARP S.  We decrease the min length by 1 for each
2784              * occurrence of 'ss' found */
2785
2786 #ifdef EBCDIC /* RD tunifold greek 0390 and 03B0 */
2787 #           define U390_first_byte 0xb4
2788             const U8 U390_tail[] = "\x68\xaf\x49\xaf\x42";
2789 #           define U3B0_first_byte 0xb5
2790             const U8 U3B0_tail[] = "\x46\xaf\x49\xaf\x42";
2791 #else
2792 #           define U390_first_byte 0xce
2793             const U8 U390_tail[] = "\xb9\xcc\x88\xcc\x81";
2794 #           define U3B0_first_byte 0xcf
2795             const U8 U3B0_tail[] = "\x85\xcc\x88\xcc\x81";
2796 #endif
2797             const U8 len = sizeof(U390_tail); /* (-1 for NUL; +1 for 1st byte;
2798                                                  yields a net of 0 */
2799             /* Examine the string for one of the problematic sequences */
2800             for (s = s0;
2801                  s < s_end - 1; /* Can stop 1 before the end, as minimum length
2802                                  * sequence we are looking for is 2 */
2803                  s += UTF8SKIP(s))
2804             {
2805
2806                 /* Look for the first byte in each problematic sequence */
2807                 switch (*s) {
2808                     /* We don't have to worry about other things that fold to
2809                      * 's' (such as the long s, U+017F), as all above-latin1
2810                      * code points have been pre-folded */
2811                     case 's':
2812                     case 'S':
2813
2814                         /* Current character is an 's' or 'S'.  If next one is
2815                          * as well, we have the dreaded sequence */
2816                         if (((*(s+1) & S_or_s_mask) == s_masked)
2817                             /* These two node types don't have special handling
2818                              * for 'ss' */
2819                             && OP(scan) != EXACTFL && OP(scan) != EXACTFA)
2820                         {
2821                             *min_subtract += 1;
2822                             OP(scan) = EXACTFU_SS;
2823                             s++;    /* No need to look at this character again */
2824                         }
2825                         break;
2826
2827                     case U390_first_byte:
2828                         if (s_end - s >= len
2829
2830                             /* The 1's are because are skipping comparing the
2831                              * first byte */
2832                             && memEQ(s + 1, U390_tail, len - 1))
2833                         {
2834                             goto greek_sequence;
2835                         }
2836                         break;
2837
2838                     case U3B0_first_byte:
2839                         if (! (s_end - s >= len
2840                                && memEQ(s + 1, U3B0_tail, len - 1)))
2841                         {
2842                             break;
2843                         }
2844                       greek_sequence:
2845                         *min_subtract += 4;
2846
2847                         /* This can't currently be handled by trie's, so change
2848                          * the node type to indicate this.  If EXACTFA and
2849                          * EXACTFL were ever to be handled by trie's, this
2850                          * would have to be changed.  If this node has already
2851                          * been changed to EXACTFU_SS in this loop, leave it as
2852                          * is.  (I (khw) think it doesn't matter in regexec.c
2853                          * for UTF patterns, but no need to change it */
2854                         if (OP(scan) == EXACTFU) {
2855                             OP(scan) = EXACTFU_TRICKYFOLD;
2856                         }
2857                         s += 6; /* We already know what this sequence is.  Skip
2858                                    the rest of it */
2859                         break;
2860                 }
2861             }
2862         }
2863         else if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2864
2865             /* Here, the pattern is not UTF-8.  We need to look only for the
2866              * 'ss' sequence, and in the EXACTF case, the sharp s, which can be
2867              * in the final position.  Otherwise we can stop looking 1 byte
2868              * earlier because have to find both the first and second 's' */
2869             const U8* upper = (OP(scan) == EXACTF) ? s_end : s_end -1;
2870
2871             for (s = s0; s < upper; s++) {
2872                 switch (*s) {
2873                     case 'S':
2874                     case 's':
2875                         if (s_end - s > 1
2876                             && ((*(s+1) & S_or_s_mask) == s_masked))
2877                         {
2878                             *min_subtract += 1;
2879
2880                             /* EXACTF nodes need to know that the minimum
2881                              * length changed so that a sharp s in the string
2882                              * can match this ss in the pattern, but they
2883                              * remain EXACTF nodes, as they are not trie'able,
2884                              * so don't have to invent a new node type to
2885                              * exclude them from the trie code */
2886                             if (OP(scan) != EXACTF) {
2887                                 OP(scan) = EXACTFU_SS;
2888                             }
2889                             s++;
2890                         }
2891                         break;
2892                     case LATIN_SMALL_LETTER_SHARP_S:
2893                         if (OP(scan) == EXACTF) {
2894                             *has_exactf_sharp_s = TRUE;
2895                         }
2896                         break;
2897                 }
2898             }
2899         }
2900     }
2901
2902 #ifdef DEBUGGING
2903     /* Allow dumping but overwriting the collection of skipped
2904      * ops and/or strings with fake optimized ops */
2905     n = scan + NODE_SZ_STR(scan);
2906     while (n <= stop) {
2907         OP(n) = OPTIMIZED;
2908         FLAGS(n) = 0;
2909         NEXT_OFF(n) = 0;
2910         n++;
2911     }
2912 #endif
2913     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2914     return stopnow;
2915 }
2916
2917 /* REx optimizer.  Converts nodes into quicker variants "in place".
2918    Finds fixed substrings.  */
2919
2920 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
2921    to the position after last scanned or to NULL. */
2922
2923 #define INIT_AND_WITHP \
2924     assert(!and_withp); \
2925     Newx(and_withp,1,struct regnode_charclass_class); \
2926     SAVEFREEPV(and_withp)
2927
2928 /* this is a chain of data about sub patterns we are processing that
2929    need to be handled separately/specially in study_chunk. Its so
2930    we can simulate recursion without losing state.  */
2931 struct scan_frame;
2932 typedef struct scan_frame {
2933     regnode *last;  /* last node to process in this frame */
2934     regnode *next;  /* next node to process when last is reached */
2935     struct scan_frame *prev; /*previous frame*/
2936     I32 stop; /* what stopparen do we use */
2937 } scan_frame;
2938
2939
2940 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
2941
2942 #define CASE_SYNST_FNC(nAmE)                                       \
2943 case nAmE:                                                         \
2944     if (flags & SCF_DO_STCLASS_AND) {                              \
2945             for (value = 0; value < 256; value++)                  \
2946                 if (!is_ ## nAmE ## _cp(value))                       \
2947                     ANYOF_BITMAP_CLEAR(data->start_class, value);  \
2948     }                                                              \
2949     else {                                                         \
2950             for (value = 0; value < 256; value++)                  \
2951                 if (is_ ## nAmE ## _cp(value))                        \
2952                     ANYOF_BITMAP_SET(data->start_class, value);    \
2953     }                                                              \
2954     break;                                                         \
2955 case N ## nAmE:                                                    \
2956     if (flags & SCF_DO_STCLASS_AND) {                              \
2957             for (value = 0; value < 256; value++)                   \
2958                 if (is_ ## nAmE ## _cp(value))                         \
2959                     ANYOF_BITMAP_CLEAR(data->start_class, value);   \
2960     }                                                               \
2961     else {                                                          \
2962             for (value = 0; value < 256; value++)                   \
2963                 if (!is_ ## nAmE ## _cp(value))                        \
2964                     ANYOF_BITMAP_SET(data->start_class, value);     \
2965     }                                                               \
2966     break
2967
2968
2969
2970 STATIC I32
2971 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
2972                         I32 *minlenp, I32 *deltap,
2973                         regnode *last,
2974                         scan_data_t *data,
2975                         I32 stopparen,
2976                         U8* recursed,
2977                         struct regnode_charclass_class *and_withp,
2978                         U32 flags, U32 depth)
2979                         /* scanp: Start here (read-write). */
2980                         /* deltap: Write maxlen-minlen here. */
2981                         /* last: Stop before this one. */
2982                         /* data: string data about the pattern */
2983                         /* stopparen: treat close N as END */
2984                         /* recursed: which subroutines have we recursed into */
2985                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
2986 {
2987     dVAR;
2988     I32 min = 0, pars = 0, code;
2989     regnode *scan = *scanp, *next;
2990     I32 delta = 0;
2991     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
2992     int is_inf_internal = 0;            /* The studied chunk is infinite */
2993     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
2994     scan_data_t data_fake;
2995     SV *re_trie_maxbuff = NULL;
2996     regnode *first_non_open = scan;
2997     I32 stopmin = I32_MAX;
2998     scan_frame *frame = NULL;
2999     GET_RE_DEBUG_FLAGS_DECL;
3000
3001     PERL_ARGS_ASSERT_STUDY_CHUNK;
3002
3003 #ifdef DEBUGGING
3004     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3005 #endif
3006
3007     if ( depth == 0 ) {
3008         while (first_non_open && OP(first_non_open) == OPEN)
3009             first_non_open=regnext(first_non_open);
3010     }
3011
3012
3013   fake_study_recurse:
3014     while ( scan && OP(scan) != END && scan < last ){
3015         UV min_subtract = 0;    /* How much to subtract from the minimum node
3016                                    length to get a real minimum (because the
3017                                    folded version may be shorter) */
3018         bool has_exactf_sharp_s = FALSE;
3019         /* Peephole optimizer: */
3020         DEBUG_STUDYDATA("Peep:", data,depth);
3021         DEBUG_PEEP("Peep",scan,depth);
3022
3023         /* Its not clear to khw or hv why this is done here, and not in the
3024          * clauses that deal with EXACT nodes.  khw's guess is that it's
3025          * because of a previous design */
3026         JOIN_EXACT(scan,&min_subtract, &has_exactf_sharp_s, 0);
3027
3028         /* Follow the next-chain of the current node and optimize
3029            away all the NOTHINGs from it.  */
3030         if (OP(scan) != CURLYX) {
3031             const int max = (reg_off_by_arg[OP(scan)]
3032                        ? I32_MAX
3033                        /* I32 may be smaller than U16 on CRAYs! */
3034                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3035             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3036             int noff;
3037             regnode *n = scan;
3038
3039             /* Skip NOTHING and LONGJMP. */
3040             while ((n = regnext(n))
3041                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3042                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3043                    && off + noff < max)
3044                 off += noff;
3045             if (reg_off_by_arg[OP(scan)])
3046                 ARG(scan) = off;
3047             else
3048                 NEXT_OFF(scan) = off;
3049         }
3050
3051
3052
3053         /* The principal pseudo-switch.  Cannot be a switch, since we
3054            look into several different things.  */
3055         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3056                    || OP(scan) == IFTHEN) {
3057             next = regnext(scan);
3058             code = OP(scan);
3059             /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
3060
3061             if (OP(next) == code || code == IFTHEN) {
3062                 /* NOTE - There is similar code to this block below for handling
3063                    TRIE nodes on a re-study.  If you change stuff here check there
3064                    too. */
3065                 I32 max1 = 0, min1 = I32_MAX, num = 0;
3066                 struct regnode_charclass_class accum;
3067                 regnode * const startbranch=scan;
3068
3069                 if (flags & SCF_DO_SUBSTR)
3070                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
3071                 if (flags & SCF_DO_STCLASS)
3072                     cl_init_zero(pRExC_state, &accum);
3073
3074                 while (OP(scan) == code) {
3075                     I32 deltanext, minnext, f = 0, fake;
3076                     struct regnode_charclass_class this_class;
3077
3078                     num++;
3079                     data_fake.flags = 0;
3080                     if (data) {
3081                         data_fake.whilem_c = data->whilem_c;
3082                         data_fake.last_closep = data->last_closep;
3083                     }
3084                     else
3085                         data_fake.last_closep = &fake;
3086
3087                     data_fake.pos_delta = delta;
3088                     next = regnext(scan);
3089                     scan = NEXTOPER(scan);
3090                     if (code != BRANCH)
3091                         scan = NEXTOPER(scan);
3092                     if (flags & SCF_DO_STCLASS) {
3093                         cl_init(pRExC_state, &this_class);
3094                         data_fake.start_class = &this_class;
3095                         f = SCF_DO_STCLASS_AND;
3096                     }
3097                     if (flags & SCF_WHILEM_VISITED_POS)
3098                         f |= SCF_WHILEM_VISITED_POS;
3099
3100                     /* we suppose the run is continuous, last=next...*/
3101                     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3102                                           next, &data_fake,
3103                                           stopparen, recursed, NULL, f,depth+1);
3104                     if (min1 > minnext)
3105                         min1 = minnext;
3106                     if (max1 < minnext + deltanext)
3107                         max1 = minnext + deltanext;
3108                     if (deltanext == I32_MAX)
3109                         is_inf = is_inf_internal = 1;
3110                     scan = next;
3111                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3112                         pars++;
3113                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
3114                         if ( stopmin > minnext) 
3115                             stopmin = min + min1;
3116                         flags &= ~SCF_DO_SUBSTR;
3117                         if (data)
3118                             data->flags |= SCF_SEEN_ACCEPT;
3119                     }
3120                     if (data) {
3121                         if (data_fake.flags & SF_HAS_EVAL)
3122                             data->flags |= SF_HAS_EVAL;
3123                         data->whilem_c = data_fake.whilem_c;
3124                     }
3125                     if (flags & SCF_DO_STCLASS)
3126                         cl_or(pRExC_state, &accum, &this_class);
3127                 }
3128                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3129                     min1 = 0;
3130                 if (flags & SCF_DO_SUBSTR) {
3131                     data->pos_min += min1;
3132                     data->pos_delta += max1 - min1;
3133                     if (max1 != min1 || is_inf)
3134                         data->longest = &(data->longest_float);
3135                 }
3136                 min += min1;
3137                 delta += max1 - min1;
3138                 if (flags & SCF_DO_STCLASS_OR) {
3139                     cl_or(pRExC_state, data->start_class, &accum);
3140                     if (min1) {
3141                         cl_and(data->start_class, and_withp);
3142                         flags &= ~SCF_DO_STCLASS;
3143                     }
3144                 }
3145                 else if (flags & SCF_DO_STCLASS_AND) {
3146                     if (min1) {
3147                         cl_and(data->start_class, &accum);
3148                         flags &= ~SCF_DO_STCLASS;
3149                     }
3150                     else {
3151                         /* Switch to OR mode: cache the old value of
3152                          * data->start_class */
3153                         INIT_AND_WITHP;
3154                         StructCopy(data->start_class, and_withp,
3155                                    struct regnode_charclass_class);
3156                         flags &= ~SCF_DO_STCLASS_AND;
3157                         StructCopy(&accum, data->start_class,
3158                                    struct regnode_charclass_class);
3159                         flags |= SCF_DO_STCLASS_OR;
3160                         data->start_class->flags |= ANYOF_EOS;
3161                     }
3162                 }
3163
3164                 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
3165                 /* demq.
3166
3167                    Assuming this was/is a branch we are dealing with: 'scan' now
3168                    points at the item that follows the branch sequence, whatever
3169                    it is. We now start at the beginning of the sequence and look
3170                    for subsequences of
3171
3172                    BRANCH->EXACT=>x1
3173                    BRANCH->EXACT=>x2
3174                    tail
3175
3176                    which would be constructed from a pattern like /A|LIST|OF|WORDS/
3177
3178                    If we can find such a subsequence we need to turn the first
3179                    element into a trie and then add the subsequent branch exact
3180                    strings to the trie.
3181
3182                    We have two cases
3183
3184                      1. patterns where the whole set of branches can be converted. 
3185
3186                      2. patterns where only a subset can be converted.
3187
3188                    In case 1 we can replace the whole set with a single regop
3189                    for the trie. In case 2 we need to keep the start and end
3190                    branches so
3191
3192                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3193                      becomes BRANCH TRIE; BRANCH X;
3194
3195                   There is an additional case, that being where there is a 
3196                   common prefix, which gets split out into an EXACT like node
3197                   preceding the TRIE node.
3198
3199                   If x(1..n)==tail then we can do a simple trie, if not we make
3200                   a "jump" trie, such that when we match the appropriate word
3201                   we "jump" to the appropriate tail node. Essentially we turn
3202                   a nested if into a case structure of sorts.
3203
3204                 */
3205
3206                     int made=0;
3207                     if (!re_trie_maxbuff) {
3208                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3209                         if (!SvIOK(re_trie_maxbuff))
3210                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3211                     }
3212                     if ( SvIV(re_trie_maxbuff)>=0  ) {
3213                         regnode *cur;
3214                         regnode *first = (regnode *)NULL;
3215                         regnode *last = (regnode *)NULL;
3216                         regnode *tail = scan;
3217                         U8 trietype = 0;
3218                         U32 count=0;
3219
3220 #ifdef DEBUGGING
3221                         SV * const mysv = sv_newmortal();       /* for dumping */
3222 #endif
3223                         /* var tail is used because there may be a TAIL
3224                            regop in the way. Ie, the exacts will point to the
3225                            thing following the TAIL, but the last branch will
3226                            point at the TAIL. So we advance tail. If we
3227                            have nested (?:) we may have to move through several
3228                            tails.
3229                          */
3230
3231                         while ( OP( tail ) == TAIL ) {
3232                             /* this is the TAIL generated by (?:) */
3233                             tail = regnext( tail );
3234                         }
3235
3236                         
3237                         DEBUG_OPTIMISE_r({
3238                             regprop(RExC_rx, mysv, tail );
3239                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3240                                 (int)depth * 2 + 2, "", 
3241                                 "Looking for TRIE'able sequences. Tail node is: ", 
3242                                 SvPV_nolen_const( mysv )
3243                             );
3244                         });
3245                         
3246                         /*
3247
3248                             Step through the branches
3249                                 cur represents each branch,
3250                                 noper is the first thing to be matched as part of that branch
3251                                 noper_next is the regnext() of that node.
3252
3253                             We normally handle a case like this /FOO[xyz]|BAR[pqr]/
3254                             via a "jump trie" but we also support building with NOJUMPTRIE,
3255                             which restricts the trie logic to structures like /FOO|BAR/.
3256
3257                             If noper is a trieable nodetype then the branch is a possible optimization
3258                             target. If we are building under NOJUMPTRIE then we require that noper_next
3259                             is the same as scan (our current position in the regex program).
3260
3261                             Once we have two or more consecutive such branches we can create a
3262                             trie of the EXACT's contents and stitch it in place into the program.
3263
3264                             If the sequence represents all of the branches in the alternation we
3265                             replace the entire thing with a single TRIE node.
3266
3267                             Otherwise when it is a subsequence we need to stitch it in place and
3268                             replace only the relevant branches. This means the first branch has
3269                             to remain as it is used by the alternation logic, and its next pointer,
3270                             and needs to be repointed at the item on the branch chain following
3271                             the last branch we have optimized away.
3272
3273                             This could be either a BRANCH, in which case the subsequence is internal,
3274                             or it could be the item following the branch sequence in which case the
3275                             subsequence is at the end (which does not necessarily mean the first node
3276                             is the start of the alternation).
3277
3278                             TRIE_TYPE(X) is a define which maps the optype to a trietype.
3279
3280                                 optype          |  trietype
3281                                 ----------------+-----------
3282                                 NOTHING         | NOTHING
3283                                 EXACT           | EXACT
3284                                 EXACTFU         | EXACTFU
3285                                 EXACTFU_SS      | EXACTFU
3286                                 EXACTFU_TRICKYFOLD | EXACTFU
3287                                 EXACTFA         | 0
3288
3289
3290                         */
3291 #define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING :   \
3292                        ( EXACT == (X) )   ? EXACT :        \
3293                        ( EXACTFU == (X) || EXACTFU_SS == (X) || EXACTFU_TRICKYFOLD == (X) ) ? EXACTFU :        \
3294                        0 )
3295
3296                         /* dont use tail as the end marker for this traverse */
3297                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3298                             regnode * const noper = NEXTOPER( cur );
3299                             U8 noper_type = OP( noper );
3300                             U8 noper_trietype = TRIE_TYPE( noper_type );
3301 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3302                             regnode * const noper_next = regnext( noper );
3303 #endif
3304
3305                             DEBUG_OPTIMISE_r({
3306                                 regprop(RExC_rx, mysv, cur);
3307                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3308                                    (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3309
3310                                 regprop(RExC_rx, mysv, noper);
3311                                 PerlIO_printf( Perl_debug_log, " -> %s",
3312                                     SvPV_nolen_const(mysv));
3313
3314                                 if ( noper_next ) {
3315                                   regprop(RExC_rx, mysv, noper_next );
3316                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3317                                     SvPV_nolen_const(mysv));
3318                                 }
3319                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d)\n",
3320                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur) );
3321                             });
3322
3323                             /* Is noper a trieable nodetype that can be merged with the
3324                              * current trie (if there is one)? */
3325                             if ( noper_trietype
3326                                   &&
3327                                   (
3328                                         /* XXX: Currently we cannot allow a NOTHING node to be the first element
3329                                          * of a TRIEABLE sequence, Otherwise we will overwrite the regop following
3330                                          * the NOTHING with the TRIE regop later on. This is because a NOTHING node
3331                                          * is only one regnode wide, and a TRIE is two regnodes. An example of a
3332                                          * problematic pattern is: "x" =~ /\A(?>(?:(?:)A|B|C?x))\z/
3333                                          * At a later point of time we can somewhat workaround this by handling
3334                                          * NOTHING -> EXACT sequences as generated by /(?:)A|(?:)B/ type patterns,
3335                                          * as we can effectively ignore the NOTHING regop in that case.
3336                                          * This clause, which allows NOTHING to start a sequence is left commented
3337                                          * out as a reference.
3338                                          * - Yves
3339
3340                                            ( noper_trietype == NOTHING)
3341                                            || ( trietype == NOTHING )
3342                                         */
3343                                         ( noper_trietype == NOTHING && trietype )
3344                                         || ( trietype == noper_trietype )
3345                                   )
3346 #ifdef NOJUMPTRIE
3347                                   && noper_next == tail
3348 #endif
3349                                   && count < U16_MAX)
3350                             {
3351                                 /* Handle mergable triable node
3352                                  * Either we are the first node in a new trieable sequence,
3353                                  * in which case we do some bookkeeping, otherwise we update
3354                                  * the end pointer. */
3355                                 count++;
3356                                 if ( !first ) {
3357                                     first = cur;
3358                                     trietype = noper_trietype;
3359                                 } else {
3360                                     if ( trietype == NOTHING )
3361                                         trietype = noper_trietype;
3362                                     last = cur;
3363                                 }
3364                             } /* end handle mergable triable node */
3365                             else {
3366                                 /* handle unmergable node -
3367                                  * noper may either be a triable node which can not be tried
3368                                  * together with the current trie, or a non triable node */
3369                                 if ( last ) {
3370                                     /* If last is set and trietype is not NOTHING then we have found
3371                                      * at least two triable branch sequences in a row of a similar
3372                                      * trietype so we can turn them into a trie. If/when we
3373                                      * allow NOTHING to start a trie sequence this condition will be
3374                                      * required, and it isn't expensive so we leave it in for now. */
3375                                     if ( trietype != NOTHING )
3376                                         make_trie( pRExC_state,
3377                                                 startbranch, first, cur, tail, count,
3378                                                 trietype, depth+1 );
3379                                     last = NULL; /* note: we clear/update first, trietype etc below, so we dont do it here */
3380                                 }
3381                                 if ( noper_trietype
3382 #ifdef NOJUMPTRIE
3383                                      && noper_next == tail
3384 #endif
3385                                 ){
3386                                     /* noper is triable, so we can start a new trie sequence */
3387                                     count = 1;
3388                                     first = cur;
3389                                     trietype = noper_trietype;
3390                                 } else if (first) {
3391                                     /* if we already saw a first but the current node is not triable then we have
3392                                      * to reset the first information. */
3393                                     count = 0;
3394                                     first = NULL;
3395                                     trietype = 0;
3396                                 }
3397                             } /* end handle unmergable node */
3398                         } /* loop over branches */
3399                         DEBUG_OPTIMISE_r({
3400                             regprop(RExC_rx, mysv, cur);
3401                             PerlIO_printf( Perl_debug_log,
3402                               "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3403                               "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3404
3405                         });
3406                         if ( last && trietype != NOTHING ) {
3407                             /* the last branch of the sequence was part of a trie,
3408                              * so we have to construct it here outside of the loop
3409                              */
3410                             made= make_trie( pRExC_state, startbranch, first, scan, tail, count, trietype, depth+1 );
3411 #ifdef TRIE_STUDY_OPT
3412                             if ( ((made == MADE_EXACT_TRIE && 
3413                                  startbranch == first) 
3414                                  || ( first_non_open == first )) && 
3415                                  depth==0 ) {
3416                                 flags |= SCF_TRIE_RESTUDY;
3417                                 if ( startbranch == first 
3418                                      && scan == tail ) 
3419                                 {
3420                                     RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3421                                 }
3422                             }
3423 #endif
3424                         } /* end if ( last) */
3425                     } /* TRIE_MAXBUF is non zero */
3426                     
3427                 } /* do trie */
3428                 
3429             }
3430             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
3431                 scan = NEXTOPER(NEXTOPER(scan));
3432             } else                      /* single branch is optimized. */
3433                 scan = NEXTOPER(scan);
3434             continue;
3435         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3436             scan_frame *newframe = NULL;
3437             I32 paren;
3438             regnode *start;
3439             regnode *end;
3440
3441             if (OP(scan) != SUSPEND) {
3442             /* set the pointer */
3443                 if (OP(scan) == GOSUB) {
3444                     paren = ARG(scan);
3445                     RExC_recurse[ARG2L(scan)] = scan;
3446                     start = RExC_open_parens[paren-1];
3447                     end   = RExC_close_parens[paren-1];
3448                 } else {
3449                     paren = 0;
3450                     start = RExC_rxi->program + 1;
3451                     end   = RExC_opend;
3452                 }
3453                 if (!recursed) {
3454                     Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3455                     SAVEFREEPV(recursed);
3456                 }
3457                 if (!PAREN_TEST(recursed,paren+1)) {
3458                     PAREN_SET(recursed,paren+1);
3459                     Newx(newframe,1,scan_frame);
3460                 } else {
3461                     if (flags & SCF_DO_SUBSTR) {
3462                         SCAN_COMMIT(pRExC_state,data,minlenp);
3463                         data->longest = &(data->longest_float);
3464                     }
3465                     is_inf = is_inf_internal = 1;
3466                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3467                         cl_anything(pRExC_state, data->start_class);
3468                     flags &= ~SCF_DO_STCLASS;
3469                 }
3470             } else {
3471                 Newx(newframe,1,scan_frame);
3472                 paren = stopparen;
3473                 start = scan+2;
3474                 end = regnext(scan);
3475             }
3476             if (newframe) {
3477                 assert(start);
3478                 assert(end);
3479                 SAVEFREEPV(newframe);
3480                 newframe->next = regnext(scan);
3481                 newframe->last = last;
3482                 newframe->stop = stopparen;
3483                 newframe->prev = frame;
3484
3485                 frame = newframe;
3486                 scan =  start;
3487                 stopparen = paren;
3488                 last = end;
3489
3490                 continue;
3491             }
3492         }
3493         else if (OP(scan) == EXACT) {
3494             I32 l = STR_LEN(scan);
3495             UV uc;
3496             if (UTF) {
3497                 const U8 * const s = (U8*)STRING(scan);
3498                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3499                 l = utf8_length(s, s + l);
3500             } else {
3501                 uc = *((U8*)STRING(scan));
3502             }
3503             min += l;
3504             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3505                 /* The code below prefers earlier match for fixed
3506                    offset, later match for variable offset.  */
3507                 if (data->last_end == -1) { /* Update the start info. */
3508                     data->last_start_min = data->pos_min;
3509                     data->last_start_max = is_inf
3510                         ? I32_MAX : data->pos_min + data->pos_delta;
3511                 }
3512                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3513                 if (UTF)
3514                     SvUTF8_on(data->last_found);
3515                 {
3516                     SV * const sv = data->last_found;
3517                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3518                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3519                     if (mg && mg->mg_len >= 0)
3520                         mg->mg_len += utf8_length((U8*)STRING(scan),
3521                                                   (U8*)STRING(scan)+STR_LEN(scan));
3522                 }
3523                 data->last_end = data->pos_min + l;
3524                 data->pos_min += l; /* As in the first entry. */
3525                 data->flags &= ~SF_BEFORE_EOL;
3526             }
3527             if (flags & SCF_DO_STCLASS_AND) {
3528                 /* Check whether it is compatible with what we know already! */
3529                 int compat = 1;
3530
3531
3532                 /* If compatible, we or it in below.  It is compatible if is
3533                  * in the bitmp and either 1) its bit or its fold is set, or 2)
3534                  * it's for a locale.  Even if there isn't unicode semantics
3535                  * here, at runtime there may be because of matching against a
3536                  * utf8 string, so accept a possible false positive for
3537                  * latin1-range folds */
3538                 if (uc >= 0x100 ||
3539                     (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
3540                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
3541                     && (!(data->start_class->flags & ANYOF_LOC_NONBITMAP_FOLD)
3542                         || !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3543                     )
3544                 {
3545                     compat = 0;
3546                 }
3547                 ANYOF_CLASS_ZERO(data->start_class);
3548                 ANYOF_BITMAP_ZERO(data->start_class);
3549                 if (compat)
3550                     ANYOF_BITMAP_SET(data->start_class, uc);
3551                 else if (uc >= 0x100) {
3552                     int i;
3553
3554                     /* Some Unicode code points fold to the Latin1 range; as
3555                      * XXX temporary code, instead of figuring out if this is
3556                      * one, just assume it is and set all the start class bits
3557                      * that could be some such above 255 code point's fold
3558                      * which will generate fals positives.  As the code
3559                      * elsewhere that does compute the fold settles down, it
3560                      * can be extracted out and re-used here */
3561                     for (i = 0; i < 256; i++){
3562                         if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3563                             ANYOF_BITMAP_SET(data->start_class, i);
3564                         }
3565                     }
3566                 }
3567                 data->start_class->flags &= ~ANYOF_EOS;
3568                 if (uc < 0x100)
3569                   data->start_class->flags &= ~ANYOF_UNICODE_ALL;
3570             }
3571             else if (flags & SCF_DO_STCLASS_OR) {
3572                 /* false positive possible if the class is case-folded */
3573                 if (uc < 0x100)
3574                     ANYOF_BITMAP_SET(data->start_class, uc);
3575                 else
3576                     data->start_class->flags |= ANYOF_UNICODE_ALL;
3577                 data->start_class->flags &= ~ANYOF_EOS;
3578                 cl_and(data->start_class, and_withp);
3579             }
3580             flags &= ~SCF_DO_STCLASS;
3581         }
3582         else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3583             I32 l = STR_LEN(scan);
3584             UV uc = *((U8*)STRING(scan));
3585
3586             /* Search for fixed substrings supports EXACT only. */
3587             if (flags & SCF_DO_SUBSTR) {
3588                 assert(data);
3589                 SCAN_COMMIT(pRExC_state, data, minlenp);
3590             }
3591             if (UTF) {
3592                 const U8 * const s = (U8 *)STRING(scan);
3593                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3594                 l = utf8_length(s, s + l);
3595             }
3596             else if (has_exactf_sharp_s) {
3597                 RExC_seen |= REG_SEEN_EXACTF_SHARP_S;
3598             }
3599             min += l - min_subtract;
3600             if (min < 0) {
3601                 min = 0;
3602             }
3603             delta += min_subtract;
3604             if (flags & SCF_DO_SUBSTR) {
3605                 data->pos_min += l - min_subtract;
3606                 if (data->pos_min < 0) {
3607                     data->pos_min = 0;
3608                 }
3609                 data->pos_delta += min_subtract;
3610                 if (min_subtract) {
3611                     data->longest = &(data->longest_float);
3612                 }
3613             }
3614             if (flags & SCF_DO_STCLASS_AND) {
3615                 /* Check whether it is compatible with what we know already! */
3616                 int compat = 1;
3617                 if (uc >= 0x100 ||
3618                  (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
3619                   && !ANYOF_BITMAP_TEST(data->start_class, uc)
3620                   && !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3621                 {
3622                     compat = 0;
3623                 }
3624                 ANYOF_CLASS_ZERO(data->start_class);
3625                 ANYOF_BITMAP_ZERO(data->start_class);
3626                 if (compat) {
3627                     ANYOF_BITMAP_SET(data->start_class, uc);
3628                     data->start_class->flags &= ~ANYOF_EOS;
3629                     data->start_class->flags |= ANYOF_LOC_NONBITMAP_FOLD;
3630                     if (OP(scan) == EXACTFL) {
3631                         /* XXX This set is probably no longer necessary, and
3632                          * probably wrong as LOCALE now is on in the initial
3633                          * state */
3634                         data->start_class->flags |= ANYOF_LOCALE;
3635                     }
3636                     else {
3637
3638                         /* Also set the other member of the fold pair.  In case
3639                          * that unicode semantics is called for at runtime, use
3640                          * the full latin1 fold.  (Can't do this for locale,
3641                          * because not known until runtime) */
3642                         ANYOF_BITMAP_SET(data->start_class, PL_fold_latin1[uc]);
3643
3644                         /* All other (EXACTFL handled above) folds except under
3645                          * /iaa that include s, S, and sharp_s also may include
3646                          * the others */
3647                         if (OP(scan) != EXACTFA) {
3648                             if (uc == 's' || uc == 'S') {
3649                                 ANYOF_BITMAP_SET(data->start_class,
3650                                                  LATIN_SMALL_LETTER_SHARP_S);
3651                             }
3652                             else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3653                                 ANYOF_BITMAP_SET(data->start_class, 's');
3654                                 ANYOF_BITMAP_SET(data->start_class, 'S');
3655                             }
3656                         }
3657                     }
3658                 }
3659                 else if (uc >= 0x100) {
3660                     int i;
3661                     for (i = 0; i < 256; i++){
3662                         if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3663                             ANYOF_BITMAP_SET(data->start_class, i);
3664                         }
3665                     }
3666                 }
3667             }
3668             else if (flags & SCF_DO_STCLASS_OR) {
3669                 if (data->start_class->flags & ANYOF_LOC_NONBITMAP_FOLD) {
3670                     /* false positive possible if the class is case-folded.
3671                        Assume that the locale settings are the same... */
3672                     if (uc < 0x100) {
3673                         ANYOF_BITMAP_SET(data->start_class, uc);
3674                         if (OP(scan) != EXACTFL) {
3675
3676                             /* And set the other member of the fold pair, but
3677                              * can't do that in locale because not known until
3678                              * run-time */
3679                             ANYOF_BITMAP_SET(data->start_class,
3680                                              PL_fold_latin1[uc]);
3681
3682                             /* All folds except under /iaa that include s, S,
3683                              * and sharp_s also may include the others */
3684                             if (OP(scan) != EXACTFA) {
3685                                 if (uc == 's' || uc == 'S') {
3686                                     ANYOF_BITMAP_SET(data->start_class,
3687                                                    LATIN_SMALL_LETTER_SHARP_S);
3688                                 }
3689                                 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3690                                     ANYOF_BITMAP_SET(data->start_class, 's');
3691                                     ANYOF_BITMAP_SET(data->start_class, 'S');
3692                                 }
3693                             }
3694                         }
3695                     }
3696                     data->start_class->flags &= ~ANYOF_EOS;
3697                 }
3698                 cl_and(data->start_class, and_withp);
3699             }
3700             flags &= ~SCF_DO_STCLASS;
3701         }
3702         else if (REGNODE_VARIES(OP(scan))) {
3703             I32 mincount, maxcount, minnext, deltanext, fl = 0;
3704             I32 f = flags, pos_before = 0;
3705             regnode * const oscan = scan;
3706             struct regnode_charclass_class this_class;
3707             struct regnode_charclass_class *oclass = NULL;
3708             I32 next_is_eval = 0;
3709
3710             switch (PL_regkind[OP(scan)]) {
3711             case WHILEM:                /* End of (?:...)* . */
3712                 scan = NEXTOPER(scan);
3713                 goto finish;
3714             case PLUS:
3715                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3716                     next = NEXTOPER(scan);
3717                     if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3718                         mincount = 1;
3719                         maxcount = REG_INFTY;
3720                         next = regnext(scan);
3721                         scan = NEXTOPER(scan);
3722                         goto do_curly;
3723                     }
3724                 }
3725                 if (flags & SCF_DO_SUBSTR)
3726                     data->pos_min++;
3727                 min++;
3728                 /* Fall through. */
3729             case STAR:
3730                 if (flags & SCF_DO_STCLASS) {
3731                     mincount = 0;
3732                     maxcount = REG_INFTY;
3733                     next = regnext(scan);
3734                     scan = NEXTOPER(scan);
3735                     goto do_curly;
3736                 }
3737                 is_inf = is_inf_internal = 1;
3738                 scan = regnext(scan);
3739                 if (flags & SCF_DO_SUBSTR) {
3740                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3741                     data->longest = &(data->longest_float);
3742                 }
3743                 goto optimize_curly_tail;
3744             case CURLY:
3745                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3746                     && (scan->flags == stopparen))
3747                 {
3748                     mincount = 1;
3749                     maxcount = 1;
3750                 } else {
3751                     mincount = ARG1(scan);
3752                     maxcount = ARG2(scan);
3753                 }
3754                 next = regnext(scan);
3755                 if (OP(scan) == CURLYX) {
3756                     I32 lp = (data ? *(data->last_closep) : 0);
3757                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3758                 }
3759                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3760                 next_is_eval = (OP(scan) == EVAL);
3761               do_curly:
3762                 if (flags & SCF_DO_SUBSTR) {
3763                     if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3764                     pos_before = data->pos_min;
3765                 }
3766                 if (data) {
3767                     fl = data->flags;
3768                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3769                     if (is_inf)
3770                         data->flags |= SF_IS_INF;
3771                 }
3772                 if (flags & SCF_DO_STCLASS) {
3773                     cl_init(pRExC_state, &this_class);
3774                     oclass = data->start_class;
3775                     data->start_class = &this_class;
3776                     f |= SCF_DO_STCLASS_AND;
3777                     f &= ~SCF_DO_STCLASS_OR;
3778                 }
3779                 /* Exclude from super-linear cache processing any {n,m}
3780                    regops for which the combination of input pos and regex
3781                    pos is not enough information to determine if a match
3782                    will be possible.
3783
3784                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
3785                    regex pos at the \s*, the prospects for a match depend not
3786                    only on the input position but also on how many (bar\s*)
3787                    repeats into the {4,8} we are. */
3788                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
3789                     f &= ~SCF_WHILEM_VISITED_POS;
3790
3791                 /* This will finish on WHILEM, setting scan, or on NULL: */
3792                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext, 
3793                                       last, data, stopparen, recursed, NULL,
3794                                       (mincount == 0
3795                                         ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3796
3797                 if (flags & SCF_DO_STCLASS)
3798                     data->start_class = oclass;
3799                 if (mincount == 0 || minnext == 0) {
3800                     if (flags & SCF_DO_STCLASS_OR) {
3801                         cl_or(pRExC_state, data->start_class, &this_class);
3802                     }
3803                     else if (flags & SCF_DO_STCLASS_AND) {
3804                         /* Switch to OR mode: cache the old value of
3805                          * data->start_class */
3806                         INIT_AND_WITHP;
3807                         StructCopy(data->start_class, and_withp,
3808                                    struct regnode_charclass_class);
3809                         flags &= ~SCF_DO_STCLASS_AND;
3810                         StructCopy(&this_class, data->start_class,
3811                                    struct regnode_charclass_class);
3812                         flags |= SCF_DO_STCLASS_OR;
3813                         data->start_class->flags |= ANYOF_EOS;
3814                     }
3815                 } else {                /* Non-zero len */
3816                     if (flags & SCF_DO_STCLASS_OR) {
3817                         cl_or(pRExC_state, data->start_class, &this_class);
3818                         cl_and(data->start_class, and_withp);
3819                     }
3820                     else if (flags & SCF_DO_STCLASS_AND)
3821                         cl_and(data->start_class, &this_class);
3822                     flags &= ~SCF_DO_STCLASS;
3823                 }
3824                 if (!scan)              /* It was not CURLYX, but CURLY. */
3825                     scan = next;
3826                 if ( /* ? quantifier ok, except for (?{ ... }) */
3827                     (next_is_eval || !(mincount == 0 && maxcount == 1))
3828                     && (minnext == 0) && (deltanext == 0)
3829                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3830                     && maxcount <= REG_INFTY/3) /* Complement check for big count */
3831                 {
3832                     ckWARNreg(RExC_parse,
3833                               "Quantifier unexpected on zero-length expression");
3834                 }
3835
3836                 min += minnext * mincount;
3837                 is_inf_internal |= ((maxcount == REG_INFTY
3838                                      && (minnext + deltanext) > 0)
3839                                     || deltanext == I32_MAX);
3840                 is_inf |= is_inf_internal;
3841                 delta += (minnext + deltanext) * maxcount - minnext * mincount;
3842
3843                 /* Try powerful optimization CURLYX => CURLYN. */
3844                 if (  OP(oscan) == CURLYX && data
3845                       && data->flags & SF_IN_PAR
3846                       && !(data->flags & SF_HAS_EVAL)
3847                       && !deltanext && minnext == 1 ) {
3848                     /* Try to optimize to CURLYN.  */
3849                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3850                     regnode * const nxt1 = nxt;
3851 #ifdef DEBUGGING
3852                     regnode *nxt2;
3853 #endif
3854
3855                     /* Skip open. */
3856                     nxt = regnext(nxt);
3857                     if (!REGNODE_SIMPLE(OP(nxt))
3858                         && !(PL_regkind[OP(nxt)] == EXACT
3859                              && STR_LEN(nxt) == 1))
3860                         goto nogo;
3861 #ifdef DEBUGGING
3862                     nxt2 = nxt;
3863 #endif
3864                     nxt = regnext(nxt);
3865                     if (OP(nxt) != CLOSE)
3866                         goto nogo;
3867                     if (RExC_open_parens) {
3868                         RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3869                         RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3870                     }
3871                     /* Now we know that nxt2 is the only contents: */
3872                     oscan->flags = (U8)ARG(nxt);
3873                     OP(oscan) = CURLYN;
3874                     OP(nxt1) = NOTHING; /* was OPEN. */
3875
3876 #ifdef DEBUGGING
3877                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3878                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
3879                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
3880                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
3881                     OP(nxt + 1) = OPTIMIZED; /* was count. */
3882                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
3883 #endif
3884                 }
3885               nogo:
3886
3887                 /* Try optimization CURLYX => CURLYM. */
3888                 if (  OP(oscan) == CURLYX && data
3889                       && !(data->flags & SF_HAS_PAR)
3890                       && !(data->flags & SF_HAS_EVAL)
3891                       && !deltanext     /* atom is fixed width */
3892                       && minnext != 0   /* CURLYM can't handle zero width */
3893                 ) {
3894                     /* XXXX How to optimize if data == 0? */
3895                     /* Optimize to a simpler form.  */
3896                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3897                     regnode *nxt2;
3898
3899                     OP(oscan) = CURLYM;
3900                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3901                             && (OP(nxt2) != WHILEM))
3902                         nxt = nxt2;
3903                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
3904                     /* Need to optimize away parenths. */
3905                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
3906                         /* Set the parenth number.  */
3907                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
3908
3909                         oscan->flags = (U8)ARG(nxt);
3910                         if (RExC_open_parens) {
3911                             RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3912                             RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
3913                         }
3914                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
3915                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
3916
3917 #ifdef DEBUGGING
3918                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3919                         OP(nxt + 1) = OPTIMIZED; /* was count. */
3920                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
3921                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
3922 #endif
3923 #if 0
3924                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
3925                             regnode *nnxt = regnext(nxt1);
3926                             if (nnxt == nxt) {
3927                                 if (reg_off_by_arg[OP(nxt1)])
3928                                     ARG_SET(nxt1, nxt2 - nxt1);
3929                                 else if (nxt2 - nxt1 < U16_MAX)
3930                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
3931                                 else
3932                                     OP(nxt) = NOTHING;  /* Cannot beautify */
3933                             }
3934                             nxt1 = nnxt;
3935                         }
3936 #endif
3937                         /* Optimize again: */
3938                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
3939                                     NULL, stopparen, recursed, NULL, 0,depth+1);
3940                     }
3941                     else
3942                         oscan->flags = 0;
3943                 }
3944                 else if ((OP(oscan) == CURLYX)
3945                          && (flags & SCF_WHILEM_VISITED_POS)
3946                          /* See the comment on a similar expression above.
3947                             However, this time it's not a subexpression
3948                             we care about, but the expression itself. */
3949                          && (maxcount == REG_INFTY)
3950                          && data && ++data->whilem_c < 16) {
3951                     /* This stays as CURLYX, we can put the count/of pair. */
3952                     /* Find WHILEM (as in regexec.c) */
3953                     regnode *nxt = oscan + NEXT_OFF(oscan);
3954
3955                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
3956                         nxt += ARG(nxt);
3957                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
3958                         | (RExC_whilem_seen << 4)); /* On WHILEM */
3959                 }
3960                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
3961                     pars++;
3962                 if (flags & SCF_DO_SUBSTR) {
3963                     SV *last_str = NULL;
3964                     int counted = mincount != 0;
3965
3966                     if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
3967 #if defined(SPARC64_GCC_WORKAROUND)
3968                         I32 b = 0;
3969                         STRLEN l = 0;
3970                         const char *s = NULL;
3971                         I32 old = 0;
3972
3973                         if (pos_before >= data->last_start_min)
3974                             b = pos_before;
3975                         else
3976                             b = data->last_start_min;
3977
3978                         l = 0;
3979                         s = SvPV_const(data->last_found, l);
3980                         old = b - data->last_start_min;
3981
3982 #else
3983                         I32 b = pos_before >= data->last_start_min
3984                             ? pos_before : data->last_start_min;
3985                         STRLEN l;
3986                         const char * const s = SvPV_const(data->last_found, l);
3987                         I32 old = b - data->last_start_min;
3988 #endif
3989
3990                         if (UTF)
3991                             old = utf8_hop((U8*)s, old) - (U8*)s;
3992                         l -= old;
3993                         /* Get the added string: */
3994                         last_str = newSVpvn_utf8(s  + old, l, UTF);
3995                         if (deltanext == 0 && pos_before == b) {
3996                             /* What was added is a constant string */
3997                             if (mincount > 1) {
3998                                 SvGROW(last_str, (mincount * l) + 1);
3999                                 repeatcpy(SvPVX(last_str) + l,
4000                                           SvPVX_const(last_str), l, mincount - 1);
4001                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
4002                                 /* Add additional parts. */
4003                                 SvCUR_set(data->last_found,
4004                                           SvCUR(data->last_found) - l);
4005                                 sv_catsv(data->last_found, last_str);
4006                                 {
4007                                     SV * sv = data->last_found;
4008                                     MAGIC *mg =
4009                                         SvUTF8(sv) && SvMAGICAL(sv) ?
4010                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4011                                     if (mg && mg->mg_len >= 0)
4012                                         mg->mg_len += CHR_SVLEN(last_str) - l;
4013                                 }
4014                                 data->last_end += l * (mincount - 1);
4015                             }
4016                         } else {
4017                             /* start offset must point into the last copy */
4018                             data->last_start_min += minnext * (mincount - 1);
4019                             data->last_start_max += is_inf ? I32_MAX
4020                                 : (maxcount - 1) * (minnext + data->pos_delta);
4021                         }
4022                     }
4023                     /* It is counted once already... */
4024                     data->pos_min += minnext * (mincount - counted);
4025                     data->pos_delta += - counted * deltanext +
4026                         (minnext + deltanext) * maxcount - minnext * mincount;
4027                     if (mincount != maxcount) {
4028                          /* Cannot extend fixed substrings found inside
4029                             the group.  */
4030                         SCAN_COMMIT(pRExC_state,data,minlenp);
4031                         if (mincount && last_str) {
4032                             SV * const sv = data->last_found;
4033                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4034                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4035
4036                             if (mg)
4037                                 mg->mg_len = -1;
4038                             sv_setsv(sv, last_str);
4039                             data->last_end = data->pos_min;
4040                             data->last_start_min =
4041                                 data->pos_min - CHR_SVLEN(last_str);
4042                             data->last_start_max = is_inf
4043                                 ? I32_MAX
4044                                 : data->pos_min + data->pos_delta
4045                                 - CHR_SVLEN(last_str);
4046                         }
4047                         data->longest = &(data->longest_float);
4048                     }
4049                     SvREFCNT_dec(last_str);
4050                 }
4051                 if (data && (fl & SF_HAS_EVAL))
4052                     data->flags |= SF_HAS_EVAL;
4053               optimize_curly_tail:
4054                 if (OP(oscan) != CURLYX) {
4055                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4056                            && NEXT_OFF(next))
4057                         NEXT_OFF(oscan) += NEXT_OFF(next);
4058                 }
4059                 continue;
4060             default:                    /* REF, ANYOFV, and CLUMP only? */
4061                 if (flags & SCF_DO_SUBSTR) {
4062                     SCAN_COMMIT(pRExC_state,data,minlenp);      /* Cannot expect anything... */
4063                     data->longest = &(data->longest_float);
4064                 }
4065                 is_inf = is_inf_internal = 1;
4066                 if (flags & SCF_DO_STCLASS_OR)
4067                     cl_anything(pRExC_state, data->start_class);
4068                 flags &= ~SCF_DO_STCLASS;
4069                 break;
4070             }
4071         }
4072         else if (OP(scan) == LNBREAK) {
4073             if (flags & SCF_DO_STCLASS) {
4074                 int value = 0;
4075                 data->start_class->flags &= ~ANYOF_EOS; /* No match on empty */
4076                 if (flags & SCF_DO_STCLASS_AND) {
4077                     for (value = 0; value < 256; value++)
4078                         if (!is_VERTWS_cp(value))
4079                             ANYOF_BITMAP_CLEAR(data->start_class, value);
4080                 }
4081                 else {
4082                     for (value = 0; value < 256; value++)
4083                         if (is_VERTWS_cp(value))
4084                             ANYOF_BITMAP_SET(data->start_class, value);
4085                 }
4086                 if (flags & SCF_DO_STCLASS_OR)
4087                     cl_and(data->start_class, and_withp);
4088                 flags &= ~SCF_DO_STCLASS;
4089             }
4090             min += 1;
4091             delta += 1;
4092             if (flags & SCF_DO_SUBSTR) {
4093                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4094                 data->pos_min += 1;
4095                 data->pos_delta += 1;
4096                 data->longest = &(data->longest_float);
4097             }
4098         }
4099         else if (REGNODE_SIMPLE(OP(scan))) {
4100             int value = 0;
4101
4102             if (flags & SCF_DO_SUBSTR) {
4103                 SCAN_COMMIT(pRExC_state,data,minlenp);
4104                 data->pos_min++;
4105             }
4106             min++;
4107             if (flags & SCF_DO_STCLASS) {
4108                 data->start_class->flags &= ~ANYOF_EOS; /* No match on empty */
4109
4110                 /* Some of the logic below assumes that switching
4111                    locale on will only add false positives. */
4112                 switch (PL_regkind[OP(scan)]) {
4113                 case SANY:
4114                 default:
4115                   do_default:
4116                     /* Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan)); */
4117                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4118                         cl_anything(pRExC_state, data->start_class);
4119                     break;
4120                 case REG_ANY:
4121                     if (OP(scan) == SANY)
4122                         goto do_default;
4123                     if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
4124                         value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
4125                                  || ANYOF_CLASS_TEST_ANY_SET(data->start_class));
4126                         cl_anything(pRExC_state, data->start_class);
4127                     }
4128                     if (flags & SCF_DO_STCLASS_AND || !value)
4129                         ANYOF_BITMAP_CLEAR(data->start_class,'\n');
4130                     break;
4131                 case ANYOF:
4132                     if (flags & SCF_DO_STCLASS_AND)
4133                         cl_and(data->start_class,
4134                                (struct regnode_charclass_class*)scan);
4135                     else
4136                         cl_or(pRExC_state, data->start_class,
4137                               (struct regnode_charclass_class*)scan);
4138                     break;
4139                 case ALNUM:
4140                     if (flags & SCF_DO_STCLASS_AND) {
4141                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4142                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NALNUM);
4143                             if (OP(scan) == ALNUMU) {
4144                                 for (value = 0; value < 256; value++) {
4145                                     if (!isWORDCHAR_L1(value)) {
4146                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
4147                                     }
4148                                 }
4149                             } else {
4150                                 for (value = 0; value < 256; value++) {
4151                                     if (!isALNUM(value)) {
4152                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
4153                                     }
4154                                 }
4155                             }
4156                         }
4157                     }
4158                     else {
4159                         if (data->start_class->flags & ANYOF_LOCALE)
4160                             ANYOF_CLASS_SET(data->start_class,ANYOF_ALNUM);
4161
4162                         /* Even if under locale, set the bits for non-locale
4163                          * in case it isn't a true locale-node.  This will
4164                          * create false positives if it truly is locale */
4165                         if (OP(scan) == ALNUMU) {
4166                             for (value = 0; value < 256; value++) {
4167                                 if (isWORDCHAR_L1(value)) {
4168                                     ANYOF_BITMAP_SET(data->start_class, value);
4169                                 }
4170                             }
4171                         } else {
4172                             for (value = 0; value < 256; value++) {
4173                                 if (isALNUM(value)) {
4174                                     ANYOF_BITMAP_SET(data->start_class, value);
4175                                 }
4176                             }
4177                         }
4178                     }
4179                     break;
4180                 case NALNUM:
4181                     if (flags & SCF_DO_STCLASS_AND) {
4182                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4183                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_ALNUM);
4184                             if (OP(scan) == NALNUMU) {
4185                                 for (value = 0; value < 256; value++) {
4186                                     if (isWORDCHAR_L1(value)) {
4187                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
4188                                     }
4189                                 }
4190                             } else {
4191                                 for (value = 0; value < 256; value++) {
4192                                     if (isALNUM(value)) {
4193                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
4194                                     }
4195                                 }
4196                             }
4197                         }
4198                     }
4199                     else {
4200                         if (data->start_class->flags & ANYOF_LOCALE)
4201                             ANYOF_CLASS_SET(data->start_class,ANYOF_NALNUM);
4202
4203                         /* Even if under locale, set the bits for non-locale in
4204                          * case it isn't a true locale-node.  This will create
4205                          * false positives if it truly is locale */
4206                         if (OP(scan) == NALNUMU) {
4207                             for (value = 0; value < 256; value++) {
4208                                 if (! isWORDCHAR_L1(value)) {
4209                                     ANYOF_BITMAP_SET(data->start_class, value);
4210                                 }
4211                             }
4212                         } else {
4213                             for (value = 0; value < 256; value++) {
4214                                 if (! isALNUM(value)) {
4215                                     ANYOF_BITMAP_SET(data->start_class, value);
4216                                 }
4217                             }
4218                         }
4219                     }
4220                     break;
4221                 case SPACE:
4222                     if (flags & SCF_DO_STCLASS_AND) {
4223                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4224                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NSPACE);
4225                             if (OP(scan) == SPACEU) {
4226                                 for (value = 0; value < 256; value++) {
4227                                     if (!isSPACE_L1(value)) {
4228                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
4229                                     }
4230                                 }
4231                             } else {
4232                                 for (value = 0; value < 256; value++) {
4233                                     if (!isSPACE(value)) {
4234                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
4235                                     }
4236                                 }
4237                             }
4238                         }
4239                     }
4240                     else {
4241                         if (data->start_class->flags & ANYOF_LOCALE) {
4242                             ANYOF_CLASS_SET(data->start_class,ANYOF_SPACE);
4243                         }
4244                         if (OP(scan) == SPACEU) {
4245                             for (value = 0; value < 256; value++) {
4246                                 if (isSPACE_L1(value)) {
4247                                     ANYOF_BITMAP_SET(data->start_class, value);
4248                                 }
4249                             }
4250                         } else {
4251                             for (value = 0; value < 256; value++) {
4252                                 if (isSPACE(value)) {
4253                                     ANYOF_BITMAP_SET(data->start_class, value);
4254                                 }
4255                             }
4256                         }
4257                     }
4258                     break;
4259                 case NSPACE:
4260                     if (flags & SCF_DO_STCLASS_AND) {
4261                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4262                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_SPACE);
4263                             if (OP(scan) == NSPACEU) {
4264                                 for (value = 0; value < 256; value++) {
4265                                     if (isSPACE_L1(value)) {
4266                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
4267                                     }
4268                                 }
4269                             } else {
4270                                 for (value = 0; value < 256; value++) {
4271                                     if (isSPACE(value)) {
4272                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
4273                                     }
4274                                 }
4275                             }
4276                         }
4277                     }
4278                     else {
4279                         if (data->start_class->flags & ANYOF_LOCALE)
4280                             ANYOF_CLASS_SET(data->start_class,ANYOF_NSPACE);
4281                         if (OP(scan) == NSPACEU) {
4282                             for (value = 0; value < 256; value++) {
4283                                 if (!isSPACE_L1(value)) {
4284                                     ANYOF_BITMAP_SET(data->start_class, value);
4285                                 }
4286                             }
4287                         }
4288                         else {
4289                             for (value = 0; value < 256; value++) {
4290                                 if (!isSPACE(value)) {
4291                                     ANYOF_BITMAP_SET(data->start_class, value);
4292                                 }
4293                             }
4294                         }
4295                     }
4296                     break;
4297                 case DIGIT:
4298                     if (flags & SCF_DO_STCLASS_AND) {
4299                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4300                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NDIGIT);
4301                             for (value = 0; value < 256; value++)
4302                                 if (!isDIGIT(value))
4303                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
4304                         }
4305                     }
4306                     else {
4307                         if (data->start_class->flags & ANYOF_LOCALE)
4308                             ANYOF_CLASS_SET(data->start_class,ANYOF_DIGIT);
4309                         for (value = 0; value < 256; value++)
4310                             if (isDIGIT(value))
4311                                 ANYOF_BITMAP_SET(data->start_class, value);
4312                     }
4313                     break;
4314                 case NDIGIT:
4315                     if (flags & SCF_DO_STCLASS_AND) {
4316                         if (!(data->start_class->flags & ANYOF_LOCALE))
4317                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_DIGIT);
4318                         for (value = 0; value < 256; value++)
4319                             if (isDIGIT(value))
4320                                 ANYOF_BITMAP_CLEAR(data->start_class, value);
4321                     }
4322                     else {
4323                         if (data->start_class->flags & ANYOF_LOCALE)
4324                             ANYOF_CLASS_SET(data->start_class,ANYOF_NDIGIT);
4325                         for (value = 0; value < 256; value++)
4326                             if (!isDIGIT(value))
4327                                 ANYOF_BITMAP_SET(data->start_class, value);
4328                     }
4329                     break;
4330                 CASE_SYNST_FNC(VERTWS);
4331                 CASE_SYNST_FNC(HORIZWS);
4332
4333                 }
4334                 if (flags & SCF_DO_STCLASS_OR)
4335                     cl_and(data->start_class, and_withp);
4336                 flags &= ~SCF_DO_STCLASS;
4337             }
4338         }
4339         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
4340             data->flags |= (OP(scan) == MEOL
4341                             ? SF_BEFORE_MEOL
4342                             : SF_BEFORE_SEOL);
4343         }
4344         else if (  PL_regkind[OP(scan)] == BRANCHJ
4345                  /* Lookbehind, or need to calculate parens/evals/stclass: */
4346                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
4347                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
4348             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY 
4349                 || OP(scan) == UNLESSM )
4350             {
4351                 /* Negative Lookahead/lookbehind
4352                    In this case we can't do fixed string optimisation.
4353                 */
4354
4355                 I32 deltanext, minnext, fake = 0;
4356                 regnode *nscan;
4357                 struct regnode_charclass_class intrnl;
4358                 int f = 0;
4359
4360                 data_fake.flags = 0;
4361                 if (data) {
4362                     data_fake.whilem_c = data->whilem_c;
4363                     data_fake.last_closep = data->last_closep;
4364                 }
4365                 else
4366                     data_fake.last_closep = &fake;
4367                 data_fake.pos_delta = delta;
4368                 if ( flags & SCF_DO_STCLASS && !scan->flags
4369                      && OP(scan) == IFMATCH ) { /* Lookahead */
4370                     cl_init(pRExC_state, &intrnl);
4371                     data_fake.start_class = &intrnl;
4372                     f |= SCF_DO_STCLASS_AND;
4373                 }
4374                 if (flags & SCF_WHILEM_VISITED_POS)
4375                     f |= SCF_WHILEM_VISITED_POS;
4376                 next = regnext(scan);
4377                 nscan = NEXTOPER(NEXTOPER(scan));
4378                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext, 
4379                     last, &data_fake, stopparen, recursed, NULL, f, depth+1);
4380                 if (scan->flags) {
4381                     if (deltanext) {
4382                         FAIL("Variable length lookbehind not implemented");
4383                     }
4384                     else if (minnext > (I32)U8_MAX) {
4385                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4386                     }
4387                     scan->flags = (U8)minnext;
4388                 }
4389                 if (data) {
4390                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4391                         pars++;
4392                     if (data_fake.flags & SF_HAS_EVAL)
4393                         data->flags |= SF_HAS_EVAL;
4394                     data->whilem_c = data_fake.whilem_c;
4395                 }
4396                 if (f & SCF_DO_STCLASS_AND) {
4397                     if (flags & SCF_DO_STCLASS_OR) {
4398                         /* OR before, AND after: ideally we would recurse with
4399                          * data_fake to get the AND applied by study of the
4400                          * remainder of the pattern, and then derecurse;
4401                          * *** HACK *** for now just treat as "no information".
4402                          * See [perl #56690].
4403                          */
4404                         cl_init(pRExC_state, data->start_class);
4405                     }  else {
4406                         /* AND before and after: combine and continue */
4407                         const int was = (data->start_class->flags & ANYOF_EOS);
4408
4409                         cl_and(data->start_class, &intrnl);
4410                         if (was)
4411                             data->start_class->flags |= ANYOF_EOS;
4412                     }
4413                 }
4414             }
4415 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4416             else {
4417                 /* Positive Lookahead/lookbehind
4418                    In this case we can do fixed string optimisation,
4419                    but we must be careful about it. Note in the case of
4420                    lookbehind the positions will be offset by the minimum
4421                    length of the pattern, something we won't know about
4422                    until after the recurse.
4423                 */
4424                 I32 deltanext, fake = 0;
4425                 regnode *nscan;
4426                 struct regnode_charclass_class intrnl;
4427                 int f = 0;
4428                 /* We use SAVEFREEPV so that when the full compile 
4429                     is finished perl will clean up the allocated 
4430                     minlens when it's all done. This way we don't
4431                     have to worry about freeing them when we know
4432                     they wont be used, which would be a pain.
4433                  */
4434                 I32 *minnextp;
4435                 Newx( minnextp, 1, I32 );
4436                 SAVEFREEPV(minnextp);
4437
4438                 if (data) {
4439                     StructCopy(data, &data_fake, scan_data_t);
4440                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
4441                         f |= SCF_DO_SUBSTR;
4442                         if (scan->flags) 
4443                             SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
4444                         data_fake.last_found=newSVsv(data->last_found);
4445                     }
4446                 }
4447                 else
4448                     data_fake.last_closep = &fake;
4449                 data_fake.flags = 0;
4450                 data_fake.pos_delta = delta;
4451                 if (is_inf)
4452                     data_fake.flags |= SF_IS_INF;
4453                 if ( flags & SCF_DO_STCLASS && !scan->flags
4454                      && OP(scan) == IFMATCH ) { /* Lookahead */
4455                     cl_init(pRExC_state, &intrnl);
4456                     data_fake.start_class = &intrnl;
4457                     f |= SCF_DO_STCLASS_AND;
4458                 }
4459                 if (flags & SCF_WHILEM_VISITED_POS)
4460                     f |= SCF_WHILEM_VISITED_POS;
4461                 next = regnext(scan);
4462                 nscan = NEXTOPER(NEXTOPER(scan));
4463
4464                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext, 
4465                     last, &data_fake, stopparen, recursed, NULL, f,depth+1);
4466                 if (scan->flags) {
4467                     if (deltanext) {
4468                         FAIL("Variable length lookbehind not implemented");
4469                     }
4470                     else if (*minnextp > (I32)U8_MAX) {
4471                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4472                     }
4473                     scan->flags = (U8)*minnextp;
4474                 }
4475
4476                 *minnextp += min;
4477
4478                 if (f & SCF_DO_STCLASS_AND) {
4479                     const int was = (data->start_class->flags & ANYOF_EOS);
4480
4481                     cl_and(data->start_class, &intrnl);
4482                     if (was)
4483                         data->start_class->flags |= ANYOF_EOS;
4484                 }
4485                 if (data) {
4486                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4487                         pars++;
4488                     if (data_fake.flags & SF_HAS_EVAL)
4489                         data->flags |= SF_HAS_EVAL;
4490                     data->whilem_c = data_fake.whilem_c;
4491                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
4492                         if (RExC_rx->minlen<*minnextp)
4493                             RExC_rx->minlen=*minnextp;
4494                         SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
4495                         SvREFCNT_dec(data_fake.last_found);
4496                         
4497                         if ( data_fake.minlen_fixed != minlenp ) 
4498                         {
4499                             data->offset_fixed= data_fake.offset_fixed;
4500                             data->minlen_fixed= data_fake.minlen_fixed;
4501                             data->lookbehind_fixed+= scan->flags;
4502                         }
4503                         if ( data_fake.minlen_float != minlenp )
4504                         {
4505                             data->minlen_float= data_fake.minlen_float;
4506                             data->offset_float_min=data_fake.offset_float_min;
4507                             data->offset_float_max=data_fake.offset_float_max;
4508                             data->lookbehind_float+= scan->flags;
4509                         }
4510                     }
4511                 }
4512
4513
4514             }
4515 #endif
4516         }
4517         else if (OP(scan) == OPEN) {
4518             if (stopparen != (I32)ARG(scan))
4519                 pars++;
4520         }
4521         else if (OP(scan) == CLOSE) {
4522             if (stopparen == (I32)ARG(scan)) {
4523                 break;
4524             }
4525             if ((I32)ARG(scan) == is_par) {
4526                 next = regnext(scan);
4527
4528                 if ( next && (OP(next) != WHILEM) && next < last)
4529                     is_par = 0;         /* Disable optimization */
4530             }
4531             if (data)
4532                 *(data->last_closep) = ARG(scan);
4533         }
4534         else if (OP(scan) == EVAL) {
4535                 if (data)
4536                     data->flags |= SF_HAS_EVAL;
4537         }
4538         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
4539             if (flags & SCF_DO_SUBSTR) {
4540                 SCAN_COMMIT(pRExC_state,data,minlenp);
4541                 flags &= ~SCF_DO_SUBSTR;
4542             }
4543             if (data && OP(scan)==ACCEPT) {
4544                 data->flags |= SCF_SEEN_ACCEPT;
4545                 if (stopmin > min)
4546                     stopmin = min;
4547             }
4548         }
4549         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
4550         {
4551                 if (flags & SCF_DO_SUBSTR) {
4552                     SCAN_COMMIT(pRExC_state,data,minlenp);
4553                     data->longest = &(data->longest_float);
4554                 }
4555                 is_inf = is_inf_internal = 1;
4556                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4557                     cl_anything(pRExC_state, data->start_class);
4558                 flags &= ~SCF_DO_STCLASS;
4559         }
4560         else if (OP(scan) == GPOS) {
4561             if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
4562                 !(delta || is_inf || (data && data->pos_delta))) 
4563             {
4564                 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
4565                     RExC_rx->extflags |= RXf_ANCH_GPOS;
4566                 if (RExC_rx->gofs < (U32)min)
4567                     RExC_rx->gofs = min;
4568             } else {
4569                 RExC_rx->extflags |= RXf_GPOS_FLOAT;
4570                 RExC_rx->gofs = 0;
4571             }       
4572         }
4573 #ifdef TRIE_STUDY_OPT
4574 #ifdef FULL_TRIE_STUDY
4575         else if (PL_regkind[OP(scan)] == TRIE) {
4576             /* NOTE - There is similar code to this block above for handling
4577                BRANCH nodes on the initial study.  If you change stuff here
4578                check there too. */
4579             regnode *trie_node= scan;
4580             regnode *tail= regnext(scan);
4581             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4582             I32 max1 = 0, min1 = I32_MAX;
4583             struct regnode_charclass_class accum;
4584
4585             if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
4586                 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
4587             if (flags & SCF_DO_STCLASS)
4588                 cl_init_zero(pRExC_state, &accum);
4589                 
4590             if (!trie->jump) {
4591                 min1= trie->minlen;
4592                 max1= trie->maxlen;
4593             } else {
4594                 const regnode *nextbranch= NULL;
4595                 U32 word;
4596                 
4597                 for ( word=1 ; word <= trie->wordcount ; word++) 
4598                 {
4599                     I32 deltanext=0, minnext=0, f = 0, fake;
4600                     struct regnode_charclass_class this_class;
4601                     
4602                     data_fake.flags = 0;
4603                     if (data) {
4604                         data_fake.whilem_c = data->whilem_c;
4605                         data_fake.last_closep = data->last_closep;
4606                     }
4607                     else
4608                         data_fake.last_closep = &fake;
4609                     data_fake.pos_delta = delta;
4610                     if (flags & SCF_DO_STCLASS) {
4611                         cl_init(pRExC_state, &this_class);
4612                         data_fake.start_class = &this_class;
4613                         f = SCF_DO_STCLASS_AND;
4614                     }
4615                     if (flags & SCF_WHILEM_VISITED_POS)
4616                         f |= SCF_WHILEM_VISITED_POS;
4617     
4618                     if (trie->jump[word]) {
4619                         if (!nextbranch)
4620                             nextbranch = trie_node + trie->jump[0];
4621                         scan= trie_node + trie->jump[word];
4622                         /* We go from the jump point to the branch that follows
4623                            it. Note this means we need the vestigal unused branches
4624                            even though they arent otherwise used.
4625                          */
4626                         minnext = study_chunk(pRExC_state, &scan, minlenp, 
4627                             &deltanext, (regnode *)nextbranch, &data_fake, 
4628                             stopparen, recursed, NULL, f,depth+1);
4629                     }
4630                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
4631                         nextbranch= regnext((regnode*)nextbranch);
4632                     
4633                     if (min1 > (I32)(minnext + trie->minlen))
4634                         min1 = minnext + trie->minlen;
4635                     if (max1 < (I32)(minnext + deltanext + trie->maxlen))
4636                         max1 = minnext + deltanext + trie->maxlen;
4637                     if (deltanext == I32_MAX)
4638                         is_inf = is_inf_internal = 1;
4639                     
4640                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4641                         pars++;
4642                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4643                         if ( stopmin > min + min1) 
4644                             stopmin = min + min1;
4645                         flags &= ~SCF_DO_SUBSTR;
4646                         if (data)
4647                             data->flags |= SCF_SEEN_ACCEPT;
4648                     }
4649                     if (data) {
4650                         if (data_fake.flags & SF_HAS_EVAL)
4651                             data->flags |= SF_HAS_EVAL;
4652                         data->whilem_c = data_fake.whilem_c;
4653                     }
4654                     if (flags & SCF_DO_STCLASS)
4655                         cl_or(pRExC_state, &accum, &this_class);
4656                 }
4657             }
4658             if (flags & SCF_DO_SUBSTR) {
4659                 data->pos_min += min1;
4660                 data->pos_delta += max1 - min1;
4661                 if (max1 != min1 || is_inf)
4662                     data->longest = &(data->longest_float);
4663             }
4664             min += min1;
4665             delta += max1 - min1;
4666             if (flags & SCF_DO_STCLASS_OR) {
4667                 cl_or(pRExC_state, data->start_class, &accum);
4668                 if (min1) {
4669                     cl_and(data->start_class, and_withp);
4670                     flags &= ~SCF_DO_STCLASS;
4671                 }
4672             }
4673             else if (flags & SCF_DO_STCLASS_AND) {
4674                 if (min1) {
4675                     cl_and(data->start_class, &accum);
4676                     flags &= ~SCF_DO_STCLASS;
4677                 }
4678                 else {
4679                     /* Switch to OR mode: cache the old value of
4680                      * data->start_class */
4681                     INIT_AND_WITHP;
4682                     StructCopy(data->start_class, and_withp,
4683                                struct regnode_charclass_class);
4684                     flags &= ~SCF_DO_STCLASS_AND;
4685                     StructCopy(&accum, data->start_class,
4686                                struct regnode_charclass_class);
4687                     flags |= SCF_DO_STCLASS_OR;
4688                     data->start_class->flags |= ANYOF_EOS;
4689                 }
4690             }
4691             scan= tail;
4692             continue;
4693         }
4694 #else
4695         else if (PL_regkind[OP(scan)] == TRIE) {
4696             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4697             U8*bang=NULL;
4698             
4699             min += trie->minlen;
4700             delta += (trie->maxlen - trie->minlen);
4701             flags &= ~SCF_DO_STCLASS; /* xxx */
4702             if (flags & SCF_DO_SUBSTR) {
4703                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4704                 data->pos_min += trie->minlen;
4705                 data->pos_delta += (trie->maxlen - trie->minlen);
4706                 if (trie->maxlen != trie->minlen)
4707                     data->longest = &(data->longest_float);
4708             }
4709             if (trie->jump) /* no more substrings -- for now /grr*/
4710                 flags &= ~SCF_DO_SUBSTR; 
4711         }
4712 #endif /* old or new */
4713 #endif /* TRIE_STUDY_OPT */
4714
4715         /* Else: zero-length, ignore. */
4716         scan = regnext(scan);
4717     }
4718     if (frame) {
4719         last = frame->last;
4720         scan = frame->next;
4721         stopparen = frame->stop;
4722         frame = frame->prev;
4723         goto fake_study_recurse;
4724     }
4725
4726   finish:
4727     assert(!frame);
4728     DEBUG_STUDYDATA("pre-fin:",data,depth);
4729
4730     *scanp = scan;
4731     *deltap = is_inf_internal ? I32_MAX : delta;
4732     if (flags & SCF_DO_SUBSTR && is_inf)
4733         data->pos_delta = I32_MAX - data->pos_min;
4734     if (is_par > (I32)U8_MAX)
4735         is_par = 0;
4736     if (is_par && pars==1 && data) {
4737         data->flags |= SF_IN_PAR;
4738         data->flags &= ~SF_HAS_PAR;
4739     }
4740     else if (pars && data) {
4741         data->flags |= SF_HAS_PAR;
4742         data->flags &= ~SF_IN_PAR;
4743     }
4744     if (flags & SCF_DO_STCLASS_OR)
4745         cl_and(data->start_class, and_withp);
4746     if (flags & SCF_TRIE_RESTUDY)
4747         data->flags |=  SCF_TRIE_RESTUDY;
4748     
4749     DEBUG_STUDYDATA("post-fin:",data,depth);
4750     
4751     return min < stopmin ? min : stopmin;
4752 }
4753
4754 STATIC U32
4755 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4756 {
4757     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4758
4759     PERL_ARGS_ASSERT_ADD_DATA;
4760
4761     Renewc(RExC_rxi->data,
4762            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4763            char, struct reg_data);
4764     if(count)
4765         Renew(RExC_rxi->data->what, count + n, U8);
4766     else
4767         Newx(RExC_rxi->data->what, n, U8);
4768     RExC_rxi->data->count = count + n;
4769     Copy(s, RExC_rxi->data->what + count, n, U8);
4770     return count;
4771 }
4772
4773 /*XXX: todo make this not included in a non debugging perl */
4774 #ifndef PERL_IN_XSUB_RE
4775 void
4776 Perl_reginitcolors(pTHX)
4777 {
4778     dVAR;
4779     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4780     if (s) {
4781         char *t = savepv(s);
4782         int i = 0;
4783         PL_colors[0] = t;
4784         while (++i < 6) {
4785             t = strchr(t, '\t');
4786             if (t) {
4787                 *t = '\0';
4788                 PL_colors[i] = ++t;
4789             }
4790             else
4791                 PL_colors[i] = t = (char *)"";
4792         }
4793     } else {
4794         int i = 0;
4795         while (i < 6)
4796             PL_colors[i++] = (char *)"";
4797     }
4798     PL_colorset = 1;
4799 }
4800 #endif
4801
4802
4803 #ifdef TRIE_STUDY_OPT
4804 #define CHECK_RESTUDY_GOTO                                  \
4805         if (                                                \
4806               (data.flags & SCF_TRIE_RESTUDY)               \
4807               && ! restudied++                              \
4808         )     goto reStudy
4809 #else
4810 #define CHECK_RESTUDY_GOTO
4811 #endif        
4812
4813 /*
4814  - pregcomp - compile a regular expression into internal code
4815  *
4816  * We can't allocate space until we know how big the compiled form will be,
4817  * but we can't compile it (and thus know how big it is) until we've got a
4818  * place to put the code.  So we cheat:  we compile it twice, once with code
4819  * generation turned off and size counting turned on, and once "for real".
4820  * This also means that we don't allocate space until we are sure that the
4821  * thing really will compile successfully, and we never have to move the
4822  * code and thus invalidate pointers into it.  (Note that it has to be in
4823  * one piece because free() must be able to free it all.) [NB: not true in perl]
4824  *
4825  * Beware that the optimization-preparation code in here knows about some
4826  * of the structure of the compiled regexp.  [I'll say.]
4827  */
4828
4829
4830
4831 #ifndef PERL_IN_XSUB_RE
4832 #define RE_ENGINE_PTR &PL_core_reg_engine
4833 #else
4834 extern const struct regexp_engine my_reg_engine;
4835 #define RE_ENGINE_PTR &my_reg_engine
4836 #endif
4837
4838 #ifndef PERL_IN_XSUB_RE 
4839 REGEXP *
4840 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
4841 {
4842     dVAR;
4843     HV * const table = GvHV(PL_hintgv);
4844
4845     PERL_ARGS_ASSERT_PREGCOMP;
4846
4847     /* Dispatch a request to compile a regexp to correct 
4848        regexp engine. */
4849     if (table) {
4850         SV **ptr= hv_fetchs(table, "regcomp", FALSE);
4851         GET_RE_DEBUG_FLAGS_DECL;
4852         if (ptr && SvIOK(*ptr) && SvIV(*ptr)) {
4853             const regexp_engine *eng=INT2PTR(regexp_engine*,SvIV(*ptr));
4854             DEBUG_COMPILE_r({
4855                 PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4856                     SvIV(*ptr));
4857             });            
4858             return CALLREGCOMP_ENG(eng, pattern, flags);
4859         } 
4860     }
4861     return Perl_re_compile(aTHX_ pattern, flags);
4862 }
4863 #endif
4864
4865 REGEXP *
4866 Perl_re_compile(pTHX_ SV * const pattern, U32 orig_pm_flags)
4867 {
4868     dVAR;
4869     REGEXP *rx;
4870     struct regexp *r;
4871     register regexp_internal *ri;
4872     STRLEN plen;
4873     char* VOL exp;
4874     char* xend;
4875     regnode *scan;
4876     I32 flags;
4877     I32 minlen = 0;
4878     U32 pm_flags;
4879
4880     /* these are all flags - maybe they should be turned
4881      * into a single int with different bit masks */
4882     I32 sawlookahead = 0;
4883     I32 sawplus = 0;
4884     I32 sawopen = 0;
4885     bool used_setjump = FALSE;
4886     regex_charset initial_charset = get_regex_charset(orig_pm_flags);
4887
4888     U8 jump_ret = 0;
4889     dJMPENV;
4890     scan_data_t data;
4891     RExC_state_t RExC_state;
4892     RExC_state_t * const pRExC_state = &RExC_state;
4893 #ifdef TRIE_STUDY_OPT    
4894     int restudied;
4895     RExC_state_t copyRExC_state;
4896 #endif    
4897     GET_RE_DEBUG_FLAGS_DECL;
4898
4899     PERL_ARGS_ASSERT_RE_COMPILE;
4900
4901     DEBUG_r(if (!PL_colorset) reginitcolors());
4902
4903 #ifndef PERL_IN_XSUB_RE
4904     /* Initialize these here instead of as-needed, as is quick and avoids
4905      * having to test them each time otherwise */
4906     if (! PL_AboveLatin1) {
4907         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
4908         PL_ASCII = _new_invlist_C_array(ASCII_invlist);
4909         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
4910
4911         PL_L1PosixAlnum = _new_invlist_C_array(L1PosixAlnum_invlist);
4912         PL_PosixAlnum = _new_invlist_C_array(PosixAlnum_invlist);
4913
4914         PL_L1PosixAlpha = _new_invlist_C_array(L1PosixAlpha_invlist);
4915         PL_PosixAlpha = _new_invlist_C_array(PosixAlpha_invlist);
4916
4917         PL_PosixBlank = _new_invlist_C_array(PosixBlank_invlist);
4918         PL_XPosixBlank = _new_invlist_C_array(XPosixBlank_invlist);
4919
4920         PL_L1Cased = _new_invlist_C_array(L1Cased_invlist);
4921
4922         PL_PosixCntrl = _new_invlist_C_array(PosixCntrl_invlist);
4923         PL_XPosixCntrl = _new_invlist_C_array(XPosixCntrl_invlist);
4924
4925         PL_PosixDigit = _new_invlist_C_array(PosixDigit_invlist);
4926
4927         PL_L1PosixGraph = _new_invlist_C_array(L1PosixGraph_invlist);
4928         PL_PosixGraph = _new_invlist_C_array(PosixGraph_invlist);
4929
4930         PL_L1PosixAlnum = _new_invlist_C_array(L1PosixAlnum_invlist);
4931         PL_PosixAlnum = _new_invlist_C_array(PosixAlnum_invlist);
4932
4933         PL_L1PosixLower = _new_invlist_C_array(L1PosixLower_invlist);
4934         PL_PosixLower = _new_invlist_C_array(PosixLower_invlist);
4935
4936         PL_L1PosixPrint = _new_invlist_C_array(L1PosixPrint_invlist);
4937         PL_PosixPrint = _new_invlist_C_array(PosixPrint_invlist);
4938
4939         PL_L1PosixPunct = _new_invlist_C_array(L1PosixPunct_invlist);
4940         PL_PosixPunct = _new_invlist_C_array(PosixPunct_invlist);
4941
4942         PL_PerlSpace = _new_invlist_C_array(PerlSpace_invlist);
4943         PL_XPerlSpace = _new_invlist_C_array(XPerlSpace_invlist);
4944
4945         PL_PosixSpace = _new_invlist_C_array(PosixSpace_invlist);
4946         PL_XPosixSpace = _new_invlist_C_array(XPosixSpace_invlist);
4947
4948         PL_L1PosixUpper = _new_invlist_C_array(L1PosixUpper_invlist);
4949         PL_PosixUpper = _new_invlist_C_array(PosixUpper_invlist);
4950
4951         PL_VertSpace = _new_invlist_C_array(VertSpace_invlist);
4952
4953         PL_PosixWord = _new_invlist_C_array(PosixWord_invlist);
4954         PL_L1PosixWord = _new_invlist_C_array(L1PosixWord_invlist);
4955
4956         PL_PosixXDigit = _new_invlist_C_array(PosixXDigit_invlist);
4957         PL_XPosixXDigit = _new_invlist_C_array(XPosixXDigit_invlist);
4958     }
4959 #endif
4960
4961     exp = SvPV(pattern, plen);
4962
4963     if (plen == 0) { /* ignore the utf8ness if the pattern is 0 length */
4964         RExC_utf8 = RExC_orig_utf8 = 0;
4965     }
4966     else {
4967         RExC_utf8 = RExC_orig_utf8 = SvUTF8(pattern);
4968     }
4969     RExC_uni_semantics = 0;
4970     RExC_contains_locale = 0;
4971
4972     /****************** LONG JUMP TARGET HERE***********************/
4973     /* Longjmp back to here if have to switch in midstream to utf8 */
4974     if (! RExC_orig_utf8) {
4975         JMPENV_PUSH(jump_ret);
4976         used_setjump = TRUE;
4977     }
4978
4979     if (jump_ret == 0) {    /* First time through */
4980         xend = exp + plen;
4981
4982         DEBUG_COMPILE_r({
4983             SV *dsv= sv_newmortal();
4984             RE_PV_QUOTED_DECL(s, RExC_utf8,
4985                 dsv, exp, plen, 60);
4986             PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
4987                            PL_colors[4],PL_colors[5],s);
4988         });
4989     }
4990     else {  /* longjumped back */
4991         STRLEN len = plen;
4992
4993         /* If the cause for the longjmp was other than changing to utf8, pop
4994          * our own setjmp, and longjmp to the correct handler */
4995         if (jump_ret != UTF8_LONGJMP) {
4996             JMPENV_POP;
4997             JMPENV_JUMP(jump_ret);
4998         }
4999
5000         GET_RE_DEBUG_FLAGS;
5001
5002         /* It's possible to write a regexp in ascii that represents Unicode
5003         codepoints outside of the byte range, such as via \x{100}. If we
5004         detect such a sequence we have to convert the entire pattern to utf8
5005         and then recompile, as our sizing calculation will have been based
5006         on 1 byte == 1 character, but we will need to use utf8 to encode
5007         at least some part of the pattern, and therefore must convert the whole
5008         thing.
5009         -- dmq */
5010         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5011             "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
5012         exp = (char*)Perl_bytes_to_utf8(aTHX_
5013                                         (U8*)SvPV_nomg(pattern, plen),
5014                                         &len);
5015         xend = exp + len;
5016         RExC_orig_utf8 = RExC_utf8 = 1;
5017         SAVEFREEPV(exp);
5018     }
5019
5020 #ifdef TRIE_STUDY_OPT
5021     restudied = 0;
5022 #endif
5023
5024     pm_flags = orig_pm_flags;
5025
5026     if (initial_charset == REGEX_LOCALE_CHARSET) {
5027         RExC_contains_locale = 1;
5028     }
5029     else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
5030
5031         /* Set to use unicode semantics if the pattern is in utf8 and has the
5032          * 'depends' charset specified, as it means unicode when utf8  */
5033         set_regex_charset(&pm_flags, REGEX_UNICODE_CHARSET);
5034     }
5035
5036     RExC_precomp = exp;
5037     RExC_flags = pm_flags;
5038     RExC_sawback = 0;
5039
5040     RExC_seen = 0;
5041     RExC_in_lookbehind = 0;
5042     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
5043     RExC_seen_evals = 0;
5044     RExC_extralen = 0;
5045     RExC_override_recoding = 0;
5046
5047     /* First pass: determine size, legality. */
5048     RExC_parse = exp;
5049     RExC_start = exp;
5050     RExC_end = xend;
5051     RExC_naughty = 0;
5052     RExC_npar = 1;
5053     RExC_nestroot = 0;
5054     RExC_size = 0L;
5055     RExC_emit = &PL_regdummy;
5056     RExC_whilem_seen = 0;
5057     RExC_open_parens = NULL;
5058     RExC_close_parens = NULL;
5059     RExC_opend = NULL;
5060     RExC_paren_names = NULL;
5061 #ifdef DEBUGGING
5062     RExC_paren_name_list = NULL;
5063 #endif
5064     RExC_recurse = NULL;
5065     RExC_recurse_count = 0;
5066
5067 #if 0 /* REGC() is (currently) a NOP at the first pass.
5068        * Clever compilers notice this and complain. --jhi */
5069     REGC((U8)REG_MAGIC, (char*)RExC_emit);
5070 #endif
5071     DEBUG_PARSE_r(
5072         PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
5073         RExC_lastnum=0;
5074         RExC_lastparse=NULL;
5075     );
5076     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5077         RExC_precomp = NULL;
5078         return(NULL);
5079     }
5080
5081     /* Here, finished first pass.  Get rid of any added setjmp */
5082     if (used_setjump) {
5083         JMPENV_POP;
5084     }
5085
5086     DEBUG_PARSE_r({
5087         PerlIO_printf(Perl_debug_log, 
5088             "Required size %"IVdf" nodes\n"
5089             "Starting second pass (creation)\n", 
5090             (IV)RExC_size);
5091         RExC_lastnum=0; 
5092         RExC_lastparse=NULL; 
5093     });
5094
5095     /* The first pass could have found things that force Unicode semantics */
5096     if ((RExC_utf8 || RExC_uni_semantics)
5097          && get_regex_charset(pm_flags) == REGEX_DEPENDS_CHARSET)
5098     {
5099         set_regex_charset(&pm_flags, REGEX_UNICODE_CHARSET);
5100     }
5101
5102     /* Small enough for pointer-storage convention?
5103        If extralen==0, this means that we will not need long jumps. */
5104     if (RExC_size >= 0x10000L && RExC_extralen)
5105         RExC_size += RExC_extralen;
5106     else
5107         RExC_extralen = 0;
5108     if (RExC_whilem_seen > 15)
5109         RExC_whilem_seen = 15;
5110
5111     /* Allocate space and zero-initialize. Note, the two step process 
5112        of zeroing when in debug mode, thus anything assigned has to 
5113        happen after that */
5114     rx = (REGEXP*) newSV_type(SVt_REGEXP);
5115     r = (struct regexp*)SvANY(rx);
5116     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
5117          char, regexp_internal);
5118     if ( r == NULL || ri == NULL )
5119         FAIL("Regexp out of space");
5120 #ifdef DEBUGGING
5121     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
5122     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
5123 #else 
5124     /* bulk initialize base fields with 0. */
5125     Zero(ri, sizeof(regexp_internal), char);        
5126 #endif
5127
5128     /* non-zero initialization begins here */
5129     RXi_SET( r, ri );
5130     r->engine= RE_ENGINE_PTR;
5131     r->extflags = pm_flags;
5132     {
5133         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
5134         bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
5135
5136         /* The caret is output if there are any defaults: if not all the STD
5137          * flags are set, or if no character set specifier is needed */
5138         bool has_default =
5139                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
5140                     || ! has_charset);
5141         bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
5142         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
5143                             >> RXf_PMf_STD_PMMOD_SHIFT);
5144         const char *fptr = STD_PAT_MODS;        /*"msix"*/
5145         char *p;
5146         /* Allocate for the worst case, which is all the std flags are turned
5147          * on.  If more precision is desired, we could do a population count of
5148          * the flags set.  This could be done with a small lookup table, or by
5149          * shifting, masking and adding, or even, when available, assembly
5150          * language for a machine-language population count.
5151          * We never output a minus, as all those are defaults, so are
5152          * covered by the caret */
5153         const STRLEN wraplen = plen + has_p + has_runon
5154             + has_default       /* If needs a caret */
5155
5156                 /* If needs a character set specifier */
5157             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
5158             + (sizeof(STD_PAT_MODS) - 1)
5159             + (sizeof("(?:)") - 1);
5160
5161         p = sv_grow(MUTABLE_SV(rx), wraplen + 1); /* +1 for the ending NUL */
5162         SvPOK_on(rx);
5163         SvFLAGS(rx) |= SvUTF8(pattern);
5164         *p++='('; *p++='?';
5165
5166         /* If a default, cover it using the caret */
5167         if (has_default) {
5168             *p++= DEFAULT_PAT_MOD;
5169         }
5170         if (has_charset) {
5171             STRLEN len;
5172             const char* const name = get_regex_charset_name(r->extflags, &len);
5173             Copy(name, p, len, char);
5174             p += len;
5175         }
5176         if (has_p)
5177             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
5178         {
5179             char ch;
5180             while((ch = *fptr++)) {
5181                 if(reganch & 1)
5182                     *p++ = ch;
5183                 reganch >>= 1;
5184             }
5185         }
5186
5187         *p++ = ':';
5188         Copy(RExC_precomp, p, plen, char);
5189         assert ((RX_WRAPPED(rx) - p) < 16);
5190         r->pre_prefix = p - RX_WRAPPED(rx);
5191         p += plen;
5192         if (has_runon)
5193             *p++ = '\n';
5194         *p++ = ')';
5195         *p = 0;
5196         SvCUR_set(rx, p - SvPVX_const(rx));
5197     }
5198
5199     r->intflags = 0;
5200     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
5201     
5202     if (RExC_seen & REG_SEEN_RECURSE) {
5203         Newxz(RExC_open_parens, RExC_npar,regnode *);
5204         SAVEFREEPV(RExC_open_parens);
5205         Newxz(RExC_close_parens,RExC_npar,regnode *);
5206         SAVEFREEPV(RExC_close_parens);
5207     }
5208
5209     /* Useful during FAIL. */
5210 #ifdef RE_TRACK_PATTERN_OFFSETS
5211     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
5212     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
5213                           "%s %"UVuf" bytes for offset annotations.\n",
5214                           ri->u.offsets ? "Got" : "Couldn't get",
5215                           (UV)((2*RExC_size+1) * sizeof(U32))));
5216 #endif
5217     SetProgLen(ri,RExC_size);
5218     RExC_rx_sv = rx;
5219     RExC_rx = r;
5220     RExC_rxi = ri;
5221
5222     /* Second pass: emit code. */
5223     RExC_flags = pm_flags;      /* don't let top level (?i) bleed */
5224     RExC_parse = exp;
5225     RExC_end = xend;
5226     RExC_naughty = 0;
5227     RExC_npar = 1;
5228     RExC_emit_start = ri->program;
5229     RExC_emit = ri->program;
5230     RExC_emit_bound = ri->program + RExC_size + 1;
5231
5232     /* Store the count of eval-groups for security checks: */
5233     RExC_rx->seen_evals = RExC_seen_evals;
5234     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
5235     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5236         ReREFCNT_dec(rx);   
5237         return(NULL);
5238     }
5239     /* XXXX To minimize changes to RE engine we always allocate
5240        3-units-long substrs field. */
5241     Newx(r->substrs, 1, struct reg_substr_data);
5242     if (RExC_recurse_count) {
5243         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
5244         SAVEFREEPV(RExC_recurse);
5245     }
5246
5247 reStudy:
5248     r->minlen = minlen = sawlookahead = sawplus = sawopen = 0;
5249     Zero(r->substrs, 1, struct reg_substr_data);
5250
5251 #ifdef TRIE_STUDY_OPT
5252     if (!restudied) {
5253         StructCopy(&zero_scan_data, &data, scan_data_t);
5254         copyRExC_state = RExC_state;
5255     } else {
5256         U32 seen=RExC_seen;
5257         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
5258         
5259         RExC_state = copyRExC_state;
5260         if (seen & REG_TOP_LEVEL_BRANCHES) 
5261             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
5262         else
5263             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
5264         if (data.last_found) {
5265             SvREFCNT_dec(data.longest_fixed);
5266             SvREFCNT_dec(data.longest_float);
5267             SvREFCNT_dec(data.last_found);
5268         }
5269         StructCopy(&zero_scan_data, &data, scan_data_t);
5270     }
5271 #else
5272     StructCopy(&zero_scan_data, &data, scan_data_t);
5273 #endif    
5274
5275     /* Dig out information for optimizations. */
5276     r->extflags = RExC_flags; /* was pm_op */
5277     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
5278  
5279     if (UTF)
5280         SvUTF8_on(rx);  /* Unicode in it? */
5281     ri->regstclass = NULL;
5282     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
5283         r->intflags |= PREGf_NAUGHTY;
5284     scan = ri->program + 1;             /* First BRANCH. */
5285
5286     /* testing for BRANCH here tells us whether there is "must appear"
5287        data in the pattern. If there is then we can use it for optimisations */
5288     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
5289         I32 fake;
5290         STRLEN longest_float_length, longest_fixed_length;
5291         struct regnode_charclass_class ch_class; /* pointed to by data */
5292         int stclass_flag;
5293         I32 last_close = 0; /* pointed to by data */
5294         regnode *first= scan;
5295         regnode *first_next= regnext(first);
5296         /*
5297          * Skip introductions and multiplicators >= 1
5298          * so that we can extract the 'meat' of the pattern that must 
5299          * match in the large if() sequence following.
5300          * NOTE that EXACT is NOT covered here, as it is normally
5301          * picked up by the optimiser separately. 
5302          *
5303          * This is unfortunate as the optimiser isnt handling lookahead
5304          * properly currently.
5305          *
5306          */
5307         while ((OP(first) == OPEN && (sawopen = 1)) ||
5308                /* An OR of *one* alternative - should not happen now. */
5309             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
5310             /* for now we can't handle lookbehind IFMATCH*/
5311             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
5312             (OP(first) == PLUS) ||
5313             (OP(first) == MINMOD) ||
5314                /* An {n,m} with n>0 */
5315             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
5316             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
5317         {
5318                 /* 
5319                  * the only op that could be a regnode is PLUS, all the rest
5320                  * will be regnode_1 or regnode_2.
5321                  *
5322                  */
5323                 if (OP(first) == PLUS)
5324                     sawplus = 1;
5325                 else
5326                     first += regarglen[OP(first)];
5327
5328                 first = NEXTOPER(first);
5329                 first_next= regnext(first);
5330         }
5331
5332         /* Starting-point info. */
5333       again:
5334         DEBUG_PEEP("first:",first,0);
5335         /* Ignore EXACT as we deal with it later. */
5336         if (PL_regkind[OP(first)] == EXACT) {
5337             if (OP(first) == EXACT)
5338                 NOOP;   /* Empty, get anchored substr later. */
5339             else
5340                 ri->regstclass = first;
5341         }
5342 #ifdef TRIE_STCLASS
5343         else if (PL_regkind[OP(first)] == TRIE &&
5344                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
5345         {
5346             regnode *trie_op;
5347             /* this can happen only on restudy */
5348             if ( OP(first) == TRIE ) {
5349                 struct regnode_1 *trieop = (struct regnode_1 *)
5350                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
5351                 StructCopy(first,trieop,struct regnode_1);
5352                 trie_op=(regnode *)trieop;
5353             } else {
5354                 struct regnode_charclass *trieop = (struct regnode_charclass *)
5355                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
5356                 StructCopy(first,trieop,struct regnode_charclass);
5357                 trie_op=(regnode *)trieop;
5358             }
5359             OP(trie_op)+=2;
5360             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
5361             ri->regstclass = trie_op;
5362         }
5363 #endif
5364         else if (REGNODE_SIMPLE(OP(first)))
5365             ri->regstclass = first;
5366         else if (PL_regkind[OP(first)] == BOUND ||
5367                  PL_regkind[OP(first)] == NBOUND)
5368             ri->regstclass = first;
5369         else if (PL_regkind[OP(first)] == BOL) {
5370             r->extflags |= (OP(first) == MBOL
5371                            ? RXf_ANCH_MBOL
5372                            : (OP(first) == SBOL
5373                               ? RXf_ANCH_SBOL
5374                               : RXf_ANCH_BOL));
5375             first = NEXTOPER(first);
5376             goto again;
5377         }
5378         else if (OP(first) == GPOS) {
5379             r->extflags |= RXf_ANCH_GPOS;
5380             first = NEXTOPER(first);
5381             goto again;
5382         }
5383         else if ((!sawopen || !RExC_sawback) &&
5384             (OP(first) == STAR &&
5385             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
5386             !(r->extflags & RXf_ANCH) && !(RExC_seen & REG_SEEN_EVAL))
5387         {
5388             /* turn .* into ^.* with an implied $*=1 */
5389             const int type =
5390                 (OP(NEXTOPER(first)) == REG_ANY)
5391                     ? RXf_ANCH_MBOL
5392                     : RXf_ANCH_SBOL;
5393             r->extflags |= type;
5394             r->intflags |= PREGf_IMPLICIT;
5395             first = NEXTOPER(first);
5396             goto again;
5397         }
5398         if (sawplus && !sawlookahead && (!sawopen || !RExC_sawback)
5399             && !(RExC_seen & REG_SEEN_EVAL)) /* May examine pos and $& */
5400             /* x+ must match at the 1st pos of run of x's */
5401             r->intflags |= PREGf_SKIP;
5402
5403         /* Scan is after the zeroth branch, first is atomic matcher. */
5404 #ifdef TRIE_STUDY_OPT
5405         DEBUG_PARSE_r(
5406             if (!restudied)
5407                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
5408                               (IV)(first - scan + 1))
5409         );
5410 #else
5411         DEBUG_PARSE_r(
5412             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
5413                 (IV)(first - scan + 1))
5414         );
5415 #endif
5416
5417
5418         /*
5419         * If there's something expensive in the r.e., find the
5420         * longest literal string that must appear and make it the
5421         * regmust.  Resolve ties in favor of later strings, since
5422         * the regstart check works with the beginning of the r.e.
5423         * and avoiding duplication strengthens checking.  Not a
5424         * strong reason, but sufficient in the absence of others.
5425         * [Now we resolve ties in favor of the earlier string if
5426         * it happens that c_offset_min has been invalidated, since the
5427         * earlier string may buy us something the later one won't.]
5428         */
5429
5430         data.longest_fixed = newSVpvs("");
5431         data.longest_float = newSVpvs("");
5432         data.last_found = newSVpvs("");
5433         data.longest = &(data.longest_fixed);
5434         first = scan;
5435         if (!ri->regstclass) {
5436             cl_init(pRExC_state, &ch_class);
5437             data.start_class = &ch_class;
5438             stclass_flag = SCF_DO_STCLASS_AND;
5439         } else                          /* XXXX Check for BOUND? */
5440             stclass_flag = 0;
5441         data.last_closep = &last_close;
5442         
5443         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
5444             &data, -1, NULL, NULL,
5445             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
5446
5447
5448         CHECK_RESTUDY_GOTO;
5449
5450
5451         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
5452              && data.last_start_min == 0 && data.last_end > 0
5453              && !RExC_seen_zerolen
5454              && !(RExC_seen & REG_SEEN_VERBARG)
5455              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
5456             r->extflags |= RXf_CHECK_ALL;
5457         scan_commit(pRExC_state, &data,&minlen,0);
5458         SvREFCNT_dec(data.last_found);
5459
5460         /* Note that code very similar to this but for anchored string 
5461            follows immediately below, changes may need to be made to both. 
5462            Be careful. 
5463          */
5464         longest_float_length = CHR_SVLEN(data.longest_float);
5465         if (longest_float_length
5466             || (data.flags & SF_FL_BEFORE_EOL
5467                 && (!(data.flags & SF_FL_BEFORE_MEOL)
5468                     || (RExC_flags & RXf_PMf_MULTILINE)))) 
5469         {
5470             I32 t,ml;
5471
5472             /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5473             if ((RExC_seen & REG_SEEN_EXACTF_SHARP_S)
5474                 || (SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
5475                     && data.offset_fixed == data.offset_float_min
5476                     && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
5477                     goto remove_float;          /* As in (a)+. */
5478
5479             /* copy the information about the longest float from the reg_scan_data
5480                over to the program. */
5481             if (SvUTF8(data.longest_float)) {
5482                 r->float_utf8 = data.longest_float;
5483                 r->float_substr = NULL;
5484             } else {
5485                 r->float_substr = data.longest_float;
5486                 r->float_utf8 = NULL;
5487             }
5488             /* float_end_shift is how many chars that must be matched that 
5489                follow this item. We calculate it ahead of time as once the
5490                lookbehind offset is added in we lose the ability to correctly
5491                calculate it.*/
5492             ml = data.minlen_float ? *(data.minlen_float) 
5493                                    : (I32)longest_float_length;
5494             r->float_end_shift = ml - data.offset_float_min
5495                 - longest_float_length + (SvTAIL(data.longest_float) != 0)
5496                 + data.lookbehind_float;
5497             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
5498             r->float_max_offset = data.offset_float_max;
5499             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
5500                 r->float_max_offset -= data.lookbehind_float;
5501             
5502             t = (data.flags & SF_FL_BEFORE_EOL /* Can't have SEOL and MULTI */
5503                        && (!(data.flags & SF_FL_BEFORE_MEOL)
5504                            || (RExC_flags & RXf_PMf_MULTILINE)));
5505             fbm_compile(data.longest_float, t ? FBMcf_TAIL : 0);
5506         }
5507         else {
5508           remove_float:
5509             r->float_substr = r->float_utf8 = NULL;
5510             SvREFCNT_dec(data.longest_float);
5511             longest_float_length = 0;
5512         }
5513
5514         /* Note that code very similar to this but for floating string 
5515            is immediately above, changes may need to be made to both. 
5516            Be careful. 
5517          */
5518         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
5519
5520         /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5521         if (! (RExC_seen & REG_SEEN_EXACTF_SHARP_S)
5522             && (longest_fixed_length
5523                 || (data.flags & SF_FIX_BEFORE_EOL /* Cannot have SEOL and MULTI */
5524                     && (!(data.flags & SF_FIX_BEFORE_MEOL)
5525                         || (RExC_flags & RXf_PMf_MULTILINE)))) )
5526         {
5527             I32 t,ml;
5528
5529             /* copy the information about the longest fixed 
5530                from the reg_scan_data over to the program. */
5531             if (SvUTF8(data.longest_fixed)) {
5532                 r->anchored_utf8 = data.longest_fixed;
5533                 r->anchored_substr = NULL;
5534             } else {
5535                 r->anchored_substr = data.longest_fixed;
5536                 r->anchored_utf8 = NULL;
5537             }
5538             /* fixed_end_shift is how many chars that must be matched that 
5539                follow this item. We calculate it ahead of time as once the
5540                lookbehind offset is added in we lose the ability to correctly
5541                calculate it.*/
5542             ml = data.minlen_fixed ? *(data.minlen_fixed) 
5543                                    : (I32)longest_fixed_length;
5544             r->anchored_end_shift = ml - data.offset_fixed
5545                 - longest_fixed_length + (SvTAIL(data.longest_fixed) != 0)
5546                 + data.lookbehind_fixed;
5547             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
5548
5549             t = (data.flags & SF_FIX_BEFORE_EOL /* Can't have SEOL and MULTI */
5550                  && (!(data.flags & SF_FIX_BEFORE_MEOL)
5551                      || (RExC_flags & RXf_PMf_MULTILINE)));
5552             fbm_compile(data.longest_fixed, t ? FBMcf_TAIL : 0);
5553         }
5554         else {
5555             r->anchored_substr = r->anchored_utf8 = NULL;
5556             SvREFCNT_dec(data.longest_fixed);
5557             longest_fixed_length = 0;
5558         }
5559         if (ri->regstclass
5560             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
5561             ri->regstclass = NULL;
5562
5563         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
5564             && stclass_flag
5565             && !(data.start_class->flags & ANYOF_EOS)
5566             && !cl_is_anything(data.start_class))
5567         {
5568             const U32 n = add_data(pRExC_state, 1, "f");
5569             data.start_class->flags |= ANYOF_IS_SYNTHETIC;
5570
5571             Newx(RExC_rxi->data->data[n], 1,
5572                 struct regnode_charclass_class);
5573             StructCopy(data.start_class,
5574                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
5575                        struct regnode_charclass_class);
5576             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
5577             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
5578             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
5579                       regprop(r, sv, (regnode*)data.start_class);
5580                       PerlIO_printf(Perl_debug_log,
5581                                     "synthetic stclass \"%s\".\n",
5582                                     SvPVX_const(sv));});
5583         }
5584
5585         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
5586         if (longest_fixed_length > longest_float_length) {
5587             r->check_end_shift = r->anchored_end_shift;
5588             r->check_substr = r->anchored_substr;
5589             r->check_utf8 = r->anchored_utf8;
5590             r->check_offset_min = r->check_offset_max = r->anchored_offset;
5591             if (r->extflags & RXf_ANCH_SINGLE)
5592                 r->extflags |= RXf_NOSCAN;
5593         }
5594         else {
5595             r->check_end_shift = r->float_end_shift;
5596             r->check_substr = r->float_substr;
5597             r->check_utf8 = r->float_utf8;
5598             r->check_offset_min = r->float_min_offset;
5599             r->check_offset_max = r->float_max_offset;
5600         }
5601         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
5602            This should be changed ASAP!  */
5603         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
5604             r->extflags |= RXf_USE_INTUIT;
5605             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
5606                 r->extflags |= RXf_INTUIT_TAIL;
5607         }
5608         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
5609         if ( (STRLEN)minlen < longest_float_length )
5610             minlen= longest_float_length;
5611         if ( (STRLEN)minlen < longest_fixed_length )
5612             minlen= longest_fixed_length;     
5613         */
5614     }
5615     else {
5616         /* Several toplevels. Best we can is to set minlen. */
5617         I32 fake;
5618         struct regnode_charclass_class ch_class;
5619         I32 last_close = 0;
5620
5621         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
5622
5623         scan = ri->program + 1;
5624         cl_init(pRExC_state, &ch_class);
5625         data.start_class = &ch_class;
5626         data.last_closep = &last_close;
5627
5628         
5629         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
5630             &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
5631         
5632         CHECK_RESTUDY_GOTO;
5633
5634         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
5635                 = r->float_substr = r->float_utf8 = NULL;
5636
5637         if (!(data.start_class->flags & ANYOF_EOS)
5638             && !cl_is_anything(data.start_class))
5639         {
5640             const U32 n = add_data(pRExC_state, 1, "f");
5641             data.start_class->flags |= ANYOF_IS_SYNTHETIC;
5642
5643             Newx(RExC_rxi->data->data[n], 1,
5644                 struct regnode_charclass_class);
5645             StructCopy(data.start_class,
5646                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
5647                        struct regnode_charclass_class);
5648             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
5649             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
5650             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
5651                       regprop(r, sv, (regnode*)data.start_class);
5652                       PerlIO_printf(Perl_debug_log,
5653                                     "synthetic stclass \"%s\".\n",
5654                                     SvPVX_const(sv));});
5655         }
5656     }
5657
5658     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
5659        the "real" pattern. */
5660     DEBUG_OPTIMISE_r({
5661         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
5662                       (IV)minlen, (IV)r->minlen);
5663     });
5664     r->minlenret = minlen;
5665     if (r->minlen < minlen) 
5666         r->minlen = minlen;
5667     
5668     if (RExC_seen & REG_SEEN_GPOS)
5669         r->extflags |= RXf_GPOS_SEEN;
5670     if (RExC_seen & REG_SEEN_LOOKBEHIND)
5671         r->extflags |= RXf_LOOKBEHIND_SEEN;
5672     if (RExC_seen & REG_SEEN_EVAL)
5673         r->extflags |= RXf_EVAL_SEEN;
5674     if (RExC_seen & REG_SEEN_CANY)
5675         r->extflags |= RXf_CANY_SEEN;
5676     if (RExC_seen & REG_SEEN_VERBARG)
5677         r->intflags |= PREGf_VERBARG_SEEN;
5678     if (RExC_seen & REG_SEEN_CUTGROUP)
5679         r->intflags |= PREGf_CUTGROUP_SEEN;
5680     if (RExC_paren_names)
5681         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
5682     else
5683         RXp_PAREN_NAMES(r) = NULL;
5684
5685 #ifdef STUPID_PATTERN_CHECKS            
5686     if (RX_PRELEN(rx) == 0)
5687         r->extflags |= RXf_NULL;
5688     if (r->extflags & RXf_SPLIT && RX_PRELEN(rx) == 1 && RX_PRECOMP(rx)[0] == ' ')
5689         /* XXX: this should happen BEFORE we compile */
5690         r->extflags |= (RXf_SKIPWHITE|RXf_WHITE); 
5691     else if (RX_PRELEN(rx) == 3 && memEQ("\\s+", RX_PRECOMP(rx), 3))
5692         r->extflags |= RXf_WHITE;
5693     else if (RX_PRELEN(rx) == 1 && RXp_PRECOMP(rx)[0] == '^')
5694         r->extflags |= RXf_START_ONLY;
5695 #else
5696     if (r->extflags & RXf_SPLIT && RX_PRELEN(rx) == 1 && RX_PRECOMP(rx)[0] == ' ')
5697             /* XXX: this should happen BEFORE we compile */
5698             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE); 
5699     else {
5700         regnode *first = ri->program + 1;
5701         U8 fop = OP(first);
5702
5703         if (PL_regkind[fop] == NOTHING && OP(NEXTOPER(first)) == END)
5704             r->extflags |= RXf_NULL;
5705         else if (PL_regkind[fop] == BOL && OP(NEXTOPER(first)) == END)
5706             r->extflags |= RXf_START_ONLY;
5707         else if (fop == PLUS && OP(NEXTOPER(first)) == SPACE
5708                              && OP(regnext(first)) == END)
5709             r->extflags |= RXf_WHITE;    
5710     }
5711 #endif
5712 #ifdef DEBUGGING
5713     if (RExC_paren_names) {
5714         ri->name_list_idx = add_data( pRExC_state, 1, "a" );
5715         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
5716     } else
5717 #endif
5718         ri->name_list_idx = 0;
5719
5720     if (RExC_recurse_count) {
5721         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
5722             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
5723             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
5724         }
5725     }
5726     Newxz(r->offs, RExC_npar, regexp_paren_pair);
5727     /* assume we don't need to swap parens around before we match */
5728
5729     DEBUG_DUMP_r({
5730         PerlIO_printf(Perl_debug_log,"Final program:\n");
5731         regdump(r);
5732     });
5733 #ifdef RE_TRACK_PATTERN_OFFSETS
5734     DEBUG_OFFSETS_r(if (ri->u.offsets) {
5735         const U32 len = ri->u.offsets[0];
5736         U32 i;
5737         GET_RE_DEBUG_FLAGS_DECL;
5738         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
5739         for (i = 1; i <= len; i++) {
5740             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
5741                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
5742                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
5743             }
5744         PerlIO_printf(Perl_debug_log, "\n");
5745     });
5746 #endif
5747     return rx;
5748 }
5749
5750 #undef RE_ENGINE_PTR
5751
5752
5753 SV*
5754 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
5755                     const U32 flags)
5756 {
5757     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
5758
5759     PERL_UNUSED_ARG(value);
5760
5761     if (flags & RXapif_FETCH) {
5762         return reg_named_buff_fetch(rx, key, flags);
5763     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
5764         Perl_croak_no_modify(aTHX);
5765         return NULL;
5766     } else if (flags & RXapif_EXISTS) {
5767         return reg_named_buff_exists(rx, key, flags)
5768             ? &PL_sv_yes
5769             : &PL_sv_no;
5770     } else if (flags & RXapif_REGNAMES) {
5771         return reg_named_buff_all(rx, flags);
5772     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
5773         return reg_named_buff_scalar(rx, flags);
5774     } else {
5775         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
5776         return NULL;
5777     }
5778 }
5779
5780 SV*
5781 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
5782                          const U32 flags)
5783 {
5784     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
5785     PERL_UNUSED_ARG(lastkey);
5786
5787     if (flags & RXapif_FIRSTKEY)
5788         return reg_named_buff_firstkey(rx, flags);
5789     else if (flags & RXapif_NEXTKEY)
5790         return reg_named_buff_nextkey(rx, flags);
5791     else {
5792         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
5793         return NULL;
5794     }
5795 }
5796
5797 SV*
5798 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
5799                           const U32 flags)
5800 {
5801     AV *retarray = NULL;
5802     SV *ret;
5803     struct regexp *const rx = (struct regexp *)SvANY(r);
5804
5805     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
5806
5807     if (flags & RXapif_ALL)
5808         retarray=newAV();
5809
5810     if (rx && RXp_PAREN_NAMES(rx)) {
5811         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
5812         if (he_str) {
5813             IV i;
5814             SV* sv_dat=HeVAL(he_str);
5815             I32 *nums=(I32*)SvPVX(sv_dat);
5816             for ( i=0; i<SvIVX(sv_dat); i++ ) {
5817                 if ((I32)(rx->nparens) >= nums[i]
5818                     && rx->offs[nums[i]].start != -1
5819                     && rx->offs[nums[i]].end != -1)
5820                 {
5821                     ret = newSVpvs("");
5822                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
5823                     if (!retarray)
5824                         return ret;
5825                 } else {
5826                     if (retarray)
5827                         ret = newSVsv(&PL_sv_undef);
5828                 }
5829                 if (retarray)
5830                     av_push(retarray, ret);
5831             }
5832             if (retarray)
5833                 return newRV_noinc(MUTABLE_SV(retarray));
5834         }
5835     }
5836     return NULL;
5837 }
5838
5839 bool
5840 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
5841                            const U32 flags)
5842 {
5843     struct regexp *const rx = (struct regexp *)SvANY(r);
5844
5845     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
5846
5847     if (rx && RXp_PAREN_NAMES(rx)) {
5848         if (flags & RXapif_ALL) {
5849             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
5850         } else {
5851             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
5852             if (sv) {
5853                 SvREFCNT_dec(sv);
5854                 return TRUE;
5855             } else {
5856                 return FALSE;
5857             }
5858         }
5859     } else {
5860         return FALSE;
5861     }
5862 }
5863
5864 SV*
5865 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
5866 {
5867     struct regexp *const rx = (struct regexp *)SvANY(r);
5868
5869     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
5870
5871     if ( rx && RXp_PAREN_NAMES(rx) ) {
5872         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
5873
5874         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
5875     } else {
5876         return FALSE;
5877     }
5878 }
5879
5880 SV*
5881 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
5882 {
5883     struct regexp *const rx = (struct regexp *)SvANY(r);
5884     GET_RE_DEBUG_FLAGS_DECL;
5885
5886     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
5887
5888     if (rx && RXp_PAREN_NAMES(rx)) {
5889         HV *hv = RXp_PAREN_NAMES(rx);
5890         HE *temphe;
5891         while ( (temphe = hv_iternext_flags(hv,0)) ) {
5892             IV i;
5893             IV parno = 0;
5894             SV* sv_dat = HeVAL(temphe);
5895             I32 *nums = (I32*)SvPVX(sv_dat);
5896             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
5897                 if ((I32)(rx->lastparen) >= nums[i] &&
5898                     rx->offs[nums[i]].start != -1 &&
5899                     rx->offs[nums[i]].end != -1)
5900                 {
5901                     parno = nums[i];
5902                     break;
5903                 }
5904             }
5905             if (parno || flags & RXapif_ALL) {
5906                 return newSVhek(HeKEY_hek(temphe));
5907             }
5908         }
5909     }
5910     return NULL;
5911 }
5912
5913 SV*
5914 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
5915 {
5916     SV *ret;
5917     AV *av;
5918     I32 length;
5919     struct regexp *const rx = (struct regexp *)SvANY(r);
5920
5921     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
5922
5923     if (rx && RXp_PAREN_NAMES(rx)) {
5924         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
5925             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
5926         } else if (flags & RXapif_ONE) {
5927             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
5928             av = MUTABLE_AV(SvRV(ret));
5929             length = av_len(av);
5930             SvREFCNT_dec(ret);
5931             return newSViv(length + 1);
5932         } else {
5933             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
5934             return NULL;
5935         }
5936     }
5937     return &PL_sv_undef;
5938 }
5939
5940 SV*
5941 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
5942 {
5943     struct regexp *const rx = (struct regexp *)SvANY(r);
5944     AV *av = newAV();
5945
5946     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
5947
5948     if (rx && RXp_PAREN_NAMES(rx)) {
5949         HV *hv= RXp_PAREN_NAMES(rx);
5950         HE *temphe;
5951         (void)hv_iterinit(hv);
5952         while ( (temphe = hv_iternext_flags(hv,0)) ) {
5953             IV i;
5954             IV parno = 0;
5955             SV* sv_dat = HeVAL(temphe);
5956             I32 *nums = (I32*)SvPVX(sv_dat);
5957             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
5958                 if ((I32)(rx->lastparen) >= nums[i] &&
5959                     rx->offs[nums[i]].start != -1 &&
5960                     rx->offs[nums[i]].end != -1)
5961                 {
5962                     parno = nums[i];
5963                     break;
5964                 }
5965             }
5966             if (parno || flags & RXapif_ALL) {
5967                 av_push(av, newSVhek(HeKEY_hek(temphe)));
5968             }
5969         }
5970     }
5971
5972     return newRV_noinc(MUTABLE_SV(av));
5973 }
5974
5975 void
5976 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
5977                              SV * const sv)
5978 {
5979     struct regexp *const rx = (struct regexp *)SvANY(r);
5980     char *s = NULL;
5981     I32 i = 0;
5982     I32 s1, t1;
5983
5984     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
5985         
5986     if (!rx->subbeg) {
5987         sv_setsv(sv,&PL_sv_undef);
5988         return;
5989     } 
5990     else               
5991     if (paren == RX_BUFF_IDX_PREMATCH && rx->offs[0].start != -1) {
5992         /* $` */
5993         i = rx->offs[0].start;
5994         s = rx->subbeg;
5995     }
5996     else 
5997     if (paren == RX_BUFF_IDX_POSTMATCH && rx->offs[0].end != -1) {
5998         /* $' */
5999         s = rx->subbeg + rx->offs[0].end;
6000         i = rx->sublen - rx->offs[0].end;
6001     } 
6002     else
6003     if ( 0 <= paren && paren <= (I32)rx->nparens &&
6004         (s1 = rx->offs[paren].start) != -1 &&
6005         (t1 = rx->offs[paren].end) != -1)
6006     {
6007         /* $& $1 ... */
6008         i = t1 - s1;
6009         s = rx->subbeg + s1;
6010     } else {
6011         sv_setsv(sv,&PL_sv_undef);
6012         return;
6013     }          
6014     assert(rx->sublen >= (s - rx->subbeg) + i );
6015     if (i >= 0) {
6016         const int oldtainted = PL_tainted;
6017         TAINT_NOT;
6018         sv_setpvn(sv, s, i);
6019         PL_tainted = oldtainted;
6020         if ( (rx->extflags & RXf_CANY_SEEN)
6021             ? (RXp_MATCH_UTF8(rx)
6022                         && (!i || is_utf8_string((U8*)s, i)))
6023             : (RXp_MATCH_UTF8(rx)) )
6024         {
6025             SvUTF8_on(sv);
6026         }
6027         else
6028             SvUTF8_off(sv);
6029         if (PL_tainting) {
6030             if (RXp_MATCH_TAINTED(rx)) {
6031                 if (SvTYPE(sv) >= SVt_PVMG) {
6032                     MAGIC* const mg = SvMAGIC(sv);
6033                     MAGIC* mgt;
6034                     PL_tainted = 1;
6035                     SvMAGIC_set(sv, mg->mg_moremagic);
6036                     SvTAINT(sv);
6037                     if ((mgt = SvMAGIC(sv))) {
6038                         mg->mg_moremagic = mgt;
6039                         SvMAGIC_set(sv, mg);
6040                     }
6041                 } else {
6042                     PL_tainted = 1;
6043                     SvTAINT(sv);
6044                 }
6045             } else 
6046                 SvTAINTED_off(sv);
6047         }
6048     } else {
6049         sv_setsv(sv,&PL_sv_undef);
6050         return;
6051     }
6052 }
6053
6054 void
6055 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6056                                                          SV const * const value)
6057 {
6058     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6059
6060     PERL_UNUSED_ARG(rx);
6061     PERL_UNUSED_ARG(paren);
6062     PERL_UNUSED_ARG(value);
6063
6064     if (!PL_localizing)
6065         Perl_croak_no_modify(aTHX);
6066 }
6067
6068 I32
6069 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6070                               const I32 paren)
6071 {
6072     struct regexp *const rx = (struct regexp *)SvANY(r);
6073     I32 i;
6074     I32 s1, t1;
6075
6076     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6077
6078     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6079         switch (paren) {
6080       /* $` / ${^PREMATCH} */
6081       case RX_BUFF_IDX_PREMATCH:
6082         if (rx->offs[0].start != -1) {
6083                         i = rx->offs[0].start;
6084                         if (i > 0) {
6085                                 s1 = 0;
6086                                 t1 = i;
6087                                 goto getlen;
6088                         }
6089             }
6090         return 0;
6091       /* $' / ${^POSTMATCH} */
6092       case RX_BUFF_IDX_POSTMATCH:
6093             if (rx->offs[0].end != -1) {
6094                         i = rx->sublen - rx->offs[0].end;
6095                         if (i > 0) {
6096                                 s1 = rx->offs[0].end;
6097                                 t1 = rx->sublen;
6098                                 goto getlen;
6099                         }
6100             }
6101         return 0;
6102       /* $& / ${^MATCH}, $1, $2, ... */
6103       default:
6104             if (paren <= (I32)rx->nparens &&
6105             (s1 = rx->offs[paren].start) != -1 &&
6106             (t1 = rx->offs[paren].end) != -1)
6107             {
6108             i = t1 - s1;
6109             goto getlen;
6110         } else {
6111             if (ckWARN(WARN_UNINITIALIZED))
6112                 report_uninit((const SV *)sv);
6113             return 0;
6114         }
6115     }
6116   getlen:
6117     if (i > 0 && RXp_MATCH_UTF8(rx)) {
6118         const char * const s = rx->subbeg + s1;
6119         const U8 *ep;
6120         STRLEN el;
6121
6122         i = t1 - s1;
6123         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6124                         i = el;
6125     }
6126     return i;
6127 }
6128
6129 SV*
6130 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6131 {
6132     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6133         PERL_UNUSED_ARG(rx);
6134         if (0)
6135             return NULL;
6136         else
6137             return newSVpvs("Regexp");
6138 }
6139
6140 /* Scans the name of a named buffer from the pattern.
6141  * If flags is REG_RSN_RETURN_NULL returns null.
6142  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6143  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6144  * to the parsed name as looked up in the RExC_paren_names hash.
6145  * If there is an error throws a vFAIL().. type exception.
6146  */
6147
6148 #define REG_RSN_RETURN_NULL    0
6149 #define REG_RSN_RETURN_NAME    1
6150 #define REG_RSN_RETURN_DATA    2
6151
6152 STATIC SV*
6153 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6154 {
6155     char *name_start = RExC_parse;
6156
6157     PERL_ARGS_ASSERT_REG_SCAN_NAME;
6158
6159     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6160          /* skip IDFIRST by using do...while */
6161         if (UTF)
6162             do {
6163                 RExC_parse += UTF8SKIP(RExC_parse);
6164             } while (isALNUM_utf8((U8*)RExC_parse));
6165         else
6166             do {
6167                 RExC_parse++;
6168             } while (isALNUM(*RExC_parse));
6169     }
6170
6171     if ( flags ) {
6172         SV* sv_name
6173             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6174                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6175         if ( flags == REG_RSN_RETURN_NAME)
6176             return sv_name;
6177         else if (flags==REG_RSN_RETURN_DATA) {
6178             HE *he_str = NULL;
6179             SV *sv_dat = NULL;
6180             if ( ! sv_name )      /* should not happen*/
6181                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6182             if (RExC_paren_names)
6183                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6184             if ( he_str )
6185                 sv_dat = HeVAL(he_str);
6186             if ( ! sv_dat )
6187                 vFAIL("Reference to nonexistent named group");
6188             return sv_dat;
6189         }
6190         else {
6191             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6192                        (unsigned long) flags);
6193         }
6194         /* NOT REACHED */
6195     }
6196     return NULL;
6197 }
6198
6199 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
6200     int rem=(int)(RExC_end - RExC_parse);                       \
6201     int cut;                                                    \
6202     int num;                                                    \
6203     int iscut=0;                                                \
6204     if (rem>10) {                                               \
6205         rem=10;                                                 \
6206         iscut=1;                                                \
6207     }                                                           \
6208     cut=10-rem;                                                 \
6209     if (RExC_lastparse!=RExC_parse)                             \
6210         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
6211             rem, RExC_parse,                                    \
6212             cut + 4,                                            \
6213             iscut ? "..." : "<"                                 \
6214         );                                                      \
6215     else                                                        \
6216         PerlIO_printf(Perl_debug_log,"%16s","");                \
6217                                                                 \
6218     if (SIZE_ONLY)                                              \
6219        num = RExC_size + 1;                                     \
6220     else                                                        \
6221        num=REG_NODE_NUM(RExC_emit);                             \
6222     if (RExC_lastnum!=num)                                      \
6223        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
6224     else                                                        \
6225        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
6226     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
6227         (int)((depth*2)), "",                                   \
6228         (funcname)                                              \
6229     );                                                          \
6230     RExC_lastnum=num;                                           \
6231     RExC_lastparse=RExC_parse;                                  \
6232 })
6233
6234
6235
6236 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
6237     DEBUG_PARSE_MSG((funcname));                            \
6238     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
6239 })
6240 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
6241     DEBUG_PARSE_MSG((funcname));                            \
6242     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
6243 })
6244
6245 /* This section of code defines the inversion list object and its methods.  The
6246  * interfaces are highly subject to change, so as much as possible is static to
6247  * this file.  An inversion list is here implemented as a malloc'd C UV array
6248  * with some added info that is placed as UVs at the beginning in a header
6249  * portion.  An inversion list for Unicode is an array of code points, sorted
6250  * by ordinal number.  The zeroth element is the first code point in the list.
6251  * The 1th element is the first element beyond that not in the list.  In other
6252  * words, the first range is
6253  *  invlist[0]..(invlist[1]-1)
6254  * The other ranges follow.  Thus every element whose index is divisible by two
6255  * marks the beginning of a range that is in the list, and every element not
6256  * divisible by two marks the beginning of a range not in the list.  A single
6257  * element inversion list that contains the single code point N generally
6258  * consists of two elements
6259  *  invlist[0] == N
6260  *  invlist[1] == N+1
6261  * (The exception is when N is the highest representable value on the
6262  * machine, in which case the list containing just it would be a single
6263  * element, itself.  By extension, if the last range in the list extends to
6264  * infinity, then the first element of that range will be in the inversion list
6265  * at a position that is divisible by two, and is the final element in the
6266  * list.)
6267  * Taking the complement (inverting) an inversion list is quite simple, if the
6268  * first element is 0, remove it; otherwise add a 0 element at the beginning.
6269  * This implementation reserves an element at the beginning of each inversion list
6270  * to contain 0 when the list contains 0, and contains 1 otherwise.  The actual
6271  * beginning of the list is either that element if 0, or the next one if 1.
6272  *
6273  * More about inversion lists can be found in "Unicode Demystified"
6274  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
6275  * More will be coming when functionality is added later.
6276  *
6277  * The inversion list data structure is currently implemented as an SV pointing
6278  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
6279  * array of UV whose memory management is automatically handled by the existing
6280  * facilities for SV's.
6281  *
6282  * Some of the methods should always be private to the implementation, and some
6283  * should eventually be made public */
6284
6285 #define INVLIST_LEN_OFFSET 0    /* Number of elements in the inversion list */
6286 #define INVLIST_ITER_OFFSET 1   /* Current iteration position */
6287
6288 /* This is a combination of a version and data structure type, so that one
6289  * being passed in can be validated to be an inversion list of the correct
6290  * vintage.  When the structure of the header is changed, a new random number
6291  * in the range 2**31-1 should be generated and the new() method changed to
6292  * insert that at this location.  Then, if an auxiliary program doesn't change
6293  * correspondingly, it will be discovered immediately */
6294 #define INVLIST_VERSION_ID_OFFSET 2
6295 #define INVLIST_VERSION_ID 1064334010
6296
6297 /* For safety, when adding new elements, remember to #undef them at the end of
6298  * the inversion list code section */
6299
6300 #define INVLIST_ZERO_OFFSET 3   /* 0 or 1; must be last element in header */
6301 /* The UV at position ZERO contains either 0 or 1.  If 0, the inversion list
6302  * contains the code point U+00000, and begins here.  If 1, the inversion list
6303  * doesn't contain U+0000, and it begins at the next UV in the array.
6304  * Inverting an inversion list consists of adding or removing the 0 at the
6305  * beginning of it.  By reserving a space for that 0, inversion can be made
6306  * very fast */
6307
6308 #define HEADER_LENGTH (INVLIST_ZERO_OFFSET + 1)
6309
6310 /* Internally things are UVs */
6311 #define TO_INTERNAL_SIZE(x) ((x + HEADER_LENGTH) * sizeof(UV))
6312 #define FROM_INTERNAL_SIZE(x) ((x / sizeof(UV)) - HEADER_LENGTH)
6313
6314 #define INVLIST_INITIAL_LEN 10
6315
6316 PERL_STATIC_INLINE UV*
6317 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
6318 {
6319     /* Returns a pointer to the first element in the inversion list's array.
6320      * This is called upon initialization of an inversion list.  Where the
6321      * array begins depends on whether the list has the code point U+0000
6322      * in it or not.  The other parameter tells it whether the code that
6323      * follows this call is about to put a 0 in the inversion list or not.
6324      * The first element is either the element with 0, if 0, or the next one,
6325      * if 1 */
6326
6327     UV* zero = get_invlist_zero_addr(invlist);
6328
6329     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
6330
6331     /* Must be empty */
6332     assert(! *get_invlist_len_addr(invlist));
6333
6334     /* 1^1 = 0; 1^0 = 1 */
6335     *zero = 1 ^ will_have_0;
6336     return zero + *zero;
6337 }
6338
6339 PERL_STATIC_INLINE UV*
6340 S_invlist_array(pTHX_ SV* const invlist)
6341 {
6342     /* Returns the pointer to the inversion list's array.  Every time the
6343      * length changes, this needs to be called in case malloc or realloc moved
6344      * it */
6345
6346     PERL_ARGS_ASSERT_INVLIST_ARRAY;
6347
6348     /* Must not be empty.  If these fail, you probably didn't check for <len>
6349      * being non-zero before trying to get the array */
6350     assert(*get_invlist_len_addr(invlist));
6351     assert(*get_invlist_zero_addr(invlist) == 0
6352            || *get_invlist_zero_addr(invlist) == 1);
6353
6354     /* The array begins either at the element reserved for zero if the
6355      * list contains 0 (that element will be set to 0), or otherwise the next
6356      * element (in which case the reserved element will be set to 1). */
6357     return (UV *) (get_invlist_zero_addr(invlist)
6358                    + *get_invlist_zero_addr(invlist));
6359 }
6360
6361 PERL_STATIC_INLINE UV*
6362 S_get_invlist_len_addr(pTHX_ SV* invlist)
6363 {
6364     /* Return the address of the UV that contains the current number
6365      * of used elements in the inversion list */
6366
6367     PERL_ARGS_ASSERT_GET_INVLIST_LEN_ADDR;
6368
6369     return (UV *) (SvPVX(invlist) + (INVLIST_LEN_OFFSET * sizeof (UV)));
6370 }
6371
6372 PERL_STATIC_INLINE UV
6373 S_invlist_len(pTHX_ SV* const invlist)
6374 {
6375     /* Returns the current number of elements stored in the inversion list's
6376      * array */
6377
6378     PERL_ARGS_ASSERT_INVLIST_LEN;
6379
6380     return *get_invlist_len_addr(invlist);
6381 }
6382
6383 PERL_STATIC_INLINE void
6384 S_invlist_set_len(pTHX_ SV* const invlist, const UV len)
6385 {
6386     /* Sets the current number of elements stored in the inversion list */
6387
6388     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
6389
6390     *get_invlist_len_addr(invlist) = len;
6391
6392     assert(len <= SvLEN(invlist));
6393
6394     SvCUR_set(invlist, TO_INTERNAL_SIZE(len));
6395     /* If the list contains U+0000, that element is part of the header,
6396      * and should not be counted as part of the array.  It will contain
6397      * 0 in that case, and 1 otherwise.  So we could flop 0=>1, 1=>0 and
6398      * subtract:
6399      *  SvCUR_set(invlist,
6400      *            TO_INTERNAL_SIZE(len
6401      *                             - (*get_invlist_zero_addr(inv_list) ^ 1)));
6402      * But, this is only valid if len is not 0.  The consequences of not doing
6403      * this is that the memory allocation code may think that 1 more UV is
6404      * being used than actually is, and so might do an unnecessary grow.  That
6405      * seems worth not bothering to make this the precise amount.
6406      *
6407      * Note that when inverting, SvCUR shouldn't change */
6408 }
6409
6410 PERL_STATIC_INLINE UV
6411 S_invlist_max(pTHX_ SV* const invlist)
6412 {
6413     /* Returns the maximum number of elements storable in the inversion list's
6414      * array, without having to realloc() */
6415
6416     PERL_ARGS_ASSERT_INVLIST_MAX;
6417
6418     return FROM_INTERNAL_SIZE(SvLEN(invlist));
6419 }
6420
6421 PERL_STATIC_INLINE UV*
6422 S_get_invlist_zero_addr(pTHX_ SV* invlist)
6423 {
6424     /* Return the address of the UV that is reserved to hold 0 if the inversion
6425      * list contains 0.  This has to be the last element of the heading, as the
6426      * list proper starts with either it if 0, or the next element if not.
6427      * (But we force it to contain either 0 or 1) */
6428
6429     PERL_ARGS_ASSERT_GET_INVLIST_ZERO_ADDR;
6430
6431     return (UV *) (SvPVX(invlist) + (INVLIST_ZERO_OFFSET * sizeof (UV)));
6432 }
6433
6434 #ifndef PERL_IN_XSUB_RE
6435 SV*
6436 Perl__new_invlist(pTHX_ IV initial_size)
6437 {
6438
6439     /* Return a pointer to a newly constructed inversion list, with enough
6440      * space to store 'initial_size' elements.  If that number is negative, a
6441      * system default is used instead */
6442
6443     SV* new_list;
6444
6445     if (initial_size < 0) {
6446         initial_size = INVLIST_INITIAL_LEN;
6447     }
6448
6449     /* Allocate the initial space */
6450     new_list = newSV(TO_INTERNAL_SIZE(initial_size));
6451     invlist_set_len(new_list, 0);
6452
6453     /* Force iterinit() to be used to get iteration to work */
6454     *get_invlist_iter_addr(new_list) = UV_MAX;
6455
6456     /* This should force a segfault if a method doesn't initialize this
6457      * properly */
6458     *get_invlist_zero_addr(new_list) = UV_MAX;
6459
6460     *get_invlist_version_id_addr(new_list) = INVLIST_VERSION_ID;
6461 #if HEADER_LENGTH != 4
6462 #   error Need to regenerate VERSION_ID by running perl -E 'say int(rand 2**31-1)', and then changing the #if to the new length
6463 #endif
6464
6465     return new_list;
6466 }
6467 #endif
6468
6469 STATIC SV*
6470 S__new_invlist_C_array(pTHX_ UV* list)
6471 {
6472     /* Return a pointer to a newly constructed inversion list, initialized to
6473      * point to <list>, which has to be in the exact correct inversion list
6474      * form, including internal fields.  Thus this is a dangerous routine that
6475      * should not be used in the wrong hands */
6476
6477     SV* invlist = newSV_type(SVt_PV);
6478
6479     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
6480
6481     SvPV_set(invlist, (char *) list);
6482     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
6483                                shouldn't touch it */
6484     SvCUR_set(invlist, TO_INTERNAL_SIZE(invlist_len(invlist)));
6485
6486     if (*get_invlist_version_id_addr(invlist) != INVLIST_VERSION_ID) {
6487         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
6488     }
6489
6490     return invlist;
6491 }
6492
6493 STATIC void
6494 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
6495 {
6496     /* Grow the maximum size of an inversion list */
6497
6498     PERL_ARGS_ASSERT_INVLIST_EXTEND;
6499
6500     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max));
6501 }
6502
6503 PERL_STATIC_INLINE void
6504 S_invlist_trim(pTHX_ SV* const invlist)
6505 {
6506     PERL_ARGS_ASSERT_INVLIST_TRIM;
6507
6508     /* Change the length of the inversion list to how many entries it currently
6509      * has */
6510
6511     SvPV_shrink_to_cur((SV *) invlist);
6512 }
6513
6514 /* An element is in an inversion list iff its index is even numbered: 0, 2, 4,
6515  * etc */
6516 #define ELEMENT_RANGE_MATCHES_INVLIST(i) (! ((i) & 1))
6517 #define PREV_RANGE_MATCHES_INVLIST(i) (! ELEMENT_RANGE_MATCHES_INVLIST(i))
6518
6519 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
6520
6521 #ifndef PERL_IN_XSUB_RE
6522 void
6523 Perl__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
6524 {
6525    /* Subject to change or removal.  Append the range from 'start' to 'end' at
6526     * the end of the inversion list.  The range must be above any existing
6527     * ones. */
6528
6529     UV* array;
6530     UV max = invlist_max(invlist);
6531     UV len = invlist_len(invlist);
6532
6533     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
6534
6535     if (len == 0) { /* Empty lists must be initialized */
6536         array = _invlist_array_init(invlist, start == 0);
6537     }
6538     else {
6539         /* Here, the existing list is non-empty. The current max entry in the
6540          * list is generally the first value not in the set, except when the
6541          * set extends to the end of permissible values, in which case it is
6542          * the first entry in that final set, and so this call is an attempt to
6543          * append out-of-order */
6544
6545         UV final_element = len - 1;
6546         array = invlist_array(invlist);
6547         if (array[final_element] > start
6548             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
6549         {
6550             Perl_croak(aTHX_ "panic: attempting to append to an inversion list, but wasn't at the end of the list, final=%"UVuf", start=%"UVuf", match=%c",
6551                        array[final_element], start,
6552                        ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
6553         }
6554
6555         /* Here, it is a legal append.  If the new range begins with the first
6556          * value not in the set, it is extending the set, so the new first
6557          * value not in the set is one greater than the newly extended range.
6558          * */
6559         if (array[final_element] == start) {
6560             if (end != UV_MAX) {
6561                 array[final_element] = end + 1;
6562             }
6563             else {
6564                 /* But if the end is the maximum representable on the machine,
6565                  * just let the range that this would extend to have no end */
6566                 invlist_set_len(invlist, len - 1);
6567             }
6568             return;
6569         }
6570     }
6571
6572     /* Here the new range doesn't extend any existing set.  Add it */
6573
6574     len += 2;   /* Includes an element each for the start and end of range */
6575
6576     /* If overflows the existing space, extend, which may cause the array to be
6577      * moved */
6578     if (max < len) {
6579         invlist_extend(invlist, len);
6580         invlist_set_len(invlist, len);  /* Have to set len here to avoid assert
6581                                            failure in invlist_array() */
6582         array = invlist_array(invlist);
6583     }
6584     else {
6585         invlist_set_len(invlist, len);
6586     }
6587
6588     /* The next item on the list starts the range, the one after that is
6589      * one past the new range.  */
6590     array[len - 2] = start;
6591     if (end != UV_MAX) {
6592         array[len - 1] = end + 1;
6593     }
6594     else {
6595         /* But if the end is the maximum representable on the machine, just let
6596          * the range have no end */
6597         invlist_set_len(invlist, len - 1);
6598     }
6599 }
6600
6601 STATIC IV
6602 S_invlist_search(pTHX_ SV* const invlist, const UV cp)
6603 {
6604     /* Searches the inversion list for the entry that contains the input code
6605      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
6606      * return value is the index into the list's array of the range that
6607      * contains <cp> */
6608
6609     IV low = 0;
6610     IV high = invlist_len(invlist);
6611     const UV * const array = invlist_array(invlist);
6612
6613     PERL_ARGS_ASSERT_INVLIST_SEARCH;
6614
6615     /* If list is empty or the code point is before the first element, return
6616      * failure. */
6617     if (high == 0 || cp < array[0]) {
6618         return -1;
6619     }
6620
6621     /* Binary search.  What we are looking for is <i> such that
6622      *  array[i] <= cp < array[i+1]
6623      * The loop below converges on the i+1. */
6624     while (low < high) {
6625         IV mid = (low + high) / 2;
6626         if (array[mid] <= cp) {
6627             low = mid + 1;
6628
6629             /* We could do this extra test to exit the loop early.
6630             if (cp < array[low]) {
6631                 return mid;
6632             }
6633             */
6634         }
6635         else { /* cp < array[mid] */
6636             high = mid;
6637         }
6638     }
6639
6640     return high - 1;
6641 }
6642
6643 void
6644 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
6645 {
6646     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
6647      * but is used when the swash has an inversion list.  This makes this much
6648      * faster, as it uses a binary search instead of a linear one.  This is
6649      * intimately tied to that function, and perhaps should be in utf8.c,
6650      * except it is intimately tied to inversion lists as well.  It assumes
6651      * that <swatch> is all 0's on input */
6652
6653     UV current = start;
6654     const IV len = invlist_len(invlist);
6655     IV i;
6656     const UV * array;
6657
6658     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
6659
6660     if (len == 0) { /* Empty inversion list */
6661         return;
6662     }
6663
6664     array = invlist_array(invlist);
6665
6666     /* Find which element it is */
6667     i = invlist_search(invlist, start);
6668
6669     /* We populate from <start> to <end> */
6670     while (current < end) {
6671         UV upper;
6672
6673         /* The inversion list gives the results for every possible code point
6674          * after the first one in the list.  Only those ranges whose index is
6675          * even are ones that the inversion list matches.  For the odd ones,
6676          * and if the initial code point is not in the list, we have to skip
6677          * forward to the next element */
6678         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
6679             i++;
6680             if (i >= len) { /* Finished if beyond the end of the array */
6681                 return;
6682             }
6683             current = array[i];
6684             if (current >= end) {   /* Finished if beyond the end of what we
6685                                        are populating */
6686                 return;
6687             }
6688         }
6689         assert(current >= start);
6690
6691         /* The current range ends one below the next one, except don't go past
6692          * <end> */
6693         i++;
6694         upper = (i < len && array[i] < end) ? array[i] : end;
6695
6696         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
6697          * for each code point in it */
6698         for (; current < upper; current++) {
6699             const STRLEN offset = (STRLEN)(current - start);
6700             swatch[offset >> 3] |= 1 << (offset & 7);
6701         }
6702
6703         /* Quit if at the end of the list */
6704         if (i >= len) {
6705
6706             /* But first, have to deal with the highest possible code point on
6707              * the platform.  The previous code assumes that <end> is one
6708              * beyond where we want to populate, but that is impossible at the
6709              * platform's infinity, so have to handle it specially */
6710             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
6711             {
6712                 const STRLEN offset = (STRLEN)(end - start);
6713                 swatch[offset >> 3] |= 1 << (offset & 7);
6714             }
6715             return;
6716         }
6717
6718         /* Advance to the next range, which will be for code points not in the
6719          * inversion list */
6720         current = array[i];
6721     }
6722
6723     return;
6724 }
6725
6726
6727 void
6728 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** output)
6729 {
6730     /* Take the union of two inversion lists and point <output> to it.  *output
6731      * should be defined upon input, and if it points to one of the two lists,
6732      * the reference count to that list will be decremented.  The first list,
6733      * <a>, may be NULL, in which case a copy of the second list is returned.
6734      * If <complement_b> is TRUE, the union is taken of the complement
6735      * (inversion) of <b> instead of b itself.
6736      *
6737      * The basis for this comes from "Unicode Demystified" Chapter 13 by
6738      * Richard Gillam, published by Addison-Wesley, and explained at some
6739      * length there.  The preface says to incorporate its examples into your
6740      * code at your own risk.
6741      *
6742      * The algorithm is like a merge sort.
6743      *
6744      * XXX A potential performance improvement is to keep track as we go along
6745      * if only one of the inputs contributes to the result, meaning the other
6746      * is a subset of that one.  In that case, we can skip the final copy and
6747      * return the larger of the input lists, but then outside code might need
6748      * to keep track of whether to free the input list or not */
6749
6750     UV* array_a;    /* a's array */
6751     UV* array_b;
6752     UV len_a;       /* length of a's array */
6753     UV len_b;
6754
6755     SV* u;                      /* the resulting union */
6756     UV* array_u;
6757     UV len_u;
6758
6759     UV i_a = 0;             /* current index into a's array */
6760     UV i_b = 0;
6761     UV i_u = 0;
6762
6763     /* running count, as explained in the algorithm source book; items are
6764      * stopped accumulating and are output when the count changes to/from 0.
6765      * The count is incremented when we start a range that's in the set, and
6766      * decremented when we start a range that's not in the set.  So its range
6767      * is 0 to 2.  Only when the count is zero is something not in the set.
6768      */
6769     UV count = 0;
6770
6771     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
6772     assert(a != b);
6773
6774     /* If either one is empty, the union is the other one */
6775     if (a == NULL || ((len_a = invlist_len(a)) == 0)) {
6776         if (*output == a) {
6777             if (a != NULL) {
6778                 SvREFCNT_dec(a);
6779             }
6780         }
6781         if (*output != b) {
6782             *output = invlist_clone(b);
6783             if (complement_b) {
6784                 _invlist_invert(*output);
6785             }
6786         } /* else *output already = b; */
6787         return;
6788     }
6789     else if ((len_b = invlist_len(b)) == 0) {
6790         if (*output == b) {
6791             SvREFCNT_dec(b);
6792         }
6793
6794         /* The complement of an empty list is a list that has everything in it,
6795          * so the union with <a> includes everything too */
6796         if (complement_b) {
6797             if (a == *output) {
6798                 SvREFCNT_dec(a);
6799             }
6800             *output = _new_invlist(1);
6801             _append_range_to_invlist(*output, 0, UV_MAX);
6802         }
6803         else if (*output != a) {
6804             *output = invlist_clone(a);
6805         }
6806         /* else *output already = a; */
6807         return;
6808     }
6809
6810     /* Here both lists exist and are non-empty */
6811     array_a = invlist_array(a);
6812     array_b = invlist_array(b);
6813
6814     /* If are to take the union of 'a' with the complement of b, set it
6815      * up so are looking at b's complement. */
6816     if (complement_b) {
6817
6818         /* To complement, we invert: if the first element is 0, remove it.  To
6819          * do this, we just pretend the array starts one later, and clear the
6820          * flag as we don't have to do anything else later */
6821         if (array_b[0] == 0) {
6822             array_b++;
6823             len_b--;
6824             complement_b = FALSE;
6825         }
6826         else {
6827
6828             /* But if the first element is not zero, we unshift a 0 before the
6829              * array.  The data structure reserves a space for that 0 (which
6830              * should be a '1' right now), so physical shifting is unneeded,
6831              * but temporarily change that element to 0.  Before exiting the
6832              * routine, we must restore the element to '1' */
6833             array_b--;
6834             len_b++;
6835             array_b[0] = 0;
6836         }
6837     }
6838
6839     /* Size the union for the worst case: that the sets are completely
6840      * disjoint */
6841     u = _new_invlist(len_a + len_b);
6842
6843     /* Will contain U+0000 if either component does */
6844     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
6845                                       || (len_b > 0 && array_b[0] == 0));
6846
6847     /* Go through each list item by item, stopping when exhausted one of
6848      * them */
6849     while (i_a < len_a && i_b < len_b) {
6850         UV cp;      /* The element to potentially add to the union's array */
6851         bool cp_in_set;   /* is it in the the input list's set or not */
6852
6853         /* We need to take one or the other of the two inputs for the union.
6854          * Since we are merging two sorted lists, we take the smaller of the
6855          * next items.  In case of a tie, we take the one that is in its set
6856          * first.  If we took one not in the set first, it would decrement the
6857          * count, possibly to 0 which would cause it to be output as ending the
6858          * range, and the next time through we would take the same number, and
6859          * output it again as beginning the next range.  By doing it the
6860          * opposite way, there is no possibility that the count will be
6861          * momentarily decremented to 0, and thus the two adjoining ranges will
6862          * be seamlessly merged.  (In a tie and both are in the set or both not
6863          * in the set, it doesn't matter which we take first.) */
6864         if (array_a[i_a] < array_b[i_b]
6865             || (array_a[i_a] == array_b[i_b]
6866                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
6867         {
6868             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
6869             cp= array_a[i_a++];
6870         }
6871         else {
6872             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
6873             cp= array_b[i_b++];
6874         }
6875
6876         /* Here, have chosen which of the two inputs to look at.  Only output
6877          * if the running count changes to/from 0, which marks the
6878          * beginning/end of a range in that's in the set */
6879         if (cp_in_set) {
6880             if (count == 0) {
6881                 array_u[i_u++] = cp;
6882             }
6883             count++;
6884         }
6885         else {
6886             count--;
6887             if (count == 0) {
6888                 array_u[i_u++] = cp;
6889             }
6890         }
6891     }
6892
6893     /* Here, we are finished going through at least one of the lists, which
6894      * means there is something remaining in at most one.  We check if the list
6895      * that hasn't been exhausted is positioned such that we are in the middle
6896      * of a range in its set or not.  (i_a and i_b point to the element beyond
6897      * the one we care about.) If in the set, we decrement 'count'; if 0, there
6898      * is potentially more to output.
6899      * There are four cases:
6900      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
6901      *     in the union is entirely from the non-exhausted set.
6902      *  2) Both were in their sets, count is 2.  Nothing further should
6903      *     be output, as everything that remains will be in the exhausted
6904      *     list's set, hence in the union; decrementing to 1 but not 0 insures
6905      *     that
6906      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
6907      *     Nothing further should be output because the union includes
6908      *     everything from the exhausted set.  Not decrementing ensures that.
6909      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
6910      *     decrementing to 0 insures that we look at the remainder of the
6911      *     non-exhausted set */
6912     if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
6913         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
6914     {
6915         count--;
6916     }
6917
6918     /* The final length is what we've output so far, plus what else is about to
6919      * be output.  (If 'count' is non-zero, then the input list we exhausted
6920      * has everything remaining up to the machine's limit in its set, and hence
6921      * in the union, so there will be no further output. */
6922     len_u = i_u;
6923     if (count == 0) {
6924         /* At most one of the subexpressions will be non-zero */
6925         len_u += (len_a - i_a) + (len_b - i_b);
6926     }
6927
6928     /* Set result to final length, which can change the pointer to array_u, so
6929      * re-find it */
6930     if (len_u != invlist_len(u)) {
6931         invlist_set_len(u, len_u);
6932         invlist_trim(u);
6933         array_u = invlist_array(u);
6934     }
6935
6936     /* When 'count' is 0, the list that was exhausted (if one was shorter than
6937      * the other) ended with everything above it not in its set.  That means
6938      * that the remaining part of the union is precisely the same as the
6939      * non-exhausted list, so can just copy it unchanged.  (If both list were
6940      * exhausted at the same time, then the operations below will be both 0.)
6941      */
6942     if (count == 0) {
6943         IV copy_count; /* At most one will have a non-zero copy count */
6944         if ((copy_count = len_a - i_a) > 0) {
6945             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
6946         }
6947         else if ((copy_count = len_b - i_b) > 0) {
6948             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
6949         }
6950     }
6951
6952     /*  We may be removing a reference to one of the inputs */
6953     if (a == *output || b == *output) {
6954         SvREFCNT_dec(*output);
6955     }
6956
6957     /* If we've changed b, restore it */
6958     if (complement_b) {
6959         array_b[0] = 1;
6960     }
6961
6962     *output = u;
6963     return;
6964 }
6965
6966 void
6967 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** i)
6968 {
6969     /* Take the intersection of two inversion lists and point <i> to it.  *i
6970      * should be defined upon input, and if it points to one of the two lists,
6971      * the reference count to that list will be decremented.
6972      * If <complement_b> is TRUE, the result will be the intersection of <a>
6973      * and the complement (or inversion) of <b> instead of <b> directly.
6974      *
6975      * The basis for this comes from "Unicode Demystified" Chapter 13 by
6976      * Richard Gillam, published by Addison-Wesley, and explained at some
6977      * length there.  The preface says to incorporate its examples into your
6978      * code at your own risk.  In fact, it had bugs
6979      *
6980      * The algorithm is like a merge sort, and is essentially the same as the
6981      * union above
6982      */
6983
6984     UV* array_a;                /* a's array */
6985     UV* array_b;
6986     UV len_a;   /* length of a's array */
6987     UV len_b;
6988
6989     SV* r;                   /* the resulting intersection */
6990     UV* array_r;
6991     UV len_r;
6992
6993     UV i_a = 0;             /* current index into a's array */
6994     UV i_b = 0;
6995     UV i_r = 0;
6996
6997     /* running count, as explained in the algorithm source book; items are
6998      * stopped accumulating and are output when the count changes to/from 2.
6999      * The count is incremented when we start a range that's in the set, and
7000      * decremented when we start a range that's not in the set.  So its range
7001      * is 0 to 2.  Only when the count is 2 is something in the intersection.
7002      */
7003     UV count = 0;
7004
7005     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7006     assert(a != b);
7007
7008     /* Special case if either one is empty */
7009     len_a = invlist_len(a);
7010     if ((len_a == 0) || ((len_b = invlist_len(b)) == 0)) {
7011
7012         if (len_a != 0 && complement_b) {
7013
7014             /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7015              * be empty.  Here, also we are using 'b's complement, which hence
7016              * must be every possible code point.  Thus the intersection is
7017              * simply 'a'. */
7018             if (*i != a) {
7019                 *i = invlist_clone(a);
7020
7021                 if (*i == b) {
7022                     SvREFCNT_dec(b);
7023                 }
7024             }
7025             /* else *i is already 'a' */
7026             return;
7027         }
7028
7029         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
7030          * intersection must be empty */
7031         if (*i == a) {
7032             SvREFCNT_dec(a);
7033         }
7034         else if (*i == b) {
7035             SvREFCNT_dec(b);
7036         }
7037         *i = _new_invlist(0);
7038         return;
7039     }
7040
7041     /* Here both lists exist and are non-empty */
7042     array_a = invlist_array(a);
7043     array_b = invlist_array(b);
7044
7045     /* If are to take the intersection of 'a' with the complement of b, set it
7046      * up so are looking at b's complement. */
7047     if (complement_b) {
7048
7049         /* To complement, we invert: if the first element is 0, remove it.  To
7050          * do this, we just pretend the array starts one later, and clear the
7051          * flag as we don't have to do anything else later */
7052         if (array_b[0] == 0) {
7053             array_b++;
7054             len_b--;
7055             complement_b = FALSE;
7056         }
7057         else {
7058
7059             /* But if the first element is not zero, we unshift a 0 before the
7060              * array.  The data structure reserves a space for that 0 (which
7061              * should be a '1' right now), so physical shifting is unneeded,
7062              * but temporarily change that element to 0.  Before exiting the
7063              * routine, we must restore the element to '1' */
7064             array_b--;
7065             len_b++;
7066             array_b[0] = 0;
7067         }
7068     }
7069
7070     /* Size the intersection for the worst case: that the intersection ends up
7071      * fragmenting everything to be completely disjoint */
7072     r= _new_invlist(len_a + len_b);
7073
7074     /* Will contain U+0000 iff both components do */
7075     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7076                                      && len_b > 0 && array_b[0] == 0);
7077
7078     /* Go through each list item by item, stopping when exhausted one of
7079      * them */
7080     while (i_a < len_a && i_b < len_b) {
7081         UV cp;      /* The element to potentially add to the intersection's
7082                        array */
7083         bool cp_in_set; /* Is it in the input list's set or not */
7084
7085         /* We need to take one or the other of the two inputs for the
7086          * intersection.  Since we are merging two sorted lists, we take the
7087          * smaller of the next items.  In case of a tie, we take the one that
7088          * is not in its set first (a difference from the union algorithm).  If
7089          * we took one in the set first, it would increment the count, possibly
7090          * to 2 which would cause it to be output as starting a range in the
7091          * intersection, and the next time through we would take that same
7092          * number, and output it again as ending the set.  By doing it the
7093          * opposite of this, there is no possibility that the count will be
7094          * momentarily incremented to 2.  (In a tie and both are in the set or
7095          * both not in the set, it doesn't matter which we take first.) */
7096         if (array_a[i_a] < array_b[i_b]
7097             || (array_a[i_a] == array_b[i_b]
7098                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7099         {
7100             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7101             cp= array_a[i_a++];
7102         }
7103         else {
7104             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7105             cp= array_b[i_b++];
7106         }
7107
7108         /* Here, have chosen which of the two inputs to look at.  Only output
7109          * if the running count changes to/from 2, which marks the
7110          * beginning/end of a range that's in the intersection */
7111         if (cp_in_set) {
7112             count++;
7113             if (count == 2) {
7114                 array_r[i_r++] = cp;
7115             }
7116         }
7117         else {
7118             if (count == 2) {
7119                 array_r[i_r++] = cp;
7120             }
7121             count--;
7122         }
7123     }
7124
7125     /* Here, we are finished going through at least one of the lists, which
7126      * means there is something remaining in at most one.  We check if the list
7127      * that has been exhausted is positioned such that we are in the middle
7128      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
7129      * the ones we care about.)  There are four cases:
7130      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
7131      *     nothing left in the intersection.
7132      *  2) Both were in their sets, count is 2 and perhaps is incremented to
7133      *     above 2.  What should be output is exactly that which is in the
7134      *     non-exhausted set, as everything it has is also in the intersection
7135      *     set, and everything it doesn't have can't be in the intersection
7136      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7137      *     gets incremented to 2.  Like the previous case, the intersection is
7138      *     everything that remains in the non-exhausted set.
7139      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7140      *     remains 1.  And the intersection has nothing more. */
7141     if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7142         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7143     {
7144         count++;
7145     }
7146
7147     /* The final length is what we've output so far plus what else is in the
7148      * intersection.  At most one of the subexpressions below will be non-zero */
7149     len_r = i_r;
7150     if (count >= 2) {
7151         len_r += (len_a - i_a) + (len_b - i_b);
7152     }
7153
7154     /* Set result to final length, which can change the pointer to array_r, so
7155      * re-find it */
7156     if (len_r != invlist_len(r)) {
7157         invlist_set_len(r, len_r);
7158         invlist_trim(r);
7159         array_r = invlist_array(r);
7160     }
7161
7162     /* Finish outputting any remaining */
7163     if (count >= 2) { /* At most one will have a non-zero copy count */
7164         IV copy_count;
7165         if ((copy_count = len_a - i_a) > 0) {
7166             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7167         }
7168         else if ((copy_count = len_b - i_b) > 0) {
7169             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7170         }
7171     }
7172
7173     /*  We may be removing a reference to one of the inputs */
7174     if (a == *i || b == *i) {
7175         SvREFCNT_dec(*i);
7176     }
7177
7178     /* If we've changed b, restore it */
7179     if (complement_b) {
7180         array_b[0] = 1;
7181     }
7182
7183     *i = r;
7184     return;
7185 }
7186
7187 #endif
7188
7189 STATIC SV*
7190 S_add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
7191 {
7192     /* Add the range from 'start' to 'end' inclusive to the inversion list's
7193      * set.  A pointer to the inversion list is returned.  This may actually be
7194      * a new list, in which case the passed in one has been destroyed.  The
7195      * passed in inversion list can be NULL, in which case a new one is created
7196      * with just the one range in it */
7197
7198     SV* range_invlist;
7199     UV len;
7200
7201     if (invlist == NULL) {
7202         invlist = _new_invlist(2);
7203         len = 0;
7204     }
7205     else {
7206         len = invlist_len(invlist);
7207     }
7208
7209     /* If comes after the final entry, can just append it to the end */
7210     if (len == 0
7211         || start >= invlist_array(invlist)
7212                                     [invlist_len(invlist) - 1])
7213     {
7214         _append_range_to_invlist(invlist, start, end);
7215         return invlist;
7216     }
7217
7218     /* Here, can't just append things, create and return a new inversion list
7219      * which is the union of this range and the existing inversion list */
7220     range_invlist = _new_invlist(2);
7221     _append_range_to_invlist(range_invlist, start, end);
7222
7223     _invlist_union(invlist, range_invlist, &invlist);
7224
7225     /* The temporary can be freed */
7226     SvREFCNT_dec(range_invlist);
7227
7228     return invlist;
7229 }
7230
7231 PERL_STATIC_INLINE SV*
7232 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
7233     return add_range_to_invlist(invlist, cp, cp);
7234 }
7235
7236 #ifndef PERL_IN_XSUB_RE
7237 void
7238 Perl__invlist_invert(pTHX_ SV* const invlist)
7239 {
7240     /* Complement the input inversion list.  This adds a 0 if the list didn't
7241      * have a zero; removes it otherwise.  As described above, the data
7242      * structure is set up so that this is very efficient */
7243
7244     UV* len_pos = get_invlist_len_addr(invlist);
7245
7246     PERL_ARGS_ASSERT__INVLIST_INVERT;
7247
7248     /* The inverse of matching nothing is matching everything */
7249     if (*len_pos == 0) {
7250         _append_range_to_invlist(invlist, 0, UV_MAX);
7251         return;
7252     }
7253
7254     /* The exclusive or complents 0 to 1; and 1 to 0.  If the result is 1, the
7255      * zero element was a 0, so it is being removed, so the length decrements
7256      * by 1; and vice-versa.  SvCUR is unaffected */
7257     if (*get_invlist_zero_addr(invlist) ^= 1) {
7258         (*len_pos)--;
7259     }
7260     else {
7261         (*len_pos)++;
7262     }
7263 }
7264
7265 void
7266 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
7267 {
7268     /* Complement the input inversion list (which must be a Unicode property,
7269      * all of which don't match above the Unicode maximum code point.)  And
7270      * Perl has chosen to not have the inversion match above that either.  This
7271      * adds a 0x110000 if the list didn't end with it, and removes it if it did
7272      */
7273
7274     UV len;
7275     UV* array;
7276
7277     PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
7278
7279     _invlist_invert(invlist);
7280
7281     len = invlist_len(invlist);
7282
7283     if (len != 0) { /* If empty do nothing */
7284         array = invlist_array(invlist);
7285         if (array[len - 1] != PERL_UNICODE_MAX + 1) {
7286             /* Add 0x110000.  First, grow if necessary */
7287             len++;
7288             if (invlist_max(invlist) < len) {
7289                 invlist_extend(invlist, len);
7290                 array = invlist_array(invlist);
7291             }
7292             invlist_set_len(invlist, len);
7293             array[len - 1] = PERL_UNICODE_MAX + 1;
7294         }
7295         else {  /* Remove the 0x110000 */
7296             invlist_set_len(invlist, len - 1);
7297         }
7298     }
7299
7300     return;
7301 }
7302 #endif
7303
7304 PERL_STATIC_INLINE SV*
7305 S_invlist_clone(pTHX_ SV* const invlist)
7306 {
7307
7308     /* Return a new inversion list that is a copy of the input one, which is
7309      * unchanged */
7310
7311     /* Need to allocate extra space to accommodate Perl's addition of a
7312      * trailing NUL to SvPV's, since it thinks they are always strings */
7313     SV* new_invlist = _new_invlist(invlist_len(invlist) + 1);
7314     STRLEN length = SvCUR(invlist);
7315
7316     PERL_ARGS_ASSERT_INVLIST_CLONE;
7317
7318     SvCUR_set(new_invlist, length); /* This isn't done automatically */
7319     Copy(SvPVX(invlist), SvPVX(new_invlist), length, char);
7320
7321     return new_invlist;
7322 }
7323
7324 PERL_STATIC_INLINE UV*
7325 S_get_invlist_iter_addr(pTHX_ SV* invlist)
7326 {
7327     /* Return the address of the UV that contains the current iteration
7328      * position */
7329
7330     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
7331
7332     return (UV *) (SvPVX(invlist) + (INVLIST_ITER_OFFSET * sizeof (UV)));
7333 }
7334
7335 PERL_STATIC_INLINE UV*
7336 S_get_invlist_version_id_addr(pTHX_ SV* invlist)
7337 {
7338     /* Return the address of the UV that contains the version id. */
7339
7340     PERL_ARGS_ASSERT_GET_INVLIST_VERSION_ID_ADDR;
7341
7342     return (UV *) (SvPVX(invlist) + (INVLIST_VERSION_ID_OFFSET * sizeof (UV)));
7343 }
7344
7345 PERL_STATIC_INLINE void
7346 S_invlist_iterinit(pTHX_ SV* invlist)   /* Initialize iterator for invlist */
7347 {
7348     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
7349
7350     *get_invlist_iter_addr(invlist) = 0;
7351 }
7352
7353 STATIC bool
7354 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
7355 {
7356     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
7357      * This call sets in <*start> and <*end>, the next range in <invlist>.
7358      * Returns <TRUE> if successful and the next call will return the next
7359      * range; <FALSE> if was already at the end of the list.  If the latter,
7360      * <*start> and <*end> are unchanged, and the next call to this function
7361      * will start over at the beginning of the list */
7362
7363     UV* pos = get_invlist_iter_addr(invlist);
7364     UV len = invlist_len(invlist);
7365     UV *array;
7366
7367     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
7368
7369     if (*pos >= len) {
7370         *pos = UV_MAX;  /* Force iternit() to be required next time */
7371         return FALSE;
7372     }
7373
7374     array = invlist_array(invlist);
7375
7376     *start = array[(*pos)++];
7377
7378     if (*pos >= len) {
7379         *end = UV_MAX;
7380     }
7381     else {
7382         *end = array[(*pos)++] - 1;
7383     }
7384
7385     return TRUE;
7386 }
7387
7388 #ifndef PERL_IN_XSUB_RE
7389 SV *
7390 Perl__invlist_contents(pTHX_ SV* const invlist)
7391 {
7392     /* Get the contents of an inversion list into a string SV so that they can
7393      * be printed out.  It uses the format traditionally done for debug tracing
7394      */
7395
7396     UV start, end;
7397     SV* output = newSVpvs("\n");
7398
7399     PERL_ARGS_ASSERT__INVLIST_CONTENTS;
7400
7401     invlist_iterinit(invlist);
7402     while (invlist_iternext(invlist, &start, &end)) {
7403         if (end == UV_MAX) {
7404             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
7405         }
7406         else if (end != start) {
7407             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
7408                     start,       end);
7409         }
7410         else {
7411             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
7412         }
7413     }
7414
7415     return output;
7416 }
7417 #endif
7418
7419 #if 0
7420 void
7421 S_invlist_dump(pTHX_ SV* const invlist, const char * const header)
7422 {
7423     /* Dumps out the ranges in an inversion list.  The string 'header'
7424      * if present is output on a line before the first range */
7425
7426     UV start, end;
7427
7428     if (header && strlen(header)) {
7429         PerlIO_printf(Perl_debug_log, "%s\n", header);
7430     }
7431     invlist_iterinit(invlist);
7432     while (invlist_iternext(invlist, &start, &end)) {
7433         if (end == UV_MAX) {
7434             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
7435         }
7436         else {
7437             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n", start, end);
7438         }
7439     }
7440 }
7441 #endif
7442
7443 #undef HEADER_LENGTH
7444 #undef INVLIST_INITIAL_LENGTH
7445 #undef TO_INTERNAL_SIZE
7446 #undef FROM_INTERNAL_SIZE
7447 #undef INVLIST_LEN_OFFSET
7448 #undef INVLIST_ZERO_OFFSET
7449 #undef INVLIST_ITER_OFFSET
7450 #undef INVLIST_VERSION_ID
7451
7452 /* End of inversion list object */
7453
7454 /*
7455  - reg - regular expression, i.e. main body or parenthesized thing
7456  *
7457  * Caller must absorb opening parenthesis.
7458  *
7459  * Combining parenthesis handling with the base level of regular expression
7460  * is a trifle forced, but the need to tie the tails of the branches to what
7461  * follows makes it hard to avoid.
7462  */
7463 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
7464 #ifdef DEBUGGING
7465 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
7466 #else
7467 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
7468 #endif
7469
7470 STATIC regnode *
7471 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
7472     /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
7473 {
7474     dVAR;
7475     register regnode *ret;              /* Will be the head of the group. */
7476     register regnode *br;
7477     register regnode *lastbr;
7478     register regnode *ender = NULL;
7479     register I32 parno = 0;
7480     I32 flags;
7481     U32 oregflags = RExC_flags;
7482     bool have_branch = 0;
7483     bool is_open = 0;
7484     I32 freeze_paren = 0;
7485     I32 after_freeze = 0;
7486
7487     /* for (?g), (?gc), and (?o) warnings; warning
7488        about (?c) will warn about (?g) -- japhy    */
7489
7490 #define WASTED_O  0x01
7491 #define WASTED_G  0x02
7492 #define WASTED_C  0x04
7493 #define WASTED_GC (0x02|0x04)
7494     I32 wastedflags = 0x00;
7495
7496     char * parse_start = RExC_parse; /* MJD */
7497     char * const oregcomp_parse = RExC_parse;
7498
7499     GET_RE_DEBUG_FLAGS_DECL;
7500
7501     PERL_ARGS_ASSERT_REG;
7502     DEBUG_PARSE("reg ");
7503
7504     *flagp = 0;                         /* Tentatively. */
7505
7506
7507     /* Make an OPEN node, if parenthesized. */
7508     if (paren) {
7509         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
7510             char *start_verb = RExC_parse;
7511             STRLEN verb_len = 0;
7512             char *start_arg = NULL;
7513             unsigned char op = 0;
7514             int argok = 1;
7515             int internal_argval = 0; /* internal_argval is only useful if !argok */
7516             while ( *RExC_parse && *RExC_parse != ')' ) {
7517                 if ( *RExC_parse == ':' ) {
7518                     start_arg = RExC_parse + 1;
7519                     break;
7520                 }
7521                 RExC_parse++;
7522             }
7523             ++start_verb;
7524             verb_len = RExC_parse - start_verb;
7525             if ( start_arg ) {
7526                 RExC_parse++;
7527                 while ( *RExC_parse && *RExC_parse != ')' ) 
7528                     RExC_parse++;
7529                 if ( *RExC_parse != ')' ) 
7530                     vFAIL("Unterminated verb pattern argument");
7531                 if ( RExC_parse == start_arg )
7532                     start_arg = NULL;
7533             } else {
7534                 if ( *RExC_parse != ')' )
7535                     vFAIL("Unterminated verb pattern");
7536             }
7537             
7538             switch ( *start_verb ) {
7539             case 'A':  /* (*ACCEPT) */
7540                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
7541                     op = ACCEPT;
7542                     internal_argval = RExC_nestroot;
7543                 }
7544                 break;
7545             case 'C':  /* (*COMMIT) */
7546                 if ( memEQs(start_verb,verb_len,"COMMIT") )
7547                     op = COMMIT;
7548                 break;
7549             case 'F':  /* (*FAIL) */
7550                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
7551                     op = OPFAIL;
7552                     argok = 0;
7553                 }
7554                 break;
7555             case ':':  /* (*:NAME) */
7556             case 'M':  /* (*MARK:NAME) */
7557                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
7558                     op = MARKPOINT;
7559                     argok = -1;
7560                 }
7561                 break;
7562             case 'P':  /* (*PRUNE) */
7563                 if ( memEQs(start_verb,verb_len,"PRUNE") )
7564                     op = PRUNE;
7565                 break;
7566             case 'S':   /* (*SKIP) */  
7567                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
7568                     op = SKIP;
7569                 break;
7570             case 'T':  /* (*THEN) */
7571                 /* [19:06] <TimToady> :: is then */
7572                 if ( memEQs(start_verb,verb_len,"THEN") ) {
7573                     op = CUTGROUP;
7574                     RExC_seen |= REG_SEEN_CUTGROUP;
7575                 }
7576                 break;
7577             }
7578             if ( ! op ) {
7579                 RExC_parse++;
7580                 vFAIL3("Unknown verb pattern '%.*s'",
7581                     verb_len, start_verb);
7582             }
7583             if ( argok ) {
7584                 if ( start_arg && internal_argval ) {
7585                     vFAIL3("Verb pattern '%.*s' may not have an argument",
7586                         verb_len, start_verb); 
7587                 } else if ( argok < 0 && !start_arg ) {
7588                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
7589                         verb_len, start_verb);    
7590                 } else {
7591                     ret = reganode(pRExC_state, op, internal_argval);
7592                     if ( ! internal_argval && ! SIZE_ONLY ) {
7593                         if (start_arg) {
7594                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
7595                             ARG(ret) = add_data( pRExC_state, 1, "S" );
7596                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
7597                             ret->flags = 0;
7598                         } else {
7599                             ret->flags = 1; 
7600                         }
7601                     }               
7602                 }
7603                 if (!internal_argval)
7604                     RExC_seen |= REG_SEEN_VERBARG;
7605             } else if ( start_arg ) {
7606                 vFAIL3("Verb pattern '%.*s' may not have an argument",
7607                         verb_len, start_verb);    
7608             } else {
7609                 ret = reg_node(pRExC_state, op);
7610             }
7611             nextchar(pRExC_state);
7612             return ret;
7613         } else 
7614         if (*RExC_parse == '?') { /* (?...) */
7615             bool is_logical = 0;
7616             const char * const seqstart = RExC_parse;
7617             bool has_use_defaults = FALSE;
7618
7619             RExC_parse++;
7620             paren = *RExC_parse++;
7621             ret = NULL;                 /* For look-ahead/behind. */
7622             switch (paren) {
7623
7624             case 'P':   /* (?P...) variants for those used to PCRE/Python */
7625                 paren = *RExC_parse++;
7626                 if ( paren == '<')         /* (?P<...>) named capture */
7627                     goto named_capture;
7628                 else if (paren == '>') {   /* (?P>name) named recursion */
7629                     goto named_recursion;
7630                 }
7631                 else if (paren == '=') {   /* (?P=...)  named backref */
7632                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
7633                        you change this make sure you change that */
7634                     char* name_start = RExC_parse;
7635                     U32 num = 0;
7636                     SV *sv_dat = reg_scan_name(pRExC_state,
7637                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7638                     if (RExC_parse == name_start || *RExC_parse != ')')
7639                         vFAIL2("Sequence %.3s... not terminated",parse_start);
7640
7641                     if (!SIZE_ONLY) {
7642                         num = add_data( pRExC_state, 1, "S" );
7643                         RExC_rxi->data->data[num]=(void*)sv_dat;
7644                         SvREFCNT_inc_simple_void(sv_dat);
7645                     }
7646                     RExC_sawback = 1;
7647                     ret = reganode(pRExC_state,
7648                                    ((! FOLD)
7649                                      ? NREF
7650                                      : (MORE_ASCII_RESTRICTED)
7651                                        ? NREFFA
7652                                        : (AT_LEAST_UNI_SEMANTICS)
7653                                          ? NREFFU
7654                                          : (LOC)
7655                                            ? NREFFL
7656                                            : NREFF),
7657                                     num);
7658                     *flagp |= HASWIDTH;
7659
7660                     Set_Node_Offset(ret, parse_start+1);
7661                     Set_Node_Cur_Length(ret); /* MJD */
7662
7663                     nextchar(pRExC_state);
7664                     return ret;
7665                 }
7666                 RExC_parse++;
7667                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
7668                 /*NOTREACHED*/
7669             case '<':           /* (?<...) */
7670                 if (*RExC_parse == '!')
7671                     paren = ',';
7672                 else if (*RExC_parse != '=') 
7673               named_capture:
7674                 {               /* (?<...>) */
7675                     char *name_start;
7676                     SV *svname;
7677                     paren= '>';
7678             case '\'':          /* (?'...') */
7679                     name_start= RExC_parse;
7680                     svname = reg_scan_name(pRExC_state,
7681                         SIZE_ONLY ?  /* reverse test from the others */
7682                         REG_RSN_RETURN_NAME : 
7683                         REG_RSN_RETURN_NULL);
7684                     if (RExC_parse == name_start) {
7685                         RExC_parse++;
7686                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
7687                         /*NOTREACHED*/
7688                     }
7689                     if (*RExC_parse != paren)
7690                         vFAIL2("Sequence (?%c... not terminated",
7691                             paren=='>' ? '<' : paren);
7692                     if (SIZE_ONLY) {
7693                         HE *he_str;
7694                         SV *sv_dat = NULL;
7695                         if (!svname) /* shouldn't happen */
7696                             Perl_croak(aTHX_
7697                                 "panic: reg_scan_name returned NULL");
7698                         if (!RExC_paren_names) {
7699                             RExC_paren_names= newHV();
7700                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
7701 #ifdef DEBUGGING
7702                             RExC_paren_name_list= newAV();
7703                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
7704 #endif
7705                         }
7706                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
7707                         if ( he_str )
7708                             sv_dat = HeVAL(he_str);
7709                         if ( ! sv_dat ) {
7710                             /* croak baby croak */
7711                             Perl_croak(aTHX_
7712                                 "panic: paren_name hash element allocation failed");
7713                         } else if ( SvPOK(sv_dat) ) {
7714                             /* (?|...) can mean we have dupes so scan to check
7715                                its already been stored. Maybe a flag indicating
7716                                we are inside such a construct would be useful,
7717                                but the arrays are likely to be quite small, so
7718                                for now we punt -- dmq */
7719                             IV count = SvIV(sv_dat);
7720                             I32 *pv = (I32*)SvPVX(sv_dat);
7721                             IV i;
7722                             for ( i = 0 ; i < count ; i++ ) {
7723                                 if ( pv[i] == RExC_npar ) {
7724                                     count = 0;
7725                                     break;
7726                                 }
7727                             }
7728                             if ( count ) {
7729                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
7730                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
7731                                 pv[count] = RExC_npar;
7732                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
7733                             }
7734                         } else {
7735                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
7736                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
7737                             SvIOK_on(sv_dat);
7738                             SvIV_set(sv_dat, 1);
7739                         }
7740 #ifdef DEBUGGING
7741                         /* Yes this does cause a memory leak in debugging Perls */
7742                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
7743                             SvREFCNT_dec(svname);
7744 #endif
7745
7746                         /*sv_dump(sv_dat);*/
7747                     }
7748                     nextchar(pRExC_state);
7749                     paren = 1;
7750                     goto capturing_parens;
7751                 }
7752                 RExC_seen |= REG_SEEN_LOOKBEHIND;
7753                 RExC_in_lookbehind++;
7754                 RExC_parse++;
7755             case '=':           /* (?=...) */
7756                 RExC_seen_zerolen++;
7757                 break;
7758             case '!':           /* (?!...) */
7759                 RExC_seen_zerolen++;
7760                 if (*RExC_parse == ')') {
7761                     ret=reg_node(pRExC_state, OPFAIL);
7762                     nextchar(pRExC_state);
7763                     return ret;
7764                 }
7765                 break;
7766             case '|':           /* (?|...) */
7767                 /* branch reset, behave like a (?:...) except that
7768                    buffers in alternations share the same numbers */
7769                 paren = ':'; 
7770                 after_freeze = freeze_paren = RExC_npar;
7771                 break;
7772             case ':':           /* (?:...) */
7773             case '>':           /* (?>...) */
7774                 break;
7775             case '$':           /* (?$...) */
7776             case '@':           /* (?@...) */
7777                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
7778                 break;
7779             case '#':           /* (?#...) */
7780                 while (*RExC_parse && *RExC_parse != ')')
7781                     RExC_parse++;
7782                 if (*RExC_parse != ')')
7783                     FAIL("Sequence (?#... not terminated");
7784                 nextchar(pRExC_state);
7785                 *flagp = TRYAGAIN;
7786                 return NULL;
7787             case '0' :           /* (?0) */
7788             case 'R' :           /* (?R) */
7789                 if (*RExC_parse != ')')
7790                     FAIL("Sequence (?R) not terminated");
7791                 ret = reg_node(pRExC_state, GOSTART);
7792                 *flagp |= POSTPONED;
7793                 nextchar(pRExC_state);
7794                 return ret;
7795                 /*notreached*/
7796             { /* named and numeric backreferences */
7797                 I32 num;
7798             case '&':            /* (?&NAME) */
7799                 parse_start = RExC_parse - 1;
7800               named_recursion:
7801                 {
7802                     SV *sv_dat = reg_scan_name(pRExC_state,
7803                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7804                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
7805                 }
7806                 goto gen_recurse_regop;
7807                 /* NOT REACHED */
7808             case '+':
7809                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
7810                     RExC_parse++;
7811                     vFAIL("Illegal pattern");
7812                 }
7813                 goto parse_recursion;
7814                 /* NOT REACHED*/
7815             case '-': /* (?-1) */
7816                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
7817                     RExC_parse--; /* rewind to let it be handled later */
7818                     goto parse_flags;
7819                 } 
7820                 /*FALLTHROUGH */
7821             case '1': case '2': case '3': case '4': /* (?1) */
7822             case '5': case '6': case '7': case '8': case '9':
7823                 RExC_parse--;
7824               parse_recursion:
7825                 num = atoi(RExC_parse);
7826                 parse_start = RExC_parse - 1; /* MJD */
7827                 if (*RExC_parse == '-')
7828                     RExC_parse++;
7829                 while (isDIGIT(*RExC_parse))
7830                         RExC_parse++;
7831                 if (*RExC_parse!=')') 
7832                     vFAIL("Expecting close bracket");
7833
7834               gen_recurse_regop:
7835                 if ( paren == '-' ) {
7836                     /*
7837                     Diagram of capture buffer numbering.
7838                     Top line is the normal capture buffer numbers
7839                     Bottom line is the negative indexing as from
7840                     the X (the (?-2))
7841
7842                     +   1 2    3 4 5 X          6 7
7843                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
7844                     -   5 4    3 2 1 X          x x
7845
7846                     */
7847                     num = RExC_npar + num;
7848                     if (num < 1)  {
7849                         RExC_parse++;
7850                         vFAIL("Reference to nonexistent group");
7851                     }
7852                 } else if ( paren == '+' ) {
7853                     num = RExC_npar + num - 1;
7854                 }
7855
7856                 ret = reganode(pRExC_state, GOSUB, num);
7857                 if (!SIZE_ONLY) {
7858                     if (num > (I32)RExC_rx->nparens) {
7859                         RExC_parse++;
7860                         vFAIL("Reference to nonexistent group");
7861                     }
7862                     ARG2L_SET( ret, RExC_recurse_count++);
7863                     RExC_emit++;
7864                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
7865                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
7866                 } else {
7867                     RExC_size++;
7868                 }
7869                 RExC_seen |= REG_SEEN_RECURSE;
7870                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
7871                 Set_Node_Offset(ret, parse_start); /* MJD */
7872
7873                 *flagp |= POSTPONED;
7874                 nextchar(pRExC_state);
7875                 return ret;
7876             } /* named and numeric backreferences */
7877             /* NOT REACHED */
7878
7879             case '?':           /* (??...) */
7880                 is_logical = 1;
7881                 if (*RExC_parse != '{') {
7882                     RExC_parse++;
7883                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
7884                     /*NOTREACHED*/
7885                 }
7886                 *flagp |= POSTPONED;
7887                 paren = *RExC_parse++;
7888                 /* FALL THROUGH */
7889             case '{':           /* (?{...}) */
7890             {
7891                 I32 count = 1;
7892                 U32 n = 0;
7893                 char c;
7894                 char *s = RExC_parse;
7895
7896                 RExC_seen_zerolen++;
7897                 RExC_seen |= REG_SEEN_EVAL;
7898                 while (count && (c = *RExC_parse)) {
7899                     if (c == '\\') {
7900                         if (RExC_parse[1])
7901                             RExC_parse++;
7902                     }
7903                     else if (c == '{')
7904                         count++;
7905                     else if (c == '}')
7906                         count--;
7907                     RExC_parse++;
7908                 }
7909                 if (*RExC_parse != ')') {
7910                     RExC_parse = s;
7911                     vFAIL("Sequence (?{...}) not terminated or not {}-balanced");
7912                 }
7913                 if (!SIZE_ONLY) {
7914                     PAD *pad;
7915                     OP_4tree *sop, *rop;
7916                     SV * const sv = newSVpvn(s, RExC_parse - 1 - s);
7917
7918                     ENTER;
7919                     Perl_save_re_context(aTHX);
7920                     rop = Perl_sv_compile_2op_is_broken(aTHX_ sv, &sop, "re", &pad);
7921                     sop->op_private |= OPpREFCOUNTED;
7922                     /* re_dup will OpREFCNT_inc */
7923                     OpREFCNT_set(sop, 1);
7924                     LEAVE;
7925
7926                     n = add_data(pRExC_state, 3, "nop");
7927                     RExC_rxi->data->data[n] = (void*)rop;
7928                     RExC_rxi->data->data[n+1] = (void*)sop;
7929                     RExC_rxi->data->data[n+2] = (void*)pad;
7930                     SvREFCNT_dec(sv);
7931                 }
7932                 else {                                          /* First pass */
7933                     if (PL_reginterp_cnt < ++RExC_seen_evals
7934                         && IN_PERL_RUNTIME)
7935                         /* No compiled RE interpolated, has runtime
7936                            components ===> unsafe.  */
7937                         FAIL("Eval-group not allowed at runtime, use re 'eval'");
7938                     if (PL_tainting && PL_tainted)
7939                         FAIL("Eval-group in insecure regular expression");
7940 #if PERL_VERSION > 8
7941                     if (IN_PERL_COMPILETIME)
7942                         PL_cv_has_eval = 1;
7943 #endif
7944                 }
7945
7946                 nextchar(pRExC_state);
7947                 if (is_logical) {
7948                     ret = reg_node(pRExC_state, LOGICAL);
7949                     if (!SIZE_ONLY)
7950                         ret->flags = 2;
7951                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, EVAL, n));
7952                     /* deal with the length of this later - MJD */
7953                     return ret;
7954                 }
7955                 ret = reganode(pRExC_state, EVAL, n);
7956                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
7957                 Set_Node_Offset(ret, parse_start);
7958                 return ret;
7959             }
7960             case '(':           /* (?(?{...})...) and (?(?=...)...) */
7961             {
7962                 int is_define= 0;
7963                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
7964                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
7965                         || RExC_parse[1] == '<'
7966                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
7967                         I32 flag;
7968
7969                         ret = reg_node(pRExC_state, LOGICAL);
7970                         if (!SIZE_ONLY)
7971                             ret->flags = 1;
7972                         REGTAIL(pRExC_state, ret, reg(pRExC_state, 1, &flag,depth+1));
7973                         goto insert_if;
7974                     }
7975                 }
7976                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
7977                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
7978                 {
7979                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
7980                     char *name_start= RExC_parse++;
7981                     U32 num = 0;
7982                     SV *sv_dat=reg_scan_name(pRExC_state,
7983                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7984                     if (RExC_parse == name_start || *RExC_parse != ch)
7985                         vFAIL2("Sequence (?(%c... not terminated",
7986                             (ch == '>' ? '<' : ch));
7987                     RExC_parse++;
7988                     if (!SIZE_ONLY) {
7989                         num = add_data( pRExC_state, 1, "S" );
7990                         RExC_rxi->data->data[num]=(void*)sv_dat;
7991                         SvREFCNT_inc_simple_void(sv_dat);
7992                     }
7993                     ret = reganode(pRExC_state,NGROUPP,num);
7994                     goto insert_if_check_paren;
7995                 }
7996                 else if (RExC_parse[0] == 'D' &&
7997                          RExC_parse[1] == 'E' &&
7998                          RExC_parse[2] == 'F' &&
7999                          RExC_parse[3] == 'I' &&
8000                          RExC_parse[4] == 'N' &&
8001                          RExC_parse[5] == 'E')
8002                 {
8003                     ret = reganode(pRExC_state,DEFINEP,0);
8004                     RExC_parse +=6 ;
8005                     is_define = 1;
8006                     goto insert_if_check_paren;
8007                 }
8008                 else if (RExC_parse[0] == 'R') {
8009                     RExC_parse++;
8010                     parno = 0;
8011                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
8012                         parno = atoi(RExC_parse++);
8013                         while (isDIGIT(*RExC_parse))
8014                             RExC_parse++;
8015                     } else if (RExC_parse[0] == '&') {
8016                         SV *sv_dat;
8017                         RExC_parse++;
8018                         sv_dat = reg_scan_name(pRExC_state,
8019                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8020                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8021                     }
8022                     ret = reganode(pRExC_state,INSUBP,parno); 
8023                     goto insert_if_check_paren;
8024                 }
8025                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
8026                     /* (?(1)...) */
8027                     char c;
8028                     parno = atoi(RExC_parse++);
8029
8030                     while (isDIGIT(*RExC_parse))
8031                         RExC_parse++;
8032                     ret = reganode(pRExC_state, GROUPP, parno);
8033
8034                  insert_if_check_paren:
8035                     if ((c = *nextchar(pRExC_state)) != ')')
8036                         vFAIL("Switch condition not recognized");
8037                   insert_if:
8038                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
8039                     br = regbranch(pRExC_state, &flags, 1,depth+1);
8040                     if (br == NULL)
8041                         br = reganode(pRExC_state, LONGJMP, 0);
8042                     else
8043                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
8044                     c = *nextchar(pRExC_state);
8045                     if (flags&HASWIDTH)
8046                         *flagp |= HASWIDTH;
8047                     if (c == '|') {
8048                         if (is_define) 
8049                             vFAIL("(?(DEFINE)....) does not allow branches");
8050                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
8051                         regbranch(pRExC_state, &flags, 1,depth+1);
8052                         REGTAIL(pRExC_state, ret, lastbr);
8053                         if (flags&HASWIDTH)
8054                             *flagp |= HASWIDTH;
8055                         c = *nextchar(pRExC_state);
8056                     }
8057                     else
8058                         lastbr = NULL;
8059                     if (c != ')')
8060                         vFAIL("Switch (?(condition)... contains too many branches");
8061                     ender = reg_node(pRExC_state, TAIL);
8062                     REGTAIL(pRExC_state, br, ender);
8063                     if (lastbr) {
8064                         REGTAIL(pRExC_state, lastbr, ender);
8065                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
8066                     }
8067                     else
8068                         REGTAIL(pRExC_state, ret, ender);
8069                     RExC_size++; /* XXX WHY do we need this?!!
8070                                     For large programs it seems to be required
8071                                     but I can't figure out why. -- dmq*/
8072                     return ret;
8073                 }
8074                 else {
8075                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
8076                 }
8077             }
8078             case 0:
8079                 RExC_parse--; /* for vFAIL to print correctly */
8080                 vFAIL("Sequence (? incomplete");
8081                 break;
8082             case DEFAULT_PAT_MOD:   /* Use default flags with the exceptions
8083                                        that follow */
8084                 has_use_defaults = TRUE;
8085                 STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8086                 set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8087                                                 ? REGEX_UNICODE_CHARSET
8088                                                 : REGEX_DEPENDS_CHARSET);
8089                 goto parse_flags;
8090             default:
8091                 --RExC_parse;
8092                 parse_flags:      /* (?i) */  
8093             {
8094                 U32 posflags = 0, negflags = 0;
8095                 U32 *flagsp = &posflags;
8096                 char has_charset_modifier = '\0';
8097                 regex_charset cs = get_regex_charset(RExC_flags);
8098                 if (cs == REGEX_DEPENDS_CHARSET
8099                     && (RExC_utf8 || RExC_uni_semantics))
8100                 {
8101                     cs = REGEX_UNICODE_CHARSET;
8102                 }
8103
8104                 while (*RExC_parse) {
8105                     /* && strchr("iogcmsx", *RExC_parse) */
8106                     /* (?g), (?gc) and (?o) are useless here
8107                        and must be globally applied -- japhy */
8108                     switch (*RExC_parse) {
8109                     CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
8110                     case LOCALE_PAT_MOD:
8111                         if (has_charset_modifier) {
8112                             goto excess_modifier;
8113                         }
8114                         else if (flagsp == &negflags) {
8115                             goto neg_modifier;
8116                         }
8117                         cs = REGEX_LOCALE_CHARSET;
8118                         has_charset_modifier = LOCALE_PAT_MOD;
8119                         RExC_contains_locale = 1;
8120                         break;
8121                     case UNICODE_PAT_MOD:
8122                         if (has_charset_modifier) {
8123                             goto excess_modifier;
8124                         }
8125                         else if (flagsp == &negflags) {
8126                             goto neg_modifier;
8127                         }
8128                         cs = REGEX_UNICODE_CHARSET;
8129                         has_charset_modifier = UNICODE_PAT_MOD;
8130                         break;
8131                     case ASCII_RESTRICT_PAT_MOD:
8132                         if (flagsp == &negflags) {
8133                             goto neg_modifier;
8134                         }
8135                         if (has_charset_modifier) {
8136                             if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
8137                                 goto excess_modifier;
8138                             }
8139                             /* Doubled modifier implies more restricted */
8140                             cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
8141                         }
8142                         else {
8143                             cs = REGEX_ASCII_RESTRICTED_CHARSET;
8144                         }
8145                         has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
8146                         break;
8147                     case DEPENDS_PAT_MOD:
8148                         if (has_use_defaults) {
8149                             goto fail_modifiers;
8150                         }
8151                         else if (flagsp == &negflags) {
8152                             goto neg_modifier;
8153                         }
8154                         else if (has_charset_modifier) {
8155                             goto excess_modifier;
8156                         }
8157
8158                         /* The dual charset means unicode semantics if the
8159                          * pattern (or target, not known until runtime) are
8160                          * utf8, or something in the pattern indicates unicode
8161                          * semantics */
8162                         cs = (RExC_utf8 || RExC_uni_semantics)
8163                              ? REGEX_UNICODE_CHARSET
8164                              : REGEX_DEPENDS_CHARSET;
8165                         has_charset_modifier = DEPENDS_PAT_MOD;
8166                         break;
8167                     excess_modifier:
8168                         RExC_parse++;
8169                         if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
8170                             vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
8171                         }
8172                         else if (has_charset_modifier == *(RExC_parse - 1)) {
8173                             vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
8174                         }
8175                         else {
8176                             vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
8177                         }
8178                         /*NOTREACHED*/
8179                     neg_modifier:
8180                         RExC_parse++;
8181                         vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
8182                         /*NOTREACHED*/
8183                     case ONCE_PAT_MOD: /* 'o' */
8184                     case GLOBAL_PAT_MOD: /* 'g' */
8185                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8186                             const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
8187                             if (! (wastedflags & wflagbit) ) {
8188                                 wastedflags |= wflagbit;
8189                                 vWARN5(
8190                                     RExC_parse + 1,
8191                                     "Useless (%s%c) - %suse /%c modifier",
8192                                     flagsp == &negflags ? "?-" : "?",
8193                                     *RExC_parse,
8194                                     flagsp == &negflags ? "don't " : "",
8195                                     *RExC_parse
8196                                 );
8197                             }
8198                         }
8199                         break;
8200                         
8201                     case CONTINUE_PAT_MOD: /* 'c' */
8202                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8203                             if (! (wastedflags & WASTED_C) ) {
8204                                 wastedflags |= WASTED_GC;
8205                                 vWARN3(
8206                                     RExC_parse + 1,
8207                                     "Useless (%sc) - %suse /gc modifier",
8208                                     flagsp == &negflags ? "?-" : "?",
8209                                     flagsp == &negflags ? "don't " : ""
8210                                 );
8211                             }
8212                         }
8213                         break;
8214                     case KEEPCOPY_PAT_MOD: /* 'p' */
8215                         if (flagsp == &negflags) {
8216                             if (SIZE_ONLY)
8217                                 ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
8218                         } else {
8219                             *flagsp |= RXf_PMf_KEEPCOPY;
8220                         }
8221                         break;
8222                     case '-':
8223                         /* A flag is a default iff it is following a minus, so
8224                          * if there is a minus, it means will be trying to
8225                          * re-specify a default which is an error */
8226                         if (has_use_defaults || flagsp == &negflags) {
8227             fail_modifiers:
8228                             RExC_parse++;
8229                             vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8230                             /*NOTREACHED*/
8231                         }
8232                         flagsp = &negflags;
8233                         wastedflags = 0;  /* reset so (?g-c) warns twice */
8234                         break;
8235                     case ':':
8236                         paren = ':';
8237                         /*FALLTHROUGH*/
8238                     case ')':
8239                         RExC_flags |= posflags;
8240                         RExC_flags &= ~negflags;
8241                         set_regex_charset(&RExC_flags, cs);
8242                         if (paren != ':') {
8243                             oregflags |= posflags;
8244                             oregflags &= ~negflags;
8245                             set_regex_charset(&oregflags, cs);
8246                         }
8247                         nextchar(pRExC_state);
8248                         if (paren != ':') {
8249                             *flagp = TRYAGAIN;
8250                             return NULL;
8251                         } else {
8252                             ret = NULL;
8253                             goto parse_rest;
8254                         }
8255                         /*NOTREACHED*/
8256                     default:
8257                         RExC_parse++;
8258                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8259                         /*NOTREACHED*/
8260                     }                           
8261                     ++RExC_parse;
8262                 }
8263             }} /* one for the default block, one for the switch */
8264         }
8265         else {                  /* (...) */
8266           capturing_parens:
8267             parno = RExC_npar;
8268             RExC_npar++;
8269             
8270             ret = reganode(pRExC_state, OPEN, parno);
8271             if (!SIZE_ONLY ){
8272                 if (!RExC_nestroot) 
8273                     RExC_nestroot = parno;
8274                 if (RExC_seen & REG_SEEN_RECURSE
8275                     && !RExC_open_parens[parno-1])
8276                 {
8277                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
8278                         "Setting open paren #%"IVdf" to %d\n", 
8279                         (IV)parno, REG_NODE_NUM(ret)));
8280                     RExC_open_parens[parno-1]= ret;
8281                 }
8282             }
8283             Set_Node_Length(ret, 1); /* MJD */
8284             Set_Node_Offset(ret, RExC_parse); /* MJD */
8285             is_open = 1;
8286         }
8287     }
8288     else                        /* ! paren */
8289         ret = NULL;
8290    
8291    parse_rest:
8292     /* Pick up the branches, linking them together. */
8293     parse_start = RExC_parse;   /* MJD */
8294     br = regbranch(pRExC_state, &flags, 1,depth+1);
8295
8296     /*     branch_len = (paren != 0); */
8297
8298     if (br == NULL)
8299         return(NULL);
8300     if (*RExC_parse == '|') {
8301         if (!SIZE_ONLY && RExC_extralen) {
8302             reginsert(pRExC_state, BRANCHJ, br, depth+1);
8303         }
8304         else {                  /* MJD */
8305             reginsert(pRExC_state, BRANCH, br, depth+1);
8306             Set_Node_Length(br, paren != 0);
8307             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
8308         }
8309         have_branch = 1;
8310         if (SIZE_ONLY)
8311             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
8312     }
8313     else if (paren == ':') {
8314         *flagp |= flags&SIMPLE;
8315     }
8316     if (is_open) {                              /* Starts with OPEN. */
8317         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
8318     }
8319     else if (paren != '?')              /* Not Conditional */
8320         ret = br;
8321     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
8322     lastbr = br;
8323     while (*RExC_parse == '|') {
8324         if (!SIZE_ONLY && RExC_extralen) {
8325             ender = reganode(pRExC_state, LONGJMP,0);
8326             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
8327         }
8328         if (SIZE_ONLY)
8329             RExC_extralen += 2;         /* Account for LONGJMP. */
8330         nextchar(pRExC_state);
8331         if (freeze_paren) {
8332             if (RExC_npar > after_freeze)
8333                 after_freeze = RExC_npar;
8334             RExC_npar = freeze_paren;       
8335         }
8336         br = regbranch(pRExC_state, &flags, 0, depth+1);
8337
8338         if (br == NULL)
8339             return(NULL);
8340         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
8341         lastbr = br;
8342         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
8343     }
8344
8345     if (have_branch || paren != ':') {
8346         /* Make a closing node, and hook it on the end. */
8347         switch (paren) {
8348         case ':':
8349             ender = reg_node(pRExC_state, TAIL);
8350             break;
8351         case 1:
8352             ender = reganode(pRExC_state, CLOSE, parno);
8353             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
8354                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
8355                         "Setting close paren #%"IVdf" to %d\n", 
8356                         (IV)parno, REG_NODE_NUM(ender)));
8357                 RExC_close_parens[parno-1]= ender;
8358                 if (RExC_nestroot == parno) 
8359                     RExC_nestroot = 0;
8360             }       
8361             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
8362             Set_Node_Length(ender,1); /* MJD */
8363             break;
8364         case '<':
8365         case ',':
8366         case '=':
8367         case '!':
8368             *flagp &= ~HASWIDTH;
8369             /* FALL THROUGH */
8370         case '>':
8371             ender = reg_node(pRExC_state, SUCCEED);
8372             break;
8373         case 0:
8374             ender = reg_node(pRExC_state, END);
8375             if (!SIZE_ONLY) {
8376                 assert(!RExC_opend); /* there can only be one! */
8377                 RExC_opend = ender;
8378             }
8379             break;
8380         }
8381         REGTAIL(pRExC_state, lastbr, ender);
8382
8383         if (have_branch && !SIZE_ONLY) {
8384             if (depth==1)
8385                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
8386
8387             /* Hook the tails of the branches to the closing node. */
8388             for (br = ret; br; br = regnext(br)) {
8389                 const U8 op = PL_regkind[OP(br)];
8390                 if (op == BRANCH) {
8391                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
8392                 }
8393                 else if (op == BRANCHJ) {
8394                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
8395                 }
8396             }
8397         }
8398     }
8399
8400     {
8401         const char *p;
8402         static const char parens[] = "=!<,>";
8403
8404         if (paren && (p = strchr(parens, paren))) {
8405             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
8406             int flag = (p - parens) > 1;
8407
8408             if (paren == '>')
8409                 node = SUSPEND, flag = 0;
8410             reginsert(pRExC_state, node,ret, depth+1);
8411             Set_Node_Cur_Length(ret);
8412             Set_Node_Offset(ret, parse_start + 1);
8413             ret->flags = flag;
8414             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
8415         }
8416     }
8417
8418     /* Check for proper termination. */
8419     if (paren) {
8420         RExC_flags = oregflags;
8421         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
8422             RExC_parse = oregcomp_parse;
8423             vFAIL("Unmatched (");
8424         }
8425     }
8426     else if (!paren && RExC_parse < RExC_end) {
8427         if (*RExC_parse == ')') {
8428             RExC_parse++;
8429             vFAIL("Unmatched )");
8430         }
8431         else
8432             FAIL("Junk on end of regexp");      /* "Can't happen". */
8433         /* NOTREACHED */
8434     }
8435
8436     if (RExC_in_lookbehind) {
8437         RExC_in_lookbehind--;
8438     }
8439     if (after_freeze > RExC_npar)
8440         RExC_npar = after_freeze;
8441     return(ret);
8442 }
8443
8444 /*
8445  - regbranch - one alternative of an | operator
8446  *
8447  * Implements the concatenation operator.
8448  */
8449 STATIC regnode *
8450 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
8451 {
8452     dVAR;
8453     register regnode *ret;
8454     register regnode *chain = NULL;
8455     register regnode *latest;
8456     I32 flags = 0, c = 0;
8457     GET_RE_DEBUG_FLAGS_DECL;
8458
8459     PERL_ARGS_ASSERT_REGBRANCH;
8460
8461     DEBUG_PARSE("brnc");
8462
8463     if (first)
8464         ret = NULL;
8465     else {
8466         if (!SIZE_ONLY && RExC_extralen)
8467             ret = reganode(pRExC_state, BRANCHJ,0);
8468         else {
8469             ret = reg_node(pRExC_state, BRANCH);
8470             Set_Node_Length(ret, 1);
8471         }
8472     }
8473
8474     if (!first && SIZE_ONLY)
8475         RExC_extralen += 1;                     /* BRANCHJ */
8476
8477     *flagp = WORST;                     /* Tentatively. */
8478
8479     RExC_parse--;
8480     nextchar(pRExC_state);
8481     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
8482         flags &= ~TRYAGAIN;
8483         latest = regpiece(pRExC_state, &flags,depth+1);
8484         if (latest == NULL) {
8485             if (flags & TRYAGAIN)
8486                 continue;
8487             return(NULL);
8488         }
8489         else if (ret == NULL)
8490             ret = latest;
8491         *flagp |= flags&(HASWIDTH|POSTPONED);
8492         if (chain == NULL)      /* First piece. */
8493             *flagp |= flags&SPSTART;
8494         else {
8495             RExC_naughty++;
8496             REGTAIL(pRExC_state, chain, latest);
8497         }
8498         chain = latest;
8499         c++;
8500     }
8501     if (chain == NULL) {        /* Loop ran zero times. */
8502         chain = reg_node(pRExC_state, NOTHING);
8503         if (ret == NULL)
8504             ret = chain;
8505     }
8506     if (c == 1) {
8507         *flagp |= flags&SIMPLE;
8508     }
8509
8510     return ret;
8511 }
8512
8513 /*
8514  - regpiece - something followed by possible [*+?]
8515  *
8516  * Note that the branching code sequences used for ? and the general cases
8517  * of * and + are somewhat optimized:  they use the same NOTHING node as
8518  * both the endmarker for their branch list and the body of the last branch.
8519  * It might seem that this node could be dispensed with entirely, but the
8520  * endmarker role is not redundant.
8521  */
8522 STATIC regnode *
8523 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
8524 {
8525     dVAR;
8526     register regnode *ret;
8527     register char op;
8528     register char *next;
8529     I32 flags;
8530     const char * const origparse = RExC_parse;
8531     I32 min;
8532     I32 max = REG_INFTY;
8533 #ifdef RE_TRACK_PATTERN_OFFSETS
8534     char *parse_start;
8535 #endif
8536     const char *maxpos = NULL;
8537     GET_RE_DEBUG_FLAGS_DECL;
8538
8539     PERL_ARGS_ASSERT_REGPIECE;
8540
8541     DEBUG_PARSE("piec");
8542
8543     ret = regatom(pRExC_state, &flags,depth+1);
8544     if (ret == NULL) {
8545         if (flags & TRYAGAIN)
8546             *flagp |= TRYAGAIN;
8547         return(NULL);
8548     }
8549
8550     op = *RExC_parse;
8551
8552     if (op == '{' && regcurly(RExC_parse)) {
8553         maxpos = NULL;
8554 #ifdef RE_TRACK_PATTERN_OFFSETS
8555         parse_start = RExC_parse; /* MJD */
8556 #endif
8557         next = RExC_parse + 1;
8558         while (isDIGIT(*next) || *next == ',') {
8559             if (*next == ',') {
8560                 if (maxpos)
8561                     break;
8562                 else
8563                     maxpos = next;
8564             }
8565             next++;
8566         }
8567         if (*next == '}') {             /* got one */
8568             if (!maxpos)
8569                 maxpos = next;
8570             RExC_parse++;
8571             min = atoi(RExC_parse);
8572             if (*maxpos == ',')
8573                 maxpos++;
8574             else
8575                 maxpos = RExC_parse;
8576             max = atoi(maxpos);
8577             if (!max && *maxpos != '0')
8578                 max = REG_INFTY;                /* meaning "infinity" */
8579             else if (max >= REG_INFTY)
8580                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
8581             RExC_parse = next;
8582             nextchar(pRExC_state);
8583
8584         do_curly:
8585             if ((flags&SIMPLE)) {
8586                 RExC_naughty += 2 + RExC_naughty / 2;
8587                 reginsert(pRExC_state, CURLY, ret, depth+1);
8588                 Set_Node_Offset(ret, parse_start+1); /* MJD */
8589                 Set_Node_Cur_Length(ret);
8590             }
8591             else {
8592                 regnode * const w = reg_node(pRExC_state, WHILEM);
8593
8594                 w->flags = 0;
8595                 REGTAIL(pRExC_state, ret, w);
8596                 if (!SIZE_ONLY && RExC_extralen) {
8597                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
8598                     reginsert(pRExC_state, NOTHING,ret, depth+1);
8599                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
8600                 }
8601                 reginsert(pRExC_state, CURLYX,ret, depth+1);
8602                                 /* MJD hk */
8603                 Set_Node_Offset(ret, parse_start+1);
8604                 Set_Node_Length(ret,
8605                                 op == '{' ? (RExC_parse - parse_start) : 1);
8606
8607                 if (!SIZE_ONLY && RExC_extralen)
8608                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
8609                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
8610                 if (SIZE_ONLY)
8611                     RExC_whilem_seen++, RExC_extralen += 3;
8612                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
8613             }
8614             ret->flags = 0;
8615
8616             if (min > 0)
8617                 *flagp = WORST;
8618             if (max > 0)
8619                 *flagp |= HASWIDTH;
8620             if (max < min)
8621                 vFAIL("Can't do {n,m} with n > m");
8622             if (!SIZE_ONLY) {
8623                 ARG1_SET(ret, (U16)min);
8624                 ARG2_SET(ret, (U16)max);
8625             }
8626
8627             goto nest_check;
8628         }
8629     }
8630
8631     if (!ISMULT1(op)) {
8632         *flagp = flags;
8633         return(ret);
8634     }
8635
8636 #if 0                           /* Now runtime fix should be reliable. */
8637
8638     /* if this is reinstated, don't forget to put this back into perldiag:
8639
8640             =item Regexp *+ operand could be empty at {#} in regex m/%s/
8641
8642            (F) The part of the regexp subject to either the * or + quantifier
8643            could match an empty string. The {#} shows in the regular
8644            expression about where the problem was discovered.
8645
8646     */
8647
8648     if (!(flags&HASWIDTH) && op != '?')
8649       vFAIL("Regexp *+ operand could be empty");
8650 #endif
8651
8652 #ifdef RE_TRACK_PATTERN_OFFSETS
8653     parse_start = RExC_parse;
8654 #endif
8655     nextchar(pRExC_state);
8656
8657     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
8658
8659     if (op == '*' && (flags&SIMPLE)) {
8660         reginsert(pRExC_state, STAR, ret, depth+1);
8661         ret->flags = 0;
8662         RExC_naughty += 4;
8663     }
8664     else if (op == '*') {
8665         min = 0;
8666         goto do_curly;
8667     }
8668     else if (op == '+' && (flags&SIMPLE)) {
8669         reginsert(pRExC_state, PLUS, ret, depth+1);
8670         ret->flags = 0;
8671         RExC_naughty += 3;
8672     }
8673     else if (op == '+') {
8674         min = 1;
8675         goto do_curly;
8676     }
8677     else if (op == '?') {
8678         min = 0; max = 1;
8679         goto do_curly;
8680     }
8681   nest_check:
8682     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
8683         ckWARN3reg(RExC_parse,
8684                    "%.*s matches null string many times",
8685                    (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
8686                    origparse);
8687     }
8688
8689     if (RExC_parse < RExC_end && *RExC_parse == '?') {
8690         nextchar(pRExC_state);
8691         reginsert(pRExC_state, MINMOD, ret, depth+1);
8692         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
8693     }
8694 #ifndef REG_ALLOW_MINMOD_SUSPEND
8695     else
8696 #endif
8697     if (RExC_parse < RExC_end && *RExC_parse == '+') {
8698         regnode *ender;
8699         nextchar(pRExC_state);
8700         ender = reg_node(pRExC_state, SUCCEED);
8701         REGTAIL(pRExC_state, ret, ender);
8702         reginsert(pRExC_state, SUSPEND, ret, depth+1);
8703         ret->flags = 0;
8704         ender = reg_node(pRExC_state, TAIL);
8705         REGTAIL(pRExC_state, ret, ender);
8706         /*ret= ender;*/
8707     }
8708
8709     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
8710         RExC_parse++;
8711         vFAIL("Nested quantifiers");
8712     }
8713
8714     return(ret);
8715 }
8716
8717
8718 /* reg_namedseq(pRExC_state,UVp, UV depth)
8719    
8720    This is expected to be called by a parser routine that has 
8721    recognized '\N' and needs to handle the rest. RExC_parse is
8722    expected to point at the first char following the N at the time
8723    of the call.
8724
8725    The \N may be inside (indicated by valuep not being NULL) or outside a
8726    character class.
8727
8728    \N may begin either a named sequence, or if outside a character class, mean
8729    to match a non-newline.  For non single-quoted regexes, the tokenizer has
8730    attempted to decide which, and in the case of a named sequence converted it
8731    into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
8732    where c1... are the characters in the sequence.  For single-quoted regexes,
8733    the tokenizer passes the \N sequence through unchanged; this code will not
8734    attempt to determine this nor expand those.  The net effect is that if the
8735    beginning of the passed-in pattern isn't '{U+' or there is no '}', it
8736    signals that this \N occurrence means to match a non-newline.
8737    
8738    Only the \N{U+...} form should occur in a character class, for the same
8739    reason that '.' inside a character class means to just match a period: it
8740    just doesn't make sense.
8741    
8742    If valuep is non-null then it is assumed that we are parsing inside 
8743    of a charclass definition and the first codepoint in the resolved
8744    string is returned via *valuep and the routine will return NULL. 
8745    In this mode if a multichar string is returned from the charnames 
8746    handler, a warning will be issued, and only the first char in the 
8747    sequence will be examined. If the string returned is zero length
8748    then the value of *valuep is undefined and NON-NULL will 
8749    be returned to indicate failure. (This will NOT be a valid pointer 
8750    to a regnode.)
8751    
8752    If valuep is null then it is assumed that we are parsing normal text and a
8753    new EXACT node is inserted into the program containing the resolved string,
8754    and a pointer to the new node is returned.  But if the string is zero length
8755    a NOTHING node is emitted instead.
8756
8757    On success RExC_parse is set to the char following the endbrace.
8758    Parsing failures will generate a fatal error via vFAIL(...)
8759  */
8760 STATIC regnode *
8761 S_reg_namedseq(pTHX_ RExC_state_t *pRExC_state, UV *valuep, I32 *flagp, U32 depth)
8762 {
8763     char * endbrace;    /* '}' following the name */
8764     regnode *ret = NULL;
8765     char* p;
8766
8767     GET_RE_DEBUG_FLAGS_DECL;
8768  
8769     PERL_ARGS_ASSERT_REG_NAMEDSEQ;
8770
8771     GET_RE_DEBUG_FLAGS;
8772
8773     /* The [^\n] meaning of \N ignores spaces and comments under the /x
8774      * modifier.  The other meaning does not */
8775     p = (RExC_flags & RXf_PMf_EXTENDED)
8776         ? regwhite( pRExC_state, RExC_parse )
8777         : RExC_parse;
8778    
8779     /* Disambiguate between \N meaning a named character versus \N meaning
8780      * [^\n].  The former is assumed when it can't be the latter. */
8781     if (*p != '{' || regcurly(p)) {
8782         RExC_parse = p;
8783         if (valuep) {
8784             /* no bare \N in a charclass */
8785             vFAIL("\\N in a character class must be a named character: \\N{...}");
8786         }
8787         nextchar(pRExC_state);
8788         ret = reg_node(pRExC_state, REG_ANY);
8789         *flagp |= HASWIDTH|SIMPLE;
8790         RExC_naughty++;
8791         RExC_parse--;
8792         Set_Node_Length(ret, 1); /* MJD */
8793         return ret;
8794     }
8795
8796     /* Here, we have decided it should be a named sequence */
8797
8798     /* The test above made sure that the next real character is a '{', but
8799      * under the /x modifier, it could be separated by space (or a comment and
8800      * \n) and this is not allowed (for consistency with \x{...} and the
8801      * tokenizer handling of \N{NAME}). */
8802     if (*RExC_parse != '{') {
8803         vFAIL("Missing braces on \\N{}");
8804     }
8805
8806     RExC_parse++;       /* Skip past the '{' */
8807
8808     if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
8809         || ! (endbrace == RExC_parse            /* nothing between the {} */
8810               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked below */
8811                   && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
8812     {
8813         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
8814         vFAIL("\\N{NAME} must be resolved by the lexer");
8815     }
8816
8817     if (endbrace == RExC_parse) {   /* empty: \N{} */
8818         if (! valuep) {
8819             RExC_parse = endbrace + 1;  
8820             return reg_node(pRExC_state,NOTHING);
8821         }
8822
8823         if (SIZE_ONLY) {
8824             ckWARNreg(RExC_parse,
8825                     "Ignoring zero length \\N{} in character class"
8826             );
8827             RExC_parse = endbrace + 1;  
8828         }
8829         *valuep = 0;
8830         return (regnode *) &RExC_parse; /* Invalid regnode pointer */
8831     }
8832
8833     REQUIRE_UTF8;       /* named sequences imply Unicode semantics */
8834     RExC_parse += 2;    /* Skip past the 'U+' */
8835
8836     if (valuep) {   /* In a bracketed char class */
8837         /* We only pay attention to the first char of 
8838         multichar strings being returned. I kinda wonder
8839         if this makes sense as it does change the behaviour
8840         from earlier versions, OTOH that behaviour was broken
8841         as well. XXX Solution is to recharacterize as
8842         [rest-of-class]|multi1|multi2... */
8843
8844         STRLEN length_of_hex;
8845         I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
8846             | PERL_SCAN_DISALLOW_PREFIX
8847             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
8848     
8849         char * endchar = RExC_parse + strcspn(RExC_parse, ".}");
8850         if (endchar < endbrace) {
8851             ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
8852         }
8853
8854         length_of_hex = (STRLEN)(endchar - RExC_parse);
8855         *valuep = grok_hex(RExC_parse, &length_of_hex, &flags, NULL);
8856
8857         /* The tokenizer should have guaranteed validity, but it's possible to
8858          * bypass it by using single quoting, so check */
8859         if (length_of_hex == 0
8860             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
8861         {
8862             RExC_parse += length_of_hex;        /* Includes all the valid */
8863             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
8864                             ? UTF8SKIP(RExC_parse)
8865                             : 1;
8866             /* Guard against malformed utf8 */
8867             if (RExC_parse >= endchar) RExC_parse = endchar;
8868             vFAIL("Invalid hexadecimal number in \\N{U+...}");
8869         }    
8870
8871         RExC_parse = endbrace + 1;
8872         if (endchar == endbrace) return NULL;
8873
8874         ret = (regnode *) &RExC_parse;  /* Invalid regnode pointer */
8875     }
8876     else {      /* Not a char class */
8877
8878         /* What is done here is to convert this to a sub-pattern of the form
8879          * (?:\x{char1}\x{char2}...)
8880          * and then call reg recursively.  That way, it retains its atomicness,
8881          * while not having to worry about special handling that some code
8882          * points may have.  toke.c has converted the original Unicode values
8883          * to native, so that we can just pass on the hex values unchanged.  We
8884          * do have to set a flag to keep recoding from happening in the
8885          * recursion */
8886
8887         SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
8888         STRLEN len;
8889         char *endchar;      /* Points to '.' or '}' ending cur char in the input
8890                                stream */
8891         char *orig_end = RExC_end;
8892
8893         while (RExC_parse < endbrace) {
8894
8895             /* Code points are separated by dots.  If none, there is only one
8896              * code point, and is terminated by the brace */
8897             endchar = RExC_parse + strcspn(RExC_parse, ".}");
8898
8899             /* Convert to notation the rest of the code understands */
8900             sv_catpv(substitute_parse, "\\x{");
8901             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
8902             sv_catpv(substitute_parse, "}");
8903
8904             /* Point to the beginning of the next character in the sequence. */
8905             RExC_parse = endchar + 1;
8906         }
8907         sv_catpv(substitute_parse, ")");
8908
8909         RExC_parse = SvPV(substitute_parse, len);
8910
8911         /* Don't allow empty number */
8912         if (len < 8) {
8913             vFAIL("Invalid hexadecimal number in \\N{U+...}");
8914         }
8915         RExC_end = RExC_parse + len;
8916
8917         /* The values are Unicode, and therefore not subject to recoding */
8918         RExC_override_recoding = 1;
8919
8920         ret = reg(pRExC_state, 1, flagp, depth+1);
8921
8922         RExC_parse = endbrace;
8923         RExC_end = orig_end;
8924         RExC_override_recoding = 0;
8925
8926         nextchar(pRExC_state);
8927     }
8928
8929     return ret;
8930 }
8931
8932
8933 /*
8934  * reg_recode
8935  *
8936  * It returns the code point in utf8 for the value in *encp.
8937  *    value: a code value in the source encoding
8938  *    encp:  a pointer to an Encode object
8939  *
8940  * If the result from Encode is not a single character,
8941  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
8942  */
8943 STATIC UV
8944 S_reg_recode(pTHX_ const char value, SV **encp)
8945 {
8946     STRLEN numlen = 1;
8947     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
8948     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
8949     const STRLEN newlen = SvCUR(sv);
8950     UV uv = UNICODE_REPLACEMENT;
8951
8952     PERL_ARGS_ASSERT_REG_RECODE;
8953
8954     if (newlen)
8955         uv = SvUTF8(sv)
8956              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
8957              : *(U8*)s;
8958
8959     if (!newlen || numlen != newlen) {
8960         uv = UNICODE_REPLACEMENT;
8961         *encp = NULL;
8962     }
8963     return uv;
8964 }
8965
8966
8967 /*
8968  - regatom - the lowest level
8969
8970    Try to identify anything special at the start of the pattern. If there
8971    is, then handle it as required. This may involve generating a single regop,
8972    such as for an assertion; or it may involve recursing, such as to
8973    handle a () structure.
8974
8975    If the string doesn't start with something special then we gobble up
8976    as much literal text as we can.
8977
8978    Once we have been able to handle whatever type of thing started the
8979    sequence, we return.
8980
8981    Note: we have to be careful with escapes, as they can be both literal
8982    and special, and in the case of \10 and friends can either, depending
8983    on context. Specifically there are two separate switches for handling
8984    escape sequences, with the one for handling literal escapes requiring
8985    a dummy entry for all of the special escapes that are actually handled
8986    by the other.
8987 */
8988
8989 STATIC regnode *
8990 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
8991 {
8992     dVAR;
8993     register regnode *ret = NULL;
8994     I32 flags;
8995     char *parse_start = RExC_parse;
8996     U8 op;
8997     GET_RE_DEBUG_FLAGS_DECL;
8998     DEBUG_PARSE("atom");
8999     *flagp = WORST;             /* Tentatively. */
9000
9001     PERL_ARGS_ASSERT_REGATOM;
9002
9003 tryagain:
9004     switch ((U8)*RExC_parse) {
9005     case '^':
9006         RExC_seen_zerolen++;
9007         nextchar(pRExC_state);
9008         if (RExC_flags & RXf_PMf_MULTILINE)
9009             ret = reg_node(pRExC_state, MBOL);
9010         else if (RExC_flags & RXf_PMf_SINGLELINE)
9011             ret = reg_node(pRExC_state, SBOL);
9012         else
9013             ret = reg_node(pRExC_state, BOL);
9014         Set_Node_Length(ret, 1); /* MJD */
9015         break;
9016     case '$':
9017         nextchar(pRExC_state);
9018         if (*RExC_parse)
9019             RExC_seen_zerolen++;
9020         if (RExC_flags & RXf_PMf_MULTILINE)
9021             ret = reg_node(pRExC_state, MEOL);
9022         else if (RExC_flags & RXf_PMf_SINGLELINE)
9023             ret = reg_node(pRExC_state, SEOL);
9024         else
9025             ret = reg_node(pRExC_state, EOL);
9026         Set_Node_Length(ret, 1); /* MJD */
9027         break;
9028     case '.':
9029         nextchar(pRExC_state);
9030         if (RExC_flags & RXf_PMf_SINGLELINE)
9031             ret = reg_node(pRExC_state, SANY);
9032         else
9033             ret = reg_node(pRExC_state, REG_ANY);
9034         *flagp |= HASWIDTH|SIMPLE;
9035         RExC_naughty++;
9036         Set_Node_Length(ret, 1); /* MJD */
9037         break;
9038     case '[':
9039     {
9040         char * const oregcomp_parse = ++RExC_parse;
9041         ret = regclass(pRExC_state,depth+1);
9042         if (*RExC_parse != ']') {
9043             RExC_parse = oregcomp_parse;
9044             vFAIL("Unmatched [");
9045         }
9046         nextchar(pRExC_state);
9047         *flagp |= HASWIDTH|SIMPLE;
9048         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
9049         break;
9050     }
9051     case '(':
9052         nextchar(pRExC_state);
9053         ret = reg(pRExC_state, 1, &flags,depth+1);
9054         if (ret == NULL) {
9055                 if (flags & TRYAGAIN) {
9056                     if (RExC_parse == RExC_end) {
9057                          /* Make parent create an empty node if needed. */
9058                         *flagp |= TRYAGAIN;
9059                         return(NULL);
9060                     }
9061                     goto tryagain;
9062                 }
9063                 return(NULL);
9064         }
9065         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
9066         break;
9067     case '|':
9068     case ')':
9069         if (flags & TRYAGAIN) {
9070             *flagp |= TRYAGAIN;
9071             return NULL;
9072         }
9073         vFAIL("Internal urp");
9074                                 /* Supposed to be caught earlier. */
9075         break;
9076     case '{':
9077         if (!regcurly(RExC_parse)) {
9078             RExC_parse++;
9079             goto defchar;
9080         }
9081         /* FALL THROUGH */
9082     case '?':
9083     case '+':
9084     case '*':
9085         RExC_parse++;
9086         vFAIL("Quantifier follows nothing");
9087         break;
9088     case '\\':
9089         /* Special Escapes
9090
9091            This switch handles escape sequences that resolve to some kind
9092            of special regop and not to literal text. Escape sequnces that
9093            resolve to literal text are handled below in the switch marked
9094            "Literal Escapes".
9095
9096            Every entry in this switch *must* have a corresponding entry
9097            in the literal escape switch. However, the opposite is not
9098            required, as the default for this switch is to jump to the
9099            literal text handling code.
9100         */
9101         switch ((U8)*++RExC_parse) {
9102         /* Special Escapes */
9103         case 'A':
9104             RExC_seen_zerolen++;
9105             ret = reg_node(pRExC_state, SBOL);
9106             *flagp |= SIMPLE;
9107             goto finish_meta_pat;
9108         case 'G':
9109             ret = reg_node(pRExC_state, GPOS);
9110             RExC_seen |= REG_SEEN_GPOS;
9111             *flagp |= SIMPLE;
9112             goto finish_meta_pat;
9113         case 'K':
9114             RExC_seen_zerolen++;
9115             ret = reg_node(pRExC_state, KEEPS);
9116             *flagp |= SIMPLE;
9117             /* XXX:dmq : disabling in-place substitution seems to
9118              * be necessary here to avoid cases of memory corruption, as
9119              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
9120              */
9121             RExC_seen |= REG_SEEN_LOOKBEHIND;
9122             goto finish_meta_pat;
9123         case 'Z':
9124             ret = reg_node(pRExC_state, SEOL);
9125             *flagp |= SIMPLE;
9126             RExC_seen_zerolen++;                /* Do not optimize RE away */
9127             goto finish_meta_pat;
9128         case 'z':
9129             ret = reg_node(pRExC_state, EOS);
9130             *flagp |= SIMPLE;
9131             RExC_seen_zerolen++;                /* Do not optimize RE away */
9132             goto finish_meta_pat;
9133         case 'C':
9134             ret = reg_node(pRExC_state, CANY);
9135             RExC_seen |= REG_SEEN_CANY;
9136             *flagp |= HASWIDTH|SIMPLE;
9137             goto finish_meta_pat;
9138         case 'X':
9139             ret = reg_node(pRExC_state, CLUMP);
9140             *flagp |= HASWIDTH;
9141             goto finish_meta_pat;
9142         case 'w':
9143             switch (get_regex_charset(RExC_flags)) {
9144                 case REGEX_LOCALE_CHARSET:
9145                     op = ALNUML;
9146                     break;
9147                 case REGEX_UNICODE_CHARSET:
9148                     op = ALNUMU;
9149                     break;
9150                 case REGEX_ASCII_RESTRICTED_CHARSET:
9151                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9152                     op = ALNUMA;
9153                     break;
9154                 case REGEX_DEPENDS_CHARSET:
9155                     op = ALNUM;
9156                     break;
9157                 default:
9158                     goto bad_charset;
9159             }
9160             ret = reg_node(pRExC_state, op);
9161             *flagp |= HASWIDTH|SIMPLE;
9162             goto finish_meta_pat;
9163         case 'W':
9164             switch (get_regex_charset(RExC_flags)) {
9165                 case REGEX_LOCALE_CHARSET:
9166                     op = NALNUML;
9167                     break;
9168                 case REGEX_UNICODE_CHARSET:
9169                     op = NALNUMU;
9170                     break;
9171                 case REGEX_ASCII_RESTRICTED_CHARSET:
9172                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9173                     op = NALNUMA;
9174                     break;
9175                 case REGEX_DEPENDS_CHARSET:
9176                     op = NALNUM;
9177                     break;
9178                 default:
9179                     goto bad_charset;
9180             }
9181             ret = reg_node(pRExC_state, op);
9182             *flagp |= HASWIDTH|SIMPLE;
9183             goto finish_meta_pat;
9184         case 'b':
9185             RExC_seen_zerolen++;
9186             RExC_seen |= REG_SEEN_LOOKBEHIND;
9187             switch (get_regex_charset(RExC_flags)) {
9188                 case REGEX_LOCALE_CHARSET:
9189                     op = BOUNDL;
9190                     break;
9191                 case REGEX_UNICODE_CHARSET:
9192                     op = BOUNDU;
9193                     break;
9194                 case REGEX_ASCII_RESTRICTED_CHARSET:
9195                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9196                     op = BOUNDA;
9197                     break;
9198                 case REGEX_DEPENDS_CHARSET:
9199                     op = BOUND;
9200                     break;
9201                 default:
9202                     goto bad_charset;
9203             }
9204             ret = reg_node(pRExC_state, op);
9205             FLAGS(ret) = get_regex_charset(RExC_flags);
9206             *flagp |= SIMPLE;
9207             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
9208                 ckWARNregdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" instead");
9209             }
9210             goto finish_meta_pat;
9211         case 'B':
9212             RExC_seen_zerolen++;
9213             RExC_seen |= REG_SEEN_LOOKBEHIND;
9214             switch (get_regex_charset(RExC_flags)) {
9215                 case REGEX_LOCALE_CHARSET:
9216                     op = NBOUNDL;
9217                     break;
9218                 case REGEX_UNICODE_CHARSET:
9219                     op = NBOUNDU;
9220                     break;
9221                 case REGEX_ASCII_RESTRICTED_CHARSET:
9222                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9223                     op = NBOUNDA;
9224                     break;
9225                 case REGEX_DEPENDS_CHARSET:
9226                     op = NBOUND;
9227                     break;
9228                 default:
9229                     goto bad_charset;
9230             }
9231             ret = reg_node(pRExC_state, op);
9232             FLAGS(ret) = get_regex_charset(RExC_flags);
9233             *flagp |= SIMPLE;
9234             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
9235                 ckWARNregdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" instead");
9236             }
9237             goto finish_meta_pat;
9238         case 's':
9239             switch (get_regex_charset(RExC_flags)) {
9240                 case REGEX_LOCALE_CHARSET:
9241                     op = SPACEL;
9242                     break;
9243                 case REGEX_UNICODE_CHARSET:
9244                     op = SPACEU;
9245                     break;
9246                 case REGEX_ASCII_RESTRICTED_CHARSET:
9247                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9248                     op = SPACEA;
9249                     break;
9250                 case REGEX_DEPENDS_CHARSET:
9251                     op = SPACE;
9252                     break;
9253                 default:
9254                     goto bad_charset;
9255             }
9256             ret = reg_node(pRExC_state, op);
9257             *flagp |= HASWIDTH|SIMPLE;
9258             goto finish_meta_pat;
9259         case 'S':
9260             switch (get_regex_charset(RExC_flags)) {
9261                 case REGEX_LOCALE_CHARSET:
9262                     op = NSPACEL;
9263                     break;
9264                 case REGEX_UNICODE_CHARSET:
9265                     op = NSPACEU;
9266                     break;
9267                 case REGEX_ASCII_RESTRICTED_CHARSET:
9268                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9269                     op = NSPACEA;
9270                     break;
9271                 case REGEX_DEPENDS_CHARSET:
9272                     op = NSPACE;
9273                     break;
9274                 default:
9275                     goto bad_charset;
9276             }
9277             ret = reg_node(pRExC_state, op);
9278             *flagp |= HASWIDTH|SIMPLE;
9279             goto finish_meta_pat;
9280         case 'd':
9281             switch (get_regex_charset(RExC_flags)) {
9282                 case REGEX_LOCALE_CHARSET:
9283                     op = DIGITL;
9284                     break;
9285                 case REGEX_ASCII_RESTRICTED_CHARSET:
9286                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9287                     op = DIGITA;
9288                     break;
9289                 case REGEX_DEPENDS_CHARSET: /* No difference between these */
9290                 case REGEX_UNICODE_CHARSET:
9291                     op = DIGIT;
9292                     break;
9293                 default:
9294                     goto bad_charset;
9295             }
9296             ret = reg_node(pRExC_state, op);
9297             *flagp |= HASWIDTH|SIMPLE;
9298             goto finish_meta_pat;
9299         case 'D':
9300             switch (get_regex_charset(RExC_flags)) {
9301                 case REGEX_LOCALE_CHARSET:
9302                     op = NDIGITL;
9303                     break;
9304                 case REGEX_ASCII_RESTRICTED_CHARSET:
9305                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9306                     op = NDIGITA;
9307                     break;
9308                 case REGEX_DEPENDS_CHARSET: /* No difference between these */
9309                 case REGEX_UNICODE_CHARSET:
9310                     op = NDIGIT;
9311                     break;
9312                 default:
9313                     goto bad_charset;
9314             }
9315             ret = reg_node(pRExC_state, op);
9316             *flagp |= HASWIDTH|SIMPLE;
9317             goto finish_meta_pat;
9318         case 'R':
9319             ret = reg_node(pRExC_state, LNBREAK);
9320             *flagp |= HASWIDTH|SIMPLE;
9321             goto finish_meta_pat;
9322         case 'h':
9323             ret = reg_node(pRExC_state, HORIZWS);
9324             *flagp |= HASWIDTH|SIMPLE;
9325             goto finish_meta_pat;
9326         case 'H':
9327             ret = reg_node(pRExC_state, NHORIZWS);
9328             *flagp |= HASWIDTH|SIMPLE;
9329             goto finish_meta_pat;
9330         case 'v':
9331             ret = reg_node(pRExC_state, VERTWS);
9332             *flagp |= HASWIDTH|SIMPLE;
9333             goto finish_meta_pat;
9334         case 'V':
9335             ret = reg_node(pRExC_state, NVERTWS);
9336             *flagp |= HASWIDTH|SIMPLE;
9337          finish_meta_pat:           
9338             nextchar(pRExC_state);
9339             Set_Node_Length(ret, 2); /* MJD */
9340             break;          
9341         case 'p':
9342         case 'P':
9343             {
9344                 char* const oldregxend = RExC_end;
9345 #ifdef DEBUGGING
9346                 char* parse_start = RExC_parse - 2;
9347 #endif
9348
9349                 if (RExC_parse[1] == '{') {
9350                   /* a lovely hack--pretend we saw [\pX] instead */
9351                     RExC_end = strchr(RExC_parse, '}');
9352                     if (!RExC_end) {
9353                         const U8 c = (U8)*RExC_parse;
9354                         RExC_parse += 2;
9355                         RExC_end = oldregxend;
9356                         vFAIL2("Missing right brace on \\%c{}", c);
9357                     }
9358                     RExC_end++;
9359                 }
9360                 else {
9361                     RExC_end = RExC_parse + 2;
9362                     if (RExC_end > oldregxend)
9363                         RExC_end = oldregxend;
9364                 }
9365                 RExC_parse--;
9366
9367                 ret = regclass(pRExC_state,depth+1);
9368
9369                 RExC_end = oldregxend;
9370                 RExC_parse--;
9371
9372                 Set_Node_Offset(ret, parse_start + 2);
9373                 Set_Node_Cur_Length(ret);
9374                 nextchar(pRExC_state);
9375                 *flagp |= HASWIDTH|SIMPLE;
9376             }
9377             break;
9378         case 'N': 
9379             /* Handle \N and \N{NAME} here and not below because it can be
9380             multicharacter. join_exact() will join them up later on. 
9381             Also this makes sure that things like /\N{BLAH}+/ and 
9382             \N{BLAH} being multi char Just Happen. dmq*/
9383             ++RExC_parse;
9384             ret= reg_namedseq(pRExC_state, NULL, flagp, depth);
9385             break;
9386         case 'k':    /* Handle \k<NAME> and \k'NAME' */
9387         parse_named_seq:
9388         {   
9389             char ch= RExC_parse[1];         
9390             if (ch != '<' && ch != '\'' && ch != '{') {
9391                 RExC_parse++;
9392                 vFAIL2("Sequence %.2s... not terminated",parse_start);
9393             } else {
9394                 /* this pretty much dupes the code for (?P=...) in reg(), if
9395                    you change this make sure you change that */
9396                 char* name_start = (RExC_parse += 2);
9397                 U32 num = 0;
9398                 SV *sv_dat = reg_scan_name(pRExC_state,
9399                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9400                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
9401                 if (RExC_parse == name_start || *RExC_parse != ch)
9402                     vFAIL2("Sequence %.3s... not terminated",parse_start);
9403
9404                 if (!SIZE_ONLY) {
9405                     num = add_data( pRExC_state, 1, "S" );
9406                     RExC_rxi->data->data[num]=(void*)sv_dat;
9407                     SvREFCNT_inc_simple_void(sv_dat);
9408                 }
9409
9410                 RExC_sawback = 1;
9411                 ret = reganode(pRExC_state,
9412                                ((! FOLD)
9413                                  ? NREF
9414                                  : (MORE_ASCII_RESTRICTED)
9415                                    ? NREFFA
9416                                    : (AT_LEAST_UNI_SEMANTICS)
9417                                      ? NREFFU
9418                                      : (LOC)
9419                                        ? NREFFL
9420                                        : NREFF),
9421                                 num);
9422                 *flagp |= HASWIDTH;
9423
9424                 /* override incorrect value set in reganode MJD */
9425                 Set_Node_Offset(ret, parse_start+1);
9426                 Set_Node_Cur_Length(ret); /* MJD */
9427                 nextchar(pRExC_state);
9428
9429             }
9430             break;
9431         }
9432         case 'g': 
9433         case '1': case '2': case '3': case '4':
9434         case '5': case '6': case '7': case '8': case '9':
9435             {
9436                 I32 num;
9437                 bool isg = *RExC_parse == 'g';
9438                 bool isrel = 0; 
9439                 bool hasbrace = 0;
9440                 if (isg) {
9441                     RExC_parse++;
9442                     if (*RExC_parse == '{') {
9443                         RExC_parse++;
9444                         hasbrace = 1;
9445                     }
9446                     if (*RExC_parse == '-') {
9447                         RExC_parse++;
9448                         isrel = 1;
9449                     }
9450                     if (hasbrace && !isDIGIT(*RExC_parse)) {
9451                         if (isrel) RExC_parse--;
9452                         RExC_parse -= 2;                            
9453                         goto parse_named_seq;
9454                 }   }
9455                 num = atoi(RExC_parse);
9456                 if (isg && num == 0)
9457                     vFAIL("Reference to invalid group 0");
9458                 if (isrel) {
9459                     num = RExC_npar - num;
9460                     if (num < 1)
9461                         vFAIL("Reference to nonexistent or unclosed group");
9462                 }
9463                 if (!isg && num > 9 && num >= RExC_npar)
9464                     goto defchar;
9465                 else {
9466                     char * const parse_start = RExC_parse - 1; /* MJD */
9467                     while (isDIGIT(*RExC_parse))
9468                         RExC_parse++;
9469                     if (parse_start == RExC_parse - 1) 
9470                         vFAIL("Unterminated \\g... pattern");
9471                     if (hasbrace) {
9472                         if (*RExC_parse != '}') 
9473                             vFAIL("Unterminated \\g{...} pattern");
9474                         RExC_parse++;
9475                     }    
9476                     if (!SIZE_ONLY) {
9477                         if (num > (I32)RExC_rx->nparens)
9478                             vFAIL("Reference to nonexistent group");
9479                     }
9480                     RExC_sawback = 1;
9481                     ret = reganode(pRExC_state,
9482                                    ((! FOLD)
9483                                      ? REF
9484                                      : (MORE_ASCII_RESTRICTED)
9485                                        ? REFFA
9486                                        : (AT_LEAST_UNI_SEMANTICS)
9487                                          ? REFFU
9488                                          : (LOC)
9489                                            ? REFFL
9490                                            : REFF),
9491                                     num);
9492                     *flagp |= HASWIDTH;
9493
9494                     /* override incorrect value set in reganode MJD */
9495                     Set_Node_Offset(ret, parse_start+1);
9496                     Set_Node_Cur_Length(ret); /* MJD */
9497                     RExC_parse--;
9498                     nextchar(pRExC_state);
9499                 }
9500             }
9501             break;
9502         case '\0':
9503             if (RExC_parse >= RExC_end)
9504                 FAIL("Trailing \\");
9505             /* FALL THROUGH */
9506         default:
9507             /* Do not generate "unrecognized" warnings here, we fall
9508                back into the quick-grab loop below */
9509             parse_start--;
9510             goto defchar;
9511         }
9512         break;
9513
9514     case '#':
9515         if (RExC_flags & RXf_PMf_EXTENDED) {
9516             if ( reg_skipcomment( pRExC_state ) )
9517                 goto tryagain;
9518         }
9519         /* FALL THROUGH */
9520
9521     default:
9522
9523             parse_start = RExC_parse - 1;
9524
9525             RExC_parse++;
9526
9527         defchar: {
9528             register STRLEN len;
9529             register UV ender;
9530             register char *p;
9531             char *s;
9532             STRLEN foldlen;
9533             U8 tmpbuf[UTF8_MAXBYTES_CASE+1], *foldbuf;
9534             U8 node_type;
9535
9536             /* Is this a LATIN LOWER CASE SHARP S in an EXACTFU node?  If so,
9537              * it is folded to 'ss' even if not utf8 */
9538             bool is_exactfu_sharp_s;
9539
9540             ender = 0;
9541             node_type = ((! FOLD) ? EXACT
9542                         : (LOC)
9543                           ? EXACTFL
9544                           : (MORE_ASCII_RESTRICTED)
9545                             ? EXACTFA
9546                             : (AT_LEAST_UNI_SEMANTICS)
9547                               ? EXACTFU
9548                               : EXACTF);
9549             ret = reg_node(pRExC_state, node_type);
9550             s = STRING(ret);
9551
9552             /* XXX The node can hold up to 255 bytes, yet this only goes to
9553              * 127.  I (khw) do not know why.  Keeping it somewhat less than
9554              * 255 allows us to not have to worry about overflow due to
9555              * converting to utf8 and fold expansion, but that value is
9556              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
9557              * split up by this limit into a single one using the real max of
9558              * 255.  Even at 127, this breaks under rare circumstances.  If
9559              * folding, we do not want to split a node at a character that is a
9560              * non-final in a multi-char fold, as an input string could just
9561              * happen to want to match across the node boundary.  The join
9562              * would solve that problem if the join actually happens.  But a
9563              * series of more than two nodes in a row each of 127 would cause
9564              * the first join to succeed to get to 254, but then there wouldn't
9565              * be room for the next one, which could at be one of those split
9566              * multi-char folds.  I don't know of any fool-proof solution.  One
9567              * could back off to end with only a code point that isn't such a
9568              * non-final, but it is possible for there not to be any in the
9569              * entire node. */
9570             for (len = 0, p = RExC_parse - 1;
9571                  len < 127 && p < RExC_end;
9572                  len++)
9573             {
9574                 char * const oldp = p;
9575
9576                 if (RExC_flags & RXf_PMf_EXTENDED)
9577                     p = regwhite( pRExC_state, p );
9578                 switch ((U8)*p) {
9579                 case '^':
9580                 case '$':
9581                 case '.':
9582                 case '[':
9583                 case '(':
9584                 case ')':
9585                 case '|':
9586                     goto loopdone;
9587                 case '\\':
9588                     /* Literal Escapes Switch
9589
9590                        This switch is meant to handle escape sequences that
9591                        resolve to a literal character.
9592
9593                        Every escape sequence that represents something
9594                        else, like an assertion or a char class, is handled
9595                        in the switch marked 'Special Escapes' above in this
9596                        routine, but also has an entry here as anything that
9597                        isn't explicitly mentioned here will be treated as
9598                        an unescaped equivalent literal.
9599                     */
9600
9601                     switch ((U8)*++p) {
9602                     /* These are all the special escapes. */
9603                     case 'A':             /* Start assertion */
9604                     case 'b': case 'B':   /* Word-boundary assertion*/
9605                     case 'C':             /* Single char !DANGEROUS! */
9606                     case 'd': case 'D':   /* digit class */
9607                     case 'g': case 'G':   /* generic-backref, pos assertion */
9608                     case 'h': case 'H':   /* HORIZWS */
9609                     case 'k': case 'K':   /* named backref, keep marker */
9610                     case 'N':             /* named char sequence */
9611                     case 'p': case 'P':   /* Unicode property */
9612                               case 'R':   /* LNBREAK */
9613                     case 's': case 'S':   /* space class */
9614                     case 'v': case 'V':   /* VERTWS */
9615                     case 'w': case 'W':   /* word class */
9616                     case 'X':             /* eXtended Unicode "combining character sequence" */
9617                     case 'z': case 'Z':   /* End of line/string assertion */
9618                         --p;
9619                         goto loopdone;
9620
9621                     /* Anything after here is an escape that resolves to a
9622                        literal. (Except digits, which may or may not)
9623                      */
9624                     case 'n':
9625                         ender = '\n';
9626                         p++;
9627                         break;
9628                     case 'r':
9629                         ender = '\r';
9630                         p++;
9631                         break;
9632                     case 't':
9633                         ender = '\t';
9634                         p++;
9635                         break;
9636                     case 'f':
9637                         ender = '\f';
9638                         p++;
9639                         break;
9640                     case 'e':
9641                           ender = ASCII_TO_NATIVE('\033');
9642                         p++;
9643                         break;
9644                     case 'a':
9645                           ender = ASCII_TO_NATIVE('\007');
9646                         p++;
9647                         break;
9648                     case 'o':
9649                         {
9650                             STRLEN brace_len = len;
9651                             UV result;
9652                             const char* error_msg;
9653
9654                             bool valid = grok_bslash_o(p,
9655                                                        &result,
9656                                                        &brace_len,
9657                                                        &error_msg,
9658                                                        1);
9659                             p += brace_len;
9660                             if (! valid) {
9661                                 RExC_parse = p; /* going to die anyway; point
9662                                                    to exact spot of failure */
9663                                 vFAIL(error_msg);
9664                             }
9665                             else
9666                             {
9667                                 ender = result;
9668                             }
9669                             if (PL_encoding && ender < 0x100) {
9670                                 goto recode_encoding;
9671                             }
9672                             if (ender > 0xff) {
9673                                 REQUIRE_UTF8;
9674                             }
9675                             break;
9676                         }
9677                     case 'x':
9678                         if (*++p == '{') {
9679                             char* const e = strchr(p, '}');
9680
9681                             if (!e) {
9682                                 RExC_parse = p + 1;
9683                                 vFAIL("Missing right brace on \\x{}");
9684                             }
9685                             else {
9686                                 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
9687                                     | PERL_SCAN_DISALLOW_PREFIX;
9688                                 STRLEN numlen = e - p - 1;
9689                                 ender = grok_hex(p + 1, &numlen, &flags, NULL);
9690                                 if (ender > 0xff)
9691                                     REQUIRE_UTF8;
9692                                 p = e + 1;
9693                             }
9694                         }
9695                         else {
9696                             I32 flags = PERL_SCAN_DISALLOW_PREFIX;
9697                             STRLEN numlen = 2;
9698                             ender = grok_hex(p, &numlen, &flags, NULL);
9699                             p += numlen;
9700                         }
9701                         if (PL_encoding && ender < 0x100)
9702                             goto recode_encoding;
9703                         break;
9704                     case 'c':
9705                         p++;
9706                         ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
9707                         break;
9708                     case '0': case '1': case '2': case '3':case '4':
9709                     case '5': case '6': case '7': case '8':case '9':
9710                         if (*p == '0' ||
9711                             (isDIGIT(p[1]) && atoi(p) >= RExC_npar))
9712                         {
9713                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
9714                             STRLEN numlen = 3;
9715                             ender = grok_oct(p, &numlen, &flags, NULL);
9716                             if (ender > 0xff) {
9717                                 REQUIRE_UTF8;
9718                             }
9719                             p += numlen;
9720                         }
9721                         else {
9722                             --p;
9723                             goto loopdone;
9724                         }
9725                         if (PL_encoding && ender < 0x100)
9726                             goto recode_encoding;
9727                         break;
9728                     recode_encoding:
9729                         if (! RExC_override_recoding) {
9730                             SV* enc = PL_encoding;
9731                             ender = reg_recode((const char)(U8)ender, &enc);
9732                             if (!enc && SIZE_ONLY)
9733                                 ckWARNreg(p, "Invalid escape in the specified encoding");
9734                             REQUIRE_UTF8;
9735                         }
9736                         break;
9737                     case '\0':
9738                         if (p >= RExC_end)
9739                             FAIL("Trailing \\");
9740                         /* FALL THROUGH */
9741                     default:
9742                         if (!SIZE_ONLY&& isALPHA(*p)) {
9743                             /* Include any { following the alpha to emphasize
9744                              * that it could be part of an escape at some point
9745                              * in the future */
9746                             int len = (*(p + 1) == '{') ? 2 : 1;
9747                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
9748                         }
9749                         goto normal_default;
9750                     }
9751                     break;
9752                 default:
9753                   normal_default:
9754                     if (UTF8_IS_START(*p) && UTF) {
9755                         STRLEN numlen;
9756                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
9757                                                &numlen, UTF8_ALLOW_DEFAULT);
9758                         p += numlen;
9759                     }
9760                     else
9761                         ender = (U8) *p++;
9762                     break;
9763                 } /* End of switch on the literal */
9764
9765                 is_exactfu_sharp_s = (node_type == EXACTFU
9766                                       && ender == LATIN_SMALL_LETTER_SHARP_S);
9767                 if ( RExC_flags & RXf_PMf_EXTENDED)
9768                     p = regwhite( pRExC_state, p );
9769                 if ((UTF && FOLD) || is_exactfu_sharp_s) {
9770                     /* Prime the casefolded buffer.  Locale rules, which apply
9771                      * only to code points < 256, aren't known until execution,
9772                      * so for them, just output the original character using
9773                      * utf8.  If we start to fold non-UTF patterns, be sure to
9774                      * update join_exact() */
9775                     if (LOC && ender < 256) {
9776                         if (UNI_IS_INVARIANT(ender)) {
9777                             *tmpbuf = (U8) ender;
9778                             foldlen = 1;
9779                         } else {
9780                             *tmpbuf = UTF8_TWO_BYTE_HI(ender);
9781                             *(tmpbuf + 1) = UTF8_TWO_BYTE_LO(ender);
9782                             foldlen = 2;
9783                         }
9784                     }
9785                     else if (isASCII(ender)) {  /* Note: Here can't also be LOC
9786                                                  */
9787                         ender = toLOWER(ender);
9788                         *tmpbuf = (U8) ender;
9789                         foldlen = 1;
9790                     }
9791                     else if (! MORE_ASCII_RESTRICTED && ! LOC) {
9792
9793                         /* Locale and /aa require more selectivity about the
9794                          * fold, so are handled below.  Otherwise, here, just
9795                          * use the fold */
9796                         ender = toFOLD_uni(ender, tmpbuf, &foldlen);
9797                     }
9798                     else {
9799                         /* Under locale rules or /aa we are not to mix,
9800                          * respectively, ords < 256 or ASCII with non-.  So
9801                          * reject folds that mix them, using only the
9802                          * non-folded code point.  So do the fold to a
9803                          * temporary, and inspect each character in it. */
9804                         U8 trialbuf[UTF8_MAXBYTES_CASE+1];
9805                         U8* s = trialbuf;
9806                         UV tmpender = toFOLD_uni(ender, trialbuf, &foldlen);
9807                         U8* e = s + foldlen;
9808                         bool fold_ok = TRUE;
9809
9810                         while (s < e) {
9811                             if (isASCII(*s)
9812                                 || (LOC && (UTF8_IS_INVARIANT(*s)
9813                                            || UTF8_IS_DOWNGRADEABLE_START(*s))))
9814                             {
9815                                 fold_ok = FALSE;
9816                                 break;
9817                             }
9818                             s += UTF8SKIP(s);
9819                         }
9820                         if (fold_ok) {
9821                             Copy(trialbuf, tmpbuf, foldlen, U8);
9822                             ender = tmpender;
9823                         }
9824                         else {
9825                             uvuni_to_utf8(tmpbuf, ender);
9826                             foldlen = UNISKIP(ender);
9827                         }
9828                     }
9829                 }
9830                 if (p < RExC_end && ISMULT2(p)) { /* Back off on ?+*. */
9831                     if (len)
9832                         p = oldp;
9833                     else if (UTF || is_exactfu_sharp_s) {
9834                          if (FOLD) {
9835                               /* Emit all the Unicode characters. */
9836                               STRLEN numlen;
9837                               for (foldbuf = tmpbuf;
9838                                    foldlen;
9839                                    foldlen -= numlen) {
9840
9841                                    /* tmpbuf has been constructed by us, so we
9842                                     * know it is valid utf8 */
9843                                    ender = valid_utf8_to_uvchr(foldbuf, &numlen);
9844                                    if (numlen > 0) {
9845                                         const STRLEN unilen = reguni(pRExC_state, ender, s);
9846                                         s       += unilen;
9847                                         len     += unilen;
9848                                         /* In EBCDIC the numlen
9849                                          * and unilen can differ. */
9850                                         foldbuf += numlen;
9851                                         if (numlen >= foldlen)
9852                                              break;
9853                                    }
9854                                    else
9855                                         break; /* "Can't happen." */
9856                               }
9857                          }
9858                          else {
9859                               const STRLEN unilen = reguni(pRExC_state, ender, s);
9860                               if (unilen > 0) {
9861                                    s   += unilen;
9862                                    len += unilen;
9863                               }
9864                          }
9865                     }
9866                     else {
9867                         len++;
9868                         REGC((char)ender, s++);
9869                     }
9870                     break;
9871                 }
9872                 if (UTF || is_exactfu_sharp_s) {
9873                      if (FOLD) {
9874                           /* Emit all the Unicode characters. */
9875                           STRLEN numlen;
9876                           for (foldbuf = tmpbuf;
9877                                foldlen;
9878                                foldlen -= numlen) {
9879                                ender = valid_utf8_to_uvchr(foldbuf, &numlen);
9880                                if (numlen > 0) {
9881                                     const STRLEN unilen = reguni(pRExC_state, ender, s);
9882                                     len     += unilen;
9883                                     s       += unilen;
9884                                     /* In EBCDIC the numlen
9885                                      * and unilen can differ. */
9886                                     foldbuf += numlen;
9887                                     if (numlen >= foldlen)
9888                                          break;
9889                                }
9890                                else
9891                                     break;
9892                           }
9893                      }
9894                      else {
9895                           const STRLEN unilen = reguni(pRExC_state, ender, s);
9896                           if (unilen > 0) {
9897                                s   += unilen;
9898                                len += unilen;
9899                           }
9900                      }
9901                      len--;
9902                 }
9903                 else {
9904                     REGC((char)ender, s++);
9905                 }
9906             }
9907         loopdone:   /* Jumped to when encounters something that shouldn't be in
9908                        the node */
9909             RExC_parse = p - 1;
9910             Set_Node_Cur_Length(ret); /* MJD */
9911             nextchar(pRExC_state);
9912             {
9913                 /* len is STRLEN which is unsigned, need to copy to signed */
9914                 IV iv = len;
9915                 if (iv < 0)
9916                     vFAIL("Internal disaster");
9917             }
9918             if (len > 0)
9919                 *flagp |= HASWIDTH;
9920             if (len == 1 && UNI_IS_INVARIANT(ender))
9921                 *flagp |= SIMPLE;
9922
9923             if (SIZE_ONLY)
9924                 RExC_size += STR_SZ(len);
9925             else {
9926                 STR_LEN(ret) = len;
9927                 RExC_emit += STR_SZ(len);
9928             }
9929         }
9930         break;
9931     }
9932
9933     return(ret);
9934
9935 /* Jumped to when an unrecognized character set is encountered */
9936 bad_charset:
9937     Perl_croak(aTHX_ "panic: Unknown regex character set encoding: %u", get_regex_charset(RExC_flags));
9938     return(NULL);
9939 }
9940
9941 STATIC char *
9942 S_regwhite( RExC_state_t *pRExC_state, char *p )
9943 {
9944     const char *e = RExC_end;
9945
9946     PERL_ARGS_ASSERT_REGWHITE;
9947
9948     while (p < e) {
9949         if (isSPACE(*p))
9950             ++p;
9951         else if (*p == '#') {
9952             bool ended = 0;
9953             do {
9954                 if (*p++ == '\n') {
9955                     ended = 1;
9956                     break;
9957                 }
9958             } while (p < e);
9959             if (!ended)
9960                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
9961         }
9962         else
9963             break;
9964     }
9965     return p;
9966 }
9967
9968 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
9969    Character classes ([:foo:]) can also be negated ([:^foo:]).
9970    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
9971    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
9972    but trigger failures because they are currently unimplemented. */
9973
9974 #define POSIXCC_DONE(c)   ((c) == ':')
9975 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
9976 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
9977
9978 STATIC I32
9979 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value)
9980 {
9981     dVAR;
9982     I32 namedclass = OOB_NAMEDCLASS;
9983
9984     PERL_ARGS_ASSERT_REGPPOSIXCC;
9985
9986     if (value == '[' && RExC_parse + 1 < RExC_end &&
9987         /* I smell either [: or [= or [. -- POSIX has been here, right? */
9988         POSIXCC(UCHARAT(RExC_parse))) {
9989         const char c = UCHARAT(RExC_parse);
9990         char* const s = RExC_parse++;
9991
9992         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
9993             RExC_parse++;
9994         if (RExC_parse == RExC_end)
9995             /* Grandfather lone [:, [=, [. */
9996             RExC_parse = s;
9997         else {
9998             const char* const t = RExC_parse++; /* skip over the c */
9999             assert(*t == c);
10000
10001             if (UCHARAT(RExC_parse) == ']') {
10002                 const char *posixcc = s + 1;
10003                 RExC_parse++; /* skip over the ending ] */
10004
10005                 if (*s == ':') {
10006                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
10007                     const I32 skip = t - posixcc;
10008
10009                     /* Initially switch on the length of the name.  */
10010                     switch (skip) {
10011                     case 4:
10012                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX, this is the Perl \w */
10013                             namedclass = complement ? ANYOF_NALNUM : ANYOF_ALNUM;
10014                         break;
10015                     case 5:
10016                         /* Names all of length 5.  */
10017                         /* alnum alpha ascii blank cntrl digit graph lower
10018                            print punct space upper  */
10019                         /* Offset 4 gives the best switch position.  */
10020                         switch (posixcc[4]) {
10021                         case 'a':
10022                             if (memEQ(posixcc, "alph", 4)) /* alpha */
10023                                 namedclass = complement ? ANYOF_NALPHA : ANYOF_ALPHA;
10024                             break;
10025                         case 'e':
10026                             if (memEQ(posixcc, "spac", 4)) /* space */
10027                                 namedclass = complement ? ANYOF_NPSXSPC : ANYOF_PSXSPC;
10028                             break;
10029                         case 'h':
10030                             if (memEQ(posixcc, "grap", 4)) /* graph */
10031                                 namedclass = complement ? ANYOF_NGRAPH : ANYOF_GRAPH;
10032                             break;
10033                         case 'i':
10034                             if (memEQ(posixcc, "asci", 4)) /* ascii */
10035                                 namedclass = complement ? ANYOF_NASCII : ANYOF_ASCII;
10036                             break;
10037                         case 'k':
10038                             if (memEQ(posixcc, "blan", 4)) /* blank */
10039                                 namedclass = complement ? ANYOF_NBLANK : ANYOF_BLANK;
10040                             break;
10041                         case 'l':
10042                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
10043                                 namedclass = complement ? ANYOF_NCNTRL : ANYOF_CNTRL;
10044                             break;
10045                         case 'm':
10046                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
10047                                 namedclass = complement ? ANYOF_NALNUMC : ANYOF_ALNUMC;
10048                             break;
10049                         case 'r':
10050                             if (memEQ(posixcc, "lowe", 4)) /* lower */
10051                                 namedclass = complement ? ANYOF_NLOWER : ANYOF_LOWER;
10052                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
10053                                 namedclass = complement ? ANYOF_NUPPER : ANYOF_UPPER;
10054                             break;
10055                         case 't':
10056                             if (memEQ(posixcc, "digi", 4)) /* digit */
10057                                 namedclass = complement ? ANYOF_NDIGIT : ANYOF_DIGIT;
10058                             else if (memEQ(posixcc, "prin", 4)) /* print */
10059                                 namedclass = complement ? ANYOF_NPRINT : ANYOF_PRINT;
10060                             else if (memEQ(posixcc, "punc", 4)) /* punct */
10061                                 namedclass = complement ? ANYOF_NPUNCT : ANYOF_PUNCT;
10062                             break;
10063                         }
10064                         break;
10065                     case 6:
10066                         if (memEQ(posixcc, "xdigit", 6))
10067                             namedclass = complement ? ANYOF_NXDIGIT : ANYOF_XDIGIT;
10068                         break;
10069                     }
10070
10071                     if (namedclass == OOB_NAMEDCLASS)
10072                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
10073                                       t - s - 1, s + 1);
10074                     assert (posixcc[skip] == ':');
10075                     assert (posixcc[skip+1] == ']');
10076                 } else if (!SIZE_ONLY) {
10077                     /* [[=foo=]] and [[.foo.]] are still future. */
10078
10079                     /* adjust RExC_parse so the warning shows after
10080                        the class closes */
10081                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
10082                         RExC_parse++;
10083                     Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
10084                 }
10085             } else {
10086                 /* Maternal grandfather:
10087                  * "[:" ending in ":" but not in ":]" */
10088                 RExC_parse = s;
10089             }
10090         }
10091     }
10092
10093     return namedclass;
10094 }
10095
10096 STATIC void
10097 S_checkposixcc(pTHX_ RExC_state_t *pRExC_state)
10098 {
10099     dVAR;
10100
10101     PERL_ARGS_ASSERT_CHECKPOSIXCC;
10102
10103     if (POSIXCC(UCHARAT(RExC_parse))) {
10104         const char *s = RExC_parse;
10105         const char  c = *s++;
10106
10107         while (isALNUM(*s))
10108             s++;
10109         if (*s && c == *s && s[1] == ']') {
10110             ckWARN3reg(s+2,
10111                        "POSIX syntax [%c %c] belongs inside character classes",
10112                        c, c);
10113
10114             /* [[=foo=]] and [[.foo.]] are still future. */
10115             if (POSIXCC_NOTYET(c)) {
10116                 /* adjust RExC_parse so the error shows after
10117                    the class closes */
10118                 while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse++) != ']')
10119                     NOOP;
10120                 Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
10121             }
10122         }
10123     }
10124 }
10125
10126 /* Generate the code to add a full posix character <class> to the bracketed
10127  * character class given by <node>.  (<node> is needed only under locale rules)
10128  * destlist     is the inversion list for non-locale rules that this class is
10129  *              to be added to
10130  * sourcelist   is the ASCII-range inversion list to add under /a rules
10131  * Xsourcelist  is the full Unicode range list to use otherwise. */
10132 #define DO_POSIX(node, class, destlist, sourcelist, Xsourcelist)           \
10133     if (LOC) {                                                             \
10134         SV* scratch_list = NULL;                                           \
10135                                                                            \
10136         /* Set this class in the node for runtime matching */              \
10137         ANYOF_CLASS_SET(node, class);                                      \
10138                                                                            \
10139         /* For above Latin1 code points, we use the full Unicode range */  \
10140         _invlist_intersection(PL_AboveLatin1,                              \
10141                               Xsourcelist,                                 \
10142                               &scratch_list);                              \
10143         /* And set the output to it, adding instead if there already is an \
10144          * output.  Checking if <destlist> is NULL first saves an extra    \
10145          * clone.  Its reference count will be decremented at the next     \
10146          * union, etc, or if this is the only instance, at the end of the  \
10147          * routine */                                                      \
10148         if (! destlist) {                                                  \
10149             destlist = scratch_list;                                       \
10150         }                                                                  \
10151         else {                                                             \
10152             _invlist_union(destlist, scratch_list, &destlist);             \
10153             SvREFCNT_dec(scratch_list);                                    \
10154         }                                                                  \
10155     }                                                                      \
10156     else {                                                                 \
10157         /* For non-locale, just add it to any existing list */             \
10158         _invlist_union(destlist,                                           \
10159                        (AT_LEAST_ASCII_RESTRICTED)                         \
10160                            ? sourcelist                                    \
10161                            : Xsourcelist,                                  \
10162                        &destlist);                                         \
10163     }
10164
10165 /* Like DO_POSIX, but matches the complement of <sourcelist> and <Xsourcelist>.
10166  */
10167 #define DO_N_POSIX(node, class, destlist, sourcelist, Xsourcelist)         \
10168     if (LOC) {                                                             \
10169         SV* scratch_list = NULL;                                           \
10170         ANYOF_CLASS_SET(node, class);                                      \
10171         _invlist_subtract(PL_AboveLatin1, Xsourcelist, &scratch_list);     \
10172         if (! destlist) {                                                  \
10173             destlist = scratch_list;                                       \
10174         }                                                                  \
10175         else {                                                             \
10176             _invlist_union(destlist, scratch_list, &destlist);             \
10177             SvREFCNT_dec(scratch_list);                                    \
10178         }                                                                  \
10179     }                                                                      \
10180     else {                                                                 \
10181         _invlist_union_complement_2nd(destlist,                            \
10182                                     (AT_LEAST_ASCII_RESTRICTED)            \
10183                                         ? sourcelist                       \
10184                                         : Xsourcelist,                     \
10185                                     &destlist);                            \
10186         /* Under /d, everything in the upper half of the Latin1 range      \
10187          * matches this complement */                                      \
10188         if (DEPENDS_SEMANTICS) {                                           \
10189             ANYOF_FLAGS(node) |= ANYOF_NON_UTF8_LATIN1_ALL;                \
10190         }                                                                  \
10191     }
10192
10193 /* Generate the code to add a posix character <class> to the bracketed
10194  * character class given by <node>.  (<node> is needed only under locale rules)
10195  * destlist       is the inversion list for non-locale rules that this class is
10196  *                to be added to
10197  * sourcelist     is the ASCII-range inversion list to add under /a rules
10198  * l1_sourcelist  is the Latin1 range list to use otherwise.
10199  * Xpropertyname  is the name to add to <run_time_list> of the property to
10200  *                specify the code points above Latin1 that will have to be
10201  *                determined at run-time
10202  * run_time_list  is a SV* that contains text names of properties that are to
10203  *                be computed at run time.  This concatenates <Xpropertyname>
10204  *                to it, apppropriately
10205  * This is essentially DO_POSIX, but we know only the Latin1 values at compile
10206  * time */
10207 #define DO_POSIX_LATIN1_ONLY_KNOWN(node, class, destlist, sourcelist,      \
10208                               l1_sourcelist, Xpropertyname, run_time_list) \
10209     /* If not /a matching, there are going to be code points we will have  \
10210      * to defer to runtime to look-up */                                   \
10211     if (! AT_LEAST_ASCII_RESTRICTED) {                                     \
10212         Perl_sv_catpvf(aTHX_ run_time_list, "+utf8::%s\n", Xpropertyname); \
10213     }                                                                      \
10214     if (LOC) {                                                             \
10215         ANYOF_CLASS_SET(node, class);                                      \
10216     }                                                                      \
10217     else {                                                                 \
10218         _invlist_union(destlist,                                           \
10219                        (AT_LEAST_ASCII_RESTRICTED)                         \
10220                            ? sourcelist                                    \
10221                            : l1_sourcelist,                                \
10222                        &destlist);                                         \
10223     }
10224
10225 /* Like DO_POSIX_LATIN1_ONLY_KNOWN, but for the complement.  A combination of
10226  * this and DO_N_POSIX */
10227 #define DO_N_POSIX_LATIN1_ONLY_KNOWN(node, class, destlist, sourcelist,    \
10228                               l1_sourcelist, Xpropertyname, run_time_list) \
10229     if (AT_LEAST_ASCII_RESTRICTED) {                                       \
10230         _invlist_union_complement_2nd(destlist, sourcelist, &destlist);    \
10231     }                                                                      \
10232     else {                                                                 \
10233         Perl_sv_catpvf(aTHX_ run_time_list, "!utf8::%s\n", Xpropertyname); \
10234         if (LOC) {                                                         \
10235             ANYOF_CLASS_SET(node, namedclass);                             \
10236         }                                                                  \
10237         else {                                                             \
10238             SV* scratch_list = NULL;                                       \
10239             _invlist_subtract(PL_Latin1, l1_sourcelist, &scratch_list);    \
10240             if (! destlist) {                                              \
10241                 destlist = scratch_list;                                   \
10242             }                                                              \
10243             else {                                                         \
10244                 _invlist_union(destlist, scratch_list, &destlist);         \
10245                 SvREFCNT_dec(scratch_list);                                \
10246             }                                                              \
10247             if (DEPENDS_SEMANTICS) {                                       \
10248                 ANYOF_FLAGS(node) |= ANYOF_NON_UTF8_LATIN1_ALL;            \
10249             }                                                              \
10250         }                                                                  \
10251     }
10252
10253 STATIC U8
10254 S_set_regclass_bit_fold(pTHX_ RExC_state_t *pRExC_state, regnode* node, const U8 value, SV** invlist_ptr, AV** alternate_ptr)
10255 {
10256
10257     /* Handle the setting of folds in the bitmap for non-locale ANYOF nodes.
10258      * Locale folding is done at run-time, so this function should not be
10259      * called for nodes that are for locales.
10260      *
10261      * This function sets the bit corresponding to the fold of the input
10262      * 'value', if not already set.  The fold of 'f' is 'F', and the fold of
10263      * 'F' is 'f'.
10264      *
10265      * It also knows about the characters that are in the bitmap that have
10266      * folds that are matchable only outside it, and sets the appropriate lists
10267      * and flags.
10268      *
10269      * It returns the number of bits that actually changed from 0 to 1 */
10270
10271     U8 stored = 0;
10272     U8 fold;
10273
10274     PERL_ARGS_ASSERT_SET_REGCLASS_BIT_FOLD;
10275
10276     fold = (AT_LEAST_UNI_SEMANTICS) ? PL_fold_latin1[value]
10277                                     : PL_fold[value];
10278
10279     /* It assumes the bit for 'value' has already been set */
10280     if (fold != value && ! ANYOF_BITMAP_TEST(node, fold)) {
10281         ANYOF_BITMAP_SET(node, fold);
10282         stored++;
10283     }
10284     if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(value) && (! isASCII(value) || ! MORE_ASCII_RESTRICTED)) {
10285         /* Certain Latin1 characters have matches outside the bitmap.  To get
10286          * here, 'value' is one of those characters.   None of these matches is
10287          * valid for ASCII characters under /aa, which have been excluded by
10288          * the 'if' above.  The matches fall into three categories:
10289          * 1) They are singly folded-to or -from an above 255 character, as
10290          *    LATIN SMALL LETTER Y WITH DIAERESIS and LATIN CAPITAL LETTER Y
10291          *    WITH DIAERESIS;
10292          * 2) They are part of a multi-char fold with another character in the
10293          *    bitmap, only LATIN SMALL LETTER SHARP S => "ss" fits that bill;
10294          * 3) They are part of a multi-char fold with a character not in the
10295          *    bitmap, such as various ligatures.
10296          * We aren't dealing fully with multi-char folds, except we do deal
10297          * with the pattern containing a character that has a multi-char fold
10298          * (not so much the inverse).
10299          * For types 1) and 3), the matches only happen when the target string
10300          * is utf8; that's not true for 2), and we set a flag for it.
10301          *
10302          * The code below adds to the passed in inversion list the single fold
10303          * closures for 'value'.  The values are hard-coded here so that an
10304          * innocent-looking character class, like /[ks]/i won't have to go out
10305          * to disk to find the possible matches.  XXX It would be better to
10306          * generate these via regen, in case a new version of the Unicode
10307          * standard adds new mappings, though that is not really likely. */
10308         switch (value) {
10309             case 'k':
10310             case 'K':
10311                 /* KELVIN SIGN */
10312                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr, 0x212A);
10313                 break;
10314             case 's':
10315             case 'S':
10316                 /* LATIN SMALL LETTER LONG S */
10317                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr, 0x017F);
10318                 break;
10319             case MICRO_SIGN:
10320                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10321                                                  GREEK_SMALL_LETTER_MU);
10322                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10323                                                  GREEK_CAPITAL_LETTER_MU);
10324                 break;
10325             case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
10326             case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
10327                 /* ANGSTROM SIGN */
10328                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr, 0x212B);
10329                 if (DEPENDS_SEMANTICS) {    /* See DEPENDS comment below */
10330                     *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10331                                                      PL_fold_latin1[value]);
10332                 }
10333                 break;
10334             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
10335                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10336                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
10337                 break;
10338             case LATIN_SMALL_LETTER_SHARP_S:
10339                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10340                                         LATIN_CAPITAL_LETTER_SHARP_S);
10341
10342                 /* Under /a, /d, and /u, this can match the two chars "ss" */
10343                 if (! MORE_ASCII_RESTRICTED) {
10344                     add_alternate(alternate_ptr, (U8 *) "ss", 2);
10345
10346                     /* And under /u or /a, it can match even if the target is
10347                      * not utf8 */
10348                     if (AT_LEAST_UNI_SEMANTICS) {
10349                         ANYOF_FLAGS(node) |= ANYOF_NONBITMAP_NON_UTF8;
10350                     }
10351                 }
10352                 break;
10353             case 'F': case 'f':
10354             case 'I': case 'i':
10355             case 'L': case 'l':
10356             case 'T': case 't':
10357             case 'A': case 'a':
10358             case 'H': case 'h':
10359             case 'J': case 'j':
10360             case 'N': case 'n':
10361             case 'W': case 'w':
10362             case 'Y': case 'y':
10363                 /* These all are targets of multi-character folds from code
10364                  * points that require UTF8 to express, so they can't match
10365                  * unless the target string is in UTF-8, so no action here is
10366                  * necessary, as regexec.c properly handles the general case
10367                  * for UTF-8 matching */
10368                 break;
10369             default:
10370                 /* Use deprecated warning to increase the chances of this
10371                  * being output */
10372                 ckWARN2regdep(RExC_parse, "Perl folding rules are not up-to-date for 0x%x; please use the perlbug utility to report;", value);
10373                 break;
10374         }
10375     }
10376     else if (DEPENDS_SEMANTICS
10377             && ! isASCII(value)
10378             && PL_fold_latin1[value] != value)
10379     {
10380            /* Under DEPENDS rules, non-ASCII Latin1 characters match their
10381             * folds only when the target string is in UTF-8.  We add the fold
10382             * here to the list of things to match outside the bitmap, which
10383             * won't be looked at unless it is UTF8 (or else if something else
10384             * says to look even if not utf8, but those things better not happen
10385             * under DEPENDS semantics. */
10386         *invlist_ptr = add_cp_to_invlist(*invlist_ptr, PL_fold_latin1[value]);
10387     }
10388
10389     return stored;
10390 }
10391
10392
10393 PERL_STATIC_INLINE U8
10394 S_set_regclass_bit(pTHX_ RExC_state_t *pRExC_state, regnode* node, const U8 value, SV** invlist_ptr, AV** alternate_ptr)
10395 {
10396     /* This inline function sets a bit in the bitmap if not already set, and if
10397      * appropriate, its fold, returning the number of bits that actually
10398      * changed from 0 to 1 */
10399
10400     U8 stored;
10401
10402     PERL_ARGS_ASSERT_SET_REGCLASS_BIT;
10403
10404     if (ANYOF_BITMAP_TEST(node, value)) {   /* Already set */
10405         return 0;
10406     }
10407
10408     ANYOF_BITMAP_SET(node, value);
10409     stored = 1;
10410
10411     if (FOLD && ! LOC) {        /* Locale folds aren't known until runtime */
10412         stored += set_regclass_bit_fold(pRExC_state, node, value, invlist_ptr, alternate_ptr);
10413     }
10414
10415     return stored;
10416 }
10417
10418 STATIC void
10419 S_add_alternate(pTHX_ AV** alternate_ptr, U8* string, STRLEN len)
10420 {
10421     /* Adds input 'string' with length 'len' to the ANYOF node's unicode
10422      * alternate list, pointed to by 'alternate_ptr'.  This is an array of
10423      * the multi-character folds of characters in the node */
10424     SV *sv;
10425
10426     PERL_ARGS_ASSERT_ADD_ALTERNATE;
10427
10428     if (! *alternate_ptr) {
10429         *alternate_ptr = newAV();
10430     }
10431     sv = newSVpvn_utf8((char*)string, len, TRUE);
10432     av_push(*alternate_ptr, sv);
10433     return;
10434 }
10435
10436 /*
10437    parse a class specification and produce either an ANYOF node that
10438    matches the pattern or perhaps will be optimized into an EXACTish node
10439    instead. The node contains a bit map for the first 256 characters, with the
10440    corresponding bit set if that character is in the list.  For characters
10441    above 255, a range list is used */
10442
10443 STATIC regnode *
10444 S_regclass(pTHX_ RExC_state_t *pRExC_state, U32 depth)
10445 {
10446     dVAR;
10447     register UV nextvalue;
10448     register IV prevvalue = OOB_UNICODE;
10449     register IV range = 0;
10450     UV value = 0; /* XXX:dmq: needs to be referenceable (unfortunately) */
10451     register regnode *ret;
10452     STRLEN numlen;
10453     IV namedclass;
10454     char *rangebegin = NULL;
10455     bool need_class = 0;
10456     bool allow_full_fold = TRUE;   /* Assume wants multi-char folding */
10457     SV *listsv = NULL;
10458     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
10459                                       than just initialized.  */
10460     SV* properties = NULL;    /* Code points that match \p{} \P{} */
10461     UV element_count = 0;   /* Number of distinct elements in the class.
10462                                Optimizations may be possible if this is tiny */
10463     UV n;
10464
10465     /* Unicode properties are stored in a swash; this holds the current one
10466      * being parsed.  If this swash is the only above-latin1 component of the
10467      * character class, an optimization is to pass it directly on to the
10468      * execution engine.  Otherwise, it is set to NULL to indicate that there
10469      * are other things in the class that have to be dealt with at execution
10470      * time */
10471     SV* swash = NULL;           /* Code points that match \p{} \P{} */
10472
10473     /* Set if a component of this character class is user-defined; just passed
10474      * on to the engine */
10475     UV has_user_defined_property = 0;
10476
10477     /* code points this node matches that can't be stored in the bitmap */
10478     SV* nonbitmap = NULL;
10479
10480     /* The items that are to match that aren't stored in the bitmap, but are a
10481      * result of things that are stored there.  This is the fold closure of
10482      * such a character, either because it has DEPENDS semantics and shouldn't
10483      * be matched unless the target string is utf8, or is a code point that is
10484      * too large for the bit map, as for example, the fold of the MICRO SIGN is
10485      * above 255.  This all is solely for performance reasons.  By having this
10486      * code know the outside-the-bitmap folds that the bitmapped characters are
10487      * involved with, we don't have to go out to disk to find the list of
10488      * matches, unless the character class includes code points that aren't
10489      * storable in the bit map.  That means that a character class with an 's'
10490      * in it, for example, doesn't need to go out to disk to find everything
10491      * that matches.  A 2nd list is used so that the 'nonbitmap' list is kept
10492      * empty unless there is something whose fold we don't know about, and will
10493      * have to go out to the disk to find. */
10494     SV* l1_fold_invlist = NULL;
10495
10496     /* List of multi-character folds that are matched by this node */
10497     AV* unicode_alternate  = NULL;
10498 #ifdef EBCDIC
10499     UV literal_endpoint = 0;
10500 #endif
10501     UV stored = 0;  /* how many chars stored in the bitmap */
10502
10503     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
10504         case we need to change the emitted regop to an EXACT. */
10505     const char * orig_parse = RExC_parse;
10506     GET_RE_DEBUG_FLAGS_DECL;
10507
10508     PERL_ARGS_ASSERT_REGCLASS;
10509 #ifndef DEBUGGING
10510     PERL_UNUSED_ARG(depth);
10511 #endif
10512
10513     DEBUG_PARSE("clas");
10514
10515     /* Assume we are going to generate an ANYOF node. */
10516     ret = reganode(pRExC_state, ANYOF, 0);
10517
10518
10519     if (!SIZE_ONLY) {
10520         ANYOF_FLAGS(ret) = 0;
10521     }
10522
10523     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
10524         RExC_naughty++;
10525         RExC_parse++;
10526         if (!SIZE_ONLY)
10527             ANYOF_FLAGS(ret) |= ANYOF_INVERT;
10528
10529         /* We have decided to not allow multi-char folds in inverted character
10530          * classes, due to the confusion that can happen, especially with
10531          * classes that are designed for a non-Unicode world:  You have the
10532          * peculiar case that:
10533             "s s" =~ /^[^\xDF]+$/i => Y
10534             "ss"  =~ /^[^\xDF]+$/i => N
10535          *
10536          * See [perl #89750] */
10537         allow_full_fold = FALSE;
10538     }
10539
10540     if (SIZE_ONLY) {
10541         RExC_size += ANYOF_SKIP;
10542         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
10543     }
10544     else {
10545         RExC_emit += ANYOF_SKIP;
10546         if (LOC) {
10547             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
10548         }
10549         ANYOF_BITMAP_ZERO(ret);
10550         listsv = newSVpvs("# comment\n");
10551         initial_listsv_len = SvCUR(listsv);
10552     }
10553
10554     nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
10555
10556     if (!SIZE_ONLY && POSIXCC(nextvalue))
10557         checkposixcc(pRExC_state);
10558
10559     /* allow 1st char to be ] (allowing it to be - is dealt with later) */
10560     if (UCHARAT(RExC_parse) == ']')
10561         goto charclassloop;
10562
10563 parseit:
10564     while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
10565
10566     charclassloop:
10567
10568         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
10569
10570         if (!range) {
10571             rangebegin = RExC_parse;
10572             element_count++;
10573         }
10574         if (UTF) {
10575             value = utf8n_to_uvchr((U8*)RExC_parse,
10576                                    RExC_end - RExC_parse,
10577                                    &numlen, UTF8_ALLOW_DEFAULT);
10578             RExC_parse += numlen;
10579         }
10580         else
10581             value = UCHARAT(RExC_parse++);
10582
10583         nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
10584         if (value == '[' && POSIXCC(nextvalue))
10585             namedclass = regpposixcc(pRExC_state, value);
10586         else if (value == '\\') {
10587             if (UTF) {
10588                 value = utf8n_to_uvchr((U8*)RExC_parse,
10589                                    RExC_end - RExC_parse,
10590                                    &numlen, UTF8_ALLOW_DEFAULT);
10591                 RExC_parse += numlen;
10592             }
10593             else
10594                 value = UCHARAT(RExC_parse++);
10595             /* Some compilers cannot handle switching on 64-bit integer
10596              * values, therefore value cannot be an UV.  Yes, this will
10597              * be a problem later if we want switch on Unicode.
10598              * A similar issue a little bit later when switching on
10599              * namedclass. --jhi */
10600             switch ((I32)value) {
10601             case 'w':   namedclass = ANYOF_ALNUM;       break;
10602             case 'W':   namedclass = ANYOF_NALNUM;      break;
10603             case 's':   namedclass = ANYOF_SPACE;       break;
10604             case 'S':   namedclass = ANYOF_NSPACE;      break;
10605             case 'd':   namedclass = ANYOF_DIGIT;       break;
10606             case 'D':   namedclass = ANYOF_NDIGIT;      break;
10607             case 'v':   namedclass = ANYOF_VERTWS;      break;
10608             case 'V':   namedclass = ANYOF_NVERTWS;     break;
10609             case 'h':   namedclass = ANYOF_HORIZWS;     break;
10610             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
10611             case 'N':  /* Handle \N{NAME} in class */
10612                 {
10613                     /* We only pay attention to the first char of 
10614                     multichar strings being returned. I kinda wonder
10615                     if this makes sense as it does change the behaviour
10616                     from earlier versions, OTOH that behaviour was broken
10617                     as well. */
10618                     UV v; /* value is register so we cant & it /grrr */
10619                     if (reg_namedseq(pRExC_state, &v, NULL, depth)) {
10620                         goto parseit;
10621                     }
10622                     value= v; 
10623                 }
10624                 break;
10625             case 'p':
10626             case 'P':
10627                 {
10628                 char *e;
10629                 if (RExC_parse >= RExC_end)
10630                     vFAIL2("Empty \\%c{}", (U8)value);
10631                 if (*RExC_parse == '{') {
10632                     const U8 c = (U8)value;
10633                     e = strchr(RExC_parse++, '}');
10634                     if (!e)
10635                         vFAIL2("Missing right brace on \\%c{}", c);
10636                     while (isSPACE(UCHARAT(RExC_parse)))
10637                         RExC_parse++;
10638                     if (e == RExC_parse)
10639                         vFAIL2("Empty \\%c{}", c);
10640                     n = e - RExC_parse;
10641                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
10642                         n--;
10643                 }
10644                 else {
10645                     e = RExC_parse;
10646                     n = 1;
10647                 }
10648                 if (!SIZE_ONLY) {
10649                     SV** invlistsvp;
10650                     SV* invlist;
10651                     char* name;
10652                     if (UCHARAT(RExC_parse) == '^') {
10653                          RExC_parse++;
10654                          n--;
10655                          value = value == 'p' ? 'P' : 'p'; /* toggle */
10656                          while (isSPACE(UCHARAT(RExC_parse))) {
10657                               RExC_parse++;
10658                               n--;
10659                          }
10660                     }
10661                     /* Try to get the definition of the property into
10662                      * <invlist>.  If /i is in effect, the effective property
10663                      * will have its name be <__NAME_i>.  The design is
10664                      * discussed in commit
10665                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
10666                     Newx(name, n + sizeof("_i__\n"), char);
10667
10668                     sprintf(name, "%s%.*s%s\n",
10669                                     (FOLD) ? "__" : "",
10670                                     (int)n,
10671                                     RExC_parse,
10672                                     (FOLD) ? "_i" : ""
10673                     );
10674
10675                     /* Look up the property name, and get its swash and
10676                      * inversion list, if the property is found  */
10677                     if (swash) {
10678                         SvREFCNT_dec(swash);
10679                     }
10680                     swash = _core_swash_init("utf8", name, &PL_sv_undef,
10681                                              1, /* binary */
10682                                              0, /* not tr/// */
10683                                              TRUE, /* this routine will handle
10684                                                       undefined properties */
10685                                              NULL, FALSE /* No inversion list */
10686                                             );
10687                     if (   ! swash
10688                         || ! SvROK(swash)
10689                         || ! SvTYPE(SvRV(swash)) == SVt_PVHV
10690                         || ! (invlistsvp =
10691                                 hv_fetchs(MUTABLE_HV(SvRV(swash)),
10692                                 "INVLIST", FALSE))
10693                         || ! (invlist = *invlistsvp))
10694                     {
10695                         if (swash) {
10696                             SvREFCNT_dec(swash);
10697                             swash = NULL;
10698                         }
10699
10700                         /* Here didn't find it.  It could be a user-defined
10701                          * property that will be available at run-time.  Add it
10702                          * to the list to look up then */
10703                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
10704                                         (value == 'p' ? '+' : '!'),
10705                                         name);
10706                         has_user_defined_property = 1;
10707
10708                         /* We don't know yet, so have to assume that the
10709                          * property could match something in the Latin1 range,
10710                          * hence something that isn't utf8 */
10711                         ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
10712                     }
10713                     else {
10714
10715                         /* Here, did get the swash and its inversion list.  If
10716                          * the swash is from a user-defined property, then this
10717                          * whole character class should be regarded as such */
10718                         SV** user_defined_svp =
10719                                             hv_fetchs(MUTABLE_HV(SvRV(swash)),
10720                                                         "USER_DEFINED", FALSE);
10721                         if (user_defined_svp) {
10722                             has_user_defined_property
10723                                                     |= SvUV(*user_defined_svp);
10724                         }
10725
10726                         /* Invert if asking for the complement */
10727                         if (value == 'P') {
10728                             _invlist_union_complement_2nd(properties, invlist, &properties);
10729
10730                             /* The swash can't be used as-is, because we've
10731                              * inverted things; delay removing it to here after
10732                              * have copied its invlist above */
10733                             SvREFCNT_dec(swash);
10734                             swash = NULL;
10735                         }
10736                         else {
10737                             _invlist_union(properties, invlist, &properties);
10738                         }
10739                     }
10740                     Safefree(name);
10741                 }
10742                 RExC_parse = e + 1;
10743                 namedclass = ANYOF_MAX;  /* no official name, but it's named */
10744
10745                 /* \p means they want Unicode semantics */
10746                 RExC_uni_semantics = 1;
10747                 }
10748                 break;
10749             case 'n':   value = '\n';                   break;
10750             case 'r':   value = '\r';                   break;
10751             case 't':   value = '\t';                   break;
10752             case 'f':   value = '\f';                   break;
10753             case 'b':   value = '\b';                   break;
10754             case 'e':   value = ASCII_TO_NATIVE('\033');break;
10755             case 'a':   value = ASCII_TO_NATIVE('\007');break;
10756             case 'o':
10757                 RExC_parse--;   /* function expects to be pointed at the 'o' */
10758                 {
10759                     const char* error_msg;
10760                     bool valid = grok_bslash_o(RExC_parse,
10761                                                &value,
10762                                                &numlen,
10763                                                &error_msg,
10764                                                SIZE_ONLY);
10765                     RExC_parse += numlen;
10766                     if (! valid) {
10767                         vFAIL(error_msg);
10768                     }
10769                 }
10770                 if (PL_encoding && value < 0x100) {
10771                     goto recode_encoding;
10772                 }
10773                 break;
10774             case 'x':
10775                 if (*RExC_parse == '{') {
10776                     I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
10777                         | PERL_SCAN_DISALLOW_PREFIX;
10778                     char * const e = strchr(RExC_parse++, '}');
10779                     if (!e)
10780                         vFAIL("Missing right brace on \\x{}");
10781
10782                     numlen = e - RExC_parse;
10783                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
10784                     RExC_parse = e + 1;
10785                 }
10786                 else {
10787                     I32 flags = PERL_SCAN_DISALLOW_PREFIX;
10788                     numlen = 2;
10789                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
10790                     RExC_parse += numlen;
10791                 }
10792                 if (PL_encoding && value < 0x100)
10793                     goto recode_encoding;
10794                 break;
10795             case 'c':
10796                 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
10797                 break;
10798             case '0': case '1': case '2': case '3': case '4':
10799             case '5': case '6': case '7':
10800                 {
10801                     /* Take 1-3 octal digits */
10802                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10803                     numlen = 3;
10804                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
10805                     RExC_parse += numlen;
10806                     if (PL_encoding && value < 0x100)
10807                         goto recode_encoding;
10808                     break;
10809                 }
10810             recode_encoding:
10811                 if (! RExC_override_recoding) {
10812                     SV* enc = PL_encoding;
10813                     value = reg_recode((const char)(U8)value, &enc);
10814                     if (!enc && SIZE_ONLY)
10815                         ckWARNreg(RExC_parse,
10816                                   "Invalid escape in the specified encoding");
10817                     break;
10818                 }
10819             default:
10820                 /* Allow \_ to not give an error */
10821                 if (!SIZE_ONLY && isALNUM(value) && value != '_') {
10822                     ckWARN2reg(RExC_parse,
10823                                "Unrecognized escape \\%c in character class passed through",
10824                                (int)value);
10825                 }
10826                 break;
10827             }
10828         } /* end of \blah */
10829 #ifdef EBCDIC
10830         else
10831             literal_endpoint++;
10832 #endif
10833
10834         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
10835
10836             /* What matches in a locale is not known until runtime, so need to
10837              * (one time per class) allocate extra space to pass to regexec.
10838              * The space will contain a bit for each named class that is to be
10839              * matched against.  This isn't needed for \p{} and pseudo-classes,
10840              * as they are not affected by locale, and hence are dealt with
10841              * separately */
10842             if (LOC && namedclass < ANYOF_MAX && ! need_class) {
10843                 need_class = 1;
10844                 if (SIZE_ONLY) {
10845                     RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
10846                 }
10847                 else {
10848                     RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
10849                     ANYOF_CLASS_ZERO(ret);
10850                 }
10851                 ANYOF_FLAGS(ret) |= ANYOF_CLASS;
10852             }
10853
10854             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
10855              * literal, as is the character that began the false range, i.e.
10856              * the 'a' in the examples */
10857             if (range) {
10858                 if (!SIZE_ONLY) {
10859                     const int w =
10860                         RExC_parse >= rangebegin ?
10861                         RExC_parse - rangebegin : 0;
10862                     ckWARN4reg(RExC_parse,
10863                                "False [] range \"%*.*s\"",
10864                                w, w, rangebegin);
10865
10866                     stored +=
10867                          set_regclass_bit(pRExC_state, ret, '-', &l1_fold_invlist, &unicode_alternate);
10868                     if (prevvalue < 256) {
10869                         stored +=
10870                          set_regclass_bit(pRExC_state, ret, (U8) prevvalue, &l1_fold_invlist, &unicode_alternate);
10871                     }
10872                     else {
10873                         nonbitmap = add_cp_to_invlist(nonbitmap, prevvalue);
10874                     }
10875                 }
10876
10877                 range = 0; /* this was not a true range */
10878             }
10879
10880             if (!SIZE_ONLY) {
10881
10882                 /* Possible truncation here but in some 64-bit environments
10883                  * the compiler gets heartburn about switch on 64-bit values.
10884                  * A similar issue a little earlier when switching on value.
10885                  * --jhi */
10886                 switch ((I32)namedclass) {
10887
10888                 case ANYOF_ALNUMC: /* C's alnum, in contrast to \w */
10889                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10890                         PL_PosixAlnum, PL_L1PosixAlnum, "XPosixAlnum", listsv);
10891                     break;
10892                 case ANYOF_NALNUMC:
10893                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10894                         PL_PosixAlnum, PL_L1PosixAlnum, "XPosixAlnum", listsv);
10895                     break;
10896                 case ANYOF_ALPHA:
10897                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10898                         PL_PosixAlpha, PL_L1PosixAlpha, "XPosixAlpha", listsv);
10899                     break;
10900                 case ANYOF_NALPHA:
10901                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10902                         PL_PosixAlpha, PL_L1PosixAlpha, "XPosixAlpha", listsv);
10903                     break;
10904                 case ANYOF_ASCII:
10905                     if (LOC) {
10906                         ANYOF_CLASS_SET(ret, namedclass);
10907                     }
10908                     else {
10909                         _invlist_union(properties, PL_ASCII, &properties);
10910                     }
10911                     break;
10912                 case ANYOF_NASCII:
10913                     if (LOC) {
10914                         ANYOF_CLASS_SET(ret, namedclass);
10915                     }
10916                     else {
10917                         _invlist_union_complement_2nd(properties,
10918                                                     PL_ASCII, &properties);
10919                         if (DEPENDS_SEMANTICS) {
10920                             ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
10921                         }
10922                     }
10923                     break;
10924                 case ANYOF_BLANK:
10925                     DO_POSIX(ret, namedclass, properties,
10926                                             PL_PosixBlank, PL_XPosixBlank);
10927                     break;
10928                 case ANYOF_NBLANK:
10929                     DO_N_POSIX(ret, namedclass, properties,
10930                                             PL_PosixBlank, PL_XPosixBlank);
10931                     break;
10932                 case ANYOF_CNTRL:
10933                     DO_POSIX(ret, namedclass, properties,
10934                                             PL_PosixCntrl, PL_XPosixCntrl);
10935                     break;
10936                 case ANYOF_NCNTRL:
10937                     DO_N_POSIX(ret, namedclass, properties,
10938                                             PL_PosixCntrl, PL_XPosixCntrl);
10939                     break;
10940                 case ANYOF_DIGIT:
10941                     /* Ignore the compiler warning for this macro, planned to
10942                      * be eliminated later */
10943                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10944                         PL_PosixDigit, PL_PosixDigit, "XPosixDigit", listsv);
10945                     break;
10946                 case ANYOF_NDIGIT:
10947                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10948                         PL_PosixDigit, PL_PosixDigit, "XPosixDigit", listsv);
10949                     break;
10950                 case ANYOF_GRAPH:
10951                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10952                         PL_PosixGraph, PL_L1PosixGraph, "XPosixGraph", listsv);
10953                     break;
10954                 case ANYOF_NGRAPH:
10955                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10956                         PL_PosixGraph, PL_L1PosixGraph, "XPosixGraph", listsv);
10957                     break;
10958                 case ANYOF_HORIZWS:
10959                     /* For these, we use the nonbitmap, as /d doesn't make a
10960                      * difference in what these match.  There would be problems
10961                      * if these characters had folds other than themselves, as
10962                      * nonbitmap is subject to folding.  It turns out that \h
10963                      * is just a synonym for XPosixBlank */
10964                     _invlist_union(nonbitmap, PL_XPosixBlank, &nonbitmap);
10965                     break;
10966                 case ANYOF_NHORIZWS:
10967                     _invlist_union_complement_2nd(nonbitmap,
10968                                                  PL_XPosixBlank, &nonbitmap);
10969                     break;
10970                 case ANYOF_LOWER:
10971                 case ANYOF_NLOWER:
10972                 {   /* These require special handling, as they differ under
10973                        folding, matching Cased there (which in the ASCII range
10974                        is the same as Alpha */
10975
10976                     SV* ascii_source;
10977                     SV* l1_source;
10978                     const char *Xname;
10979
10980                     if (FOLD && ! LOC) {
10981                         ascii_source = PL_PosixAlpha;
10982                         l1_source = PL_L1Cased;
10983                         Xname = "Cased";
10984                     }
10985                     else {
10986                         ascii_source = PL_PosixLower;
10987                         l1_source = PL_L1PosixLower;
10988                         Xname = "XPosixLower";
10989                     }
10990                     if (namedclass == ANYOF_LOWER) {
10991                         DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10992                                     ascii_source, l1_source, Xname, listsv);
10993                     }
10994                     else {
10995                         DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass,
10996                             properties, ascii_source, l1_source, Xname, listsv);
10997                     }
10998                     break;
10999                 }
11000                 case ANYOF_PRINT:
11001                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11002                         PL_PosixPrint, PL_L1PosixPrint, "XPosixPrint", listsv);
11003                     break;
11004                 case ANYOF_NPRINT:
11005                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11006                         PL_PosixPrint, PL_L1PosixPrint, "XPosixPrint", listsv);
11007                     break;
11008                 case ANYOF_PUNCT:
11009                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11010                         PL_PosixPunct, PL_L1PosixPunct, "XPosixPunct", listsv);
11011                     break;
11012                 case ANYOF_NPUNCT:
11013                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11014                         PL_PosixPunct, PL_L1PosixPunct, "XPosixPunct", listsv);
11015                     break;
11016                 case ANYOF_PSXSPC:
11017                     DO_POSIX(ret, namedclass, properties,
11018                                             PL_PosixSpace, PL_XPosixSpace);
11019                     break;
11020                 case ANYOF_NPSXSPC:
11021                     DO_N_POSIX(ret, namedclass, properties,
11022                                             PL_PosixSpace, PL_XPosixSpace);
11023                     break;
11024                 case ANYOF_SPACE:
11025                     DO_POSIX(ret, namedclass, properties,
11026                                             PL_PerlSpace, PL_XPerlSpace);
11027                     break;
11028                 case ANYOF_NSPACE:
11029                     DO_N_POSIX(ret, namedclass, properties,
11030                                             PL_PerlSpace, PL_XPerlSpace);
11031                     break;
11032                 case ANYOF_UPPER:   /* Same as LOWER, above */
11033                 case ANYOF_NUPPER:
11034                 {
11035                     SV* ascii_source;
11036                     SV* l1_source;
11037                     const char *Xname;
11038
11039                     if (FOLD && ! LOC) {
11040                         ascii_source = PL_PosixAlpha;
11041                         l1_source = PL_L1Cased;
11042                         Xname = "Cased";
11043                     }
11044                     else {
11045                         ascii_source = PL_PosixUpper;
11046                         l1_source = PL_L1PosixUpper;
11047                         Xname = "XPosixUpper";
11048                     }
11049                     if (namedclass == ANYOF_UPPER) {
11050                         DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11051                                     ascii_source, l1_source, Xname, listsv);
11052                     }
11053                     else {
11054                         DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass,
11055                         properties, ascii_source, l1_source, Xname, listsv);
11056                     }
11057                     break;
11058                 }
11059                 case ANYOF_ALNUM:   /* Really is 'Word' */
11060                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11061                             PL_PosixWord, PL_L1PosixWord, "XPosixWord", listsv);
11062                     break;
11063                 case ANYOF_NALNUM:
11064                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11065                             PL_PosixWord, PL_L1PosixWord, "XPosixWord", listsv);
11066                     break;
11067                 case ANYOF_VERTWS:
11068                     /* For these, we use the nonbitmap, as /d doesn't make a
11069                      * difference in what these match.  There would be problems
11070                      * if these characters had folds other than themselves, as
11071                      * nonbitmap is subject to folding */
11072                     _invlist_union(nonbitmap, PL_VertSpace, &nonbitmap);
11073                     break;
11074                 case ANYOF_NVERTWS:
11075                     _invlist_union_complement_2nd(nonbitmap,
11076                                                     PL_VertSpace, &nonbitmap);
11077                     break;
11078                 case ANYOF_XDIGIT:
11079                     DO_POSIX(ret, namedclass, properties,
11080                                             PL_PosixXDigit, PL_XPosixXDigit);
11081                     break;
11082                 case ANYOF_NXDIGIT:
11083                     DO_N_POSIX(ret, namedclass, properties,
11084                                             PL_PosixXDigit, PL_XPosixXDigit);
11085                     break;
11086                 case ANYOF_MAX:
11087                     /* this is to handle \p and \P */
11088                     break;
11089                 default:
11090                     vFAIL("Invalid [::] class");
11091                     break;
11092                 }
11093
11094                 continue;
11095             }
11096         } /* end of namedclass \blah */
11097
11098         if (range) {
11099             if (prevvalue > (IV)value) /* b-a */ {
11100                 const int w = RExC_parse - rangebegin;
11101                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
11102                 range = 0; /* not a valid range */
11103             }
11104         }
11105         else {
11106             prevvalue = value; /* save the beginning of the range */
11107             if (RExC_parse+1 < RExC_end
11108                 && *RExC_parse == '-'
11109                 && RExC_parse[1] != ']')
11110             {
11111                 RExC_parse++;
11112
11113                 /* a bad range like \w-, [:word:]- ? */
11114                 if (namedclass > OOB_NAMEDCLASS) {
11115                     if (ckWARN(WARN_REGEXP)) {
11116                         const int w =
11117                             RExC_parse >= rangebegin ?
11118                             RExC_parse - rangebegin : 0;
11119                         vWARN4(RExC_parse,
11120                                "False [] range \"%*.*s\"",
11121                                w, w, rangebegin);
11122                     }
11123                     if (!SIZE_ONLY)
11124                         stored +=
11125                             set_regclass_bit(pRExC_state, ret, '-', &l1_fold_invlist, &unicode_alternate);
11126                 } else
11127                     range = 1;  /* yeah, it's a range! */
11128                 continue;       /* but do it the next time */
11129             }
11130         }
11131
11132         /* non-Latin1 code point implies unicode semantics.  Must be set in
11133          * pass1 so is there for the whole of pass 2 */
11134         if (value > 255) {
11135             RExC_uni_semantics = 1;
11136         }
11137
11138         /* now is the next time */
11139         if (!SIZE_ONLY) {
11140             if (prevvalue < 256) {
11141                 const IV ceilvalue = value < 256 ? value : 255;
11142                 IV i;
11143 #ifdef EBCDIC
11144                 /* In EBCDIC [\x89-\x91] should include
11145                  * the \x8e but [i-j] should not. */
11146                 if (literal_endpoint == 2 &&
11147                     ((isLOWER(prevvalue) && isLOWER(ceilvalue)) ||
11148                      (isUPPER(prevvalue) && isUPPER(ceilvalue))))
11149                 {
11150                     if (isLOWER(prevvalue)) {
11151                         for (i = prevvalue; i <= ceilvalue; i++)
11152                             if (isLOWER(i) && !ANYOF_BITMAP_TEST(ret,i)) {
11153                                 stored +=
11154                                   set_regclass_bit(pRExC_state, ret, (U8) i, &l1_fold_invlist, &unicode_alternate);
11155                             }
11156                     } else {
11157                         for (i = prevvalue; i <= ceilvalue; i++)
11158                             if (isUPPER(i) && !ANYOF_BITMAP_TEST(ret,i)) {
11159                                 stored +=
11160                                   set_regclass_bit(pRExC_state, ret, (U8) i, &l1_fold_invlist, &unicode_alternate);
11161                             }
11162                     }
11163                 }
11164                 else
11165 #endif
11166                       for (i = prevvalue; i <= ceilvalue; i++) {
11167                         stored += set_regclass_bit(pRExC_state, ret, (U8) i, &l1_fold_invlist, &unicode_alternate);
11168                       }
11169           }
11170           if (value > 255) {
11171             const UV prevnatvalue  = NATIVE_TO_UNI(prevvalue);
11172             const UV natvalue      = NATIVE_TO_UNI(value);
11173             nonbitmap = add_range_to_invlist(nonbitmap, prevnatvalue, natvalue);
11174         }
11175 #ifdef EBCDIC
11176             literal_endpoint = 0;
11177 #endif
11178         }
11179
11180         range = 0; /* this range (if it was one) is done now */
11181     }
11182
11183
11184
11185     if (SIZE_ONLY)
11186         return ret;
11187     /****** !SIZE_ONLY AFTER HERE *********/
11188
11189     /* If folding and there are code points above 255, we calculate all
11190      * characters that could fold to or from the ones already on the list */
11191     if (FOLD && nonbitmap) {
11192         UV start, end;  /* End points of code point ranges */
11193
11194         SV* fold_intersection = NULL;
11195
11196         /* This is a list of all the characters that participate in folds
11197             * (except marks, etc in multi-char folds */
11198         if (! PL_utf8_foldable) {
11199             SV* swash = swash_init("utf8", "Cased", &PL_sv_undef, 1, 0);
11200             PL_utf8_foldable = _swash_to_invlist(swash);
11201             SvREFCNT_dec(swash);
11202         }
11203
11204         /* This is a hash that for a particular fold gives all characters
11205             * that are involved in it */
11206         if (! PL_utf8_foldclosures) {
11207
11208             /* If we were unable to find any folds, then we likely won't be
11209              * able to find the closures.  So just create an empty list.
11210              * Folding will effectively be restricted to the non-Unicode rules
11211              * hard-coded into Perl.  (This case happens legitimately during
11212              * compilation of Perl itself before the Unicode tables are
11213              * generated) */
11214             if (invlist_len(PL_utf8_foldable) == 0) {
11215                 PL_utf8_foldclosures = newHV();
11216             } else {
11217                 /* If the folds haven't been read in, call a fold function
11218                     * to force that */
11219                 if (! PL_utf8_tofold) {
11220                     U8 dummy[UTF8_MAXBYTES+1];
11221                     STRLEN dummy_len;
11222
11223                     /* This particular string is above \xff in both UTF-8 and
11224                      * UTFEBCDIC */
11225                     to_utf8_fold((U8*) "\xC8\x80", dummy, &dummy_len);
11226                     assert(PL_utf8_tofold); /* Verify that worked */
11227                 }
11228                 PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
11229             }
11230         }
11231
11232         /* Only the characters in this class that participate in folds need be
11233          * checked.  Get the intersection of this class and all the possible
11234          * characters that are foldable.  This can quickly narrow down a large
11235          * class */
11236         _invlist_intersection(PL_utf8_foldable, nonbitmap, &fold_intersection);
11237
11238         /* Now look at the foldable characters in this class individually */
11239         invlist_iterinit(fold_intersection);
11240         while (invlist_iternext(fold_intersection, &start, &end)) {
11241             UV j;
11242
11243             /* Look at every character in the range */
11244             for (j = start; j <= end; j++) {
11245
11246                 /* Get its fold */
11247                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
11248                 STRLEN foldlen;
11249                 const UV f =
11250                     _to_uni_fold_flags(j, foldbuf, &foldlen, allow_full_fold);
11251
11252                 if (foldlen > (STRLEN)UNISKIP(f)) {
11253
11254                     /* Any multicharacter foldings (disallowed in lookbehind
11255                      * patterns) require the following transform: [ABCDEF] ->
11256                      * (?:[ABCabcDEFd]|pq|rst) where E folds into "pq" and F
11257                      * folds into "rst", all other characters fold to single
11258                      * characters.  We save away these multicharacter foldings,
11259                      * to be later saved as part of the additional "s" data. */
11260                     if (! RExC_in_lookbehind) {
11261                         U8* loc = foldbuf;
11262                         U8* e = foldbuf + foldlen;
11263
11264                         /* If any of the folded characters of this are in the
11265                          * Latin1 range, tell the regex engine that this can
11266                          * match a non-utf8 target string.  The only multi-byte
11267                          * fold whose source is in the Latin1 range (U+00DF)
11268                          * applies only when the target string is utf8, or
11269                          * under unicode rules */
11270                         if (j > 255 || AT_LEAST_UNI_SEMANTICS) {
11271                             while (loc < e) {
11272
11273                                 /* Can't mix ascii with non- under /aa */
11274                                 if (MORE_ASCII_RESTRICTED
11275                                     && (isASCII(*loc) != isASCII(j)))
11276                                 {
11277                                     goto end_multi_fold;
11278                                 }
11279                                 if (UTF8_IS_INVARIANT(*loc)
11280                                     || UTF8_IS_DOWNGRADEABLE_START(*loc))
11281                                 {
11282                                     /* Can't mix above and below 256 under LOC
11283                                      */
11284                                     if (LOC) {
11285                                         goto end_multi_fold;
11286                                     }
11287                                     ANYOF_FLAGS(ret)
11288                                             |= ANYOF_NONBITMAP_NON_UTF8;
11289                                     break;
11290                                 }
11291                                 loc += UTF8SKIP(loc);
11292                             }
11293                         }
11294
11295                         add_alternate(&unicode_alternate, foldbuf, foldlen);
11296                     end_multi_fold: ;
11297                     }
11298
11299                     /* This is special-cased, as it is the only letter which
11300                      * has both a multi-fold and single-fold in Latin1.  All
11301                      * the other chars that have single and multi-folds are
11302                      * always in utf8, and the utf8 folding algorithm catches
11303                      * them */
11304                     if (! LOC && j == LATIN_CAPITAL_LETTER_SHARP_S) {
11305                         stored += set_regclass_bit(pRExC_state,
11306                                         ret,
11307                                         LATIN_SMALL_LETTER_SHARP_S,
11308                                         &l1_fold_invlist, &unicode_alternate);
11309                     }
11310                 }
11311                 else {
11312                     /* Single character fold.  Add everything in its fold
11313                      * closure to the list that this node should match */
11314                     SV** listp;
11315
11316                     /* The fold closures data structure is a hash with the keys
11317                      * being every character that is folded to, like 'k', and
11318                      * the values each an array of everything that folds to its
11319                      * key.  e.g. [ 'k', 'K', KELVIN_SIGN ] */
11320                     if ((listp = hv_fetch(PL_utf8_foldclosures,
11321                                     (char *) foldbuf, foldlen, FALSE)))
11322                     {
11323                         AV* list = (AV*) *listp;
11324                         IV k;
11325                         for (k = 0; k <= av_len(list); k++) {
11326                             SV** c_p = av_fetch(list, k, FALSE);
11327                             UV c;
11328                             if (c_p == NULL) {
11329                                 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
11330                             }
11331                             c = SvUV(*c_p);
11332
11333                             /* /aa doesn't allow folds between ASCII and non-;
11334                              * /l doesn't allow them between above and below
11335                              * 256 */
11336                             if ((MORE_ASCII_RESTRICTED
11337                                  && (isASCII(c) != isASCII(j)))
11338                                     || (LOC && ((c < 256) != (j < 256))))
11339                             {
11340                                 continue;
11341                             }
11342
11343                             if (c < 256 && AT_LEAST_UNI_SEMANTICS) {
11344                                 stored += set_regclass_bit(pRExC_state,
11345                                         ret,
11346                                         (U8) c,
11347                                         &l1_fold_invlist, &unicode_alternate);
11348                             }
11349                                 /* It may be that the code point is already in
11350                                  * this range or already in the bitmap, in
11351                                  * which case we need do nothing */
11352                             else if ((c < start || c > end)
11353                                         && (c > 255
11354                                             || ! ANYOF_BITMAP_TEST(ret, c)))
11355                             {
11356                                 nonbitmap = add_cp_to_invlist(nonbitmap, c);
11357                             }
11358                         }
11359                     }
11360                 }
11361             }
11362         }
11363         SvREFCNT_dec(fold_intersection);
11364     }
11365
11366     /* Combine the two lists into one. */
11367     if (l1_fold_invlist) {
11368         if (nonbitmap) {
11369             _invlist_union(nonbitmap, l1_fold_invlist, &nonbitmap);
11370             SvREFCNT_dec(l1_fold_invlist);
11371         }
11372         else {
11373             nonbitmap = l1_fold_invlist;
11374         }
11375     }
11376
11377     /* And combine the result (if any) with any inversion list from properties.
11378      * The lists are kept separate up to now because we don't want to fold the
11379      * properties */
11380     if (properties) {
11381         if (nonbitmap) {
11382             _invlist_union(nonbitmap, properties, &nonbitmap);
11383             SvREFCNT_dec(properties);
11384         }
11385         else {
11386             nonbitmap = properties;
11387         }
11388     }
11389
11390     /* Here, <nonbitmap> contains all the code points we can determine at
11391      * compile time that we haven't put into the bitmap.  Go through it, and
11392      * for things that belong in the bitmap, put them there, and delete from
11393      * <nonbitmap> */
11394     if (nonbitmap) {
11395
11396         /* Above-ASCII code points in /d have to stay in <nonbitmap>, as they
11397          * possibly only should match when the target string is UTF-8 */
11398         UV max_cp_to_set = (DEPENDS_SEMANTICS) ? 127 : 255;
11399
11400         /* This gets set if we actually need to modify things */
11401         bool change_invlist = FALSE;
11402
11403         UV start, end;
11404
11405         /* Start looking through <nonbitmap> */
11406         invlist_iterinit(nonbitmap);
11407         while (invlist_iternext(nonbitmap, &start, &end)) {
11408             UV high;
11409             int i;
11410
11411             /* Quit if are above what we should change */
11412             if (start > max_cp_to_set) {
11413                 break;
11414             }
11415
11416             change_invlist = TRUE;
11417
11418             /* Set all the bits in the range, up to the max that we are doing */
11419             high = (end < max_cp_to_set) ? end : max_cp_to_set;
11420             for (i = start; i <= (int) high; i++) {
11421                 if (! ANYOF_BITMAP_TEST(ret, i)) {
11422                     ANYOF_BITMAP_SET(ret, i);
11423                     stored++;
11424                     prevvalue = value;
11425                     value = i;
11426                 }
11427             }
11428         }
11429
11430         /* Done with loop; remove any code points that are in the bitmap from
11431          * <nonbitmap> */
11432         if (change_invlist) {
11433             _invlist_subtract(nonbitmap,
11434                               (DEPENDS_SEMANTICS)
11435                                 ? PL_ASCII
11436                                 : PL_Latin1,
11437                               &nonbitmap);
11438         }
11439
11440         /* If have completely emptied it, remove it completely */
11441         if (invlist_len(nonbitmap) == 0) {
11442             SvREFCNT_dec(nonbitmap);
11443             nonbitmap = NULL;
11444         }
11445     }
11446
11447     /* Here, we have calculated what code points should be in the character
11448      * class.  <nonbitmap> does not overlap the bitmap except possibly in the
11449      * case of DEPENDS rules.
11450      *
11451      * Now we can see about various optimizations.  Fold calculation (which we
11452      * did above) needs to take place before inversion.  Otherwise /[^k]/i
11453      * would invert to include K, which under /i would match k, which it
11454      * shouldn't. */
11455
11456     /* Optimize inverted simple patterns (e.g. [^a-z]).  Note that we haven't
11457      * set the FOLD flag yet, so this does optimize those.  It doesn't
11458      * optimize locale.  Doing so perhaps could be done as long as there is
11459      * nothing like \w in it; some thought also would have to be given to the
11460      * interaction with above 0x100 chars */
11461     if ((ANYOF_FLAGS(ret) & ANYOF_INVERT)
11462         && ! LOC
11463         && ! unicode_alternate
11464         /* In case of /d, there are some things that should match only when in
11465          * not in the bitmap, i.e., they require UTF8 to match.  These are
11466          * listed in nonbitmap, but if ANYOF_NONBITMAP_NON_UTF8 is set in this
11467          * case, they don't require UTF8, so can invert here */
11468         && (! nonbitmap
11469             || ! DEPENDS_SEMANTICS
11470             || (ANYOF_FLAGS(ret) & ANYOF_NONBITMAP_NON_UTF8))
11471         && SvCUR(listsv) == initial_listsv_len)
11472     {
11473         int i;
11474         if (! nonbitmap) {
11475             for (i = 0; i < 256; ++i) {
11476                 if (ANYOF_BITMAP_TEST(ret, i)) {
11477                     ANYOF_BITMAP_CLEAR(ret, i);
11478                 }
11479                 else {
11480                     ANYOF_BITMAP_SET(ret, i);
11481                     prevvalue = value;
11482                     value = i;
11483                 }
11484             }
11485             /* The inversion means that everything above 255 is matched */
11486             ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
11487         }
11488         else {
11489             /* Here, also has things outside the bitmap that may overlap with
11490              * the bitmap.  We have to sync them up, so that they get inverted
11491              * in both places.  Earlier, we removed all overlaps except in the
11492              * case of /d rules, so no syncing is needed except for this case
11493              */
11494             SV *remove_list = NULL;
11495
11496             if (DEPENDS_SEMANTICS) {
11497                 UV start, end;
11498
11499                 /* Set the bits that correspond to the ones that aren't in the
11500                  * bitmap.  Otherwise, when we invert, we'll miss these.
11501                  * Earlier, we removed from the nonbitmap all code points
11502                  * < 128, so there is no extra work here */
11503                 invlist_iterinit(nonbitmap);
11504                 while (invlist_iternext(nonbitmap, &start, &end)) {
11505                     if (start > 255) {  /* The bit map goes to 255 */
11506                         break;
11507                     }
11508                     if (end > 255) {
11509                         end = 255;
11510                     }
11511                     for (i = start; i <= (int) end; ++i) {
11512                         ANYOF_BITMAP_SET(ret, i);
11513                         prevvalue = value;
11514                         value = i;
11515                     }
11516                 }
11517             }
11518
11519             /* Now invert both the bitmap and the nonbitmap.  Anything in the
11520              * bitmap has to also be removed from the non-bitmap, but again,
11521              * there should not be overlap unless is /d rules. */
11522             _invlist_invert(nonbitmap);
11523
11524             /* Any swash can't be used as-is, because we've inverted things */
11525             if (swash) {
11526                 SvREFCNT_dec(swash);
11527                 swash = NULL;
11528             }
11529
11530             for (i = 0; i < 256; ++i) {
11531                 if (ANYOF_BITMAP_TEST(ret, i)) {
11532                     ANYOF_BITMAP_CLEAR(ret, i);
11533                     if (DEPENDS_SEMANTICS) {
11534                         if (! remove_list) {
11535                             remove_list = _new_invlist(2);
11536                         }
11537                         remove_list = add_cp_to_invlist(remove_list, i);
11538                     }
11539                 }
11540                 else {
11541                     ANYOF_BITMAP_SET(ret, i);
11542                     prevvalue = value;
11543                     value = i;
11544                 }
11545             }
11546
11547             /* And do the removal */
11548             if (DEPENDS_SEMANTICS) {
11549                 if (remove_list) {
11550                     _invlist_subtract(nonbitmap, remove_list, &nonbitmap);
11551                     SvREFCNT_dec(remove_list);
11552                 }
11553             }
11554             else {
11555                 /* There is no overlap for non-/d, so just delete anything
11556                  * below 256 */
11557                 _invlist_intersection(nonbitmap, PL_AboveLatin1, &nonbitmap);
11558             }
11559         }
11560
11561         stored = 256 - stored;
11562
11563         /* Clear the invert flag since have just done it here */
11564         ANYOF_FLAGS(ret) &= ~ANYOF_INVERT;
11565     }
11566
11567     /* Folding in the bitmap is taken care of above, but not for locale (for
11568      * which we have to wait to see what folding is in effect at runtime), and
11569      * for some things not in the bitmap (only the upper latin folds in this
11570      * case, as all other single-char folding has been set above).  Set
11571      * run-time fold flag for these */
11572     if (FOLD && (LOC
11573                 || (DEPENDS_SEMANTICS
11574                     && nonbitmap
11575                     && ! (ANYOF_FLAGS(ret) & ANYOF_NONBITMAP_NON_UTF8))
11576                 || unicode_alternate))
11577     {
11578         ANYOF_FLAGS(ret) |= ANYOF_LOC_NONBITMAP_FOLD;
11579     }
11580
11581     /* A single character class can be "optimized" into an EXACTish node.
11582      * Note that since we don't currently count how many characters there are
11583      * outside the bitmap, we are XXX missing optimization possibilities for
11584      * them.  This optimization can't happen unless this is a truly single
11585      * character class, which means that it can't be an inversion into a
11586      * many-character class, and there must be no possibility of there being
11587      * things outside the bitmap.  'stored' (only) for locales doesn't include
11588      * \w, etc, so have to make a special test that they aren't present
11589      *
11590      * Similarly A 2-character class of the very special form like [bB] can be
11591      * optimized into an EXACTFish node, but only for non-locales, and for
11592      * characters which only have the two folds; so things like 'fF' and 'Ii'
11593      * wouldn't work because they are part of the fold of 'LATIN SMALL LIGATURE
11594      * FI'. */
11595     if (! nonbitmap
11596         && ! unicode_alternate
11597         && SvCUR(listsv) == initial_listsv_len
11598         && ! (ANYOF_FLAGS(ret) & (ANYOF_INVERT|ANYOF_UNICODE_ALL))
11599         && (((stored == 1 && ((! (ANYOF_FLAGS(ret) & ANYOF_LOCALE))
11600                               || (! ANYOF_CLASS_TEST_ANY_SET(ret)))))
11601             || (stored == 2 && ((! (ANYOF_FLAGS(ret) & ANYOF_LOCALE))
11602                                  && (! _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(value))
11603                                  /* If the latest code point has a fold whose
11604                                   * bit is set, it must be the only other one */
11605                                 && ((prevvalue = PL_fold_latin1[value]) != (IV)value)
11606                                  && ANYOF_BITMAP_TEST(ret, prevvalue)))))
11607     {
11608         /* Note that the information needed to decide to do this optimization
11609          * is not currently available until the 2nd pass, and that the actually
11610          * used EXACTish node takes less space than the calculated ANYOF node,
11611          * and hence the amount of space calculated in the first pass is larger
11612          * than actually used, so this optimization doesn't gain us any space.
11613          * But an EXACT node is faster than an ANYOF node, and can be combined
11614          * with any adjacent EXACT nodes later by the optimizer for further
11615          * gains.  The speed of executing an EXACTF is similar to an ANYOF
11616          * node, so the optimization advantage comes from the ability to join
11617          * it to adjacent EXACT nodes */
11618
11619         const char * cur_parse= RExC_parse;
11620         U8 op;
11621         RExC_emit = (regnode *)orig_emit;
11622         RExC_parse = (char *)orig_parse;
11623
11624         if (stored == 1) {
11625
11626             /* A locale node with one point can be folded; all the other cases
11627              * with folding will have two points, since we calculate them above
11628              */
11629             if (ANYOF_FLAGS(ret) & ANYOF_LOC_NONBITMAP_FOLD) {
11630                  op = EXACTFL;
11631             }
11632             else {
11633                 op = EXACT;
11634             }
11635         }
11636         else {   /* else 2 chars in the bit map: the folds of each other */
11637
11638             /* Use the folded value, which for the cases where we get here,
11639              * is just the lower case of the current one (which may resolve to
11640              * itself, or to the other one */
11641             value = toLOWER_LATIN1(value);
11642
11643             /* To join adjacent nodes, they must be the exact EXACTish type.
11644              * Try to use the most likely type, by using EXACTFA if possible,
11645              * then EXACTFU if the regex calls for it, or is required because
11646              * the character is non-ASCII.  (If <value> is ASCII, its fold is
11647              * also ASCII for the cases where we get here.) */
11648             if (MORE_ASCII_RESTRICTED && isASCII(value)) {
11649                 op = EXACTFA;
11650             }
11651             else if (AT_LEAST_UNI_SEMANTICS || !isASCII(value)) {
11652                 op = EXACTFU;
11653             }
11654             else {    /* Otherwise, more likely to be EXACTF type */
11655                 op = EXACTF;
11656             }
11657         }
11658
11659         ret = reg_node(pRExC_state, op);
11660         RExC_parse = (char *)cur_parse;
11661         if (UTF && ! NATIVE_IS_INVARIANT(value)) {
11662             *STRING(ret)= UTF8_EIGHT_BIT_HI((U8) value);
11663             *(STRING(ret) + 1)= UTF8_EIGHT_BIT_LO((U8) value);
11664             STR_LEN(ret)= 2;
11665             RExC_emit += STR_SZ(2);
11666         }
11667         else {
11668             *STRING(ret)= (char)value;
11669             STR_LEN(ret)= 1;
11670             RExC_emit += STR_SZ(1);
11671         }
11672         SvREFCNT_dec(listsv);
11673         return ret;
11674     }
11675
11676     /* If there is a swash and more than one element, we can't use the swash in
11677      * the optimization below. */
11678     if (swash && element_count > 1) {
11679         SvREFCNT_dec(swash);
11680         swash = NULL;
11681     }
11682     if (! nonbitmap
11683         && SvCUR(listsv) == initial_listsv_len
11684         && ! unicode_alternate)
11685     {
11686         ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
11687         SvREFCNT_dec(listsv);
11688         SvREFCNT_dec(unicode_alternate);
11689     }
11690     else {
11691         /* av[0] stores the character class description in its textual form:
11692          *       used later (regexec.c:Perl_regclass_swash()) to initialize the
11693          *       appropriate swash, and is also useful for dumping the regnode.
11694          * av[1] if NULL, is a placeholder to later contain the swash computed
11695          *       from av[0].  But if no further computation need be done, the
11696          *       swash is stored there now.
11697          * av[2] stores the multicharacter foldings, used later in
11698          *       regexec.c:S_reginclass().
11699          * av[3] stores the nonbitmap inversion list for use in addition or
11700          *       instead of av[0]; not used if av[1] isn't NULL
11701          * av[4] is set if any component of the class is from a user-defined
11702          *       property; not used if av[1] isn't NULL */
11703         AV * const av = newAV();
11704         SV *rv;
11705
11706         av_store(av, 0, (SvCUR(listsv) == initial_listsv_len)
11707                         ? &PL_sv_undef
11708                         : listsv);
11709         if (swash) {
11710             av_store(av, 1, swash);
11711             SvREFCNT_dec(nonbitmap);
11712         }
11713         else {
11714             av_store(av, 1, NULL);
11715             if (nonbitmap) {
11716                 av_store(av, 3, nonbitmap);
11717                 av_store(av, 4, newSVuv(has_user_defined_property));
11718             }
11719         }
11720
11721         /* Store any computed multi-char folds only if we are allowing
11722          * them */
11723         if (allow_full_fold) {
11724             av_store(av, 2, MUTABLE_SV(unicode_alternate));
11725             if (unicode_alternate) { /* This node is variable length */
11726                 OP(ret) = ANYOFV;
11727             }
11728         }
11729         else {
11730             av_store(av, 2, NULL);
11731         }
11732         rv = newRV_noinc(MUTABLE_SV(av));
11733         n = add_data(pRExC_state, 1, "s");
11734         RExC_rxi->data->data[n] = (void*)rv;
11735         ARG_SET(ret, n);
11736     }
11737     return ret;
11738 }
11739
11740
11741 /* reg_skipcomment()
11742
11743    Absorbs an /x style # comments from the input stream.
11744    Returns true if there is more text remaining in the stream.
11745    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
11746    terminates the pattern without including a newline.
11747
11748    Note its the callers responsibility to ensure that we are
11749    actually in /x mode
11750
11751 */
11752
11753 STATIC bool
11754 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
11755 {
11756     bool ended = 0;
11757
11758     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
11759
11760     while (RExC_parse < RExC_end)
11761         if (*RExC_parse++ == '\n') {
11762             ended = 1;
11763             break;
11764         }
11765     if (!ended) {
11766         /* we ran off the end of the pattern without ending
11767            the comment, so we have to add an \n when wrapping */
11768         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11769         return 0;
11770     } else
11771         return 1;
11772 }
11773
11774 /* nextchar()
11775
11776    Advances the parse position, and optionally absorbs
11777    "whitespace" from the inputstream.
11778
11779    Without /x "whitespace" means (?#...) style comments only,
11780    with /x this means (?#...) and # comments and whitespace proper.
11781
11782    Returns the RExC_parse point from BEFORE the scan occurs.
11783
11784    This is the /x friendly way of saying RExC_parse++.
11785 */
11786
11787 STATIC char*
11788 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
11789 {
11790     char* const retval = RExC_parse++;
11791
11792     PERL_ARGS_ASSERT_NEXTCHAR;
11793
11794     for (;;) {
11795         if (RExC_end - RExC_parse >= 3
11796             && *RExC_parse == '('
11797             && RExC_parse[1] == '?'
11798             && RExC_parse[2] == '#')
11799         {
11800             while (*RExC_parse != ')') {
11801                 if (RExC_parse == RExC_end)
11802                     FAIL("Sequence (?#... not terminated");
11803                 RExC_parse++;
11804             }
11805             RExC_parse++;
11806             continue;
11807         }
11808         if (RExC_flags & RXf_PMf_EXTENDED) {
11809             if (isSPACE(*RExC_parse)) {
11810                 RExC_parse++;
11811                 continue;
11812             }
11813             else if (*RExC_parse == '#') {
11814                 if ( reg_skipcomment( pRExC_state ) )
11815                     continue;
11816             }
11817         }
11818         return retval;
11819     }
11820 }
11821
11822 /*
11823 - reg_node - emit a node
11824 */
11825 STATIC regnode *                        /* Location. */
11826 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
11827 {
11828     dVAR;
11829     register regnode *ptr;
11830     regnode * const ret = RExC_emit;
11831     GET_RE_DEBUG_FLAGS_DECL;
11832
11833     PERL_ARGS_ASSERT_REG_NODE;
11834
11835     if (SIZE_ONLY) {
11836         SIZE_ALIGN(RExC_size);
11837         RExC_size += 1;
11838         return(ret);
11839     }
11840     if (RExC_emit >= RExC_emit_bound)
11841         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
11842                    op, RExC_emit, RExC_emit_bound);
11843
11844     NODE_ALIGN_FILL(ret);
11845     ptr = ret;
11846     FILL_ADVANCE_NODE(ptr, op);
11847 #ifdef RE_TRACK_PATTERN_OFFSETS
11848     if (RExC_offsets) {         /* MJD */
11849         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
11850               "reg_node", __LINE__, 
11851               PL_reg_name[op],
11852               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
11853                 ? "Overwriting end of array!\n" : "OK",
11854               (UV)(RExC_emit - RExC_emit_start),
11855               (UV)(RExC_parse - RExC_start),
11856               (UV)RExC_offsets[0])); 
11857         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
11858     }
11859 #endif
11860     RExC_emit = ptr;
11861     return(ret);
11862 }
11863
11864 /*
11865 - reganode - emit a node with an argument
11866 */
11867 STATIC regnode *                        /* Location. */
11868 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
11869 {
11870     dVAR;
11871     register regnode *ptr;
11872     regnode * const ret = RExC_emit;
11873     GET_RE_DEBUG_FLAGS_DECL;
11874
11875     PERL_ARGS_ASSERT_REGANODE;
11876
11877     if (SIZE_ONLY) {
11878         SIZE_ALIGN(RExC_size);
11879         RExC_size += 2;
11880         /* 
11881            We can't do this:
11882            
11883            assert(2==regarglen[op]+1); 
11884
11885            Anything larger than this has to allocate the extra amount.
11886            If we changed this to be:
11887            
11888            RExC_size += (1 + regarglen[op]);
11889            
11890            then it wouldn't matter. Its not clear what side effect
11891            might come from that so its not done so far.
11892            -- dmq
11893         */
11894         return(ret);
11895     }
11896     if (RExC_emit >= RExC_emit_bound)
11897         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
11898                    op, RExC_emit, RExC_emit_bound);
11899
11900     NODE_ALIGN_FILL(ret);
11901     ptr = ret;
11902     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
11903 #ifdef RE_TRACK_PATTERN_OFFSETS
11904     if (RExC_offsets) {         /* MJD */
11905         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
11906               "reganode",
11907               __LINE__,
11908               PL_reg_name[op],
11909               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
11910               "Overwriting end of array!\n" : "OK",
11911               (UV)(RExC_emit - RExC_emit_start),
11912               (UV)(RExC_parse - RExC_start),
11913               (UV)RExC_offsets[0])); 
11914         Set_Cur_Node_Offset;
11915     }
11916 #endif            
11917     RExC_emit = ptr;
11918     return(ret);
11919 }
11920
11921 /*
11922 - reguni - emit (if appropriate) a Unicode character
11923 */
11924 STATIC STRLEN
11925 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
11926 {
11927     dVAR;
11928
11929     PERL_ARGS_ASSERT_REGUNI;
11930
11931     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
11932 }
11933
11934 /*
11935 - reginsert - insert an operator in front of already-emitted operand
11936 *
11937 * Means relocating the operand.
11938 */
11939 STATIC void
11940 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
11941 {
11942     dVAR;
11943     register regnode *src;
11944     register regnode *dst;
11945     register regnode *place;
11946     const int offset = regarglen[(U8)op];
11947     const int size = NODE_STEP_REGNODE + offset;
11948     GET_RE_DEBUG_FLAGS_DECL;
11949
11950     PERL_ARGS_ASSERT_REGINSERT;
11951     PERL_UNUSED_ARG(depth);
11952 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
11953     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
11954     if (SIZE_ONLY) {
11955         RExC_size += size;
11956         return;
11957     }
11958
11959     src = RExC_emit;
11960     RExC_emit += size;
11961     dst = RExC_emit;
11962     if (RExC_open_parens) {
11963         int paren;
11964         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
11965         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
11966             if ( RExC_open_parens[paren] >= opnd ) {
11967                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
11968                 RExC_open_parens[paren] += size;
11969             } else {
11970                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
11971             }
11972             if ( RExC_close_parens[paren] >= opnd ) {
11973                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
11974                 RExC_close_parens[paren] += size;
11975             } else {
11976                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
11977             }
11978         }
11979     }
11980
11981     while (src > opnd) {
11982         StructCopy(--src, --dst, regnode);
11983 #ifdef RE_TRACK_PATTERN_OFFSETS
11984         if (RExC_offsets) {     /* MJD 20010112 */
11985             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
11986                   "reg_insert",
11987                   __LINE__,
11988                   PL_reg_name[op],
11989                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
11990                     ? "Overwriting end of array!\n" : "OK",
11991                   (UV)(src - RExC_emit_start),
11992                   (UV)(dst - RExC_emit_start),
11993                   (UV)RExC_offsets[0])); 
11994             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
11995             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
11996         }
11997 #endif
11998     }
11999     
12000
12001     place = opnd;               /* Op node, where operand used to be. */
12002 #ifdef RE_TRACK_PATTERN_OFFSETS
12003     if (RExC_offsets) {         /* MJD */
12004         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
12005               "reginsert",
12006               __LINE__,
12007               PL_reg_name[op],
12008               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
12009               ? "Overwriting end of array!\n" : "OK",
12010               (UV)(place - RExC_emit_start),
12011               (UV)(RExC_parse - RExC_start),
12012               (UV)RExC_offsets[0]));
12013         Set_Node_Offset(place, RExC_parse);
12014         Set_Node_Length(place, 1);
12015     }
12016 #endif    
12017     src = NEXTOPER(place);
12018     FILL_ADVANCE_NODE(place, op);
12019     Zero(src, offset, regnode);
12020 }
12021
12022 /*
12023 - regtail - set the next-pointer at the end of a node chain of p to val.
12024 - SEE ALSO: regtail_study
12025 */
12026 /* TODO: All three parms should be const */
12027 STATIC void
12028 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
12029 {
12030     dVAR;
12031     register regnode *scan;
12032     GET_RE_DEBUG_FLAGS_DECL;
12033
12034     PERL_ARGS_ASSERT_REGTAIL;
12035 #ifndef DEBUGGING
12036     PERL_UNUSED_ARG(depth);
12037 #endif
12038
12039     if (SIZE_ONLY)
12040         return;
12041
12042     /* Find last node. */
12043     scan = p;
12044     for (;;) {
12045         regnode * const temp = regnext(scan);
12046         DEBUG_PARSE_r({
12047             SV * const mysv=sv_newmortal();
12048             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
12049             regprop(RExC_rx, mysv, scan);
12050             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
12051                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
12052                     (temp == NULL ? "->" : ""),
12053                     (temp == NULL ? PL_reg_name[OP(val)] : "")
12054             );
12055         });
12056         if (temp == NULL)
12057             break;
12058         scan = temp;
12059     }
12060
12061     if (reg_off_by_arg[OP(scan)]) {
12062         ARG_SET(scan, val - scan);
12063     }
12064     else {
12065         NEXT_OFF(scan) = val - scan;
12066     }
12067 }
12068
12069 #ifdef DEBUGGING
12070 /*
12071 - regtail_study - set the next-pointer at the end of a node chain of p to val.
12072 - Look for optimizable sequences at the same time.
12073 - currently only looks for EXACT chains.
12074
12075 This is experimental code. The idea is to use this routine to perform 
12076 in place optimizations on branches and groups as they are constructed,
12077 with the long term intention of removing optimization from study_chunk so
12078 that it is purely analytical.
12079
12080 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
12081 to control which is which.
12082
12083 */
12084 /* TODO: All four parms should be const */
12085
12086 STATIC U8
12087 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
12088 {
12089     dVAR;
12090     register regnode *scan;
12091     U8 exact = PSEUDO;
12092 #ifdef EXPERIMENTAL_INPLACESCAN
12093     I32 min = 0;
12094 #endif
12095     GET_RE_DEBUG_FLAGS_DECL;
12096
12097     PERL_ARGS_ASSERT_REGTAIL_STUDY;
12098
12099
12100     if (SIZE_ONLY)
12101         return exact;
12102
12103     /* Find last node. */
12104
12105     scan = p;
12106     for (;;) {
12107         regnode * const temp = regnext(scan);
12108 #ifdef EXPERIMENTAL_INPLACESCAN
12109         if (PL_regkind[OP(scan)] == EXACT) {
12110             bool has_exactf_sharp_s;    /* Unexamined in this routine */
12111             if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
12112                 return EXACT;
12113         }
12114 #endif
12115         if ( exact ) {
12116             switch (OP(scan)) {
12117                 case EXACT:
12118                 case EXACTF:
12119                 case EXACTFA:
12120                 case EXACTFU:
12121                 case EXACTFU_SS:
12122                 case EXACTFU_TRICKYFOLD:
12123                 case EXACTFL:
12124                         if( exact == PSEUDO )
12125                             exact= OP(scan);
12126                         else if ( exact != OP(scan) )
12127                             exact= 0;
12128                 case NOTHING:
12129                     break;
12130                 default:
12131                     exact= 0;
12132             }
12133         }
12134         DEBUG_PARSE_r({
12135             SV * const mysv=sv_newmortal();
12136             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
12137             regprop(RExC_rx, mysv, scan);
12138             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
12139                 SvPV_nolen_const(mysv),
12140                 REG_NODE_NUM(scan),
12141                 PL_reg_name[exact]);
12142         });
12143         if (temp == NULL)
12144             break;
12145         scan = temp;
12146     }
12147     DEBUG_PARSE_r({
12148         SV * const mysv_val=sv_newmortal();
12149         DEBUG_PARSE_MSG("");
12150         regprop(RExC_rx, mysv_val, val);
12151         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
12152                       SvPV_nolen_const(mysv_val),
12153                       (IV)REG_NODE_NUM(val),
12154                       (IV)(val - scan)
12155         );
12156     });
12157     if (reg_off_by_arg[OP(scan)]) {
12158         ARG_SET(scan, val - scan);
12159     }
12160     else {
12161         NEXT_OFF(scan) = val - scan;
12162     }
12163
12164     return exact;
12165 }
12166 #endif
12167
12168 /*
12169  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
12170  */
12171 #ifdef DEBUGGING
12172 static void 
12173 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
12174 {
12175     int bit;
12176     int set=0;
12177     regex_charset cs;
12178
12179     for (bit=0; bit<32; bit++) {
12180         if (flags & (1<<bit)) {
12181             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
12182                 continue;
12183             }
12184             if (!set++ && lead) 
12185                 PerlIO_printf(Perl_debug_log, "%s",lead);
12186             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
12187         }               
12188     }      
12189     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
12190             if (!set++ && lead) {
12191                 PerlIO_printf(Perl_debug_log, "%s",lead);
12192             }
12193             switch (cs) {
12194                 case REGEX_UNICODE_CHARSET:
12195                     PerlIO_printf(Perl_debug_log, "UNICODE");
12196                     break;
12197                 case REGEX_LOCALE_CHARSET:
12198                     PerlIO_printf(Perl_debug_log, "LOCALE");
12199                     break;
12200                 case REGEX_ASCII_RESTRICTED_CHARSET:
12201                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
12202                     break;
12203                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
12204                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
12205                     break;
12206                 default:
12207                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
12208                     break;
12209             }
12210     }
12211     if (lead)  {
12212         if (set) 
12213             PerlIO_printf(Perl_debug_log, "\n");
12214         else 
12215             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
12216     }            
12217 }   
12218 #endif
12219
12220 void
12221 Perl_regdump(pTHX_ const regexp *r)
12222 {
12223 #ifdef DEBUGGING
12224     dVAR;
12225     SV * const sv = sv_newmortal();
12226     SV *dsv= sv_newmortal();
12227     RXi_GET_DECL(r,ri);
12228     GET_RE_DEBUG_FLAGS_DECL;
12229
12230     PERL_ARGS_ASSERT_REGDUMP;
12231
12232     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
12233
12234     /* Header fields of interest. */
12235     if (r->anchored_substr) {
12236         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
12237             RE_SV_DUMPLEN(r->anchored_substr), 30);
12238         PerlIO_printf(Perl_debug_log,
12239                       "anchored %s%s at %"IVdf" ",
12240                       s, RE_SV_TAIL(r->anchored_substr),
12241                       (IV)r->anchored_offset);
12242     } else if (r->anchored_utf8) {
12243         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
12244             RE_SV_DUMPLEN(r->anchored_utf8), 30);
12245         PerlIO_printf(Perl_debug_log,
12246                       "anchored utf8 %s%s at %"IVdf" ",
12247                       s, RE_SV_TAIL(r->anchored_utf8),
12248                       (IV)r->anchored_offset);
12249     }                 
12250     if (r->float_substr) {
12251         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
12252             RE_SV_DUMPLEN(r->float_substr), 30);
12253         PerlIO_printf(Perl_debug_log,
12254                       "floating %s%s at %"IVdf"..%"UVuf" ",
12255                       s, RE_SV_TAIL(r->float_substr),
12256                       (IV)r->float_min_offset, (UV)r->float_max_offset);
12257     } else if (r->float_utf8) {
12258         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
12259             RE_SV_DUMPLEN(r->float_utf8), 30);
12260         PerlIO_printf(Perl_debug_log,
12261                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
12262                       s, RE_SV_TAIL(r->float_utf8),
12263                       (IV)r->float_min_offset, (UV)r->float_max_offset);
12264     }
12265     if (r->check_substr || r->check_utf8)
12266         PerlIO_printf(Perl_debug_log,
12267                       (const char *)
12268                       (r->check_substr == r->float_substr
12269                        && r->check_utf8 == r->float_utf8
12270                        ? "(checking floating" : "(checking anchored"));
12271     if (r->extflags & RXf_NOSCAN)
12272         PerlIO_printf(Perl_debug_log, " noscan");
12273     if (r->extflags & RXf_CHECK_ALL)
12274         PerlIO_printf(Perl_debug_log, " isall");
12275     if (r->check_substr || r->check_utf8)
12276         PerlIO_printf(Perl_debug_log, ") ");
12277
12278     if (ri->regstclass) {
12279         regprop(r, sv, ri->regstclass);
12280         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
12281     }
12282     if (r->extflags & RXf_ANCH) {
12283         PerlIO_printf(Perl_debug_log, "anchored");
12284         if (r->extflags & RXf_ANCH_BOL)
12285             PerlIO_printf(Perl_debug_log, "(BOL)");
12286         if (r->extflags & RXf_ANCH_MBOL)
12287             PerlIO_printf(Perl_debug_log, "(MBOL)");
12288         if (r->extflags & RXf_ANCH_SBOL)
12289             PerlIO_printf(Perl_debug_log, "(SBOL)");
12290         if (r->extflags & RXf_ANCH_GPOS)
12291             PerlIO_printf(Perl_debug_log, "(GPOS)");
12292         PerlIO_putc(Perl_debug_log, ' ');
12293     }
12294     if (r->extflags & RXf_GPOS_SEEN)
12295         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
12296     if (r->intflags & PREGf_SKIP)
12297         PerlIO_printf(Perl_debug_log, "plus ");
12298     if (r->intflags & PREGf_IMPLICIT)
12299         PerlIO_printf(Perl_debug_log, "implicit ");
12300     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
12301     if (r->extflags & RXf_EVAL_SEEN)
12302         PerlIO_printf(Perl_debug_log, "with eval ");
12303     PerlIO_printf(Perl_debug_log, "\n");
12304     DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));            
12305 #else
12306     PERL_ARGS_ASSERT_REGDUMP;
12307     PERL_UNUSED_CONTEXT;
12308     PERL_UNUSED_ARG(r);
12309 #endif  /* DEBUGGING */
12310 }
12311
12312 /*
12313 - regprop - printable representation of opcode
12314 */
12315 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
12316 STMT_START { \
12317         if (do_sep) {                           \
12318             Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
12319             if (flags & ANYOF_INVERT)           \
12320                 /*make sure the invert info is in each */ \
12321                 sv_catpvs(sv, "^");             \
12322             do_sep = 0;                         \
12323         }                                       \
12324 } STMT_END
12325
12326 void
12327 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
12328 {
12329 #ifdef DEBUGGING
12330     dVAR;
12331     register int k;
12332     RXi_GET_DECL(prog,progi);
12333     GET_RE_DEBUG_FLAGS_DECL;
12334     
12335     PERL_ARGS_ASSERT_REGPROP;
12336
12337     sv_setpvs(sv, "");
12338
12339     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
12340         /* It would be nice to FAIL() here, but this may be called from
12341            regexec.c, and it would be hard to supply pRExC_state. */
12342         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
12343     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
12344
12345     k = PL_regkind[OP(o)];
12346
12347     if (k == EXACT) {
12348         sv_catpvs(sv, " ");
12349         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
12350          * is a crude hack but it may be the best for now since 
12351          * we have no flag "this EXACTish node was UTF-8" 
12352          * --jhi */
12353         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
12354                   PERL_PV_ESCAPE_UNI_DETECT |
12355                   PERL_PV_ESCAPE_NONASCII   |
12356                   PERL_PV_PRETTY_ELLIPSES   |
12357                   PERL_PV_PRETTY_LTGT       |
12358                   PERL_PV_PRETTY_NOCLEAR
12359                   );
12360     } else if (k == TRIE) {
12361         /* print the details of the trie in dumpuntil instead, as
12362          * progi->data isn't available here */
12363         const char op = OP(o);
12364         const U32 n = ARG(o);
12365         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
12366                (reg_ac_data *)progi->data->data[n] :
12367                NULL;
12368         const reg_trie_data * const trie
12369             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
12370         
12371         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
12372         DEBUG_TRIE_COMPILE_r(
12373             Perl_sv_catpvf(aTHX_ sv,
12374                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
12375                 (UV)trie->startstate,
12376                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
12377                 (UV)trie->wordcount,
12378                 (UV)trie->minlen,
12379                 (UV)trie->maxlen,
12380                 (UV)TRIE_CHARCOUNT(trie),
12381                 (UV)trie->uniquecharcount
12382             )
12383         );
12384         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
12385             int i;
12386             int rangestart = -1;
12387             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
12388             sv_catpvs(sv, "[");
12389             for (i = 0; i <= 256; i++) {
12390                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
12391                     if (rangestart == -1)
12392                         rangestart = i;
12393                 } else if (rangestart != -1) {
12394                     if (i <= rangestart + 3)
12395                         for (; rangestart < i; rangestart++)
12396                             put_byte(sv, rangestart);
12397                     else {
12398                         put_byte(sv, rangestart);
12399                         sv_catpvs(sv, "-");
12400                         put_byte(sv, i - 1);
12401                     }
12402                     rangestart = -1;
12403                 }
12404             }
12405             sv_catpvs(sv, "]");
12406         } 
12407          
12408     } else if (k == CURLY) {
12409         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
12410             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
12411         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
12412     }
12413     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
12414         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
12415     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
12416         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
12417         if ( RXp_PAREN_NAMES(prog) ) {
12418             if ( k != REF || (OP(o) < NREF)) {
12419                 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
12420                 SV **name= av_fetch(list, ARG(o), 0 );
12421                 if (name)
12422                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
12423             }       
12424             else {
12425                 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
12426                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
12427                 I32 *nums=(I32*)SvPVX(sv_dat);
12428                 SV **name= av_fetch(list, nums[0], 0 );
12429                 I32 n;
12430                 if (name) {
12431                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
12432                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
12433                                     (n ? "," : ""), (IV)nums[n]);
12434                     }
12435                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
12436                 }
12437             }
12438         }            
12439     } else if (k == GOSUB) 
12440         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
12441     else if (k == VERB) {
12442         if (!o->flags) 
12443             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
12444                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
12445     } else if (k == LOGICAL)
12446         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
12447     else if (k == ANYOF) {
12448         int i, rangestart = -1;
12449         const U8 flags = ANYOF_FLAGS(o);
12450         int do_sep = 0;
12451
12452         /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
12453         static const char * const anyofs[] = {
12454             "\\w",
12455             "\\W",
12456             "\\s",
12457             "\\S",
12458             "\\d",
12459             "\\D",
12460             "[:alnum:]",
12461             "[:^alnum:]",
12462             "[:alpha:]",
12463             "[:^alpha:]",
12464             "[:ascii:]",
12465             "[:^ascii:]",
12466             "[:cntrl:]",
12467             "[:^cntrl:]",
12468             "[:graph:]",
12469             "[:^graph:]",
12470             "[:lower:]",
12471             "[:^lower:]",
12472             "[:print:]",
12473             "[:^print:]",
12474             "[:punct:]",
12475             "[:^punct:]",
12476             "[:upper:]",
12477             "[:^upper:]",
12478             "[:xdigit:]",
12479             "[:^xdigit:]",
12480             "[:space:]",
12481             "[:^space:]",
12482             "[:blank:]",
12483             "[:^blank:]"
12484         };
12485
12486         if (flags & ANYOF_LOCALE)
12487             sv_catpvs(sv, "{loc}");
12488         if (flags & ANYOF_LOC_NONBITMAP_FOLD)
12489             sv_catpvs(sv, "{i}");
12490         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
12491         if (flags & ANYOF_INVERT)
12492             sv_catpvs(sv, "^");
12493
12494         /* output what the standard cp 0-255 bitmap matches */
12495         for (i = 0; i <= 256; i++) {
12496             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
12497                 if (rangestart == -1)
12498                     rangestart = i;
12499             } else if (rangestart != -1) {
12500                 if (i <= rangestart + 3)
12501                     for (; rangestart < i; rangestart++)
12502                         put_byte(sv, rangestart);
12503                 else {
12504                     put_byte(sv, rangestart);
12505                     sv_catpvs(sv, "-");
12506                     put_byte(sv, i - 1);
12507                 }
12508                 do_sep = 1;
12509                 rangestart = -1;
12510             }
12511         }
12512         
12513         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
12514         /* output any special charclass tests (used entirely under use locale) */
12515         if (ANYOF_CLASS_TEST_ANY_SET(o))
12516             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
12517                 if (ANYOF_CLASS_TEST(o,i)) {
12518                     sv_catpv(sv, anyofs[i]);
12519                     do_sep = 1;
12520                 }
12521         
12522         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
12523         
12524         if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
12525             sv_catpvs(sv, "{non-utf8-latin1-all}");
12526         }
12527
12528         /* output information about the unicode matching */
12529         if (flags & ANYOF_UNICODE_ALL)
12530             sv_catpvs(sv, "{unicode_all}");
12531         else if (ANYOF_NONBITMAP(o))
12532             sv_catpvs(sv, "{unicode}");
12533         if (flags & ANYOF_NONBITMAP_NON_UTF8)
12534             sv_catpvs(sv, "{outside bitmap}");
12535
12536         if (ANYOF_NONBITMAP(o)) {
12537             SV *lv; /* Set if there is something outside the bit map */
12538             SV * const sw = regclass_swash(prog, o, FALSE, &lv, 0);
12539             bool byte_output = FALSE;   /* If something in the bitmap has been
12540                                            output */
12541
12542             if (lv && lv != &PL_sv_undef) {
12543                 if (sw) {
12544                     U8 s[UTF8_MAXBYTES_CASE+1];
12545
12546                     for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
12547                         uvchr_to_utf8(s, i);
12548
12549                         if (i < 256
12550                             && ! ANYOF_BITMAP_TEST(o, i)    /* Don't duplicate
12551                                                                things already
12552                                                                output as part
12553                                                                of the bitmap */
12554                             && swash_fetch(sw, s, TRUE))
12555                         {
12556                             if (rangestart == -1)
12557                                 rangestart = i;
12558                         } else if (rangestart != -1) {
12559                             byte_output = TRUE;
12560                             if (i <= rangestart + 3)
12561                                 for (; rangestart < i; rangestart++) {
12562                                     put_byte(sv, rangestart);
12563                                 }
12564                             else {
12565                                 put_byte(sv, rangestart);
12566                                 sv_catpvs(sv, "-");
12567                                 put_byte(sv, i-1);
12568                             }
12569                             rangestart = -1;
12570                         }
12571                     }
12572                 }
12573
12574                 {
12575                     char *s = savesvpv(lv);
12576                     char * const origs = s;
12577
12578                     while (*s && *s != '\n')
12579                         s++;
12580
12581                     if (*s == '\n') {
12582                         const char * const t = ++s;
12583
12584                         if (byte_output) {
12585                             sv_catpvs(sv, " ");
12586                         }
12587
12588                         while (*s) {
12589                             if (*s == '\n') {
12590
12591                                 /* Truncate very long output */
12592                                 if (s - origs > 256) {
12593                                     Perl_sv_catpvf(aTHX_ sv,
12594                                                    "%.*s...",
12595                                                    (int) (s - origs - 1),
12596                                                    t);
12597                                     goto out_dump;
12598                                 }
12599                                 *s = ' ';
12600                             }
12601                             else if (*s == '\t') {
12602                                 *s = '-';
12603                             }
12604                             s++;
12605                         }
12606                         if (s[-1] == ' ')
12607                             s[-1] = 0;
12608
12609                         sv_catpv(sv, t);
12610                     }
12611
12612                 out_dump:
12613
12614                     Safefree(origs);
12615                 }
12616                 SvREFCNT_dec(lv);
12617             }
12618         }
12619
12620         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
12621     }
12622     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
12623         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
12624 #else
12625     PERL_UNUSED_CONTEXT;
12626     PERL_UNUSED_ARG(sv);
12627     PERL_UNUSED_ARG(o);
12628     PERL_UNUSED_ARG(prog);
12629 #endif  /* DEBUGGING */
12630 }
12631
12632 SV *
12633 Perl_re_intuit_string(pTHX_ REGEXP * const r)
12634 {                               /* Assume that RE_INTUIT is set */
12635     dVAR;
12636     struct regexp *const prog = (struct regexp *)SvANY(r);
12637     GET_RE_DEBUG_FLAGS_DECL;
12638
12639     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
12640     PERL_UNUSED_CONTEXT;
12641
12642     DEBUG_COMPILE_r(
12643         {
12644             const char * const s = SvPV_nolen_const(prog->check_substr
12645                       ? prog->check_substr : prog->check_utf8);
12646
12647             if (!PL_colorset) reginitcolors();
12648             PerlIO_printf(Perl_debug_log,
12649                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
12650                       PL_colors[4],
12651                       prog->check_substr ? "" : "utf8 ",
12652                       PL_colors[5],PL_colors[0],
12653                       s,
12654                       PL_colors[1],
12655                       (strlen(s) > 60 ? "..." : ""));
12656         } );
12657
12658     return prog->check_substr ? prog->check_substr : prog->check_utf8;
12659 }
12660
12661 /* 
12662    pregfree() 
12663    
12664    handles refcounting and freeing the perl core regexp structure. When 
12665    it is necessary to actually free the structure the first thing it 
12666    does is call the 'free' method of the regexp_engine associated to
12667    the regexp, allowing the handling of the void *pprivate; member 
12668    first. (This routine is not overridable by extensions, which is why 
12669    the extensions free is called first.)
12670    
12671    See regdupe and regdupe_internal if you change anything here. 
12672 */
12673 #ifndef PERL_IN_XSUB_RE
12674 void
12675 Perl_pregfree(pTHX_ REGEXP *r)
12676 {
12677     SvREFCNT_dec(r);
12678 }
12679
12680 void
12681 Perl_pregfree2(pTHX_ REGEXP *rx)
12682 {
12683     dVAR;
12684     struct regexp *const r = (struct regexp *)SvANY(rx);
12685     GET_RE_DEBUG_FLAGS_DECL;
12686
12687     PERL_ARGS_ASSERT_PREGFREE2;
12688
12689     if (r->mother_re) {
12690         ReREFCNT_dec(r->mother_re);
12691     } else {
12692         CALLREGFREE_PVT(rx); /* free the private data */
12693         SvREFCNT_dec(RXp_PAREN_NAMES(r));
12694     }        
12695     if (r->substrs) {
12696         SvREFCNT_dec(r->anchored_substr);
12697         SvREFCNT_dec(r->anchored_utf8);
12698         SvREFCNT_dec(r->float_substr);
12699         SvREFCNT_dec(r->float_utf8);
12700         Safefree(r->substrs);
12701     }
12702     RX_MATCH_COPY_FREE(rx);
12703 #ifdef PERL_OLD_COPY_ON_WRITE
12704     SvREFCNT_dec(r->saved_copy);
12705 #endif
12706     Safefree(r->offs);
12707 }
12708
12709 /*  reg_temp_copy()
12710     
12711     This is a hacky workaround to the structural issue of match results
12712     being stored in the regexp structure which is in turn stored in
12713     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
12714     could be PL_curpm in multiple contexts, and could require multiple
12715     result sets being associated with the pattern simultaneously, such
12716     as when doing a recursive match with (??{$qr})
12717     
12718     The solution is to make a lightweight copy of the regexp structure 
12719     when a qr// is returned from the code executed by (??{$qr}) this
12720     lightweight copy doesn't actually own any of its data except for
12721     the starp/end and the actual regexp structure itself. 
12722     
12723 */    
12724     
12725     
12726 REGEXP *
12727 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
12728 {
12729     struct regexp *ret;
12730     struct regexp *const r = (struct regexp *)SvANY(rx);
12731     register const I32 npar = r->nparens+1;
12732
12733     PERL_ARGS_ASSERT_REG_TEMP_COPY;
12734
12735     if (!ret_x)
12736         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
12737     ret = (struct regexp *)SvANY(ret_x);
12738     
12739     (void)ReREFCNT_inc(rx);
12740     /* We can take advantage of the existing "copied buffer" mechanism in SVs
12741        by pointing directly at the buffer, but flagging that the allocated
12742        space in the copy is zero. As we've just done a struct copy, it's now
12743        a case of zero-ing that, rather than copying the current length.  */
12744     SvPV_set(ret_x, RX_WRAPPED(rx));
12745     SvFLAGS(ret_x) |= SvFLAGS(rx) & (SVf_POK|SVp_POK|SVf_UTF8);
12746     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
12747            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
12748     SvLEN_set(ret_x, 0);
12749     SvSTASH_set(ret_x, NULL);
12750     SvMAGIC_set(ret_x, NULL);
12751     Newx(ret->offs, npar, regexp_paren_pair);
12752     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
12753     if (r->substrs) {
12754         Newx(ret->substrs, 1, struct reg_substr_data);
12755         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
12756
12757         SvREFCNT_inc_void(ret->anchored_substr);
12758         SvREFCNT_inc_void(ret->anchored_utf8);
12759         SvREFCNT_inc_void(ret->float_substr);
12760         SvREFCNT_inc_void(ret->float_utf8);
12761
12762         /* check_substr and check_utf8, if non-NULL, point to either their
12763            anchored or float namesakes, and don't hold a second reference.  */
12764     }
12765     RX_MATCH_COPIED_off(ret_x);
12766 #ifdef PERL_OLD_COPY_ON_WRITE
12767     ret->saved_copy = NULL;
12768 #endif
12769     ret->mother_re = rx;
12770     
12771     return ret_x;
12772 }
12773 #endif
12774
12775 /* regfree_internal() 
12776
12777    Free the private data in a regexp. This is overloadable by 
12778    extensions. Perl takes care of the regexp structure in pregfree(), 
12779    this covers the *pprivate pointer which technically perl doesn't 
12780    know about, however of course we have to handle the 
12781    regexp_internal structure when no extension is in use. 
12782    
12783    Note this is called before freeing anything in the regexp 
12784    structure. 
12785  */
12786  
12787 void
12788 Perl_regfree_internal(pTHX_ REGEXP * const rx)
12789 {
12790     dVAR;
12791     struct regexp *const r = (struct regexp *)SvANY(rx);
12792     RXi_GET_DECL(r,ri);
12793     GET_RE_DEBUG_FLAGS_DECL;
12794
12795     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
12796
12797     DEBUG_COMPILE_r({
12798         if (!PL_colorset)
12799             reginitcolors();
12800         {
12801             SV *dsv= sv_newmortal();
12802             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
12803                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
12804             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
12805                 PL_colors[4],PL_colors[5],s);
12806         }
12807     });
12808 #ifdef RE_TRACK_PATTERN_OFFSETS
12809     if (ri->u.offsets)
12810         Safefree(ri->u.offsets);             /* 20010421 MJD */
12811 #endif
12812     if (ri->data) {
12813         int n = ri->data->count;
12814         PAD* new_comppad = NULL;
12815         PAD* old_comppad;
12816         PADOFFSET refcnt;
12817
12818         while (--n >= 0) {
12819           /* If you add a ->what type here, update the comment in regcomp.h */
12820             switch (ri->data->what[n]) {
12821             case 'a':
12822             case 's':
12823             case 'S':
12824             case 'u':
12825                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
12826                 break;
12827             case 'f':
12828                 Safefree(ri->data->data[n]);
12829                 break;
12830             case 'p':
12831                 new_comppad = MUTABLE_AV(ri->data->data[n]);
12832                 break;
12833             case 'o':
12834                 if (new_comppad == NULL)
12835                     Perl_croak(aTHX_ "panic: pregfree comppad");
12836                 PAD_SAVE_LOCAL(old_comppad,
12837                     /* Watch out for global destruction's random ordering. */
12838                     (SvTYPE(new_comppad) == SVt_PVAV) ? new_comppad : NULL
12839                 );
12840                 OP_REFCNT_LOCK;
12841                 refcnt = OpREFCNT_dec((OP_4tree*)ri->data->data[n]);
12842                 OP_REFCNT_UNLOCK;
12843                 if (!refcnt)
12844                     op_free((OP_4tree*)ri->data->data[n]);
12845
12846                 PAD_RESTORE_LOCAL(old_comppad);
12847                 SvREFCNT_dec(MUTABLE_SV(new_comppad));
12848                 new_comppad = NULL;
12849                 break;
12850             case 'n':
12851                 break;
12852             case 'T':           
12853                 { /* Aho Corasick add-on structure for a trie node.
12854                      Used in stclass optimization only */
12855                     U32 refcount;
12856                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
12857                     OP_REFCNT_LOCK;
12858                     refcount = --aho->refcount;
12859                     OP_REFCNT_UNLOCK;
12860                     if ( !refcount ) {
12861                         PerlMemShared_free(aho->states);
12862                         PerlMemShared_free(aho->fail);
12863                          /* do this last!!!! */
12864                         PerlMemShared_free(ri->data->data[n]);
12865                         PerlMemShared_free(ri->regstclass);
12866                     }
12867                 }
12868                 break;
12869             case 't':
12870                 {
12871                     /* trie structure. */
12872                     U32 refcount;
12873                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
12874                     OP_REFCNT_LOCK;
12875                     refcount = --trie->refcount;
12876                     OP_REFCNT_UNLOCK;
12877                     if ( !refcount ) {
12878                         PerlMemShared_free(trie->charmap);
12879                         PerlMemShared_free(trie->states);
12880                         PerlMemShared_free(trie->trans);
12881                         if (trie->bitmap)
12882                             PerlMemShared_free(trie->bitmap);
12883                         if (trie->jump)
12884                             PerlMemShared_free(trie->jump);
12885                         PerlMemShared_free(trie->wordinfo);
12886                         /* do this last!!!! */
12887                         PerlMemShared_free(ri->data->data[n]);
12888                     }
12889                 }
12890                 break;
12891             default:
12892                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
12893             }
12894         }
12895         Safefree(ri->data->what);
12896         Safefree(ri->data);
12897     }
12898
12899     Safefree(ri);
12900 }
12901
12902 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
12903 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
12904 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
12905
12906 /* 
12907    re_dup - duplicate a regexp. 
12908    
12909    This routine is expected to clone a given regexp structure. It is only
12910    compiled under USE_ITHREADS.
12911
12912    After all of the core data stored in struct regexp is duplicated
12913    the regexp_engine.dupe method is used to copy any private data
12914    stored in the *pprivate pointer. This allows extensions to handle
12915    any duplication it needs to do.
12916
12917    See pregfree() and regfree_internal() if you change anything here. 
12918 */
12919 #if defined(USE_ITHREADS)
12920 #ifndef PERL_IN_XSUB_RE
12921 void
12922 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
12923 {
12924     dVAR;
12925     I32 npar;
12926     const struct regexp *r = (const struct regexp *)SvANY(sstr);
12927     struct regexp *ret = (struct regexp *)SvANY(dstr);
12928     
12929     PERL_ARGS_ASSERT_RE_DUP_GUTS;
12930
12931     npar = r->nparens+1;
12932     Newx(ret->offs, npar, regexp_paren_pair);
12933     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
12934     if(ret->swap) {
12935         /* no need to copy these */
12936         Newx(ret->swap, npar, regexp_paren_pair);
12937     }
12938
12939     if (ret->substrs) {
12940         /* Do it this way to avoid reading from *r after the StructCopy().
12941            That way, if any of the sv_dup_inc()s dislodge *r from the L1
12942            cache, it doesn't matter.  */
12943         const bool anchored = r->check_substr
12944             ? r->check_substr == r->anchored_substr
12945             : r->check_utf8 == r->anchored_utf8;
12946         Newx(ret->substrs, 1, struct reg_substr_data);
12947         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
12948
12949         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
12950         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
12951         ret->float_substr = sv_dup_inc(ret->float_substr, param);
12952         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
12953
12954         /* check_substr and check_utf8, if non-NULL, point to either their
12955            anchored or float namesakes, and don't hold a second reference.  */
12956
12957         if (ret->check_substr) {
12958             if (anchored) {
12959                 assert(r->check_utf8 == r->anchored_utf8);
12960                 ret->check_substr = ret->anchored_substr;
12961                 ret->check_utf8 = ret->anchored_utf8;
12962             } else {
12963                 assert(r->check_substr == r->float_substr);
12964                 assert(r->check_utf8 == r->float_utf8);
12965                 ret->check_substr = ret->float_substr;
12966                 ret->check_utf8 = ret->float_utf8;
12967             }
12968         } else if (ret->check_utf8) {
12969             if (anchored) {
12970                 ret->check_utf8 = ret->anchored_utf8;
12971             } else {
12972                 ret->check_utf8 = ret->float_utf8;
12973             }
12974         }
12975     }
12976
12977     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
12978
12979     if (ret->pprivate)
12980         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
12981
12982     if (RX_MATCH_COPIED(dstr))
12983         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
12984     else
12985         ret->subbeg = NULL;
12986 #ifdef PERL_OLD_COPY_ON_WRITE
12987     ret->saved_copy = NULL;
12988 #endif
12989
12990     if (ret->mother_re) {
12991         if (SvPVX_const(dstr) == SvPVX_const(ret->mother_re)) {
12992             /* Our storage points directly to our mother regexp, but that's
12993                1: a buffer in a different thread
12994                2: something we no longer hold a reference on
12995                so we need to copy it locally.  */
12996             /* Note we need to use SvCUR(), rather than
12997                SvLEN(), on our mother_re, because it, in
12998                turn, may well be pointing to its own mother_re.  */
12999             SvPV_set(dstr, SAVEPVN(SvPVX_const(ret->mother_re),
13000                                    SvCUR(ret->mother_re)+1));
13001             SvLEN_set(dstr, SvCUR(ret->mother_re)+1);
13002         }
13003         ret->mother_re      = NULL;
13004     }
13005     ret->gofs = 0;
13006 }
13007 #endif /* PERL_IN_XSUB_RE */
13008
13009 /*
13010    regdupe_internal()
13011    
13012    This is the internal complement to regdupe() which is used to copy
13013    the structure pointed to by the *pprivate pointer in the regexp.
13014    This is the core version of the extension overridable cloning hook.
13015    The regexp structure being duplicated will be copied by perl prior
13016    to this and will be provided as the regexp *r argument, however 
13017    with the /old/ structures pprivate pointer value. Thus this routine
13018    may override any copying normally done by perl.
13019    
13020    It returns a pointer to the new regexp_internal structure.
13021 */
13022
13023 void *
13024 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
13025 {
13026     dVAR;
13027     struct regexp *const r = (struct regexp *)SvANY(rx);
13028     regexp_internal *reti;
13029     int len;
13030     RXi_GET_DECL(r,ri);
13031
13032     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
13033     
13034     len = ProgLen(ri);
13035     
13036     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
13037     Copy(ri->program, reti->program, len+1, regnode);
13038     
13039
13040     reti->regstclass = NULL;
13041
13042     if (ri->data) {
13043         struct reg_data *d;
13044         const int count = ri->data->count;
13045         int i;
13046
13047         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
13048                 char, struct reg_data);
13049         Newx(d->what, count, U8);
13050
13051         d->count = count;
13052         for (i = 0; i < count; i++) {
13053             d->what[i] = ri->data->what[i];
13054             switch (d->what[i]) {
13055                 /* legal options are one of: sSfpontTua
13056                    see also regcomp.h and pregfree() */
13057             case 'a': /* actually an AV, but the dup function is identical.  */
13058             case 's':
13059             case 'S':
13060             case 'p': /* actually an AV, but the dup function is identical.  */
13061             case 'u': /* actually an HV, but the dup function is identical.  */
13062                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
13063                 break;
13064             case 'f':
13065                 /* This is cheating. */
13066                 Newx(d->data[i], 1, struct regnode_charclass_class);
13067                 StructCopy(ri->data->data[i], d->data[i],
13068                             struct regnode_charclass_class);
13069                 reti->regstclass = (regnode*)d->data[i];
13070                 break;
13071             case 'o':
13072                 /* Compiled op trees are readonly and in shared memory,
13073                    and can thus be shared without duplication. */
13074                 OP_REFCNT_LOCK;
13075                 d->data[i] = (void*)OpREFCNT_inc((OP*)ri->data->data[i]);
13076                 OP_REFCNT_UNLOCK;
13077                 break;
13078             case 'T':
13079                 /* Trie stclasses are readonly and can thus be shared
13080                  * without duplication. We free the stclass in pregfree
13081                  * when the corresponding reg_ac_data struct is freed.
13082                  */
13083                 reti->regstclass= ri->regstclass;
13084                 /* Fall through */
13085             case 't':
13086                 OP_REFCNT_LOCK;
13087                 ((reg_trie_data*)ri->data->data[i])->refcount++;
13088                 OP_REFCNT_UNLOCK;
13089                 /* Fall through */
13090             case 'n':
13091                 d->data[i] = ri->data->data[i];
13092                 break;
13093             default:
13094                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
13095             }
13096         }
13097
13098         reti->data = d;
13099     }
13100     else
13101         reti->data = NULL;
13102
13103     reti->name_list_idx = ri->name_list_idx;
13104
13105 #ifdef RE_TRACK_PATTERN_OFFSETS
13106     if (ri->u.offsets) {
13107         Newx(reti->u.offsets, 2*len+1, U32);
13108         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
13109     }
13110 #else
13111     SetProgLen(reti,len);
13112 #endif
13113
13114     return (void*)reti;
13115 }
13116
13117 #endif    /* USE_ITHREADS */
13118
13119 #ifndef PERL_IN_XSUB_RE
13120
13121 /*
13122  - regnext - dig the "next" pointer out of a node
13123  */
13124 regnode *
13125 Perl_regnext(pTHX_ register regnode *p)
13126 {
13127     dVAR;
13128     register I32 offset;
13129
13130     if (!p)
13131         return(NULL);
13132
13133     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
13134         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
13135     }
13136
13137     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
13138     if (offset == 0)
13139         return(NULL);
13140
13141     return(p+offset);
13142 }
13143 #endif
13144
13145 STATIC void
13146 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
13147 {
13148     va_list args;
13149     STRLEN l1 = strlen(pat1);
13150     STRLEN l2 = strlen(pat2);
13151     char buf[512];
13152     SV *msv;
13153     const char *message;
13154
13155     PERL_ARGS_ASSERT_RE_CROAK2;
13156
13157     if (l1 > 510)
13158         l1 = 510;
13159     if (l1 + l2 > 510)
13160         l2 = 510 - l1;
13161     Copy(pat1, buf, l1 , char);
13162     Copy(pat2, buf + l1, l2 , char);
13163     buf[l1 + l2] = '\n';
13164     buf[l1 + l2 + 1] = '\0';
13165 #ifdef I_STDARG
13166     /* ANSI variant takes additional second argument */
13167     va_start(args, pat2);
13168 #else
13169     va_start(args);
13170 #endif
13171     msv = vmess(buf, &args);
13172     va_end(args);
13173     message = SvPV_const(msv,l1);
13174     if (l1 > 512)
13175         l1 = 512;
13176     Copy(message, buf, l1 , char);
13177     buf[l1-1] = '\0';                   /* Overwrite \n */
13178     Perl_croak(aTHX_ "%s", buf);
13179 }
13180
13181 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
13182
13183 #ifndef PERL_IN_XSUB_RE
13184 void
13185 Perl_save_re_context(pTHX)
13186 {
13187     dVAR;
13188
13189     struct re_save_state *state;
13190
13191     SAVEVPTR(PL_curcop);
13192     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
13193
13194     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
13195     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
13196     SSPUSHUV(SAVEt_RE_STATE);
13197
13198     Copy(&PL_reg_state, state, 1, struct re_save_state);
13199
13200     PL_reg_start_tmp = 0;
13201     PL_reg_start_tmpl = 0;
13202     PL_reg_oldsaved = NULL;
13203     PL_reg_oldsavedlen = 0;
13204     PL_reg_maxiter = 0;
13205     PL_reg_leftiter = 0;
13206     PL_reg_poscache = NULL;
13207     PL_reg_poscache_size = 0;
13208 #ifdef PERL_OLD_COPY_ON_WRITE
13209     PL_nrs = NULL;
13210 #endif
13211
13212     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
13213     if (PL_curpm) {
13214         const REGEXP * const rx = PM_GETRE(PL_curpm);
13215         if (rx) {
13216             U32 i;
13217             for (i = 1; i <= RX_NPARENS(rx); i++) {
13218                 char digits[TYPE_CHARS(long)];
13219                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
13220                 GV *const *const gvp
13221                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
13222
13223                 if (gvp) {
13224                     GV * const gv = *gvp;
13225                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
13226                         save_scalar(gv);
13227                 }
13228             }
13229         }
13230     }
13231 }
13232 #endif
13233
13234 static void
13235 clear_re(pTHX_ void *r)
13236 {
13237     dVAR;
13238     ReREFCNT_dec((REGEXP *)r);
13239 }
13240
13241 #ifdef DEBUGGING
13242
13243 STATIC void
13244 S_put_byte(pTHX_ SV *sv, int c)
13245 {
13246     PERL_ARGS_ASSERT_PUT_BYTE;
13247
13248     /* Our definition of isPRINT() ignores locales, so only bytes that are
13249        not part of UTF-8 are considered printable. I assume that the same
13250        holds for UTF-EBCDIC.
13251        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
13252        which Wikipedia says:
13253
13254        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
13255        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
13256        identical, to the ASCII delete (DEL) or rubout control character.
13257        ) So the old condition can be simplified to !isPRINT(c)  */
13258     if (!isPRINT(c)) {
13259         if (c < 256) {
13260             Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
13261         }
13262         else {
13263             Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
13264         }
13265     }
13266     else {
13267         const char string = c;
13268         if (c == '-' || c == ']' || c == '\\' || c == '^')
13269             sv_catpvs(sv, "\\");
13270         sv_catpvn(sv, &string, 1);
13271     }
13272 }
13273
13274
13275 #define CLEAR_OPTSTART \
13276     if (optstart) STMT_START { \
13277             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
13278             optstart=NULL; \
13279     } STMT_END
13280
13281 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
13282
13283 STATIC const regnode *
13284 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
13285             const regnode *last, const regnode *plast, 
13286             SV* sv, I32 indent, U32 depth)
13287 {
13288     dVAR;
13289     register U8 op = PSEUDO;    /* Arbitrary non-END op. */
13290     register const regnode *next;
13291     const regnode *optstart= NULL;
13292     
13293     RXi_GET_DECL(r,ri);
13294     GET_RE_DEBUG_FLAGS_DECL;
13295
13296     PERL_ARGS_ASSERT_DUMPUNTIL;
13297
13298 #ifdef DEBUG_DUMPUNTIL
13299     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
13300         last ? last-start : 0,plast ? plast-start : 0);
13301 #endif
13302             
13303     if (plast && plast < last) 
13304         last= plast;
13305
13306     while (PL_regkind[op] != END && (!last || node < last)) {
13307         /* While that wasn't END last time... */
13308         NODE_ALIGN(node);
13309         op = OP(node);
13310         if (op == CLOSE || op == WHILEM)
13311             indent--;
13312         next = regnext((regnode *)node);
13313
13314         /* Where, what. */
13315         if (OP(node) == OPTIMIZED) {
13316             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
13317                 optstart = node;
13318             else
13319                 goto after_print;
13320         } else
13321             CLEAR_OPTSTART;
13322
13323         regprop(r, sv, node);
13324         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
13325                       (int)(2*indent + 1), "", SvPVX_const(sv));
13326         
13327         if (OP(node) != OPTIMIZED) {                  
13328             if (next == NULL)           /* Next ptr. */
13329                 PerlIO_printf(Perl_debug_log, " (0)");
13330             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
13331                 PerlIO_printf(Perl_debug_log, " (FAIL)");
13332             else 
13333                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
13334             (void)PerlIO_putc(Perl_debug_log, '\n'); 
13335         }
13336         
13337       after_print:
13338         if (PL_regkind[(U8)op] == BRANCHJ) {
13339             assert(next);
13340             {
13341                 register const regnode *nnode = (OP(next) == LONGJMP
13342                                              ? regnext((regnode *)next)
13343                                              : next);
13344                 if (last && nnode > last)
13345                     nnode = last;
13346                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
13347             }
13348         }
13349         else if (PL_regkind[(U8)op] == BRANCH) {
13350             assert(next);
13351             DUMPUNTIL(NEXTOPER(node), next);
13352         }
13353         else if ( PL_regkind[(U8)op]  == TRIE ) {
13354             const regnode *this_trie = node;
13355             const char op = OP(node);
13356             const U32 n = ARG(node);
13357             const reg_ac_data * const ac = op>=AHOCORASICK ?
13358                (reg_ac_data *)ri->data->data[n] :
13359                NULL;
13360             const reg_trie_data * const trie =
13361                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
13362 #ifdef DEBUGGING
13363             AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
13364 #endif
13365             const regnode *nextbranch= NULL;
13366             I32 word_idx;
13367             sv_setpvs(sv, "");
13368             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
13369                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
13370
13371                 PerlIO_printf(Perl_debug_log, "%*s%s ",
13372                    (int)(2*(indent+3)), "",
13373                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
13374                             PL_colors[0], PL_colors[1],
13375                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
13376                             PERL_PV_PRETTY_ELLIPSES    |
13377                             PERL_PV_PRETTY_LTGT
13378                             )
13379                             : "???"
13380                 );
13381                 if (trie->jump) {
13382                     U16 dist= trie->jump[word_idx+1];
13383                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
13384                                   (UV)((dist ? this_trie + dist : next) - start));
13385                     if (dist) {
13386                         if (!nextbranch)
13387                             nextbranch= this_trie + trie->jump[0];    
13388                         DUMPUNTIL(this_trie + dist, nextbranch);
13389                     }
13390                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
13391                         nextbranch= regnext((regnode *)nextbranch);
13392                 } else {
13393                     PerlIO_printf(Perl_debug_log, "\n");
13394                 }
13395             }
13396             if (last && next > last)
13397                 node= last;
13398             else
13399                 node= next;
13400         }
13401         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
13402             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
13403                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
13404         }
13405         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
13406             assert(next);
13407             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
13408         }
13409         else if ( op == PLUS || op == STAR) {
13410             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
13411         }
13412         else if (PL_regkind[(U8)op] == ANYOF) {
13413             /* arglen 1 + class block */
13414             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
13415                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
13416             node = NEXTOPER(node);
13417         }
13418         else if (PL_regkind[(U8)op] == EXACT) {
13419             /* Literal string, where present. */
13420             node += NODE_SZ_STR(node) - 1;
13421             node = NEXTOPER(node);
13422         }
13423         else {
13424             node = NEXTOPER(node);
13425             node += regarglen[(U8)op];
13426         }
13427         if (op == CURLYX || op == OPEN)
13428             indent++;
13429     }
13430     CLEAR_OPTSTART;
13431 #ifdef DEBUG_DUMPUNTIL    
13432     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
13433 #endif
13434     return node;
13435 }
13436
13437 #endif  /* DEBUGGING */
13438
13439 /*
13440  * Local variables:
13441  * c-indentation-style: bsd
13442  * c-basic-offset: 4
13443  * indent-tabs-mode: t
13444  * End:
13445  *
13446  * ex: set ts=8 sts=4 sw=4 noet:
13447  */