]> git.vpit.fr Git - perl/modules/re-engine-Hooks.git/blob - src/5015009/regcomp.c
Attach the callbacks to every regexps in a thread-safe way
[perl/modules/re-engine-Hooks.git] / src / 5015009 / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * 'A fair jaw-cracker dwarf-language must be.'            --Samwise Gamgee
6  *
7  *     [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
8  */
9
10 /* This file contains functions for compiling a regular expression.  See
11  * also regexec.c which funnily enough, contains functions for executing
12  * a regular expression.
13  *
14  * This file is also copied at build time to ext/re/re_comp.c, where
15  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16  * This causes the main functions to be compiled under new names and with
17  * debugging support added, which makes "use re 'debug'" work.
18  */
19
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21  * confused with the original package (see point 3 below).  Thanks, Henry!
22  */
23
24 /* Additional note: this code is very heavily munged from Henry's version
25  * in places.  In some spots I've traded clarity for efficiency, so don't
26  * blame Henry for some of the lack of readability.
27  */
28
29 /* The names of the functions have been changed from regcomp and
30  * regexec to pregcomp and pregexec in order to avoid conflicts
31  * with the POSIX routines of the same names.
32 */
33
34 #ifdef PERL_EXT_RE_BUILD
35 #include "re_top.h"
36 #endif
37
38 /*
39  * pregcomp and pregexec -- regsub and regerror are not used in perl
40  *
41  *      Copyright (c) 1986 by University of Toronto.
42  *      Written by Henry Spencer.  Not derived from licensed software.
43  *
44  *      Permission is granted to anyone to use this software for any
45  *      purpose on any computer system, and to redistribute it freely,
46  *      subject to the following restrictions:
47  *
48  *      1. The author is not responsible for the consequences of use of
49  *              this software, no matter how awful, even if they arise
50  *              from defects in it.
51  *
52  *      2. The origin of this software must not be misrepresented, either
53  *              by explicit claim or by omission.
54  *
55  *      3. Altered versions must be plainly marked as such, and must not
56  *              be misrepresented as being the original software.
57  *
58  *
59  ****    Alterations to Henry's code are...
60  ****
61  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63  ****    by Larry Wall and others
64  ****
65  ****    You may distribute under the terms of either the GNU General Public
66  ****    License or the Artistic License, as specified in the README file.
67
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGCOMP_C
75 #include "perl.h"
76
77 #ifndef PERL_IN_XSUB_RE
78 #include "re_defs.h"
79 #endif
80
81 #define REG_COMP_C
82 #ifdef PERL_IN_XSUB_RE
83 #  include "re_comp.h"
84 #else
85 #  include "regcomp.h"
86 #endif
87
88 #include "dquote_static.c"
89 #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     REH_CALL_COMP_BEGIN_HOOK(pRExC_state->rx);
5222
5223     /* Second pass: emit code. */
5224     RExC_flags = pm_flags;      /* don't let top level (?i) bleed */
5225     RExC_parse = exp;
5226     RExC_end = xend;
5227     RExC_naughty = 0;
5228     RExC_npar = 1;
5229     RExC_emit_start = ri->program;
5230     RExC_emit = ri->program;
5231     RExC_emit_bound = ri->program + RExC_size + 1;
5232
5233     /* Store the count of eval-groups for security checks: */
5234     RExC_rx->seen_evals = RExC_seen_evals;
5235     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
5236     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5237         ReREFCNT_dec(rx);   
5238         return(NULL);
5239     }
5240     /* XXXX To minimize changes to RE engine we always allocate
5241        3-units-long substrs field. */
5242     Newx(r->substrs, 1, struct reg_substr_data);
5243     if (RExC_recurse_count) {
5244         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
5245         SAVEFREEPV(RExC_recurse);
5246     }
5247
5248 reStudy:
5249     r->minlen = minlen = sawlookahead = sawplus = sawopen = 0;
5250     Zero(r->substrs, 1, struct reg_substr_data);
5251
5252 #ifdef TRIE_STUDY_OPT
5253     if (!restudied) {
5254         StructCopy(&zero_scan_data, &data, scan_data_t);
5255         copyRExC_state = RExC_state;
5256     } else {
5257         U32 seen=RExC_seen;
5258         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
5259         
5260         RExC_state = copyRExC_state;
5261         if (seen & REG_TOP_LEVEL_BRANCHES) 
5262             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
5263         else
5264             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
5265         if (data.last_found) {
5266             SvREFCNT_dec(data.longest_fixed);
5267             SvREFCNT_dec(data.longest_float);
5268             SvREFCNT_dec(data.last_found);
5269         }
5270         StructCopy(&zero_scan_data, &data, scan_data_t);
5271     }
5272 #else
5273     StructCopy(&zero_scan_data, &data, scan_data_t);
5274 #endif    
5275
5276     /* Dig out information for optimizations. */
5277     r->extflags = RExC_flags; /* was pm_op */
5278     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
5279  
5280     if (UTF)
5281         SvUTF8_on(rx);  /* Unicode in it? */
5282     ri->regstclass = NULL;
5283     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
5284         r->intflags |= PREGf_NAUGHTY;
5285     scan = ri->program + 1;             /* First BRANCH. */
5286
5287     /* testing for BRANCH here tells us whether there is "must appear"
5288        data in the pattern. If there is then we can use it for optimisations */
5289     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
5290         I32 fake;
5291         STRLEN longest_float_length, longest_fixed_length;
5292         struct regnode_charclass_class ch_class; /* pointed to by data */
5293         int stclass_flag;
5294         I32 last_close = 0; /* pointed to by data */
5295         regnode *first= scan;
5296         regnode *first_next= regnext(first);
5297         /*
5298          * Skip introductions and multiplicators >= 1
5299          * so that we can extract the 'meat' of the pattern that must 
5300          * match in the large if() sequence following.
5301          * NOTE that EXACT is NOT covered here, as it is normally
5302          * picked up by the optimiser separately. 
5303          *
5304          * This is unfortunate as the optimiser isnt handling lookahead
5305          * properly currently.
5306          *
5307          */
5308         while ((OP(first) == OPEN && (sawopen = 1)) ||
5309                /* An OR of *one* alternative - should not happen now. */
5310             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
5311             /* for now we can't handle lookbehind IFMATCH*/
5312             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
5313             (OP(first) == PLUS) ||
5314             (OP(first) == MINMOD) ||
5315                /* An {n,m} with n>0 */
5316             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
5317             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
5318         {
5319                 /* 
5320                  * the only op that could be a regnode is PLUS, all the rest
5321                  * will be regnode_1 or regnode_2.
5322                  *
5323                  */
5324                 if (OP(first) == PLUS)
5325                     sawplus = 1;
5326                 else
5327                     first += regarglen[OP(first)];
5328
5329                 first = NEXTOPER(first);
5330                 first_next= regnext(first);
5331         }
5332
5333         /* Starting-point info. */
5334       again:
5335         DEBUG_PEEP("first:",first,0);
5336         /* Ignore EXACT as we deal with it later. */
5337         if (PL_regkind[OP(first)] == EXACT) {
5338             if (OP(first) == EXACT)
5339                 NOOP;   /* Empty, get anchored substr later. */
5340             else
5341                 ri->regstclass = first;
5342         }
5343 #ifdef TRIE_STCLASS
5344         else if (PL_regkind[OP(first)] == TRIE &&
5345                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
5346         {
5347             regnode *trie_op;
5348             /* this can happen only on restudy */
5349             if ( OP(first) == TRIE ) {
5350                 struct regnode_1 *trieop = (struct regnode_1 *)
5351                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
5352                 StructCopy(first,trieop,struct regnode_1);
5353                 trie_op=(regnode *)trieop;
5354             } else {
5355                 struct regnode_charclass *trieop = (struct regnode_charclass *)
5356                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
5357                 StructCopy(first,trieop,struct regnode_charclass);
5358                 trie_op=(regnode *)trieop;
5359             }
5360             OP(trie_op)+=2;
5361             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
5362             ri->regstclass = trie_op;
5363         }
5364 #endif
5365         else if (REGNODE_SIMPLE(OP(first)))
5366             ri->regstclass = first;
5367         else if (PL_regkind[OP(first)] == BOUND ||
5368                  PL_regkind[OP(first)] == NBOUND)
5369             ri->regstclass = first;
5370         else if (PL_regkind[OP(first)] == BOL) {
5371             r->extflags |= (OP(first) == MBOL
5372                            ? RXf_ANCH_MBOL
5373                            : (OP(first) == SBOL
5374                               ? RXf_ANCH_SBOL
5375                               : RXf_ANCH_BOL));
5376             first = NEXTOPER(first);
5377             goto again;
5378         }
5379         else if (OP(first) == GPOS) {
5380             r->extflags |= RXf_ANCH_GPOS;
5381             first = NEXTOPER(first);
5382             goto again;
5383         }
5384         else if ((!sawopen || !RExC_sawback) &&
5385             (OP(first) == STAR &&
5386             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
5387             !(r->extflags & RXf_ANCH) && !(RExC_seen & REG_SEEN_EVAL))
5388         {
5389             /* turn .* into ^.* with an implied $*=1 */
5390             const int type =
5391                 (OP(NEXTOPER(first)) == REG_ANY)
5392                     ? RXf_ANCH_MBOL
5393                     : RXf_ANCH_SBOL;
5394             r->extflags |= type;
5395             r->intflags |= PREGf_IMPLICIT;
5396             first = NEXTOPER(first);
5397             goto again;
5398         }
5399         if (sawplus && !sawlookahead && (!sawopen || !RExC_sawback)
5400             && !(RExC_seen & REG_SEEN_EVAL)) /* May examine pos and $& */
5401             /* x+ must match at the 1st pos of run of x's */
5402             r->intflags |= PREGf_SKIP;
5403
5404         /* Scan is after the zeroth branch, first is atomic matcher. */
5405 #ifdef TRIE_STUDY_OPT
5406         DEBUG_PARSE_r(
5407             if (!restudied)
5408                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
5409                               (IV)(first - scan + 1))
5410         );
5411 #else
5412         DEBUG_PARSE_r(
5413             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
5414                 (IV)(first - scan + 1))
5415         );
5416 #endif
5417
5418
5419         /*
5420         * If there's something expensive in the r.e., find the
5421         * longest literal string that must appear and make it the
5422         * regmust.  Resolve ties in favor of later strings, since
5423         * the regstart check works with the beginning of the r.e.
5424         * and avoiding duplication strengthens checking.  Not a
5425         * strong reason, but sufficient in the absence of others.
5426         * [Now we resolve ties in favor of the earlier string if
5427         * it happens that c_offset_min has been invalidated, since the
5428         * earlier string may buy us something the later one won't.]
5429         */
5430
5431         data.longest_fixed = newSVpvs("");
5432         data.longest_float = newSVpvs("");
5433         data.last_found = newSVpvs("");
5434         data.longest = &(data.longest_fixed);
5435         first = scan;
5436         if (!ri->regstclass) {
5437             cl_init(pRExC_state, &ch_class);
5438             data.start_class = &ch_class;
5439             stclass_flag = SCF_DO_STCLASS_AND;
5440         } else                          /* XXXX Check for BOUND? */
5441             stclass_flag = 0;
5442         data.last_closep = &last_close;
5443         
5444         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
5445             &data, -1, NULL, NULL,
5446             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
5447
5448
5449         CHECK_RESTUDY_GOTO;
5450
5451
5452         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
5453              && data.last_start_min == 0 && data.last_end > 0
5454              && !RExC_seen_zerolen
5455              && !(RExC_seen & REG_SEEN_VERBARG)
5456              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
5457             r->extflags |= RXf_CHECK_ALL;
5458         scan_commit(pRExC_state, &data,&minlen,0);
5459         SvREFCNT_dec(data.last_found);
5460
5461         /* Note that code very similar to this but for anchored string 
5462            follows immediately below, changes may need to be made to both. 
5463            Be careful. 
5464          */
5465         longest_float_length = CHR_SVLEN(data.longest_float);
5466         if (longest_float_length
5467             || (data.flags & SF_FL_BEFORE_EOL
5468                 && (!(data.flags & SF_FL_BEFORE_MEOL)
5469                     || (RExC_flags & RXf_PMf_MULTILINE)))) 
5470         {
5471             I32 t,ml;
5472
5473             /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5474             if ((RExC_seen & REG_SEEN_EXACTF_SHARP_S)
5475                 || (SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
5476                     && data.offset_fixed == data.offset_float_min
5477                     && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
5478                     goto remove_float;          /* As in (a)+. */
5479
5480             /* copy the information about the longest float from the reg_scan_data
5481                over to the program. */
5482             if (SvUTF8(data.longest_float)) {
5483                 r->float_utf8 = data.longest_float;
5484                 r->float_substr = NULL;
5485             } else {
5486                 r->float_substr = data.longest_float;
5487                 r->float_utf8 = NULL;
5488             }
5489             /* float_end_shift is how many chars that must be matched that 
5490                follow this item. We calculate it ahead of time as once the
5491                lookbehind offset is added in we lose the ability to correctly
5492                calculate it.*/
5493             ml = data.minlen_float ? *(data.minlen_float) 
5494                                    : (I32)longest_float_length;
5495             r->float_end_shift = ml - data.offset_float_min
5496                 - longest_float_length + (SvTAIL(data.longest_float) != 0)
5497                 + data.lookbehind_float;
5498             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
5499             r->float_max_offset = data.offset_float_max;
5500             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
5501                 r->float_max_offset -= data.lookbehind_float;
5502             
5503             t = (data.flags & SF_FL_BEFORE_EOL /* Can't have SEOL and MULTI */
5504                        && (!(data.flags & SF_FL_BEFORE_MEOL)
5505                            || (RExC_flags & RXf_PMf_MULTILINE)));
5506             fbm_compile(data.longest_float, t ? FBMcf_TAIL : 0);
5507         }
5508         else {
5509           remove_float:
5510             r->float_substr = r->float_utf8 = NULL;
5511             SvREFCNT_dec(data.longest_float);
5512             longest_float_length = 0;
5513         }
5514
5515         /* Note that code very similar to this but for floating string 
5516            is immediately above, changes may need to be made to both. 
5517            Be careful. 
5518          */
5519         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
5520
5521         /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5522         if (! (RExC_seen & REG_SEEN_EXACTF_SHARP_S)
5523             && (longest_fixed_length
5524                 || (data.flags & SF_FIX_BEFORE_EOL /* Cannot have SEOL and MULTI */
5525                     && (!(data.flags & SF_FIX_BEFORE_MEOL)
5526                         || (RExC_flags & RXf_PMf_MULTILINE)))) )
5527         {
5528             I32 t,ml;
5529
5530             /* copy the information about the longest fixed 
5531                from the reg_scan_data over to the program. */
5532             if (SvUTF8(data.longest_fixed)) {
5533                 r->anchored_utf8 = data.longest_fixed;
5534                 r->anchored_substr = NULL;
5535             } else {
5536                 r->anchored_substr = data.longest_fixed;
5537                 r->anchored_utf8 = NULL;
5538             }
5539             /* fixed_end_shift is how many chars that must be matched that 
5540                follow this item. We calculate it ahead of time as once the
5541                lookbehind offset is added in we lose the ability to correctly
5542                calculate it.*/
5543             ml = data.minlen_fixed ? *(data.minlen_fixed) 
5544                                    : (I32)longest_fixed_length;
5545             r->anchored_end_shift = ml - data.offset_fixed
5546                 - longest_fixed_length + (SvTAIL(data.longest_fixed) != 0)
5547                 + data.lookbehind_fixed;
5548             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
5549
5550             t = (data.flags & SF_FIX_BEFORE_EOL /* Can't have SEOL and MULTI */
5551                  && (!(data.flags & SF_FIX_BEFORE_MEOL)
5552                      || (RExC_flags & RXf_PMf_MULTILINE)));
5553             fbm_compile(data.longest_fixed, t ? FBMcf_TAIL : 0);
5554         }
5555         else {
5556             r->anchored_substr = r->anchored_utf8 = NULL;
5557             SvREFCNT_dec(data.longest_fixed);
5558             longest_fixed_length = 0;
5559         }
5560         if (ri->regstclass
5561             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
5562             ri->regstclass = NULL;
5563
5564         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
5565             && stclass_flag
5566             && !(data.start_class->flags & ANYOF_EOS)
5567             && !cl_is_anything(data.start_class))
5568         {
5569             const U32 n = add_data(pRExC_state, 1, "f");
5570             data.start_class->flags |= ANYOF_IS_SYNTHETIC;
5571
5572             Newx(RExC_rxi->data->data[n], 1,
5573                 struct regnode_charclass_class);
5574             StructCopy(data.start_class,
5575                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
5576                        struct regnode_charclass_class);
5577             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
5578             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
5579             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
5580                       regprop(r, sv, (regnode*)data.start_class);
5581                       PerlIO_printf(Perl_debug_log,
5582                                     "synthetic stclass \"%s\".\n",
5583                                     SvPVX_const(sv));});
5584         }
5585
5586         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
5587         if (longest_fixed_length > longest_float_length) {
5588             r->check_end_shift = r->anchored_end_shift;
5589             r->check_substr = r->anchored_substr;
5590             r->check_utf8 = r->anchored_utf8;
5591             r->check_offset_min = r->check_offset_max = r->anchored_offset;
5592             if (r->extflags & RXf_ANCH_SINGLE)
5593                 r->extflags |= RXf_NOSCAN;
5594         }
5595         else {
5596             r->check_end_shift = r->float_end_shift;
5597             r->check_substr = r->float_substr;
5598             r->check_utf8 = r->float_utf8;
5599             r->check_offset_min = r->float_min_offset;
5600             r->check_offset_max = r->float_max_offset;
5601         }
5602         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
5603            This should be changed ASAP!  */
5604         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
5605             r->extflags |= RXf_USE_INTUIT;
5606             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
5607                 r->extflags |= RXf_INTUIT_TAIL;
5608         }
5609         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
5610         if ( (STRLEN)minlen < longest_float_length )
5611             minlen= longest_float_length;
5612         if ( (STRLEN)minlen < longest_fixed_length )
5613             minlen= longest_fixed_length;     
5614         */
5615     }
5616     else {
5617         /* Several toplevels. Best we can is to set minlen. */
5618         I32 fake;
5619         struct regnode_charclass_class ch_class;
5620         I32 last_close = 0;
5621
5622         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
5623
5624         scan = ri->program + 1;
5625         cl_init(pRExC_state, &ch_class);
5626         data.start_class = &ch_class;
5627         data.last_closep = &last_close;
5628
5629         
5630         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
5631             &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
5632         
5633         CHECK_RESTUDY_GOTO;
5634
5635         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
5636                 = r->float_substr = r->float_utf8 = NULL;
5637
5638         if (!(data.start_class->flags & ANYOF_EOS)
5639             && !cl_is_anything(data.start_class))
5640         {
5641             const U32 n = add_data(pRExC_state, 1, "f");
5642             data.start_class->flags |= ANYOF_IS_SYNTHETIC;
5643
5644             Newx(RExC_rxi->data->data[n], 1,
5645                 struct regnode_charclass_class);
5646             StructCopy(data.start_class,
5647                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
5648                        struct regnode_charclass_class);
5649             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
5650             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
5651             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
5652                       regprop(r, sv, (regnode*)data.start_class);
5653                       PerlIO_printf(Perl_debug_log,
5654                                     "synthetic stclass \"%s\".\n",
5655                                     SvPVX_const(sv));});
5656         }
5657     }
5658
5659     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
5660        the "real" pattern. */
5661     DEBUG_OPTIMISE_r({
5662         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
5663                       (IV)minlen, (IV)r->minlen);
5664     });
5665     r->minlenret = minlen;
5666     if (r->minlen < minlen) 
5667         r->minlen = minlen;
5668     
5669     if (RExC_seen & REG_SEEN_GPOS)
5670         r->extflags |= RXf_GPOS_SEEN;
5671     if (RExC_seen & REG_SEEN_LOOKBEHIND)
5672         r->extflags |= RXf_LOOKBEHIND_SEEN;
5673     if (RExC_seen & REG_SEEN_EVAL)
5674         r->extflags |= RXf_EVAL_SEEN;
5675     if (RExC_seen & REG_SEEN_CANY)
5676         r->extflags |= RXf_CANY_SEEN;
5677     if (RExC_seen & REG_SEEN_VERBARG)
5678         r->intflags |= PREGf_VERBARG_SEEN;
5679     if (RExC_seen & REG_SEEN_CUTGROUP)
5680         r->intflags |= PREGf_CUTGROUP_SEEN;
5681     if (RExC_paren_names)
5682         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
5683     else
5684         RXp_PAREN_NAMES(r) = NULL;
5685
5686 #ifdef STUPID_PATTERN_CHECKS            
5687     if (RX_PRELEN(rx) == 0)
5688         r->extflags |= RXf_NULL;
5689     if (r->extflags & RXf_SPLIT && RX_PRELEN(rx) == 1 && RX_PRECOMP(rx)[0] == ' ')
5690         /* XXX: this should happen BEFORE we compile */
5691         r->extflags |= (RXf_SKIPWHITE|RXf_WHITE); 
5692     else if (RX_PRELEN(rx) == 3 && memEQ("\\s+", RX_PRECOMP(rx), 3))
5693         r->extflags |= RXf_WHITE;
5694     else if (RX_PRELEN(rx) == 1 && RXp_PRECOMP(rx)[0] == '^')
5695         r->extflags |= RXf_START_ONLY;
5696 #else
5697     if (r->extflags & RXf_SPLIT && RX_PRELEN(rx) == 1 && RX_PRECOMP(rx)[0] == ' ')
5698             /* XXX: this should happen BEFORE we compile */
5699             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE); 
5700     else {
5701         regnode *first = ri->program + 1;
5702         U8 fop = OP(first);
5703
5704         if (PL_regkind[fop] == NOTHING && OP(NEXTOPER(first)) == END)
5705             r->extflags |= RXf_NULL;
5706         else if (PL_regkind[fop] == BOL && OP(NEXTOPER(first)) == END)
5707             r->extflags |= RXf_START_ONLY;
5708         else if (fop == PLUS && OP(NEXTOPER(first)) == SPACE
5709                              && OP(regnext(first)) == END)
5710             r->extflags |= RXf_WHITE;    
5711     }
5712 #endif
5713 #ifdef DEBUGGING
5714     if (RExC_paren_names) {
5715         ri->name_list_idx = add_data( pRExC_state, 1, "a" );
5716         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
5717     } else
5718 #endif
5719         ri->name_list_idx = 0;
5720
5721     if (RExC_recurse_count) {
5722         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
5723             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
5724             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
5725         }
5726     }
5727     Newxz(r->offs, RExC_npar, regexp_paren_pair);
5728     /* assume we don't need to swap parens around before we match */
5729
5730     DEBUG_DUMP_r({
5731         PerlIO_printf(Perl_debug_log,"Final program:\n");
5732         regdump(r);
5733     });
5734 #ifdef RE_TRACK_PATTERN_OFFSETS
5735     DEBUG_OFFSETS_r(if (ri->u.offsets) {
5736         const U32 len = ri->u.offsets[0];
5737         U32 i;
5738         GET_RE_DEBUG_FLAGS_DECL;
5739         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
5740         for (i = 1; i <= len; i++) {
5741             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
5742                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
5743                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
5744             }
5745         PerlIO_printf(Perl_debug_log, "\n");
5746     });
5747 #endif
5748     return rx;
5749 }
5750
5751 #undef RE_ENGINE_PTR
5752
5753
5754 SV*
5755 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
5756                     const U32 flags)
5757 {
5758     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
5759
5760     PERL_UNUSED_ARG(value);
5761
5762     if (flags & RXapif_FETCH) {
5763         return reg_named_buff_fetch(rx, key, flags);
5764     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
5765         Perl_croak_no_modify(aTHX);
5766         return NULL;
5767     } else if (flags & RXapif_EXISTS) {
5768         return reg_named_buff_exists(rx, key, flags)
5769             ? &PL_sv_yes
5770             : &PL_sv_no;
5771     } else if (flags & RXapif_REGNAMES) {
5772         return reg_named_buff_all(rx, flags);
5773     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
5774         return reg_named_buff_scalar(rx, flags);
5775     } else {
5776         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
5777         return NULL;
5778     }
5779 }
5780
5781 SV*
5782 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
5783                          const U32 flags)
5784 {
5785     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
5786     PERL_UNUSED_ARG(lastkey);
5787
5788     if (flags & RXapif_FIRSTKEY)
5789         return reg_named_buff_firstkey(rx, flags);
5790     else if (flags & RXapif_NEXTKEY)
5791         return reg_named_buff_nextkey(rx, flags);
5792     else {
5793         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
5794         return NULL;
5795     }
5796 }
5797
5798 SV*
5799 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
5800                           const U32 flags)
5801 {
5802     AV *retarray = NULL;
5803     SV *ret;
5804     struct regexp *const rx = (struct regexp *)SvANY(r);
5805
5806     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
5807
5808     if (flags & RXapif_ALL)
5809         retarray=newAV();
5810
5811     if (rx && RXp_PAREN_NAMES(rx)) {
5812         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
5813         if (he_str) {
5814             IV i;
5815             SV* sv_dat=HeVAL(he_str);
5816             I32 *nums=(I32*)SvPVX(sv_dat);
5817             for ( i=0; i<SvIVX(sv_dat); i++ ) {
5818                 if ((I32)(rx->nparens) >= nums[i]
5819                     && rx->offs[nums[i]].start != -1
5820                     && rx->offs[nums[i]].end != -1)
5821                 {
5822                     ret = newSVpvs("");
5823                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
5824                     if (!retarray)
5825                         return ret;
5826                 } else {
5827                     if (retarray)
5828                         ret = newSVsv(&PL_sv_undef);
5829                 }
5830                 if (retarray)
5831                     av_push(retarray, ret);
5832             }
5833             if (retarray)
5834                 return newRV_noinc(MUTABLE_SV(retarray));
5835         }
5836     }
5837     return NULL;
5838 }
5839
5840 bool
5841 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
5842                            const U32 flags)
5843 {
5844     struct regexp *const rx = (struct regexp *)SvANY(r);
5845
5846     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
5847
5848     if (rx && RXp_PAREN_NAMES(rx)) {
5849         if (flags & RXapif_ALL) {
5850             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
5851         } else {
5852             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
5853             if (sv) {
5854                 SvREFCNT_dec(sv);
5855                 return TRUE;
5856             } else {
5857                 return FALSE;
5858             }
5859         }
5860     } else {
5861         return FALSE;
5862     }
5863 }
5864
5865 SV*
5866 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
5867 {
5868     struct regexp *const rx = (struct regexp *)SvANY(r);
5869
5870     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
5871
5872     if ( rx && RXp_PAREN_NAMES(rx) ) {
5873         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
5874
5875         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
5876     } else {
5877         return FALSE;
5878     }
5879 }
5880
5881 SV*
5882 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
5883 {
5884     struct regexp *const rx = (struct regexp *)SvANY(r);
5885     GET_RE_DEBUG_FLAGS_DECL;
5886
5887     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
5888
5889     if (rx && RXp_PAREN_NAMES(rx)) {
5890         HV *hv = RXp_PAREN_NAMES(rx);
5891         HE *temphe;
5892         while ( (temphe = hv_iternext_flags(hv,0)) ) {
5893             IV i;
5894             IV parno = 0;
5895             SV* sv_dat = HeVAL(temphe);
5896             I32 *nums = (I32*)SvPVX(sv_dat);
5897             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
5898                 if ((I32)(rx->lastparen) >= nums[i] &&
5899                     rx->offs[nums[i]].start != -1 &&
5900                     rx->offs[nums[i]].end != -1)
5901                 {
5902                     parno = nums[i];
5903                     break;
5904                 }
5905             }
5906             if (parno || flags & RXapif_ALL) {
5907                 return newSVhek(HeKEY_hek(temphe));
5908             }
5909         }
5910     }
5911     return NULL;
5912 }
5913
5914 SV*
5915 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
5916 {
5917     SV *ret;
5918     AV *av;
5919     I32 length;
5920     struct regexp *const rx = (struct regexp *)SvANY(r);
5921
5922     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
5923
5924     if (rx && RXp_PAREN_NAMES(rx)) {
5925         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
5926             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
5927         } else if (flags & RXapif_ONE) {
5928             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
5929             av = MUTABLE_AV(SvRV(ret));
5930             length = av_len(av);
5931             SvREFCNT_dec(ret);
5932             return newSViv(length + 1);
5933         } else {
5934             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
5935             return NULL;
5936         }
5937     }
5938     return &PL_sv_undef;
5939 }
5940
5941 SV*
5942 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
5943 {
5944     struct regexp *const rx = (struct regexp *)SvANY(r);
5945     AV *av = newAV();
5946
5947     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
5948
5949     if (rx && RXp_PAREN_NAMES(rx)) {
5950         HV *hv= RXp_PAREN_NAMES(rx);
5951         HE *temphe;
5952         (void)hv_iterinit(hv);
5953         while ( (temphe = hv_iternext_flags(hv,0)) ) {
5954             IV i;
5955             IV parno = 0;
5956             SV* sv_dat = HeVAL(temphe);
5957             I32 *nums = (I32*)SvPVX(sv_dat);
5958             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
5959                 if ((I32)(rx->lastparen) >= nums[i] &&
5960                     rx->offs[nums[i]].start != -1 &&
5961                     rx->offs[nums[i]].end != -1)
5962                 {
5963                     parno = nums[i];
5964                     break;
5965                 }
5966             }
5967             if (parno || flags & RXapif_ALL) {
5968                 av_push(av, newSVhek(HeKEY_hek(temphe)));
5969             }
5970         }
5971     }
5972
5973     return newRV_noinc(MUTABLE_SV(av));
5974 }
5975
5976 void
5977 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
5978                              SV * const sv)
5979 {
5980     struct regexp *const rx = (struct regexp *)SvANY(r);
5981     char *s = NULL;
5982     I32 i = 0;
5983     I32 s1, t1;
5984
5985     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
5986         
5987     if (!rx->subbeg) {
5988         sv_setsv(sv,&PL_sv_undef);
5989         return;
5990     } 
5991     else               
5992     if (paren == RX_BUFF_IDX_PREMATCH && rx->offs[0].start != -1) {
5993         /* $` */
5994         i = rx->offs[0].start;
5995         s = rx->subbeg;
5996     }
5997     else 
5998     if (paren == RX_BUFF_IDX_POSTMATCH && rx->offs[0].end != -1) {
5999         /* $' */
6000         s = rx->subbeg + rx->offs[0].end;
6001         i = rx->sublen - rx->offs[0].end;
6002     } 
6003     else
6004     if ( 0 <= paren && paren <= (I32)rx->nparens &&
6005         (s1 = rx->offs[paren].start) != -1 &&
6006         (t1 = rx->offs[paren].end) != -1)
6007     {
6008         /* $& $1 ... */
6009         i = t1 - s1;
6010         s = rx->subbeg + s1;
6011     } else {
6012         sv_setsv(sv,&PL_sv_undef);
6013         return;
6014     }          
6015     assert(rx->sublen >= (s - rx->subbeg) + i );
6016     if (i >= 0) {
6017         const int oldtainted = PL_tainted;
6018         TAINT_NOT;
6019         sv_setpvn(sv, s, i);
6020         PL_tainted = oldtainted;
6021         if ( (rx->extflags & RXf_CANY_SEEN)
6022             ? (RXp_MATCH_UTF8(rx)
6023                         && (!i || is_utf8_string((U8*)s, i)))
6024             : (RXp_MATCH_UTF8(rx)) )
6025         {
6026             SvUTF8_on(sv);
6027         }
6028         else
6029             SvUTF8_off(sv);
6030         if (PL_tainting) {
6031             if (RXp_MATCH_TAINTED(rx)) {
6032                 if (SvTYPE(sv) >= SVt_PVMG) {
6033                     MAGIC* const mg = SvMAGIC(sv);
6034                     MAGIC* mgt;
6035                     PL_tainted = 1;
6036                     SvMAGIC_set(sv, mg->mg_moremagic);
6037                     SvTAINT(sv);
6038                     if ((mgt = SvMAGIC(sv))) {
6039                         mg->mg_moremagic = mgt;
6040                         SvMAGIC_set(sv, mg);
6041                     }
6042                 } else {
6043                     PL_tainted = 1;
6044                     SvTAINT(sv);
6045                 }
6046             } else 
6047                 SvTAINTED_off(sv);
6048         }
6049     } else {
6050         sv_setsv(sv,&PL_sv_undef);
6051         return;
6052     }
6053 }
6054
6055 void
6056 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6057                                                          SV const * const value)
6058 {
6059     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6060
6061     PERL_UNUSED_ARG(rx);
6062     PERL_UNUSED_ARG(paren);
6063     PERL_UNUSED_ARG(value);
6064
6065     if (!PL_localizing)
6066         Perl_croak_no_modify(aTHX);
6067 }
6068
6069 I32
6070 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6071                               const I32 paren)
6072 {
6073     struct regexp *const rx = (struct regexp *)SvANY(r);
6074     I32 i;
6075     I32 s1, t1;
6076
6077     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6078
6079     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6080         switch (paren) {
6081       /* $` / ${^PREMATCH} */
6082       case RX_BUFF_IDX_PREMATCH:
6083         if (rx->offs[0].start != -1) {
6084                         i = rx->offs[0].start;
6085                         if (i > 0) {
6086                                 s1 = 0;
6087                                 t1 = i;
6088                                 goto getlen;
6089                         }
6090             }
6091         return 0;
6092       /* $' / ${^POSTMATCH} */
6093       case RX_BUFF_IDX_POSTMATCH:
6094             if (rx->offs[0].end != -1) {
6095                         i = rx->sublen - rx->offs[0].end;
6096                         if (i > 0) {
6097                                 s1 = rx->offs[0].end;
6098                                 t1 = rx->sublen;
6099                                 goto getlen;
6100                         }
6101             }
6102         return 0;
6103       /* $& / ${^MATCH}, $1, $2, ... */
6104       default:
6105             if (paren <= (I32)rx->nparens &&
6106             (s1 = rx->offs[paren].start) != -1 &&
6107             (t1 = rx->offs[paren].end) != -1)
6108             {
6109             i = t1 - s1;
6110             goto getlen;
6111         } else {
6112             if (ckWARN(WARN_UNINITIALIZED))
6113                 report_uninit((const SV *)sv);
6114             return 0;
6115         }
6116     }
6117   getlen:
6118     if (i > 0 && RXp_MATCH_UTF8(rx)) {
6119         const char * const s = rx->subbeg + s1;
6120         const U8 *ep;
6121         STRLEN el;
6122
6123         i = t1 - s1;
6124         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6125                         i = el;
6126     }
6127     return i;
6128 }
6129
6130 SV*
6131 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6132 {
6133     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6134         PERL_UNUSED_ARG(rx);
6135         if (0)
6136             return NULL;
6137         else
6138             return newSVpvs("Regexp");
6139 }
6140
6141 /* Scans the name of a named buffer from the pattern.
6142  * If flags is REG_RSN_RETURN_NULL returns null.
6143  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6144  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6145  * to the parsed name as looked up in the RExC_paren_names hash.
6146  * If there is an error throws a vFAIL().. type exception.
6147  */
6148
6149 #define REG_RSN_RETURN_NULL    0
6150 #define REG_RSN_RETURN_NAME    1
6151 #define REG_RSN_RETURN_DATA    2
6152
6153 STATIC SV*
6154 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6155 {
6156     char *name_start = RExC_parse;
6157
6158     PERL_ARGS_ASSERT_REG_SCAN_NAME;
6159
6160     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6161          /* skip IDFIRST by using do...while */
6162         if (UTF)
6163             do {
6164                 RExC_parse += UTF8SKIP(RExC_parse);
6165             } while (isALNUM_utf8((U8*)RExC_parse));
6166         else
6167             do {
6168                 RExC_parse++;
6169             } while (isALNUM(*RExC_parse));
6170     }
6171
6172     if ( flags ) {
6173         SV* sv_name
6174             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6175                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6176         if ( flags == REG_RSN_RETURN_NAME)
6177             return sv_name;
6178         else if (flags==REG_RSN_RETURN_DATA) {
6179             HE *he_str = NULL;
6180             SV *sv_dat = NULL;
6181             if ( ! sv_name )      /* should not happen*/
6182                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6183             if (RExC_paren_names)
6184                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6185             if ( he_str )
6186                 sv_dat = HeVAL(he_str);
6187             if ( ! sv_dat )
6188                 vFAIL("Reference to nonexistent named group");
6189             return sv_dat;
6190         }
6191         else {
6192             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6193                        (unsigned long) flags);
6194         }
6195         /* NOT REACHED */
6196     }
6197     return NULL;
6198 }
6199
6200 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
6201     int rem=(int)(RExC_end - RExC_parse);                       \
6202     int cut;                                                    \
6203     int num;                                                    \
6204     int iscut=0;                                                \
6205     if (rem>10) {                                               \
6206         rem=10;                                                 \
6207         iscut=1;                                                \
6208     }                                                           \
6209     cut=10-rem;                                                 \
6210     if (RExC_lastparse!=RExC_parse)                             \
6211         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
6212             rem, RExC_parse,                                    \
6213             cut + 4,                                            \
6214             iscut ? "..." : "<"                                 \
6215         );                                                      \
6216     else                                                        \
6217         PerlIO_printf(Perl_debug_log,"%16s","");                \
6218                                                                 \
6219     if (SIZE_ONLY)                                              \
6220        num = RExC_size + 1;                                     \
6221     else                                                        \
6222        num=REG_NODE_NUM(RExC_emit);                             \
6223     if (RExC_lastnum!=num)                                      \
6224        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
6225     else                                                        \
6226        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
6227     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
6228         (int)((depth*2)), "",                                   \
6229         (funcname)                                              \
6230     );                                                          \
6231     RExC_lastnum=num;                                           \
6232     RExC_lastparse=RExC_parse;                                  \
6233 })
6234
6235
6236
6237 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
6238     DEBUG_PARSE_MSG((funcname));                            \
6239     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
6240 })
6241 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
6242     DEBUG_PARSE_MSG((funcname));                            \
6243     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
6244 })
6245
6246 /* This section of code defines the inversion list object and its methods.  The
6247  * interfaces are highly subject to change, so as much as possible is static to
6248  * this file.  An inversion list is here implemented as a malloc'd C UV array
6249  * with some added info that is placed as UVs at the beginning in a header
6250  * portion.  An inversion list for Unicode is an array of code points, sorted
6251  * by ordinal number.  The zeroth element is the first code point in the list.
6252  * The 1th element is the first element beyond that not in the list.  In other
6253  * words, the first range is
6254  *  invlist[0]..(invlist[1]-1)
6255  * The other ranges follow.  Thus every element whose index is divisible by two
6256  * marks the beginning of a range that is in the list, and every element not
6257  * divisible by two marks the beginning of a range not in the list.  A single
6258  * element inversion list that contains the single code point N generally
6259  * consists of two elements
6260  *  invlist[0] == N
6261  *  invlist[1] == N+1
6262  * (The exception is when N is the highest representable value on the
6263  * machine, in which case the list containing just it would be a single
6264  * element, itself.  By extension, if the last range in the list extends to
6265  * infinity, then the first element of that range will be in the inversion list
6266  * at a position that is divisible by two, and is the final element in the
6267  * list.)
6268  * Taking the complement (inverting) an inversion list is quite simple, if the
6269  * first element is 0, remove it; otherwise add a 0 element at the beginning.
6270  * This implementation reserves an element at the beginning of each inversion list
6271  * to contain 0 when the list contains 0, and contains 1 otherwise.  The actual
6272  * beginning of the list is either that element if 0, or the next one if 1.
6273  *
6274  * More about inversion lists can be found in "Unicode Demystified"
6275  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
6276  * More will be coming when functionality is added later.
6277  *
6278  * The inversion list data structure is currently implemented as an SV pointing
6279  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
6280  * array of UV whose memory management is automatically handled by the existing
6281  * facilities for SV's.
6282  *
6283  * Some of the methods should always be private to the implementation, and some
6284  * should eventually be made public */
6285
6286 #define INVLIST_LEN_OFFSET 0    /* Number of elements in the inversion list */
6287 #define INVLIST_ITER_OFFSET 1   /* Current iteration position */
6288
6289 /* This is a combination of a version and data structure type, so that one
6290  * being passed in can be validated to be an inversion list of the correct
6291  * vintage.  When the structure of the header is changed, a new random number
6292  * in the range 2**31-1 should be generated and the new() method changed to
6293  * insert that at this location.  Then, if an auxiliary program doesn't change
6294  * correspondingly, it will be discovered immediately */
6295 #define INVLIST_VERSION_ID_OFFSET 2
6296 #define INVLIST_VERSION_ID 1064334010
6297
6298 /* For safety, when adding new elements, remember to #undef them at the end of
6299  * the inversion list code section */
6300
6301 #define INVLIST_ZERO_OFFSET 3   /* 0 or 1; must be last element in header */
6302 /* The UV at position ZERO contains either 0 or 1.  If 0, the inversion list
6303  * contains the code point U+00000, and begins here.  If 1, the inversion list
6304  * doesn't contain U+0000, and it begins at the next UV in the array.
6305  * Inverting an inversion list consists of adding or removing the 0 at the
6306  * beginning of it.  By reserving a space for that 0, inversion can be made
6307  * very fast */
6308
6309 #define HEADER_LENGTH (INVLIST_ZERO_OFFSET + 1)
6310
6311 /* Internally things are UVs */
6312 #define TO_INTERNAL_SIZE(x) ((x + HEADER_LENGTH) * sizeof(UV))
6313 #define FROM_INTERNAL_SIZE(x) ((x / sizeof(UV)) - HEADER_LENGTH)
6314
6315 #define INVLIST_INITIAL_LEN 10
6316
6317 PERL_STATIC_INLINE UV*
6318 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
6319 {
6320     /* Returns a pointer to the first element in the inversion list's array.
6321      * This is called upon initialization of an inversion list.  Where the
6322      * array begins depends on whether the list has the code point U+0000
6323      * in it or not.  The other parameter tells it whether the code that
6324      * follows this call is about to put a 0 in the inversion list or not.
6325      * The first element is either the element with 0, if 0, or the next one,
6326      * if 1 */
6327
6328     UV* zero = get_invlist_zero_addr(invlist);
6329
6330     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
6331
6332     /* Must be empty */
6333     assert(! *get_invlist_len_addr(invlist));
6334
6335     /* 1^1 = 0; 1^0 = 1 */
6336     *zero = 1 ^ will_have_0;
6337     return zero + *zero;
6338 }
6339
6340 PERL_STATIC_INLINE UV*
6341 S_invlist_array(pTHX_ SV* const invlist)
6342 {
6343     /* Returns the pointer to the inversion list's array.  Every time the
6344      * length changes, this needs to be called in case malloc or realloc moved
6345      * it */
6346
6347     PERL_ARGS_ASSERT_INVLIST_ARRAY;
6348
6349     /* Must not be empty.  If these fail, you probably didn't check for <len>
6350      * being non-zero before trying to get the array */
6351     assert(*get_invlist_len_addr(invlist));
6352     assert(*get_invlist_zero_addr(invlist) == 0
6353            || *get_invlist_zero_addr(invlist) == 1);
6354
6355     /* The array begins either at the element reserved for zero if the
6356      * list contains 0 (that element will be set to 0), or otherwise the next
6357      * element (in which case the reserved element will be set to 1). */
6358     return (UV *) (get_invlist_zero_addr(invlist)
6359                    + *get_invlist_zero_addr(invlist));
6360 }
6361
6362 PERL_STATIC_INLINE UV*
6363 S_get_invlist_len_addr(pTHX_ SV* invlist)
6364 {
6365     /* Return the address of the UV that contains the current number
6366      * of used elements in the inversion list */
6367
6368     PERL_ARGS_ASSERT_GET_INVLIST_LEN_ADDR;
6369
6370     return (UV *) (SvPVX(invlist) + (INVLIST_LEN_OFFSET * sizeof (UV)));
6371 }
6372
6373 PERL_STATIC_INLINE UV
6374 S_invlist_len(pTHX_ SV* const invlist)
6375 {
6376     /* Returns the current number of elements stored in the inversion list's
6377      * array */
6378
6379     PERL_ARGS_ASSERT_INVLIST_LEN;
6380
6381     return *get_invlist_len_addr(invlist);
6382 }
6383
6384 PERL_STATIC_INLINE void
6385 S_invlist_set_len(pTHX_ SV* const invlist, const UV len)
6386 {
6387     /* Sets the current number of elements stored in the inversion list */
6388
6389     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
6390
6391     *get_invlist_len_addr(invlist) = len;
6392
6393     assert(len <= SvLEN(invlist));
6394
6395     SvCUR_set(invlist, TO_INTERNAL_SIZE(len));
6396     /* If the list contains U+0000, that element is part of the header,
6397      * and should not be counted as part of the array.  It will contain
6398      * 0 in that case, and 1 otherwise.  So we could flop 0=>1, 1=>0 and
6399      * subtract:
6400      *  SvCUR_set(invlist,
6401      *            TO_INTERNAL_SIZE(len
6402      *                             - (*get_invlist_zero_addr(inv_list) ^ 1)));
6403      * But, this is only valid if len is not 0.  The consequences of not doing
6404      * this is that the memory allocation code may think that 1 more UV is
6405      * being used than actually is, and so might do an unnecessary grow.  That
6406      * seems worth not bothering to make this the precise amount.
6407      *
6408      * Note that when inverting, SvCUR shouldn't change */
6409 }
6410
6411 PERL_STATIC_INLINE UV
6412 S_invlist_max(pTHX_ SV* const invlist)
6413 {
6414     /* Returns the maximum number of elements storable in the inversion list's
6415      * array, without having to realloc() */
6416
6417     PERL_ARGS_ASSERT_INVLIST_MAX;
6418
6419     return FROM_INTERNAL_SIZE(SvLEN(invlist));
6420 }
6421
6422 PERL_STATIC_INLINE UV*
6423 S_get_invlist_zero_addr(pTHX_ SV* invlist)
6424 {
6425     /* Return the address of the UV that is reserved to hold 0 if the inversion
6426      * list contains 0.  This has to be the last element of the heading, as the
6427      * list proper starts with either it if 0, or the next element if not.
6428      * (But we force it to contain either 0 or 1) */
6429
6430     PERL_ARGS_ASSERT_GET_INVLIST_ZERO_ADDR;
6431
6432     return (UV *) (SvPVX(invlist) + (INVLIST_ZERO_OFFSET * sizeof (UV)));
6433 }
6434
6435 #ifndef PERL_IN_XSUB_RE
6436 SV*
6437 Perl__new_invlist(pTHX_ IV initial_size)
6438 {
6439
6440     /* Return a pointer to a newly constructed inversion list, with enough
6441      * space to store 'initial_size' elements.  If that number is negative, a
6442      * system default is used instead */
6443
6444     SV* new_list;
6445
6446     if (initial_size < 0) {
6447         initial_size = INVLIST_INITIAL_LEN;
6448     }
6449
6450     /* Allocate the initial space */
6451     new_list = newSV(TO_INTERNAL_SIZE(initial_size));
6452     invlist_set_len(new_list, 0);
6453
6454     /* Force iterinit() to be used to get iteration to work */
6455     *get_invlist_iter_addr(new_list) = UV_MAX;
6456
6457     /* This should force a segfault if a method doesn't initialize this
6458      * properly */
6459     *get_invlist_zero_addr(new_list) = UV_MAX;
6460
6461     *get_invlist_version_id_addr(new_list) = INVLIST_VERSION_ID;
6462 #if HEADER_LENGTH != 4
6463 #   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
6464 #endif
6465
6466     return new_list;
6467 }
6468 #endif
6469
6470 STATIC SV*
6471 S__new_invlist_C_array(pTHX_ UV* list)
6472 {
6473     /* Return a pointer to a newly constructed inversion list, initialized to
6474      * point to <list>, which has to be in the exact correct inversion list
6475      * form, including internal fields.  Thus this is a dangerous routine that
6476      * should not be used in the wrong hands */
6477
6478     SV* invlist = newSV_type(SVt_PV);
6479
6480     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
6481
6482     SvPV_set(invlist, (char *) list);
6483     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
6484                                shouldn't touch it */
6485     SvCUR_set(invlist, TO_INTERNAL_SIZE(invlist_len(invlist)));
6486
6487     if (*get_invlist_version_id_addr(invlist) != INVLIST_VERSION_ID) {
6488         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
6489     }
6490
6491     return invlist;
6492 }
6493
6494 STATIC void
6495 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
6496 {
6497     /* Grow the maximum size of an inversion list */
6498
6499     PERL_ARGS_ASSERT_INVLIST_EXTEND;
6500
6501     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max));
6502 }
6503
6504 PERL_STATIC_INLINE void
6505 S_invlist_trim(pTHX_ SV* const invlist)
6506 {
6507     PERL_ARGS_ASSERT_INVLIST_TRIM;
6508
6509     /* Change the length of the inversion list to how many entries it currently
6510      * has */
6511
6512     SvPV_shrink_to_cur((SV *) invlist);
6513 }
6514
6515 /* An element is in an inversion list iff its index is even numbered: 0, 2, 4,
6516  * etc */
6517 #define ELEMENT_RANGE_MATCHES_INVLIST(i) (! ((i) & 1))
6518 #define PREV_RANGE_MATCHES_INVLIST(i) (! ELEMENT_RANGE_MATCHES_INVLIST(i))
6519
6520 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
6521
6522 #ifndef PERL_IN_XSUB_RE
6523 void
6524 Perl__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
6525 {
6526    /* Subject to change or removal.  Append the range from 'start' to 'end' at
6527     * the end of the inversion list.  The range must be above any existing
6528     * ones. */
6529
6530     UV* array;
6531     UV max = invlist_max(invlist);
6532     UV len = invlist_len(invlist);
6533
6534     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
6535
6536     if (len == 0) { /* Empty lists must be initialized */
6537         array = _invlist_array_init(invlist, start == 0);
6538     }
6539     else {
6540         /* Here, the existing list is non-empty. The current max entry in the
6541          * list is generally the first value not in the set, except when the
6542          * set extends to the end of permissible values, in which case it is
6543          * the first entry in that final set, and so this call is an attempt to
6544          * append out-of-order */
6545
6546         UV final_element = len - 1;
6547         array = invlist_array(invlist);
6548         if (array[final_element] > start
6549             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
6550         {
6551             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",
6552                        array[final_element], start,
6553                        ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
6554         }
6555
6556         /* Here, it is a legal append.  If the new range begins with the first
6557          * value not in the set, it is extending the set, so the new first
6558          * value not in the set is one greater than the newly extended range.
6559          * */
6560         if (array[final_element] == start) {
6561             if (end != UV_MAX) {
6562                 array[final_element] = end + 1;
6563             }
6564             else {
6565                 /* But if the end is the maximum representable on the machine,
6566                  * just let the range that this would extend to have no end */
6567                 invlist_set_len(invlist, len - 1);
6568             }
6569             return;
6570         }
6571     }
6572
6573     /* Here the new range doesn't extend any existing set.  Add it */
6574
6575     len += 2;   /* Includes an element each for the start and end of range */
6576
6577     /* If overflows the existing space, extend, which may cause the array to be
6578      * moved */
6579     if (max < len) {
6580         invlist_extend(invlist, len);
6581         invlist_set_len(invlist, len);  /* Have to set len here to avoid assert
6582                                            failure in invlist_array() */
6583         array = invlist_array(invlist);
6584     }
6585     else {
6586         invlist_set_len(invlist, len);
6587     }
6588
6589     /* The next item on the list starts the range, the one after that is
6590      * one past the new range.  */
6591     array[len - 2] = start;
6592     if (end != UV_MAX) {
6593         array[len - 1] = end + 1;
6594     }
6595     else {
6596         /* But if the end is the maximum representable on the machine, just let
6597          * the range have no end */
6598         invlist_set_len(invlist, len - 1);
6599     }
6600 }
6601
6602 STATIC IV
6603 S_invlist_search(pTHX_ SV* const invlist, const UV cp)
6604 {
6605     /* Searches the inversion list for the entry that contains the input code
6606      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
6607      * return value is the index into the list's array of the range that
6608      * contains <cp> */
6609
6610     IV low = 0;
6611     IV high = invlist_len(invlist);
6612     const UV * const array = invlist_array(invlist);
6613
6614     PERL_ARGS_ASSERT_INVLIST_SEARCH;
6615
6616     /* If list is empty or the code point is before the first element, return
6617      * failure. */
6618     if (high == 0 || cp < array[0]) {
6619         return -1;
6620     }
6621
6622     /* Binary search.  What we are looking for is <i> such that
6623      *  array[i] <= cp < array[i+1]
6624      * The loop below converges on the i+1. */
6625     while (low < high) {
6626         IV mid = (low + high) / 2;
6627         if (array[mid] <= cp) {
6628             low = mid + 1;
6629
6630             /* We could do this extra test to exit the loop early.
6631             if (cp < array[low]) {
6632                 return mid;
6633             }
6634             */
6635         }
6636         else { /* cp < array[mid] */
6637             high = mid;
6638         }
6639     }
6640
6641     return high - 1;
6642 }
6643
6644 void
6645 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
6646 {
6647     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
6648      * but is used when the swash has an inversion list.  This makes this much
6649      * faster, as it uses a binary search instead of a linear one.  This is
6650      * intimately tied to that function, and perhaps should be in utf8.c,
6651      * except it is intimately tied to inversion lists as well.  It assumes
6652      * that <swatch> is all 0's on input */
6653
6654     UV current = start;
6655     const IV len = invlist_len(invlist);
6656     IV i;
6657     const UV * array;
6658
6659     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
6660
6661     if (len == 0) { /* Empty inversion list */
6662         return;
6663     }
6664
6665     array = invlist_array(invlist);
6666
6667     /* Find which element it is */
6668     i = invlist_search(invlist, start);
6669
6670     /* We populate from <start> to <end> */
6671     while (current < end) {
6672         UV upper;
6673
6674         /* The inversion list gives the results for every possible code point
6675          * after the first one in the list.  Only those ranges whose index is
6676          * even are ones that the inversion list matches.  For the odd ones,
6677          * and if the initial code point is not in the list, we have to skip
6678          * forward to the next element */
6679         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
6680             i++;
6681             if (i >= len) { /* Finished if beyond the end of the array */
6682                 return;
6683             }
6684             current = array[i];
6685             if (current >= end) {   /* Finished if beyond the end of what we
6686                                        are populating */
6687                 return;
6688             }
6689         }
6690         assert(current >= start);
6691
6692         /* The current range ends one below the next one, except don't go past
6693          * <end> */
6694         i++;
6695         upper = (i < len && array[i] < end) ? array[i] : end;
6696
6697         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
6698          * for each code point in it */
6699         for (; current < upper; current++) {
6700             const STRLEN offset = (STRLEN)(current - start);
6701             swatch[offset >> 3] |= 1 << (offset & 7);
6702         }
6703
6704         /* Quit if at the end of the list */
6705         if (i >= len) {
6706
6707             /* But first, have to deal with the highest possible code point on
6708              * the platform.  The previous code assumes that <end> is one
6709              * beyond where we want to populate, but that is impossible at the
6710              * platform's infinity, so have to handle it specially */
6711             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
6712             {
6713                 const STRLEN offset = (STRLEN)(end - start);
6714                 swatch[offset >> 3] |= 1 << (offset & 7);
6715             }
6716             return;
6717         }
6718
6719         /* Advance to the next range, which will be for code points not in the
6720          * inversion list */
6721         current = array[i];
6722     }
6723
6724     return;
6725 }
6726
6727
6728 void
6729 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** output)
6730 {
6731     /* Take the union of two inversion lists and point <output> to it.  *output
6732      * should be defined upon input, and if it points to one of the two lists,
6733      * the reference count to that list will be decremented.  The first list,
6734      * <a>, may be NULL, in which case a copy of the second list is returned.
6735      * If <complement_b> is TRUE, the union is taken of the complement
6736      * (inversion) of <b> instead of b itself.
6737      *
6738      * The basis for this comes from "Unicode Demystified" Chapter 13 by
6739      * Richard Gillam, published by Addison-Wesley, and explained at some
6740      * length there.  The preface says to incorporate its examples into your
6741      * code at your own risk.
6742      *
6743      * The algorithm is like a merge sort.
6744      *
6745      * XXX A potential performance improvement is to keep track as we go along
6746      * if only one of the inputs contributes to the result, meaning the other
6747      * is a subset of that one.  In that case, we can skip the final copy and
6748      * return the larger of the input lists, but then outside code might need
6749      * to keep track of whether to free the input list or not */
6750
6751     UV* array_a;    /* a's array */
6752     UV* array_b;
6753     UV len_a;       /* length of a's array */
6754     UV len_b;
6755
6756     SV* u;                      /* the resulting union */
6757     UV* array_u;
6758     UV len_u;
6759
6760     UV i_a = 0;             /* current index into a's array */
6761     UV i_b = 0;
6762     UV i_u = 0;
6763
6764     /* running count, as explained in the algorithm source book; items are
6765      * stopped accumulating and are output when the count changes to/from 0.
6766      * The count is incremented when we start a range that's in the set, and
6767      * decremented when we start a range that's not in the set.  So its range
6768      * is 0 to 2.  Only when the count is zero is something not in the set.
6769      */
6770     UV count = 0;
6771
6772     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
6773     assert(a != b);
6774
6775     /* If either one is empty, the union is the other one */
6776     if (a == NULL || ((len_a = invlist_len(a)) == 0)) {
6777         if (*output == a) {
6778             if (a != NULL) {
6779                 SvREFCNT_dec(a);
6780             }
6781         }
6782         if (*output != b) {
6783             *output = invlist_clone(b);
6784             if (complement_b) {
6785                 _invlist_invert(*output);
6786             }
6787         } /* else *output already = b; */
6788         return;
6789     }
6790     else if ((len_b = invlist_len(b)) == 0) {
6791         if (*output == b) {
6792             SvREFCNT_dec(b);
6793         }
6794
6795         /* The complement of an empty list is a list that has everything in it,
6796          * so the union with <a> includes everything too */
6797         if (complement_b) {
6798             if (a == *output) {
6799                 SvREFCNT_dec(a);
6800             }
6801             *output = _new_invlist(1);
6802             _append_range_to_invlist(*output, 0, UV_MAX);
6803         }
6804         else if (*output != a) {
6805             *output = invlist_clone(a);
6806         }
6807         /* else *output already = a; */
6808         return;
6809     }
6810
6811     /* Here both lists exist and are non-empty */
6812     array_a = invlist_array(a);
6813     array_b = invlist_array(b);
6814
6815     /* If are to take the union of 'a' with the complement of b, set it
6816      * up so are looking at b's complement. */
6817     if (complement_b) {
6818
6819         /* To complement, we invert: if the first element is 0, remove it.  To
6820          * do this, we just pretend the array starts one later, and clear the
6821          * flag as we don't have to do anything else later */
6822         if (array_b[0] == 0) {
6823             array_b++;
6824             len_b--;
6825             complement_b = FALSE;
6826         }
6827         else {
6828
6829             /* But if the first element is not zero, we unshift a 0 before the
6830              * array.  The data structure reserves a space for that 0 (which
6831              * should be a '1' right now), so physical shifting is unneeded,
6832              * but temporarily change that element to 0.  Before exiting the
6833              * routine, we must restore the element to '1' */
6834             array_b--;
6835             len_b++;
6836             array_b[0] = 0;
6837         }
6838     }
6839
6840     /* Size the union for the worst case: that the sets are completely
6841      * disjoint */
6842     u = _new_invlist(len_a + len_b);
6843
6844     /* Will contain U+0000 if either component does */
6845     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
6846                                       || (len_b > 0 && array_b[0] == 0));
6847
6848     /* Go through each list item by item, stopping when exhausted one of
6849      * them */
6850     while (i_a < len_a && i_b < len_b) {
6851         UV cp;      /* The element to potentially add to the union's array */
6852         bool cp_in_set;   /* is it in the the input list's set or not */
6853
6854         /* We need to take one or the other of the two inputs for the union.
6855          * Since we are merging two sorted lists, we take the smaller of the
6856          * next items.  In case of a tie, we take the one that is in its set
6857          * first.  If we took one not in the set first, it would decrement the
6858          * count, possibly to 0 which would cause it to be output as ending the
6859          * range, and the next time through we would take the same number, and
6860          * output it again as beginning the next range.  By doing it the
6861          * opposite way, there is no possibility that the count will be
6862          * momentarily decremented to 0, and thus the two adjoining ranges will
6863          * be seamlessly merged.  (In a tie and both are in the set or both not
6864          * in the set, it doesn't matter which we take first.) */
6865         if (array_a[i_a] < array_b[i_b]
6866             || (array_a[i_a] == array_b[i_b]
6867                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
6868         {
6869             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
6870             cp= array_a[i_a++];
6871         }
6872         else {
6873             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
6874             cp= array_b[i_b++];
6875         }
6876
6877         /* Here, have chosen which of the two inputs to look at.  Only output
6878          * if the running count changes to/from 0, which marks the
6879          * beginning/end of a range in that's in the set */
6880         if (cp_in_set) {
6881             if (count == 0) {
6882                 array_u[i_u++] = cp;
6883             }
6884             count++;
6885         }
6886         else {
6887             count--;
6888             if (count == 0) {
6889                 array_u[i_u++] = cp;
6890             }
6891         }
6892     }
6893
6894     /* Here, we are finished going through at least one of the lists, which
6895      * means there is something remaining in at most one.  We check if the list
6896      * that hasn't been exhausted is positioned such that we are in the middle
6897      * of a range in its set or not.  (i_a and i_b point to the element beyond
6898      * the one we care about.) If in the set, we decrement 'count'; if 0, there
6899      * is potentially more to output.
6900      * There are four cases:
6901      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
6902      *     in the union is entirely from the non-exhausted set.
6903      *  2) Both were in their sets, count is 2.  Nothing further should
6904      *     be output, as everything that remains will be in the exhausted
6905      *     list's set, hence in the union; decrementing to 1 but not 0 insures
6906      *     that
6907      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
6908      *     Nothing further should be output because the union includes
6909      *     everything from the exhausted set.  Not decrementing ensures that.
6910      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
6911      *     decrementing to 0 insures that we look at the remainder of the
6912      *     non-exhausted set */
6913     if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
6914         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
6915     {
6916         count--;
6917     }
6918
6919     /* The final length is what we've output so far, plus what else is about to
6920      * be output.  (If 'count' is non-zero, then the input list we exhausted
6921      * has everything remaining up to the machine's limit in its set, and hence
6922      * in the union, so there will be no further output. */
6923     len_u = i_u;
6924     if (count == 0) {
6925         /* At most one of the subexpressions will be non-zero */
6926         len_u += (len_a - i_a) + (len_b - i_b);
6927     }
6928
6929     /* Set result to final length, which can change the pointer to array_u, so
6930      * re-find it */
6931     if (len_u != invlist_len(u)) {
6932         invlist_set_len(u, len_u);
6933         invlist_trim(u);
6934         array_u = invlist_array(u);
6935     }
6936
6937     /* When 'count' is 0, the list that was exhausted (if one was shorter than
6938      * the other) ended with everything above it not in its set.  That means
6939      * that the remaining part of the union is precisely the same as the
6940      * non-exhausted list, so can just copy it unchanged.  (If both list were
6941      * exhausted at the same time, then the operations below will be both 0.)
6942      */
6943     if (count == 0) {
6944         IV copy_count; /* At most one will have a non-zero copy count */
6945         if ((copy_count = len_a - i_a) > 0) {
6946             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
6947         }
6948         else if ((copy_count = len_b - i_b) > 0) {
6949             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
6950         }
6951     }
6952
6953     /*  We may be removing a reference to one of the inputs */
6954     if (a == *output || b == *output) {
6955         SvREFCNT_dec(*output);
6956     }
6957
6958     /* If we've changed b, restore it */
6959     if (complement_b) {
6960         array_b[0] = 1;
6961     }
6962
6963     *output = u;
6964     return;
6965 }
6966
6967 void
6968 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** i)
6969 {
6970     /* Take the intersection of two inversion lists and point <i> to it.  *i
6971      * should be defined upon input, and if it points to one of the two lists,
6972      * the reference count to that list will be decremented.
6973      * If <complement_b> is TRUE, the result will be the intersection of <a>
6974      * and the complement (or inversion) of <b> instead of <b> directly.
6975      *
6976      * The basis for this comes from "Unicode Demystified" Chapter 13 by
6977      * Richard Gillam, published by Addison-Wesley, and explained at some
6978      * length there.  The preface says to incorporate its examples into your
6979      * code at your own risk.  In fact, it had bugs
6980      *
6981      * The algorithm is like a merge sort, and is essentially the same as the
6982      * union above
6983      */
6984
6985     UV* array_a;                /* a's array */
6986     UV* array_b;
6987     UV len_a;   /* length of a's array */
6988     UV len_b;
6989
6990     SV* r;                   /* the resulting intersection */
6991     UV* array_r;
6992     UV len_r;
6993
6994     UV i_a = 0;             /* current index into a's array */
6995     UV i_b = 0;
6996     UV i_r = 0;
6997
6998     /* running count, as explained in the algorithm source book; items are
6999      * stopped accumulating and are output when the count changes to/from 2.
7000      * The count is incremented when we start a range that's in the set, and
7001      * decremented when we start a range that's not in the set.  So its range
7002      * is 0 to 2.  Only when the count is 2 is something in the intersection.
7003      */
7004     UV count = 0;
7005
7006     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7007     assert(a != b);
7008
7009     /* Special case if either one is empty */
7010     len_a = invlist_len(a);
7011     if ((len_a == 0) || ((len_b = invlist_len(b)) == 0)) {
7012
7013         if (len_a != 0 && complement_b) {
7014
7015             /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7016              * be empty.  Here, also we are using 'b's complement, which hence
7017              * must be every possible code point.  Thus the intersection is
7018              * simply 'a'. */
7019             if (*i != a) {
7020                 *i = invlist_clone(a);
7021
7022                 if (*i == b) {
7023                     SvREFCNT_dec(b);
7024                 }
7025             }
7026             /* else *i is already 'a' */
7027             return;
7028         }
7029
7030         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
7031          * intersection must be empty */
7032         if (*i == a) {
7033             SvREFCNT_dec(a);
7034         }
7035         else if (*i == b) {
7036             SvREFCNT_dec(b);
7037         }
7038         *i = _new_invlist(0);
7039         return;
7040     }
7041
7042     /* Here both lists exist and are non-empty */
7043     array_a = invlist_array(a);
7044     array_b = invlist_array(b);
7045
7046     /* If are to take the intersection of 'a' with the complement of b, set it
7047      * up so are looking at b's complement. */
7048     if (complement_b) {
7049
7050         /* To complement, we invert: if the first element is 0, remove it.  To
7051          * do this, we just pretend the array starts one later, and clear the
7052          * flag as we don't have to do anything else later */
7053         if (array_b[0] == 0) {
7054             array_b++;
7055             len_b--;
7056             complement_b = FALSE;
7057         }
7058         else {
7059
7060             /* But if the first element is not zero, we unshift a 0 before the
7061              * array.  The data structure reserves a space for that 0 (which
7062              * should be a '1' right now), so physical shifting is unneeded,
7063              * but temporarily change that element to 0.  Before exiting the
7064              * routine, we must restore the element to '1' */
7065             array_b--;
7066             len_b++;
7067             array_b[0] = 0;
7068         }
7069     }
7070
7071     /* Size the intersection for the worst case: that the intersection ends up
7072      * fragmenting everything to be completely disjoint */
7073     r= _new_invlist(len_a + len_b);
7074
7075     /* Will contain U+0000 iff both components do */
7076     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7077                                      && len_b > 0 && array_b[0] == 0);
7078
7079     /* Go through each list item by item, stopping when exhausted one of
7080      * them */
7081     while (i_a < len_a && i_b < len_b) {
7082         UV cp;      /* The element to potentially add to the intersection's
7083                        array */
7084         bool cp_in_set; /* Is it in the input list's set or not */
7085
7086         /* We need to take one or the other of the two inputs for the
7087          * intersection.  Since we are merging two sorted lists, we take the
7088          * smaller of the next items.  In case of a tie, we take the one that
7089          * is not in its set first (a difference from the union algorithm).  If
7090          * we took one in the set first, it would increment the count, possibly
7091          * to 2 which would cause it to be output as starting a range in the
7092          * intersection, and the next time through we would take that same
7093          * number, and output it again as ending the set.  By doing it the
7094          * opposite of this, there is no possibility that the count will be
7095          * momentarily incremented to 2.  (In a tie and both are in the set or
7096          * both not in the set, it doesn't matter which we take first.) */
7097         if (array_a[i_a] < array_b[i_b]
7098             || (array_a[i_a] == array_b[i_b]
7099                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7100         {
7101             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7102             cp= array_a[i_a++];
7103         }
7104         else {
7105             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7106             cp= array_b[i_b++];
7107         }
7108
7109         /* Here, have chosen which of the two inputs to look at.  Only output
7110          * if the running count changes to/from 2, which marks the
7111          * beginning/end of a range that's in the intersection */
7112         if (cp_in_set) {
7113             count++;
7114             if (count == 2) {
7115                 array_r[i_r++] = cp;
7116             }
7117         }
7118         else {
7119             if (count == 2) {
7120                 array_r[i_r++] = cp;
7121             }
7122             count--;
7123         }
7124     }
7125
7126     /* Here, we are finished going through at least one of the lists, which
7127      * means there is something remaining in at most one.  We check if the list
7128      * that has been exhausted is positioned such that we are in the middle
7129      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
7130      * the ones we care about.)  There are four cases:
7131      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
7132      *     nothing left in the intersection.
7133      *  2) Both were in their sets, count is 2 and perhaps is incremented to
7134      *     above 2.  What should be output is exactly that which is in the
7135      *     non-exhausted set, as everything it has is also in the intersection
7136      *     set, and everything it doesn't have can't be in the intersection
7137      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7138      *     gets incremented to 2.  Like the previous case, the intersection is
7139      *     everything that remains in the non-exhausted set.
7140      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7141      *     remains 1.  And the intersection has nothing more. */
7142     if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7143         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7144     {
7145         count++;
7146     }
7147
7148     /* The final length is what we've output so far plus what else is in the
7149      * intersection.  At most one of the subexpressions below will be non-zero */
7150     len_r = i_r;
7151     if (count >= 2) {
7152         len_r += (len_a - i_a) + (len_b - i_b);
7153     }
7154
7155     /* Set result to final length, which can change the pointer to array_r, so
7156      * re-find it */
7157     if (len_r != invlist_len(r)) {
7158         invlist_set_len(r, len_r);
7159         invlist_trim(r);
7160         array_r = invlist_array(r);
7161     }
7162
7163     /* Finish outputting any remaining */
7164     if (count >= 2) { /* At most one will have a non-zero copy count */
7165         IV copy_count;
7166         if ((copy_count = len_a - i_a) > 0) {
7167             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7168         }
7169         else if ((copy_count = len_b - i_b) > 0) {
7170             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7171         }
7172     }
7173
7174     /*  We may be removing a reference to one of the inputs */
7175     if (a == *i || b == *i) {
7176         SvREFCNT_dec(*i);
7177     }
7178
7179     /* If we've changed b, restore it */
7180     if (complement_b) {
7181         array_b[0] = 1;
7182     }
7183
7184     *i = r;
7185     return;
7186 }
7187
7188 #endif
7189
7190 STATIC SV*
7191 S_add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
7192 {
7193     /* Add the range from 'start' to 'end' inclusive to the inversion list's
7194      * set.  A pointer to the inversion list is returned.  This may actually be
7195      * a new list, in which case the passed in one has been destroyed.  The
7196      * passed in inversion list can be NULL, in which case a new one is created
7197      * with just the one range in it */
7198
7199     SV* range_invlist;
7200     UV len;
7201
7202     if (invlist == NULL) {
7203         invlist = _new_invlist(2);
7204         len = 0;
7205     }
7206     else {
7207         len = invlist_len(invlist);
7208     }
7209
7210     /* If comes after the final entry, can just append it to the end */
7211     if (len == 0
7212         || start >= invlist_array(invlist)
7213                                     [invlist_len(invlist) - 1])
7214     {
7215         _append_range_to_invlist(invlist, start, end);
7216         return invlist;
7217     }
7218
7219     /* Here, can't just append things, create and return a new inversion list
7220      * which is the union of this range and the existing inversion list */
7221     range_invlist = _new_invlist(2);
7222     _append_range_to_invlist(range_invlist, start, end);
7223
7224     _invlist_union(invlist, range_invlist, &invlist);
7225
7226     /* The temporary can be freed */
7227     SvREFCNT_dec(range_invlist);
7228
7229     return invlist;
7230 }
7231
7232 PERL_STATIC_INLINE SV*
7233 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
7234     return add_range_to_invlist(invlist, cp, cp);
7235 }
7236
7237 #ifndef PERL_IN_XSUB_RE
7238 void
7239 Perl__invlist_invert(pTHX_ SV* const invlist)
7240 {
7241     /* Complement the input inversion list.  This adds a 0 if the list didn't
7242      * have a zero; removes it otherwise.  As described above, the data
7243      * structure is set up so that this is very efficient */
7244
7245     UV* len_pos = get_invlist_len_addr(invlist);
7246
7247     PERL_ARGS_ASSERT__INVLIST_INVERT;
7248
7249     /* The inverse of matching nothing is matching everything */
7250     if (*len_pos == 0) {
7251         _append_range_to_invlist(invlist, 0, UV_MAX);
7252         return;
7253     }
7254
7255     /* The exclusive or complents 0 to 1; and 1 to 0.  If the result is 1, the
7256      * zero element was a 0, so it is being removed, so the length decrements
7257      * by 1; and vice-versa.  SvCUR is unaffected */
7258     if (*get_invlist_zero_addr(invlist) ^= 1) {
7259         (*len_pos)--;
7260     }
7261     else {
7262         (*len_pos)++;
7263     }
7264 }
7265
7266 void
7267 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
7268 {
7269     /* Complement the input inversion list (which must be a Unicode property,
7270      * all of which don't match above the Unicode maximum code point.)  And
7271      * Perl has chosen to not have the inversion match above that either.  This
7272      * adds a 0x110000 if the list didn't end with it, and removes it if it did
7273      */
7274
7275     UV len;
7276     UV* array;
7277
7278     PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
7279
7280     _invlist_invert(invlist);
7281
7282     len = invlist_len(invlist);
7283
7284     if (len != 0) { /* If empty do nothing */
7285         array = invlist_array(invlist);
7286         if (array[len - 1] != PERL_UNICODE_MAX + 1) {
7287             /* Add 0x110000.  First, grow if necessary */
7288             len++;
7289             if (invlist_max(invlist) < len) {
7290                 invlist_extend(invlist, len);
7291                 array = invlist_array(invlist);
7292             }
7293             invlist_set_len(invlist, len);
7294             array[len - 1] = PERL_UNICODE_MAX + 1;
7295         }
7296         else {  /* Remove the 0x110000 */
7297             invlist_set_len(invlist, len - 1);
7298         }
7299     }
7300
7301     return;
7302 }
7303 #endif
7304
7305 PERL_STATIC_INLINE SV*
7306 S_invlist_clone(pTHX_ SV* const invlist)
7307 {
7308
7309     /* Return a new inversion list that is a copy of the input one, which is
7310      * unchanged */
7311
7312     /* Need to allocate extra space to accommodate Perl's addition of a
7313      * trailing NUL to SvPV's, since it thinks they are always strings */
7314     SV* new_invlist = _new_invlist(invlist_len(invlist) + 1);
7315     STRLEN length = SvCUR(invlist);
7316
7317     PERL_ARGS_ASSERT_INVLIST_CLONE;
7318
7319     SvCUR_set(new_invlist, length); /* This isn't done automatically */
7320     Copy(SvPVX(invlist), SvPVX(new_invlist), length, char);
7321
7322     return new_invlist;
7323 }
7324
7325 PERL_STATIC_INLINE UV*
7326 S_get_invlist_iter_addr(pTHX_ SV* invlist)
7327 {
7328     /* Return the address of the UV that contains the current iteration
7329      * position */
7330
7331     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
7332
7333     return (UV *) (SvPVX(invlist) + (INVLIST_ITER_OFFSET * sizeof (UV)));
7334 }
7335
7336 PERL_STATIC_INLINE UV*
7337 S_get_invlist_version_id_addr(pTHX_ SV* invlist)
7338 {
7339     /* Return the address of the UV that contains the version id. */
7340
7341     PERL_ARGS_ASSERT_GET_INVLIST_VERSION_ID_ADDR;
7342
7343     return (UV *) (SvPVX(invlist) + (INVLIST_VERSION_ID_OFFSET * sizeof (UV)));
7344 }
7345
7346 PERL_STATIC_INLINE void
7347 S_invlist_iterinit(pTHX_ SV* invlist)   /* Initialize iterator for invlist */
7348 {
7349     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
7350
7351     *get_invlist_iter_addr(invlist) = 0;
7352 }
7353
7354 STATIC bool
7355 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
7356 {
7357     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
7358      * This call sets in <*start> and <*end>, the next range in <invlist>.
7359      * Returns <TRUE> if successful and the next call will return the next
7360      * range; <FALSE> if was already at the end of the list.  If the latter,
7361      * <*start> and <*end> are unchanged, and the next call to this function
7362      * will start over at the beginning of the list */
7363
7364     UV* pos = get_invlist_iter_addr(invlist);
7365     UV len = invlist_len(invlist);
7366     UV *array;
7367
7368     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
7369
7370     if (*pos >= len) {
7371         *pos = UV_MAX;  /* Force iternit() to be required next time */
7372         return FALSE;
7373     }
7374
7375     array = invlist_array(invlist);
7376
7377     *start = array[(*pos)++];
7378
7379     if (*pos >= len) {
7380         *end = UV_MAX;
7381     }
7382     else {
7383         *end = array[(*pos)++] - 1;
7384     }
7385
7386     return TRUE;
7387 }
7388
7389 #ifndef PERL_IN_XSUB_RE
7390 SV *
7391 Perl__invlist_contents(pTHX_ SV* const invlist)
7392 {
7393     /* Get the contents of an inversion list into a string SV so that they can
7394      * be printed out.  It uses the format traditionally done for debug tracing
7395      */
7396
7397     UV start, end;
7398     SV* output = newSVpvs("\n");
7399
7400     PERL_ARGS_ASSERT__INVLIST_CONTENTS;
7401
7402     invlist_iterinit(invlist);
7403     while (invlist_iternext(invlist, &start, &end)) {
7404         if (end == UV_MAX) {
7405             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
7406         }
7407         else if (end != start) {
7408             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
7409                     start,       end);
7410         }
7411         else {
7412             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
7413         }
7414     }
7415
7416     return output;
7417 }
7418 #endif
7419
7420 #if 0
7421 void
7422 S_invlist_dump(pTHX_ SV* const invlist, const char * const header)
7423 {
7424     /* Dumps out the ranges in an inversion list.  The string 'header'
7425      * if present is output on a line before the first range */
7426
7427     UV start, end;
7428
7429     if (header && strlen(header)) {
7430         PerlIO_printf(Perl_debug_log, "%s\n", header);
7431     }
7432     invlist_iterinit(invlist);
7433     while (invlist_iternext(invlist, &start, &end)) {
7434         if (end == UV_MAX) {
7435             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
7436         }
7437         else {
7438             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n", start, end);
7439         }
7440     }
7441 }
7442 #endif
7443
7444 #undef HEADER_LENGTH
7445 #undef INVLIST_INITIAL_LENGTH
7446 #undef TO_INTERNAL_SIZE
7447 #undef FROM_INTERNAL_SIZE
7448 #undef INVLIST_LEN_OFFSET
7449 #undef INVLIST_ZERO_OFFSET
7450 #undef INVLIST_ITER_OFFSET
7451 #undef INVLIST_VERSION_ID
7452
7453 /* End of inversion list object */
7454
7455 /*
7456  - reg - regular expression, i.e. main body or parenthesized thing
7457  *
7458  * Caller must absorb opening parenthesis.
7459  *
7460  * Combining parenthesis handling with the base level of regular expression
7461  * is a trifle forced, but the need to tie the tails of the branches to what
7462  * follows makes it hard to avoid.
7463  */
7464 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
7465 #ifdef DEBUGGING
7466 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
7467 #else
7468 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
7469 #endif
7470
7471 STATIC regnode *
7472 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
7473     /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
7474 {
7475     dVAR;
7476     register regnode *ret;              /* Will be the head of the group. */
7477     register regnode *br;
7478     register regnode *lastbr;
7479     register regnode *ender = NULL;
7480     register I32 parno = 0;
7481     I32 flags;
7482     U32 oregflags = RExC_flags;
7483     bool have_branch = 0;
7484     bool is_open = 0;
7485     I32 freeze_paren = 0;
7486     I32 after_freeze = 0;
7487
7488     /* for (?g), (?gc), and (?o) warnings; warning
7489        about (?c) will warn about (?g) -- japhy    */
7490
7491 #define WASTED_O  0x01
7492 #define WASTED_G  0x02
7493 #define WASTED_C  0x04
7494 #define WASTED_GC (0x02|0x04)
7495     I32 wastedflags = 0x00;
7496
7497     char * parse_start = RExC_parse; /* MJD */
7498     char * const oregcomp_parse = RExC_parse;
7499
7500     GET_RE_DEBUG_FLAGS_DECL;
7501
7502     PERL_ARGS_ASSERT_REG;
7503     DEBUG_PARSE("reg ");
7504
7505     *flagp = 0;                         /* Tentatively. */
7506
7507
7508     /* Make an OPEN node, if parenthesized. */
7509     if (paren) {
7510         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
7511             char *start_verb = RExC_parse;
7512             STRLEN verb_len = 0;
7513             char *start_arg = NULL;
7514             unsigned char op = 0;
7515             int argok = 1;
7516             int internal_argval = 0; /* internal_argval is only useful if !argok */
7517             while ( *RExC_parse && *RExC_parse != ')' ) {
7518                 if ( *RExC_parse == ':' ) {
7519                     start_arg = RExC_parse + 1;
7520                     break;
7521                 }
7522                 RExC_parse++;
7523             }
7524             ++start_verb;
7525             verb_len = RExC_parse - start_verb;
7526             if ( start_arg ) {
7527                 RExC_parse++;
7528                 while ( *RExC_parse && *RExC_parse != ')' ) 
7529                     RExC_parse++;
7530                 if ( *RExC_parse != ')' ) 
7531                     vFAIL("Unterminated verb pattern argument");
7532                 if ( RExC_parse == start_arg )
7533                     start_arg = NULL;
7534             } else {
7535                 if ( *RExC_parse != ')' )
7536                     vFAIL("Unterminated verb pattern");
7537             }
7538             
7539             switch ( *start_verb ) {
7540             case 'A':  /* (*ACCEPT) */
7541                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
7542                     op = ACCEPT;
7543                     internal_argval = RExC_nestroot;
7544                 }
7545                 break;
7546             case 'C':  /* (*COMMIT) */
7547                 if ( memEQs(start_verb,verb_len,"COMMIT") )
7548                     op = COMMIT;
7549                 break;
7550             case 'F':  /* (*FAIL) */
7551                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
7552                     op = OPFAIL;
7553                     argok = 0;
7554                 }
7555                 break;
7556             case ':':  /* (*:NAME) */
7557             case 'M':  /* (*MARK:NAME) */
7558                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
7559                     op = MARKPOINT;
7560                     argok = -1;
7561                 }
7562                 break;
7563             case 'P':  /* (*PRUNE) */
7564                 if ( memEQs(start_verb,verb_len,"PRUNE") )
7565                     op = PRUNE;
7566                 break;
7567             case 'S':   /* (*SKIP) */  
7568                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
7569                     op = SKIP;
7570                 break;
7571             case 'T':  /* (*THEN) */
7572                 /* [19:06] <TimToady> :: is then */
7573                 if ( memEQs(start_verb,verb_len,"THEN") ) {
7574                     op = CUTGROUP;
7575                     RExC_seen |= REG_SEEN_CUTGROUP;
7576                 }
7577                 break;
7578             }
7579             if ( ! op ) {
7580                 RExC_parse++;
7581                 vFAIL3("Unknown verb pattern '%.*s'",
7582                     verb_len, start_verb);
7583             }
7584             if ( argok ) {
7585                 if ( start_arg && internal_argval ) {
7586                     vFAIL3("Verb pattern '%.*s' may not have an argument",
7587                         verb_len, start_verb); 
7588                 } else if ( argok < 0 && !start_arg ) {
7589                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
7590                         verb_len, start_verb);    
7591                 } else {
7592                     ret = reganode(pRExC_state, op, internal_argval);
7593                     if ( ! internal_argval && ! SIZE_ONLY ) {
7594                         if (start_arg) {
7595                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
7596                             ARG(ret) = add_data( pRExC_state, 1, "S" );
7597                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
7598                             ret->flags = 0;
7599                         } else {
7600                             ret->flags = 1; 
7601                         }
7602                     }               
7603                 }
7604                 if (!internal_argval)
7605                     RExC_seen |= REG_SEEN_VERBARG;
7606             } else if ( start_arg ) {
7607                 vFAIL3("Verb pattern '%.*s' may not have an argument",
7608                         verb_len, start_verb);    
7609             } else {
7610                 ret = reg_node(pRExC_state, op);
7611             }
7612             nextchar(pRExC_state);
7613             return ret;
7614         } else 
7615         if (*RExC_parse == '?') { /* (?...) */
7616             bool is_logical = 0;
7617             const char * const seqstart = RExC_parse;
7618             bool has_use_defaults = FALSE;
7619
7620             RExC_parse++;
7621             paren = *RExC_parse++;
7622             ret = NULL;                 /* For look-ahead/behind. */
7623             switch (paren) {
7624
7625             case 'P':   /* (?P...) variants for those used to PCRE/Python */
7626                 paren = *RExC_parse++;
7627                 if ( paren == '<')         /* (?P<...>) named capture */
7628                     goto named_capture;
7629                 else if (paren == '>') {   /* (?P>name) named recursion */
7630                     goto named_recursion;
7631                 }
7632                 else if (paren == '=') {   /* (?P=...)  named backref */
7633                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
7634                        you change this make sure you change that */
7635                     char* name_start = RExC_parse;
7636                     U32 num = 0;
7637                     SV *sv_dat = reg_scan_name(pRExC_state,
7638                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7639                     if (RExC_parse == name_start || *RExC_parse != ')')
7640                         vFAIL2("Sequence %.3s... not terminated",parse_start);
7641
7642                     if (!SIZE_ONLY) {
7643                         num = add_data( pRExC_state, 1, "S" );
7644                         RExC_rxi->data->data[num]=(void*)sv_dat;
7645                         SvREFCNT_inc_simple_void(sv_dat);
7646                     }
7647                     RExC_sawback = 1;
7648                     ret = reganode(pRExC_state,
7649                                    ((! FOLD)
7650                                      ? NREF
7651                                      : (MORE_ASCII_RESTRICTED)
7652                                        ? NREFFA
7653                                        : (AT_LEAST_UNI_SEMANTICS)
7654                                          ? NREFFU
7655                                          : (LOC)
7656                                            ? NREFFL
7657                                            : NREFF),
7658                                     num);
7659                     *flagp |= HASWIDTH;
7660
7661                     Set_Node_Offset(ret, parse_start+1);
7662                     Set_Node_Cur_Length(ret); /* MJD */
7663
7664                     nextchar(pRExC_state);
7665                     return ret;
7666                 }
7667                 RExC_parse++;
7668                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
7669                 /*NOTREACHED*/
7670             case '<':           /* (?<...) */
7671                 if (*RExC_parse == '!')
7672                     paren = ',';
7673                 else if (*RExC_parse != '=') 
7674               named_capture:
7675                 {               /* (?<...>) */
7676                     char *name_start;
7677                     SV *svname;
7678                     paren= '>';
7679             case '\'':          /* (?'...') */
7680                     name_start= RExC_parse;
7681                     svname = reg_scan_name(pRExC_state,
7682                         SIZE_ONLY ?  /* reverse test from the others */
7683                         REG_RSN_RETURN_NAME : 
7684                         REG_RSN_RETURN_NULL);
7685                     if (RExC_parse == name_start) {
7686                         RExC_parse++;
7687                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
7688                         /*NOTREACHED*/
7689                     }
7690                     if (*RExC_parse != paren)
7691                         vFAIL2("Sequence (?%c... not terminated",
7692                             paren=='>' ? '<' : paren);
7693                     if (SIZE_ONLY) {
7694                         HE *he_str;
7695                         SV *sv_dat = NULL;
7696                         if (!svname) /* shouldn't happen */
7697                             Perl_croak(aTHX_
7698                                 "panic: reg_scan_name returned NULL");
7699                         if (!RExC_paren_names) {
7700                             RExC_paren_names= newHV();
7701                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
7702 #ifdef DEBUGGING
7703                             RExC_paren_name_list= newAV();
7704                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
7705 #endif
7706                         }
7707                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
7708                         if ( he_str )
7709                             sv_dat = HeVAL(he_str);
7710                         if ( ! sv_dat ) {
7711                             /* croak baby croak */
7712                             Perl_croak(aTHX_
7713                                 "panic: paren_name hash element allocation failed");
7714                         } else if ( SvPOK(sv_dat) ) {
7715                             /* (?|...) can mean we have dupes so scan to check
7716                                its already been stored. Maybe a flag indicating
7717                                we are inside such a construct would be useful,
7718                                but the arrays are likely to be quite small, so
7719                                for now we punt -- dmq */
7720                             IV count = SvIV(sv_dat);
7721                             I32 *pv = (I32*)SvPVX(sv_dat);
7722                             IV i;
7723                             for ( i = 0 ; i < count ; i++ ) {
7724                                 if ( pv[i] == RExC_npar ) {
7725                                     count = 0;
7726                                     break;
7727                                 }
7728                             }
7729                             if ( count ) {
7730                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
7731                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
7732                                 pv[count] = RExC_npar;
7733                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
7734                             }
7735                         } else {
7736                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
7737                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
7738                             SvIOK_on(sv_dat);
7739                             SvIV_set(sv_dat, 1);
7740                         }
7741 #ifdef DEBUGGING
7742                         /* Yes this does cause a memory leak in debugging Perls */
7743                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
7744                             SvREFCNT_dec(svname);
7745 #endif
7746
7747                         /*sv_dump(sv_dat);*/
7748                     }
7749                     nextchar(pRExC_state);
7750                     paren = 1;
7751                     goto capturing_parens;
7752                 }
7753                 RExC_seen |= REG_SEEN_LOOKBEHIND;
7754                 RExC_in_lookbehind++;
7755                 RExC_parse++;
7756             case '=':           /* (?=...) */
7757                 RExC_seen_zerolen++;
7758                 break;
7759             case '!':           /* (?!...) */
7760                 RExC_seen_zerolen++;
7761                 if (*RExC_parse == ')') {
7762                     ret=reg_node(pRExC_state, OPFAIL);
7763                     nextchar(pRExC_state);
7764                     return ret;
7765                 }
7766                 break;
7767             case '|':           /* (?|...) */
7768                 /* branch reset, behave like a (?:...) except that
7769                    buffers in alternations share the same numbers */
7770                 paren = ':'; 
7771                 after_freeze = freeze_paren = RExC_npar;
7772                 break;
7773             case ':':           /* (?:...) */
7774             case '>':           /* (?>...) */
7775                 break;
7776             case '$':           /* (?$...) */
7777             case '@':           /* (?@...) */
7778                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
7779                 break;
7780             case '#':           /* (?#...) */
7781                 while (*RExC_parse && *RExC_parse != ')')
7782                     RExC_parse++;
7783                 if (*RExC_parse != ')')
7784                     FAIL("Sequence (?#... not terminated");
7785                 nextchar(pRExC_state);
7786                 *flagp = TRYAGAIN;
7787                 return NULL;
7788             case '0' :           /* (?0) */
7789             case 'R' :           /* (?R) */
7790                 if (*RExC_parse != ')')
7791                     FAIL("Sequence (?R) not terminated");
7792                 ret = reg_node(pRExC_state, GOSTART);
7793                 *flagp |= POSTPONED;
7794                 nextchar(pRExC_state);
7795                 return ret;
7796                 /*notreached*/
7797             { /* named and numeric backreferences */
7798                 I32 num;
7799             case '&':            /* (?&NAME) */
7800                 parse_start = RExC_parse - 1;
7801               named_recursion:
7802                 {
7803                     SV *sv_dat = reg_scan_name(pRExC_state,
7804                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7805                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
7806                 }
7807                 goto gen_recurse_regop;
7808                 /* NOT REACHED */
7809             case '+':
7810                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
7811                     RExC_parse++;
7812                     vFAIL("Illegal pattern");
7813                 }
7814                 goto parse_recursion;
7815                 /* NOT REACHED*/
7816             case '-': /* (?-1) */
7817                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
7818                     RExC_parse--; /* rewind to let it be handled later */
7819                     goto parse_flags;
7820                 } 
7821                 /*FALLTHROUGH */
7822             case '1': case '2': case '3': case '4': /* (?1) */
7823             case '5': case '6': case '7': case '8': case '9':
7824                 RExC_parse--;
7825               parse_recursion:
7826                 num = atoi(RExC_parse);
7827                 parse_start = RExC_parse - 1; /* MJD */
7828                 if (*RExC_parse == '-')
7829                     RExC_parse++;
7830                 while (isDIGIT(*RExC_parse))
7831                         RExC_parse++;
7832                 if (*RExC_parse!=')') 
7833                     vFAIL("Expecting close bracket");
7834
7835               gen_recurse_regop:
7836                 if ( paren == '-' ) {
7837                     /*
7838                     Diagram of capture buffer numbering.
7839                     Top line is the normal capture buffer numbers
7840                     Bottom line is the negative indexing as from
7841                     the X (the (?-2))
7842
7843                     +   1 2    3 4 5 X          6 7
7844                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
7845                     -   5 4    3 2 1 X          x x
7846
7847                     */
7848                     num = RExC_npar + num;
7849                     if (num < 1)  {
7850                         RExC_parse++;
7851                         vFAIL("Reference to nonexistent group");
7852                     }
7853                 } else if ( paren == '+' ) {
7854                     num = RExC_npar + num - 1;
7855                 }
7856
7857                 ret = reganode(pRExC_state, GOSUB, num);
7858                 if (!SIZE_ONLY) {
7859                     if (num > (I32)RExC_rx->nparens) {
7860                         RExC_parse++;
7861                         vFAIL("Reference to nonexistent group");
7862                     }
7863                     ARG2L_SET( ret, RExC_recurse_count++);
7864                     RExC_emit++;
7865                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
7866                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
7867                 } else {
7868                     RExC_size++;
7869                 }
7870                 RExC_seen |= REG_SEEN_RECURSE;
7871                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
7872                 Set_Node_Offset(ret, parse_start); /* MJD */
7873
7874                 *flagp |= POSTPONED;
7875                 nextchar(pRExC_state);
7876                 return ret;
7877             } /* named and numeric backreferences */
7878             /* NOT REACHED */
7879
7880             case '?':           /* (??...) */
7881                 is_logical = 1;
7882                 if (*RExC_parse != '{') {
7883                     RExC_parse++;
7884                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
7885                     /*NOTREACHED*/
7886                 }
7887                 *flagp |= POSTPONED;
7888                 paren = *RExC_parse++;
7889                 /* FALL THROUGH */
7890             case '{':           /* (?{...}) */
7891             {
7892                 I32 count = 1;
7893                 U32 n = 0;
7894                 char c;
7895                 char *s = RExC_parse;
7896
7897                 RExC_seen_zerolen++;
7898                 RExC_seen |= REG_SEEN_EVAL;
7899                 while (count && (c = *RExC_parse)) {
7900                     if (c == '\\') {
7901                         if (RExC_parse[1])
7902                             RExC_parse++;
7903                     }
7904                     else if (c == '{')
7905                         count++;
7906                     else if (c == '}')
7907                         count--;
7908                     RExC_parse++;
7909                 }
7910                 if (*RExC_parse != ')') {
7911                     RExC_parse = s;
7912                     vFAIL("Sequence (?{...}) not terminated or not {}-balanced");
7913                 }
7914                 if (!SIZE_ONLY) {
7915                     PAD *pad;
7916                     OP_4tree *sop, *rop;
7917                     SV * const sv = newSVpvn(s, RExC_parse - 1 - s);
7918
7919                     ENTER;
7920                     Perl_save_re_context(aTHX);
7921                     rop = Perl_sv_compile_2op_is_broken(aTHX_ sv, &sop, "re", &pad);
7922                     sop->op_private |= OPpREFCOUNTED;
7923                     /* re_dup will OpREFCNT_inc */
7924                     OpREFCNT_set(sop, 1);
7925                     LEAVE;
7926
7927                     n = add_data(pRExC_state, 3, "nop");
7928                     RExC_rxi->data->data[n] = (void*)rop;
7929                     RExC_rxi->data->data[n+1] = (void*)sop;
7930                     RExC_rxi->data->data[n+2] = (void*)pad;
7931                     SvREFCNT_dec(sv);
7932                 }
7933                 else {                                          /* First pass */
7934                     if (PL_reginterp_cnt < ++RExC_seen_evals
7935                         && IN_PERL_RUNTIME)
7936                         /* No compiled RE interpolated, has runtime
7937                            components ===> unsafe.  */
7938                         FAIL("Eval-group not allowed at runtime, use re 'eval'");
7939                     if (PL_tainting && PL_tainted)
7940                         FAIL("Eval-group in insecure regular expression");
7941 #if PERL_VERSION > 8
7942                     if (IN_PERL_COMPILETIME)
7943                         PL_cv_has_eval = 1;
7944 #endif
7945                 }
7946
7947                 nextchar(pRExC_state);
7948                 if (is_logical) {
7949                     ret = reg_node(pRExC_state, LOGICAL);
7950                     if (!SIZE_ONLY)
7951                         ret->flags = 2;
7952                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, EVAL, n));
7953                     /* deal with the length of this later - MJD */
7954                     return ret;
7955                 }
7956                 ret = reganode(pRExC_state, EVAL, n);
7957                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
7958                 Set_Node_Offset(ret, parse_start);
7959                 return ret;
7960             }
7961             case '(':           /* (?(?{...})...) and (?(?=...)...) */
7962             {
7963                 int is_define= 0;
7964                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
7965                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
7966                         || RExC_parse[1] == '<'
7967                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
7968                         I32 flag;
7969
7970                         ret = reg_node(pRExC_state, LOGICAL);
7971                         if (!SIZE_ONLY)
7972                             ret->flags = 1;
7973                         REGTAIL(pRExC_state, ret, reg(pRExC_state, 1, &flag,depth+1));
7974                         goto insert_if;
7975                     }
7976                 }
7977                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
7978                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
7979                 {
7980                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
7981                     char *name_start= RExC_parse++;
7982                     U32 num = 0;
7983                     SV *sv_dat=reg_scan_name(pRExC_state,
7984                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7985                     if (RExC_parse == name_start || *RExC_parse != ch)
7986                         vFAIL2("Sequence (?(%c... not terminated",
7987                             (ch == '>' ? '<' : ch));
7988                     RExC_parse++;
7989                     if (!SIZE_ONLY) {
7990                         num = add_data( pRExC_state, 1, "S" );
7991                         RExC_rxi->data->data[num]=(void*)sv_dat;
7992                         SvREFCNT_inc_simple_void(sv_dat);
7993                     }
7994                     ret = reganode(pRExC_state,NGROUPP,num);
7995                     goto insert_if_check_paren;
7996                 }
7997                 else if (RExC_parse[0] == 'D' &&
7998                          RExC_parse[1] == 'E' &&
7999                          RExC_parse[2] == 'F' &&
8000                          RExC_parse[3] == 'I' &&
8001                          RExC_parse[4] == 'N' &&
8002                          RExC_parse[5] == 'E')
8003                 {
8004                     ret = reganode(pRExC_state,DEFINEP,0);
8005                     RExC_parse +=6 ;
8006                     is_define = 1;
8007                     goto insert_if_check_paren;
8008                 }
8009                 else if (RExC_parse[0] == 'R') {
8010                     RExC_parse++;
8011                     parno = 0;
8012                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
8013                         parno = atoi(RExC_parse++);
8014                         while (isDIGIT(*RExC_parse))
8015                             RExC_parse++;
8016                     } else if (RExC_parse[0] == '&') {
8017                         SV *sv_dat;
8018                         RExC_parse++;
8019                         sv_dat = reg_scan_name(pRExC_state,
8020                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8021                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8022                     }
8023                     ret = reganode(pRExC_state,INSUBP,parno); 
8024                     goto insert_if_check_paren;
8025                 }
8026                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
8027                     /* (?(1)...) */
8028                     char c;
8029                     parno = atoi(RExC_parse++);
8030
8031                     while (isDIGIT(*RExC_parse))
8032                         RExC_parse++;
8033                     ret = reganode(pRExC_state, GROUPP, parno);
8034
8035                  insert_if_check_paren:
8036                     if ((c = *nextchar(pRExC_state)) != ')')
8037                         vFAIL("Switch condition not recognized");
8038                   insert_if:
8039                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
8040                     br = regbranch(pRExC_state, &flags, 1,depth+1);
8041                     if (br == NULL)
8042                         br = reganode(pRExC_state, LONGJMP, 0);
8043                     else
8044                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
8045                     c = *nextchar(pRExC_state);
8046                     if (flags&HASWIDTH)
8047                         *flagp |= HASWIDTH;
8048                     if (c == '|') {
8049                         if (is_define) 
8050                             vFAIL("(?(DEFINE)....) does not allow branches");
8051                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
8052                         regbranch(pRExC_state, &flags, 1,depth+1);
8053                         REGTAIL(pRExC_state, ret, lastbr);
8054                         if (flags&HASWIDTH)
8055                             *flagp |= HASWIDTH;
8056                         c = *nextchar(pRExC_state);
8057                     }
8058                     else
8059                         lastbr = NULL;
8060                     if (c != ')')
8061                         vFAIL("Switch (?(condition)... contains too many branches");
8062                     ender = reg_node(pRExC_state, TAIL);
8063                     REGTAIL(pRExC_state, br, ender);
8064                     if (lastbr) {
8065                         REGTAIL(pRExC_state, lastbr, ender);
8066                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
8067                     }
8068                     else
8069                         REGTAIL(pRExC_state, ret, ender);
8070                     RExC_size++; /* XXX WHY do we need this?!!
8071                                     For large programs it seems to be required
8072                                     but I can't figure out why. -- dmq*/
8073                     return ret;
8074                 }
8075                 else {
8076                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
8077                 }
8078             }
8079             case 0:
8080                 RExC_parse--; /* for vFAIL to print correctly */
8081                 vFAIL("Sequence (? incomplete");
8082                 break;
8083             case DEFAULT_PAT_MOD:   /* Use default flags with the exceptions
8084                                        that follow */
8085                 has_use_defaults = TRUE;
8086                 STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8087                 set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8088                                                 ? REGEX_UNICODE_CHARSET
8089                                                 : REGEX_DEPENDS_CHARSET);
8090                 goto parse_flags;
8091             default:
8092                 --RExC_parse;
8093                 parse_flags:      /* (?i) */  
8094             {
8095                 U32 posflags = 0, negflags = 0;
8096                 U32 *flagsp = &posflags;
8097                 char has_charset_modifier = '\0';
8098                 regex_charset cs = get_regex_charset(RExC_flags);
8099                 if (cs == REGEX_DEPENDS_CHARSET
8100                     && (RExC_utf8 || RExC_uni_semantics))
8101                 {
8102                     cs = REGEX_UNICODE_CHARSET;
8103                 }
8104
8105                 while (*RExC_parse) {
8106                     /* && strchr("iogcmsx", *RExC_parse) */
8107                     /* (?g), (?gc) and (?o) are useless here
8108                        and must be globally applied -- japhy */
8109                     switch (*RExC_parse) {
8110                     CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
8111                     case LOCALE_PAT_MOD:
8112                         if (has_charset_modifier) {
8113                             goto excess_modifier;
8114                         }
8115                         else if (flagsp == &negflags) {
8116                             goto neg_modifier;
8117                         }
8118                         cs = REGEX_LOCALE_CHARSET;
8119                         has_charset_modifier = LOCALE_PAT_MOD;
8120                         RExC_contains_locale = 1;
8121                         break;
8122                     case UNICODE_PAT_MOD:
8123                         if (has_charset_modifier) {
8124                             goto excess_modifier;
8125                         }
8126                         else if (flagsp == &negflags) {
8127                             goto neg_modifier;
8128                         }
8129                         cs = REGEX_UNICODE_CHARSET;
8130                         has_charset_modifier = UNICODE_PAT_MOD;
8131                         break;
8132                     case ASCII_RESTRICT_PAT_MOD:
8133                         if (flagsp == &negflags) {
8134                             goto neg_modifier;
8135                         }
8136                         if (has_charset_modifier) {
8137                             if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
8138                                 goto excess_modifier;
8139                             }
8140                             /* Doubled modifier implies more restricted */
8141                             cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
8142                         }
8143                         else {
8144                             cs = REGEX_ASCII_RESTRICTED_CHARSET;
8145                         }
8146                         has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
8147                         break;
8148                     case DEPENDS_PAT_MOD:
8149                         if (has_use_defaults) {
8150                             goto fail_modifiers;
8151                         }
8152                         else if (flagsp == &negflags) {
8153                             goto neg_modifier;
8154                         }
8155                         else if (has_charset_modifier) {
8156                             goto excess_modifier;
8157                         }
8158
8159                         /* The dual charset means unicode semantics if the
8160                          * pattern (or target, not known until runtime) are
8161                          * utf8, or something in the pattern indicates unicode
8162                          * semantics */
8163                         cs = (RExC_utf8 || RExC_uni_semantics)
8164                              ? REGEX_UNICODE_CHARSET
8165                              : REGEX_DEPENDS_CHARSET;
8166                         has_charset_modifier = DEPENDS_PAT_MOD;
8167                         break;
8168                     excess_modifier:
8169                         RExC_parse++;
8170                         if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
8171                             vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
8172                         }
8173                         else if (has_charset_modifier == *(RExC_parse - 1)) {
8174                             vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
8175                         }
8176                         else {
8177                             vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
8178                         }
8179                         /*NOTREACHED*/
8180                     neg_modifier:
8181                         RExC_parse++;
8182                         vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
8183                         /*NOTREACHED*/
8184                     case ONCE_PAT_MOD: /* 'o' */
8185                     case GLOBAL_PAT_MOD: /* 'g' */
8186                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8187                             const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
8188                             if (! (wastedflags & wflagbit) ) {
8189                                 wastedflags |= wflagbit;
8190                                 vWARN5(
8191                                     RExC_parse + 1,
8192                                     "Useless (%s%c) - %suse /%c modifier",
8193                                     flagsp == &negflags ? "?-" : "?",
8194                                     *RExC_parse,
8195                                     flagsp == &negflags ? "don't " : "",
8196                                     *RExC_parse
8197                                 );
8198                             }
8199                         }
8200                         break;
8201                         
8202                     case CONTINUE_PAT_MOD: /* 'c' */
8203                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8204                             if (! (wastedflags & WASTED_C) ) {
8205                                 wastedflags |= WASTED_GC;
8206                                 vWARN3(
8207                                     RExC_parse + 1,
8208                                     "Useless (%sc) - %suse /gc modifier",
8209                                     flagsp == &negflags ? "?-" : "?",
8210                                     flagsp == &negflags ? "don't " : ""
8211                                 );
8212                             }
8213                         }
8214                         break;
8215                     case KEEPCOPY_PAT_MOD: /* 'p' */
8216                         if (flagsp == &negflags) {
8217                             if (SIZE_ONLY)
8218                                 ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
8219                         } else {
8220                             *flagsp |= RXf_PMf_KEEPCOPY;
8221                         }
8222                         break;
8223                     case '-':
8224                         /* A flag is a default iff it is following a minus, so
8225                          * if there is a minus, it means will be trying to
8226                          * re-specify a default which is an error */
8227                         if (has_use_defaults || flagsp == &negflags) {
8228             fail_modifiers:
8229                             RExC_parse++;
8230                             vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8231                             /*NOTREACHED*/
8232                         }
8233                         flagsp = &negflags;
8234                         wastedflags = 0;  /* reset so (?g-c) warns twice */
8235                         break;
8236                     case ':':
8237                         paren = ':';
8238                         /*FALLTHROUGH*/
8239                     case ')':
8240                         RExC_flags |= posflags;
8241                         RExC_flags &= ~negflags;
8242                         set_regex_charset(&RExC_flags, cs);
8243                         if (paren != ':') {
8244                             oregflags |= posflags;
8245                             oregflags &= ~negflags;
8246                             set_regex_charset(&oregflags, cs);
8247                         }
8248                         nextchar(pRExC_state);
8249                         if (paren != ':') {
8250                             *flagp = TRYAGAIN;
8251                             return NULL;
8252                         } else {
8253                             ret = NULL;
8254                             goto parse_rest;
8255                         }
8256                         /*NOTREACHED*/
8257                     default:
8258                         RExC_parse++;
8259                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8260                         /*NOTREACHED*/
8261                     }                           
8262                     ++RExC_parse;
8263                 }
8264             }} /* one for the default block, one for the switch */
8265         }
8266         else {                  /* (...) */
8267           capturing_parens:
8268             parno = RExC_npar;
8269             RExC_npar++;
8270             
8271             ret = reganode(pRExC_state, OPEN, parno);
8272             if (!SIZE_ONLY ){
8273                 if (!RExC_nestroot) 
8274                     RExC_nestroot = parno;
8275                 if (RExC_seen & REG_SEEN_RECURSE
8276                     && !RExC_open_parens[parno-1])
8277                 {
8278                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
8279                         "Setting open paren #%"IVdf" to %d\n", 
8280                         (IV)parno, REG_NODE_NUM(ret)));
8281                     RExC_open_parens[parno-1]= ret;
8282                 }
8283             }
8284             Set_Node_Length(ret, 1); /* MJD */
8285             Set_Node_Offset(ret, RExC_parse); /* MJD */
8286             is_open = 1;
8287         }
8288     }
8289     else                        /* ! paren */
8290         ret = NULL;
8291    
8292    parse_rest:
8293     /* Pick up the branches, linking them together. */
8294     parse_start = RExC_parse;   /* MJD */
8295     br = regbranch(pRExC_state, &flags, 1,depth+1);
8296
8297     /*     branch_len = (paren != 0); */
8298
8299     if (br == NULL)
8300         return(NULL);
8301     if (*RExC_parse == '|') {
8302         if (!SIZE_ONLY && RExC_extralen) {
8303             reginsert(pRExC_state, BRANCHJ, br, depth+1);
8304         }
8305         else {                  /* MJD */
8306             reginsert(pRExC_state, BRANCH, br, depth+1);
8307             Set_Node_Length(br, paren != 0);
8308             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
8309         }
8310         have_branch = 1;
8311         if (SIZE_ONLY)
8312             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
8313     }
8314     else if (paren == ':') {
8315         *flagp |= flags&SIMPLE;
8316     }
8317     if (is_open) {                              /* Starts with OPEN. */
8318         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
8319     }
8320     else if (paren != '?')              /* Not Conditional */
8321         ret = br;
8322     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
8323     lastbr = br;
8324     while (*RExC_parse == '|') {
8325         if (!SIZE_ONLY && RExC_extralen) {
8326             ender = reganode(pRExC_state, LONGJMP,0);
8327             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
8328         }
8329         if (SIZE_ONLY)
8330             RExC_extralen += 2;         /* Account for LONGJMP. */
8331         nextchar(pRExC_state);
8332         if (freeze_paren) {
8333             if (RExC_npar > after_freeze)
8334                 after_freeze = RExC_npar;
8335             RExC_npar = freeze_paren;       
8336         }
8337         br = regbranch(pRExC_state, &flags, 0, depth+1);
8338
8339         if (br == NULL)
8340             return(NULL);
8341         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
8342         lastbr = br;
8343         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
8344     }
8345
8346     if (have_branch || paren != ':') {
8347         /* Make a closing node, and hook it on the end. */
8348         switch (paren) {
8349         case ':':
8350             ender = reg_node(pRExC_state, TAIL);
8351             break;
8352         case 1:
8353             ender = reganode(pRExC_state, CLOSE, parno);
8354             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
8355                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
8356                         "Setting close paren #%"IVdf" to %d\n", 
8357                         (IV)parno, REG_NODE_NUM(ender)));
8358                 RExC_close_parens[parno-1]= ender;
8359                 if (RExC_nestroot == parno) 
8360                     RExC_nestroot = 0;
8361             }       
8362             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
8363             Set_Node_Length(ender,1); /* MJD */
8364             break;
8365         case '<':
8366         case ',':
8367         case '=':
8368         case '!':
8369             *flagp &= ~HASWIDTH;
8370             /* FALL THROUGH */
8371         case '>':
8372             ender = reg_node(pRExC_state, SUCCEED);
8373             break;
8374         case 0:
8375             ender = reg_node(pRExC_state, END);
8376             if (!SIZE_ONLY) {
8377                 assert(!RExC_opend); /* there can only be one! */
8378                 RExC_opend = ender;
8379             }
8380             break;
8381         }
8382         REGTAIL(pRExC_state, lastbr, ender);
8383
8384         if (have_branch && !SIZE_ONLY) {
8385             if (depth==1)
8386                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
8387
8388             /* Hook the tails of the branches to the closing node. */
8389             for (br = ret; br; br = regnext(br)) {
8390                 const U8 op = PL_regkind[OP(br)];
8391                 if (op == BRANCH) {
8392                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
8393                 }
8394                 else if (op == BRANCHJ) {
8395                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
8396                 }
8397             }
8398         }
8399     }
8400
8401     {
8402         const char *p;
8403         static const char parens[] = "=!<,>";
8404
8405         if (paren && (p = strchr(parens, paren))) {
8406             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
8407             int flag = (p - parens) > 1;
8408
8409             if (paren == '>')
8410                 node = SUSPEND, flag = 0;
8411             reginsert(pRExC_state, node,ret, depth+1);
8412             Set_Node_Cur_Length(ret);
8413             Set_Node_Offset(ret, parse_start + 1);
8414             ret->flags = flag;
8415             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
8416         }
8417     }
8418
8419     /* Check for proper termination. */
8420     if (paren) {
8421         RExC_flags = oregflags;
8422         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
8423             RExC_parse = oregcomp_parse;
8424             vFAIL("Unmatched (");
8425         }
8426     }
8427     else if (!paren && RExC_parse < RExC_end) {
8428         if (*RExC_parse == ')') {
8429             RExC_parse++;
8430             vFAIL("Unmatched )");
8431         }
8432         else
8433             FAIL("Junk on end of regexp");      /* "Can't happen". */
8434         /* NOTREACHED */
8435     }
8436
8437     if (RExC_in_lookbehind) {
8438         RExC_in_lookbehind--;
8439     }
8440     if (after_freeze > RExC_npar)
8441         RExC_npar = after_freeze;
8442     return(ret);
8443 }
8444
8445 /*
8446  - regbranch - one alternative of an | operator
8447  *
8448  * Implements the concatenation operator.
8449  */
8450 STATIC regnode *
8451 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
8452 {
8453     dVAR;
8454     register regnode *ret;
8455     register regnode *chain = NULL;
8456     register regnode *latest;
8457     I32 flags = 0, c = 0;
8458     GET_RE_DEBUG_FLAGS_DECL;
8459
8460     PERL_ARGS_ASSERT_REGBRANCH;
8461
8462     DEBUG_PARSE("brnc");
8463
8464     if (first)
8465         ret = NULL;
8466     else {
8467         if (!SIZE_ONLY && RExC_extralen)
8468             ret = reganode(pRExC_state, BRANCHJ,0);
8469         else {
8470             ret = reg_node(pRExC_state, BRANCH);
8471             Set_Node_Length(ret, 1);
8472         }
8473     }
8474
8475     if (!first && SIZE_ONLY)
8476         RExC_extralen += 1;                     /* BRANCHJ */
8477
8478     *flagp = WORST;                     /* Tentatively. */
8479
8480     RExC_parse--;
8481     nextchar(pRExC_state);
8482     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
8483         flags &= ~TRYAGAIN;
8484         latest = regpiece(pRExC_state, &flags,depth+1);
8485         if (latest == NULL) {
8486             if (flags & TRYAGAIN)
8487                 continue;
8488             return(NULL);
8489         }
8490         else if (ret == NULL)
8491             ret = latest;
8492         *flagp |= flags&(HASWIDTH|POSTPONED);
8493         if (chain == NULL)      /* First piece. */
8494             *flagp |= flags&SPSTART;
8495         else {
8496             RExC_naughty++;
8497             REGTAIL(pRExC_state, chain, latest);
8498         }
8499         chain = latest;
8500         c++;
8501     }
8502     if (chain == NULL) {        /* Loop ran zero times. */
8503         chain = reg_node(pRExC_state, NOTHING);
8504         if (ret == NULL)
8505             ret = chain;
8506     }
8507     if (c == 1) {
8508         *flagp |= flags&SIMPLE;
8509     }
8510
8511     return ret;
8512 }
8513
8514 /*
8515  - regpiece - something followed by possible [*+?]
8516  *
8517  * Note that the branching code sequences used for ? and the general cases
8518  * of * and + are somewhat optimized:  they use the same NOTHING node as
8519  * both the endmarker for their branch list and the body of the last branch.
8520  * It might seem that this node could be dispensed with entirely, but the
8521  * endmarker role is not redundant.
8522  */
8523 STATIC regnode *
8524 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
8525 {
8526     dVAR;
8527     register regnode *ret;
8528     register char op;
8529     register char *next;
8530     I32 flags;
8531     const char * const origparse = RExC_parse;
8532     I32 min;
8533     I32 max = REG_INFTY;
8534 #ifdef RE_TRACK_PATTERN_OFFSETS
8535     char *parse_start;
8536 #endif
8537     const char *maxpos = NULL;
8538     GET_RE_DEBUG_FLAGS_DECL;
8539
8540     PERL_ARGS_ASSERT_REGPIECE;
8541
8542     DEBUG_PARSE("piec");
8543
8544     ret = regatom(pRExC_state, &flags,depth+1);
8545     if (ret == NULL) {
8546         if (flags & TRYAGAIN)
8547             *flagp |= TRYAGAIN;
8548         return(NULL);
8549     }
8550
8551     op = *RExC_parse;
8552
8553     if (op == '{' && regcurly(RExC_parse)) {
8554         maxpos = NULL;
8555 #ifdef RE_TRACK_PATTERN_OFFSETS
8556         parse_start = RExC_parse; /* MJD */
8557 #endif
8558         next = RExC_parse + 1;
8559         while (isDIGIT(*next) || *next == ',') {
8560             if (*next == ',') {
8561                 if (maxpos)
8562                     break;
8563                 else
8564                     maxpos = next;
8565             }
8566             next++;
8567         }
8568         if (*next == '}') {             /* got one */
8569             if (!maxpos)
8570                 maxpos = next;
8571             RExC_parse++;
8572             min = atoi(RExC_parse);
8573             if (*maxpos == ',')
8574                 maxpos++;
8575             else
8576                 maxpos = RExC_parse;
8577             max = atoi(maxpos);
8578             if (!max && *maxpos != '0')
8579                 max = REG_INFTY;                /* meaning "infinity" */
8580             else if (max >= REG_INFTY)
8581                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
8582             RExC_parse = next;
8583             nextchar(pRExC_state);
8584
8585         do_curly:
8586             if ((flags&SIMPLE)) {
8587                 RExC_naughty += 2 + RExC_naughty / 2;
8588                 reginsert(pRExC_state, CURLY, ret, depth+1);
8589                 Set_Node_Offset(ret, parse_start+1); /* MJD */
8590                 Set_Node_Cur_Length(ret);
8591             }
8592             else {
8593                 regnode * const w = reg_node(pRExC_state, WHILEM);
8594
8595                 w->flags = 0;
8596                 REGTAIL(pRExC_state, ret, w);
8597                 if (!SIZE_ONLY && RExC_extralen) {
8598                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
8599                     reginsert(pRExC_state, NOTHING,ret, depth+1);
8600                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
8601                 }
8602                 reginsert(pRExC_state, CURLYX,ret, depth+1);
8603                                 /* MJD hk */
8604                 Set_Node_Offset(ret, parse_start+1);
8605                 Set_Node_Length(ret,
8606                                 op == '{' ? (RExC_parse - parse_start) : 1);
8607
8608                 if (!SIZE_ONLY && RExC_extralen)
8609                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
8610                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
8611                 if (SIZE_ONLY)
8612                     RExC_whilem_seen++, RExC_extralen += 3;
8613                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
8614             }
8615             ret->flags = 0;
8616
8617             if (min > 0)
8618                 *flagp = WORST;
8619             if (max > 0)
8620                 *flagp |= HASWIDTH;
8621             if (max < min)
8622                 vFAIL("Can't do {n,m} with n > m");
8623             if (!SIZE_ONLY) {
8624                 ARG1_SET(ret, (U16)min);
8625                 ARG2_SET(ret, (U16)max);
8626             }
8627
8628             goto nest_check;
8629         }
8630     }
8631
8632     if (!ISMULT1(op)) {
8633         *flagp = flags;
8634         return(ret);
8635     }
8636
8637 #if 0                           /* Now runtime fix should be reliable. */
8638
8639     /* if this is reinstated, don't forget to put this back into perldiag:
8640
8641             =item Regexp *+ operand could be empty at {#} in regex m/%s/
8642
8643            (F) The part of the regexp subject to either the * or + quantifier
8644            could match an empty string. The {#} shows in the regular
8645            expression about where the problem was discovered.
8646
8647     */
8648
8649     if (!(flags&HASWIDTH) && op != '?')
8650       vFAIL("Regexp *+ operand could be empty");
8651 #endif
8652
8653 #ifdef RE_TRACK_PATTERN_OFFSETS
8654     parse_start = RExC_parse;
8655 #endif
8656     nextchar(pRExC_state);
8657
8658     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
8659
8660     if (op == '*' && (flags&SIMPLE)) {
8661         reginsert(pRExC_state, STAR, ret, depth+1);
8662         ret->flags = 0;
8663         RExC_naughty += 4;
8664     }
8665     else if (op == '*') {
8666         min = 0;
8667         goto do_curly;
8668     }
8669     else if (op == '+' && (flags&SIMPLE)) {
8670         reginsert(pRExC_state, PLUS, ret, depth+1);
8671         ret->flags = 0;
8672         RExC_naughty += 3;
8673     }
8674     else if (op == '+') {
8675         min = 1;
8676         goto do_curly;
8677     }
8678     else if (op == '?') {
8679         min = 0; max = 1;
8680         goto do_curly;
8681     }
8682   nest_check:
8683     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
8684         ckWARN3reg(RExC_parse,
8685                    "%.*s matches null string many times",
8686                    (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
8687                    origparse);
8688     }
8689
8690     if (RExC_parse < RExC_end && *RExC_parse == '?') {
8691         nextchar(pRExC_state);
8692         reginsert(pRExC_state, MINMOD, ret, depth+1);
8693         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
8694     }
8695 #ifndef REG_ALLOW_MINMOD_SUSPEND
8696     else
8697 #endif
8698     if (RExC_parse < RExC_end && *RExC_parse == '+') {
8699         regnode *ender;
8700         nextchar(pRExC_state);
8701         ender = reg_node(pRExC_state, SUCCEED);
8702         REGTAIL(pRExC_state, ret, ender);
8703         reginsert(pRExC_state, SUSPEND, ret, depth+1);
8704         ret->flags = 0;
8705         ender = reg_node(pRExC_state, TAIL);
8706         REGTAIL(pRExC_state, ret, ender);
8707         /*ret= ender;*/
8708     }
8709
8710     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
8711         RExC_parse++;
8712         vFAIL("Nested quantifiers");
8713     }
8714
8715     return(ret);
8716 }
8717
8718
8719 /* reg_namedseq(pRExC_state,UVp, UV depth)
8720    
8721    This is expected to be called by a parser routine that has 
8722    recognized '\N' and needs to handle the rest. RExC_parse is
8723    expected to point at the first char following the N at the time
8724    of the call.
8725
8726    The \N may be inside (indicated by valuep not being NULL) or outside a
8727    character class.
8728
8729    \N may begin either a named sequence, or if outside a character class, mean
8730    to match a non-newline.  For non single-quoted regexes, the tokenizer has
8731    attempted to decide which, and in the case of a named sequence converted it
8732    into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
8733    where c1... are the characters in the sequence.  For single-quoted regexes,
8734    the tokenizer passes the \N sequence through unchanged; this code will not
8735    attempt to determine this nor expand those.  The net effect is that if the
8736    beginning of the passed-in pattern isn't '{U+' or there is no '}', it
8737    signals that this \N occurrence means to match a non-newline.
8738    
8739    Only the \N{U+...} form should occur in a character class, for the same
8740    reason that '.' inside a character class means to just match a period: it
8741    just doesn't make sense.
8742    
8743    If valuep is non-null then it is assumed that we are parsing inside 
8744    of a charclass definition and the first codepoint in the resolved
8745    string is returned via *valuep and the routine will return NULL. 
8746    In this mode if a multichar string is returned from the charnames 
8747    handler, a warning will be issued, and only the first char in the 
8748    sequence will be examined. If the string returned is zero length
8749    then the value of *valuep is undefined and NON-NULL will 
8750    be returned to indicate failure. (This will NOT be a valid pointer 
8751    to a regnode.)
8752    
8753    If valuep is null then it is assumed that we are parsing normal text and a
8754    new EXACT node is inserted into the program containing the resolved string,
8755    and a pointer to the new node is returned.  But if the string is zero length
8756    a NOTHING node is emitted instead.
8757
8758    On success RExC_parse is set to the char following the endbrace.
8759    Parsing failures will generate a fatal error via vFAIL(...)
8760  */
8761 STATIC regnode *
8762 S_reg_namedseq(pTHX_ RExC_state_t *pRExC_state, UV *valuep, I32 *flagp, U32 depth)
8763 {
8764     char * endbrace;    /* '}' following the name */
8765     regnode *ret = NULL;
8766     char* p;
8767
8768     GET_RE_DEBUG_FLAGS_DECL;
8769  
8770     PERL_ARGS_ASSERT_REG_NAMEDSEQ;
8771
8772     GET_RE_DEBUG_FLAGS;
8773
8774     /* The [^\n] meaning of \N ignores spaces and comments under the /x
8775      * modifier.  The other meaning does not */
8776     p = (RExC_flags & RXf_PMf_EXTENDED)
8777         ? regwhite( pRExC_state, RExC_parse )
8778         : RExC_parse;
8779    
8780     /* Disambiguate between \N meaning a named character versus \N meaning
8781      * [^\n].  The former is assumed when it can't be the latter. */
8782     if (*p != '{' || regcurly(p)) {
8783         RExC_parse = p;
8784         if (valuep) {
8785             /* no bare \N in a charclass */
8786             vFAIL("\\N in a character class must be a named character: \\N{...}");
8787         }
8788         nextchar(pRExC_state);
8789         ret = reg_node(pRExC_state, REG_ANY);
8790         *flagp |= HASWIDTH|SIMPLE;
8791         RExC_naughty++;
8792         RExC_parse--;
8793         Set_Node_Length(ret, 1); /* MJD */
8794         return ret;
8795     }
8796
8797     /* Here, we have decided it should be a named sequence */
8798
8799     /* The test above made sure that the next real character is a '{', but
8800      * under the /x modifier, it could be separated by space (or a comment and
8801      * \n) and this is not allowed (for consistency with \x{...} and the
8802      * tokenizer handling of \N{NAME}). */
8803     if (*RExC_parse != '{') {
8804         vFAIL("Missing braces on \\N{}");
8805     }
8806
8807     RExC_parse++;       /* Skip past the '{' */
8808
8809     if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
8810         || ! (endbrace == RExC_parse            /* nothing between the {} */
8811               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked below */
8812                   && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
8813     {
8814         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
8815         vFAIL("\\N{NAME} must be resolved by the lexer");
8816     }
8817
8818     if (endbrace == RExC_parse) {   /* empty: \N{} */
8819         if (! valuep) {
8820             RExC_parse = endbrace + 1;  
8821             return reg_node(pRExC_state,NOTHING);
8822         }
8823
8824         if (SIZE_ONLY) {
8825             ckWARNreg(RExC_parse,
8826                     "Ignoring zero length \\N{} in character class"
8827             );
8828             RExC_parse = endbrace + 1;  
8829         }
8830         *valuep = 0;
8831         return (regnode *) &RExC_parse; /* Invalid regnode pointer */
8832     }
8833
8834     REQUIRE_UTF8;       /* named sequences imply Unicode semantics */
8835     RExC_parse += 2;    /* Skip past the 'U+' */
8836
8837     if (valuep) {   /* In a bracketed char class */
8838         /* We only pay attention to the first char of 
8839         multichar strings being returned. I kinda wonder
8840         if this makes sense as it does change the behaviour
8841         from earlier versions, OTOH that behaviour was broken
8842         as well. XXX Solution is to recharacterize as
8843         [rest-of-class]|multi1|multi2... */
8844
8845         STRLEN length_of_hex;
8846         I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
8847             | PERL_SCAN_DISALLOW_PREFIX
8848             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
8849     
8850         char * endchar = RExC_parse + strcspn(RExC_parse, ".}");
8851         if (endchar < endbrace) {
8852             ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
8853         }
8854
8855         length_of_hex = (STRLEN)(endchar - RExC_parse);
8856         *valuep = grok_hex(RExC_parse, &length_of_hex, &flags, NULL);
8857
8858         /* The tokenizer should have guaranteed validity, but it's possible to
8859          * bypass it by using single quoting, so check */
8860         if (length_of_hex == 0
8861             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
8862         {
8863             RExC_parse += length_of_hex;        /* Includes all the valid */
8864             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
8865                             ? UTF8SKIP(RExC_parse)
8866                             : 1;
8867             /* Guard against malformed utf8 */
8868             if (RExC_parse >= endchar) RExC_parse = endchar;
8869             vFAIL("Invalid hexadecimal number in \\N{U+...}");
8870         }    
8871
8872         RExC_parse = endbrace + 1;
8873         if (endchar == endbrace) return NULL;
8874
8875         ret = (regnode *) &RExC_parse;  /* Invalid regnode pointer */
8876     }
8877     else {      /* Not a char class */
8878
8879         /* What is done here is to convert this to a sub-pattern of the form
8880          * (?:\x{char1}\x{char2}...)
8881          * and then call reg recursively.  That way, it retains its atomicness,
8882          * while not having to worry about special handling that some code
8883          * points may have.  toke.c has converted the original Unicode values
8884          * to native, so that we can just pass on the hex values unchanged.  We
8885          * do have to set a flag to keep recoding from happening in the
8886          * recursion */
8887
8888         SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
8889         STRLEN len;
8890         char *endchar;      /* Points to '.' or '}' ending cur char in the input
8891                                stream */
8892         char *orig_end = RExC_end;
8893
8894         while (RExC_parse < endbrace) {
8895
8896             /* Code points are separated by dots.  If none, there is only one
8897              * code point, and is terminated by the brace */
8898             endchar = RExC_parse + strcspn(RExC_parse, ".}");
8899
8900             /* Convert to notation the rest of the code understands */
8901             sv_catpv(substitute_parse, "\\x{");
8902             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
8903             sv_catpv(substitute_parse, "}");
8904
8905             /* Point to the beginning of the next character in the sequence. */
8906             RExC_parse = endchar + 1;
8907         }
8908         sv_catpv(substitute_parse, ")");
8909
8910         RExC_parse = SvPV(substitute_parse, len);
8911
8912         /* Don't allow empty number */
8913         if (len < 8) {
8914             vFAIL("Invalid hexadecimal number in \\N{U+...}");
8915         }
8916         RExC_end = RExC_parse + len;
8917
8918         /* The values are Unicode, and therefore not subject to recoding */
8919         RExC_override_recoding = 1;
8920
8921         ret = reg(pRExC_state, 1, flagp, depth+1);
8922
8923         RExC_parse = endbrace;
8924         RExC_end = orig_end;
8925         RExC_override_recoding = 0;
8926
8927         nextchar(pRExC_state);
8928     }
8929
8930     return ret;
8931 }
8932
8933
8934 /*
8935  * reg_recode
8936  *
8937  * It returns the code point in utf8 for the value in *encp.
8938  *    value: a code value in the source encoding
8939  *    encp:  a pointer to an Encode object
8940  *
8941  * If the result from Encode is not a single character,
8942  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
8943  */
8944 STATIC UV
8945 S_reg_recode(pTHX_ const char value, SV **encp)
8946 {
8947     STRLEN numlen = 1;
8948     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
8949     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
8950     const STRLEN newlen = SvCUR(sv);
8951     UV uv = UNICODE_REPLACEMENT;
8952
8953     PERL_ARGS_ASSERT_REG_RECODE;
8954
8955     if (newlen)
8956         uv = SvUTF8(sv)
8957              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
8958              : *(U8*)s;
8959
8960     if (!newlen || numlen != newlen) {
8961         uv = UNICODE_REPLACEMENT;
8962         *encp = NULL;
8963     }
8964     return uv;
8965 }
8966
8967
8968 /*
8969  - regatom - the lowest level
8970
8971    Try to identify anything special at the start of the pattern. If there
8972    is, then handle it as required. This may involve generating a single regop,
8973    such as for an assertion; or it may involve recursing, such as to
8974    handle a () structure.
8975
8976    If the string doesn't start with something special then we gobble up
8977    as much literal text as we can.
8978
8979    Once we have been able to handle whatever type of thing started the
8980    sequence, we return.
8981
8982    Note: we have to be careful with escapes, as they can be both literal
8983    and special, and in the case of \10 and friends can either, depending
8984    on context. Specifically there are two separate switches for handling
8985    escape sequences, with the one for handling literal escapes requiring
8986    a dummy entry for all of the special escapes that are actually handled
8987    by the other.
8988 */
8989
8990 STATIC regnode *
8991 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
8992 {
8993     dVAR;
8994     register regnode *ret = NULL;
8995     I32 flags;
8996     char *parse_start = RExC_parse;
8997     U8 op;
8998     GET_RE_DEBUG_FLAGS_DECL;
8999     DEBUG_PARSE("atom");
9000     *flagp = WORST;             /* Tentatively. */
9001
9002     PERL_ARGS_ASSERT_REGATOM;
9003
9004 tryagain:
9005     switch ((U8)*RExC_parse) {
9006     case '^':
9007         RExC_seen_zerolen++;
9008         nextchar(pRExC_state);
9009         if (RExC_flags & RXf_PMf_MULTILINE)
9010             ret = reg_node(pRExC_state, MBOL);
9011         else if (RExC_flags & RXf_PMf_SINGLELINE)
9012             ret = reg_node(pRExC_state, SBOL);
9013         else
9014             ret = reg_node(pRExC_state, BOL);
9015         Set_Node_Length(ret, 1); /* MJD */
9016         break;
9017     case '$':
9018         nextchar(pRExC_state);
9019         if (*RExC_parse)
9020             RExC_seen_zerolen++;
9021         if (RExC_flags & RXf_PMf_MULTILINE)
9022             ret = reg_node(pRExC_state, MEOL);
9023         else if (RExC_flags & RXf_PMf_SINGLELINE)
9024             ret = reg_node(pRExC_state, SEOL);
9025         else
9026             ret = reg_node(pRExC_state, EOL);
9027         Set_Node_Length(ret, 1); /* MJD */
9028         break;
9029     case '.':
9030         nextchar(pRExC_state);
9031         if (RExC_flags & RXf_PMf_SINGLELINE)
9032             ret = reg_node(pRExC_state, SANY);
9033         else
9034             ret = reg_node(pRExC_state, REG_ANY);
9035         *flagp |= HASWIDTH|SIMPLE;
9036         RExC_naughty++;
9037         Set_Node_Length(ret, 1); /* MJD */
9038         break;
9039     case '[':
9040     {
9041         char * const oregcomp_parse = ++RExC_parse;
9042         ret = regclass(pRExC_state,depth+1);
9043         if (*RExC_parse != ']') {
9044             RExC_parse = oregcomp_parse;
9045             vFAIL("Unmatched [");
9046         }
9047         nextchar(pRExC_state);
9048         *flagp |= HASWIDTH|SIMPLE;
9049         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
9050         break;
9051     }
9052     case '(':
9053         nextchar(pRExC_state);
9054         ret = reg(pRExC_state, 1, &flags,depth+1);
9055         if (ret == NULL) {
9056                 if (flags & TRYAGAIN) {
9057                     if (RExC_parse == RExC_end) {
9058                          /* Make parent create an empty node if needed. */
9059                         *flagp |= TRYAGAIN;
9060                         return(NULL);
9061                     }
9062                     goto tryagain;
9063                 }
9064                 return(NULL);
9065         }
9066         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
9067         break;
9068     case '|':
9069     case ')':
9070         if (flags & TRYAGAIN) {
9071             *flagp |= TRYAGAIN;
9072             return NULL;
9073         }
9074         vFAIL("Internal urp");
9075                                 /* Supposed to be caught earlier. */
9076         break;
9077     case '{':
9078         if (!regcurly(RExC_parse)) {
9079             RExC_parse++;
9080             goto defchar;
9081         }
9082         /* FALL THROUGH */
9083     case '?':
9084     case '+':
9085     case '*':
9086         RExC_parse++;
9087         vFAIL("Quantifier follows nothing");
9088         break;
9089     case '\\':
9090         /* Special Escapes
9091
9092            This switch handles escape sequences that resolve to some kind
9093            of special regop and not to literal text. Escape sequnces that
9094            resolve to literal text are handled below in the switch marked
9095            "Literal Escapes".
9096
9097            Every entry in this switch *must* have a corresponding entry
9098            in the literal escape switch. However, the opposite is not
9099            required, as the default for this switch is to jump to the
9100            literal text handling code.
9101         */
9102         switch ((U8)*++RExC_parse) {
9103         /* Special Escapes */
9104         case 'A':
9105             RExC_seen_zerolen++;
9106             ret = reg_node(pRExC_state, SBOL);
9107             *flagp |= SIMPLE;
9108             goto finish_meta_pat;
9109         case 'G':
9110             ret = reg_node(pRExC_state, GPOS);
9111             RExC_seen |= REG_SEEN_GPOS;
9112             *flagp |= SIMPLE;
9113             goto finish_meta_pat;
9114         case 'K':
9115             RExC_seen_zerolen++;
9116             ret = reg_node(pRExC_state, KEEPS);
9117             *flagp |= SIMPLE;
9118             /* XXX:dmq : disabling in-place substitution seems to
9119              * be necessary here to avoid cases of memory corruption, as
9120              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
9121              */
9122             RExC_seen |= REG_SEEN_LOOKBEHIND;
9123             goto finish_meta_pat;
9124         case 'Z':
9125             ret = reg_node(pRExC_state, SEOL);
9126             *flagp |= SIMPLE;
9127             RExC_seen_zerolen++;                /* Do not optimize RE away */
9128             goto finish_meta_pat;
9129         case 'z':
9130             ret = reg_node(pRExC_state, EOS);
9131             *flagp |= SIMPLE;
9132             RExC_seen_zerolen++;                /* Do not optimize RE away */
9133             goto finish_meta_pat;
9134         case 'C':
9135             ret = reg_node(pRExC_state, CANY);
9136             RExC_seen |= REG_SEEN_CANY;
9137             *flagp |= HASWIDTH|SIMPLE;
9138             goto finish_meta_pat;
9139         case 'X':
9140             ret = reg_node(pRExC_state, CLUMP);
9141             *flagp |= HASWIDTH;
9142             goto finish_meta_pat;
9143         case 'w':
9144             switch (get_regex_charset(RExC_flags)) {
9145                 case REGEX_LOCALE_CHARSET:
9146                     op = ALNUML;
9147                     break;
9148                 case REGEX_UNICODE_CHARSET:
9149                     op = ALNUMU;
9150                     break;
9151                 case REGEX_ASCII_RESTRICTED_CHARSET:
9152                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9153                     op = ALNUMA;
9154                     break;
9155                 case REGEX_DEPENDS_CHARSET:
9156                     op = ALNUM;
9157                     break;
9158                 default:
9159                     goto bad_charset;
9160             }
9161             ret = reg_node(pRExC_state, op);
9162             *flagp |= HASWIDTH|SIMPLE;
9163             goto finish_meta_pat;
9164         case 'W':
9165             switch (get_regex_charset(RExC_flags)) {
9166                 case REGEX_LOCALE_CHARSET:
9167                     op = NALNUML;
9168                     break;
9169                 case REGEX_UNICODE_CHARSET:
9170                     op = NALNUMU;
9171                     break;
9172                 case REGEX_ASCII_RESTRICTED_CHARSET:
9173                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9174                     op = NALNUMA;
9175                     break;
9176                 case REGEX_DEPENDS_CHARSET:
9177                     op = NALNUM;
9178                     break;
9179                 default:
9180                     goto bad_charset;
9181             }
9182             ret = reg_node(pRExC_state, op);
9183             *flagp |= HASWIDTH|SIMPLE;
9184             goto finish_meta_pat;
9185         case 'b':
9186             RExC_seen_zerolen++;
9187             RExC_seen |= REG_SEEN_LOOKBEHIND;
9188             switch (get_regex_charset(RExC_flags)) {
9189                 case REGEX_LOCALE_CHARSET:
9190                     op = BOUNDL;
9191                     break;
9192                 case REGEX_UNICODE_CHARSET:
9193                     op = BOUNDU;
9194                     break;
9195                 case REGEX_ASCII_RESTRICTED_CHARSET:
9196                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9197                     op = BOUNDA;
9198                     break;
9199                 case REGEX_DEPENDS_CHARSET:
9200                     op = BOUND;
9201                     break;
9202                 default:
9203                     goto bad_charset;
9204             }
9205             ret = reg_node(pRExC_state, op);
9206             FLAGS(ret) = get_regex_charset(RExC_flags);
9207             *flagp |= SIMPLE;
9208             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
9209                 ckWARNregdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" instead");
9210             }
9211             goto finish_meta_pat;
9212         case 'B':
9213             RExC_seen_zerolen++;
9214             RExC_seen |= REG_SEEN_LOOKBEHIND;
9215             switch (get_regex_charset(RExC_flags)) {
9216                 case REGEX_LOCALE_CHARSET:
9217                     op = NBOUNDL;
9218                     break;
9219                 case REGEX_UNICODE_CHARSET:
9220                     op = NBOUNDU;
9221                     break;
9222                 case REGEX_ASCII_RESTRICTED_CHARSET:
9223                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9224                     op = NBOUNDA;
9225                     break;
9226                 case REGEX_DEPENDS_CHARSET:
9227                     op = NBOUND;
9228                     break;
9229                 default:
9230                     goto bad_charset;
9231             }
9232             ret = reg_node(pRExC_state, op);
9233             FLAGS(ret) = get_regex_charset(RExC_flags);
9234             *flagp |= SIMPLE;
9235             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
9236                 ckWARNregdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" instead");
9237             }
9238             goto finish_meta_pat;
9239         case 's':
9240             switch (get_regex_charset(RExC_flags)) {
9241                 case REGEX_LOCALE_CHARSET:
9242                     op = SPACEL;
9243                     break;
9244                 case REGEX_UNICODE_CHARSET:
9245                     op = SPACEU;
9246                     break;
9247                 case REGEX_ASCII_RESTRICTED_CHARSET:
9248                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9249                     op = SPACEA;
9250                     break;
9251                 case REGEX_DEPENDS_CHARSET:
9252                     op = SPACE;
9253                     break;
9254                 default:
9255                     goto bad_charset;
9256             }
9257             ret = reg_node(pRExC_state, op);
9258             *flagp |= HASWIDTH|SIMPLE;
9259             goto finish_meta_pat;
9260         case 'S':
9261             switch (get_regex_charset(RExC_flags)) {
9262                 case REGEX_LOCALE_CHARSET:
9263                     op = NSPACEL;
9264                     break;
9265                 case REGEX_UNICODE_CHARSET:
9266                     op = NSPACEU;
9267                     break;
9268                 case REGEX_ASCII_RESTRICTED_CHARSET:
9269                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9270                     op = NSPACEA;
9271                     break;
9272                 case REGEX_DEPENDS_CHARSET:
9273                     op = NSPACE;
9274                     break;
9275                 default:
9276                     goto bad_charset;
9277             }
9278             ret = reg_node(pRExC_state, op);
9279             *flagp |= HASWIDTH|SIMPLE;
9280             goto finish_meta_pat;
9281         case 'd':
9282             switch (get_regex_charset(RExC_flags)) {
9283                 case REGEX_LOCALE_CHARSET:
9284                     op = DIGITL;
9285                     break;
9286                 case REGEX_ASCII_RESTRICTED_CHARSET:
9287                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9288                     op = DIGITA;
9289                     break;
9290                 case REGEX_DEPENDS_CHARSET: /* No difference between these */
9291                 case REGEX_UNICODE_CHARSET:
9292                     op = DIGIT;
9293                     break;
9294                 default:
9295                     goto bad_charset;
9296             }
9297             ret = reg_node(pRExC_state, op);
9298             *flagp |= HASWIDTH|SIMPLE;
9299             goto finish_meta_pat;
9300         case 'D':
9301             switch (get_regex_charset(RExC_flags)) {
9302                 case REGEX_LOCALE_CHARSET:
9303                     op = NDIGITL;
9304                     break;
9305                 case REGEX_ASCII_RESTRICTED_CHARSET:
9306                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
9307                     op = NDIGITA;
9308                     break;
9309                 case REGEX_DEPENDS_CHARSET: /* No difference between these */
9310                 case REGEX_UNICODE_CHARSET:
9311                     op = NDIGIT;
9312                     break;
9313                 default:
9314                     goto bad_charset;
9315             }
9316             ret = reg_node(pRExC_state, op);
9317             *flagp |= HASWIDTH|SIMPLE;
9318             goto finish_meta_pat;
9319         case 'R':
9320             ret = reg_node(pRExC_state, LNBREAK);
9321             *flagp |= HASWIDTH|SIMPLE;
9322             goto finish_meta_pat;
9323         case 'h':
9324             ret = reg_node(pRExC_state, HORIZWS);
9325             *flagp |= HASWIDTH|SIMPLE;
9326             goto finish_meta_pat;
9327         case 'H':
9328             ret = reg_node(pRExC_state, NHORIZWS);
9329             *flagp |= HASWIDTH|SIMPLE;
9330             goto finish_meta_pat;
9331         case 'v':
9332             ret = reg_node(pRExC_state, VERTWS);
9333             *flagp |= HASWIDTH|SIMPLE;
9334             goto finish_meta_pat;
9335         case 'V':
9336             ret = reg_node(pRExC_state, NVERTWS);
9337             *flagp |= HASWIDTH|SIMPLE;
9338          finish_meta_pat:           
9339             nextchar(pRExC_state);
9340             Set_Node_Length(ret, 2); /* MJD */
9341             break;          
9342         case 'p':
9343         case 'P':
9344             {
9345                 char* const oldregxend = RExC_end;
9346 #ifdef DEBUGGING
9347                 char* parse_start = RExC_parse - 2;
9348 #endif
9349
9350                 if (RExC_parse[1] == '{') {
9351                   /* a lovely hack--pretend we saw [\pX] instead */
9352                     RExC_end = strchr(RExC_parse, '}');
9353                     if (!RExC_end) {
9354                         const U8 c = (U8)*RExC_parse;
9355                         RExC_parse += 2;
9356                         RExC_end = oldregxend;
9357                         vFAIL2("Missing right brace on \\%c{}", c);
9358                     }
9359                     RExC_end++;
9360                 }
9361                 else {
9362                     RExC_end = RExC_parse + 2;
9363                     if (RExC_end > oldregxend)
9364                         RExC_end = oldregxend;
9365                 }
9366                 RExC_parse--;
9367
9368                 ret = regclass(pRExC_state,depth+1);
9369
9370                 RExC_end = oldregxend;
9371                 RExC_parse--;
9372
9373                 Set_Node_Offset(ret, parse_start + 2);
9374                 Set_Node_Cur_Length(ret);
9375                 nextchar(pRExC_state);
9376                 *flagp |= HASWIDTH|SIMPLE;
9377             }
9378             break;
9379         case 'N': 
9380             /* Handle \N and \N{NAME} here and not below because it can be
9381             multicharacter. join_exact() will join them up later on. 
9382             Also this makes sure that things like /\N{BLAH}+/ and 
9383             \N{BLAH} being multi char Just Happen. dmq*/
9384             ++RExC_parse;
9385             ret= reg_namedseq(pRExC_state, NULL, flagp, depth);
9386             break;
9387         case 'k':    /* Handle \k<NAME> and \k'NAME' */
9388         parse_named_seq:
9389         {   
9390             char ch= RExC_parse[1];         
9391             if (ch != '<' && ch != '\'' && ch != '{') {
9392                 RExC_parse++;
9393                 vFAIL2("Sequence %.2s... not terminated",parse_start);
9394             } else {
9395                 /* this pretty much dupes the code for (?P=...) in reg(), if
9396                    you change this make sure you change that */
9397                 char* name_start = (RExC_parse += 2);
9398                 U32 num = 0;
9399                 SV *sv_dat = reg_scan_name(pRExC_state,
9400                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9401                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
9402                 if (RExC_parse == name_start || *RExC_parse != ch)
9403                     vFAIL2("Sequence %.3s... not terminated",parse_start);
9404
9405                 if (!SIZE_ONLY) {
9406                     num = add_data( pRExC_state, 1, "S" );
9407                     RExC_rxi->data->data[num]=(void*)sv_dat;
9408                     SvREFCNT_inc_simple_void(sv_dat);
9409                 }
9410
9411                 RExC_sawback = 1;
9412                 ret = reganode(pRExC_state,
9413                                ((! FOLD)
9414                                  ? NREF
9415                                  : (MORE_ASCII_RESTRICTED)
9416                                    ? NREFFA
9417                                    : (AT_LEAST_UNI_SEMANTICS)
9418                                      ? NREFFU
9419                                      : (LOC)
9420                                        ? NREFFL
9421                                        : NREFF),
9422                                 num);
9423                 *flagp |= HASWIDTH;
9424
9425                 /* override incorrect value set in reganode MJD */
9426                 Set_Node_Offset(ret, parse_start+1);
9427                 Set_Node_Cur_Length(ret); /* MJD */
9428                 nextchar(pRExC_state);
9429
9430             }
9431             break;
9432         }
9433         case 'g': 
9434         case '1': case '2': case '3': case '4':
9435         case '5': case '6': case '7': case '8': case '9':
9436             {
9437                 I32 num;
9438                 bool isg = *RExC_parse == 'g';
9439                 bool isrel = 0; 
9440                 bool hasbrace = 0;
9441                 if (isg) {
9442                     RExC_parse++;
9443                     if (*RExC_parse == '{') {
9444                         RExC_parse++;
9445                         hasbrace = 1;
9446                     }
9447                     if (*RExC_parse == '-') {
9448                         RExC_parse++;
9449                         isrel = 1;
9450                     }
9451                     if (hasbrace && !isDIGIT(*RExC_parse)) {
9452                         if (isrel) RExC_parse--;
9453                         RExC_parse -= 2;                            
9454                         goto parse_named_seq;
9455                 }   }
9456                 num = atoi(RExC_parse);
9457                 if (isg && num == 0)
9458                     vFAIL("Reference to invalid group 0");
9459                 if (isrel) {
9460                     num = RExC_npar - num;
9461                     if (num < 1)
9462                         vFAIL("Reference to nonexistent or unclosed group");
9463                 }
9464                 if (!isg && num > 9 && num >= RExC_npar)
9465                     goto defchar;
9466                 else {
9467                     char * const parse_start = RExC_parse - 1; /* MJD */
9468                     while (isDIGIT(*RExC_parse))
9469                         RExC_parse++;
9470                     if (parse_start == RExC_parse - 1) 
9471                         vFAIL("Unterminated \\g... pattern");
9472                     if (hasbrace) {
9473                         if (*RExC_parse != '}') 
9474                             vFAIL("Unterminated \\g{...} pattern");
9475                         RExC_parse++;
9476                     }    
9477                     if (!SIZE_ONLY) {
9478                         if (num > (I32)RExC_rx->nparens)
9479                             vFAIL("Reference to nonexistent group");
9480                     }
9481                     RExC_sawback = 1;
9482                     ret = reganode(pRExC_state,
9483                                    ((! FOLD)
9484                                      ? REF
9485                                      : (MORE_ASCII_RESTRICTED)
9486                                        ? REFFA
9487                                        : (AT_LEAST_UNI_SEMANTICS)
9488                                          ? REFFU
9489                                          : (LOC)
9490                                            ? REFFL
9491                                            : REFF),
9492                                     num);
9493                     *flagp |= HASWIDTH;
9494
9495                     /* override incorrect value set in reganode MJD */
9496                     Set_Node_Offset(ret, parse_start+1);
9497                     Set_Node_Cur_Length(ret); /* MJD */
9498                     RExC_parse--;
9499                     nextchar(pRExC_state);
9500                 }
9501             }
9502             break;
9503         case '\0':
9504             if (RExC_parse >= RExC_end)
9505                 FAIL("Trailing \\");
9506             /* FALL THROUGH */
9507         default:
9508             /* Do not generate "unrecognized" warnings here, we fall
9509                back into the quick-grab loop below */
9510             parse_start--;
9511             goto defchar;
9512         }
9513         break;
9514
9515     case '#':
9516         if (RExC_flags & RXf_PMf_EXTENDED) {
9517             if ( reg_skipcomment( pRExC_state ) )
9518                 goto tryagain;
9519         }
9520         /* FALL THROUGH */
9521
9522     default:
9523
9524             parse_start = RExC_parse - 1;
9525
9526             RExC_parse++;
9527
9528         defchar: {
9529             register STRLEN len;
9530             register UV ender;
9531             register char *p;
9532             char *s;
9533             STRLEN foldlen;
9534             U8 tmpbuf[UTF8_MAXBYTES_CASE+1], *foldbuf;
9535             U8 node_type;
9536
9537             /* Is this a LATIN LOWER CASE SHARP S in an EXACTFU node?  If so,
9538              * it is folded to 'ss' even if not utf8 */
9539             bool is_exactfu_sharp_s;
9540
9541             ender = 0;
9542             node_type = ((! FOLD) ? EXACT
9543                         : (LOC)
9544                           ? EXACTFL
9545                           : (MORE_ASCII_RESTRICTED)
9546                             ? EXACTFA
9547                             : (AT_LEAST_UNI_SEMANTICS)
9548                               ? EXACTFU
9549                               : EXACTF);
9550             ret = reg_node(pRExC_state, node_type);
9551             s = STRING(ret);
9552
9553             /* XXX The node can hold up to 255 bytes, yet this only goes to
9554              * 127.  I (khw) do not know why.  Keeping it somewhat less than
9555              * 255 allows us to not have to worry about overflow due to
9556              * converting to utf8 and fold expansion, but that value is
9557              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
9558              * split up by this limit into a single one using the real max of
9559              * 255.  Even at 127, this breaks under rare circumstances.  If
9560              * folding, we do not want to split a node at a character that is a
9561              * non-final in a multi-char fold, as an input string could just
9562              * happen to want to match across the node boundary.  The join
9563              * would solve that problem if the join actually happens.  But a
9564              * series of more than two nodes in a row each of 127 would cause
9565              * the first join to succeed to get to 254, but then there wouldn't
9566              * be room for the next one, which could at be one of those split
9567              * multi-char folds.  I don't know of any fool-proof solution.  One
9568              * could back off to end with only a code point that isn't such a
9569              * non-final, but it is possible for there not to be any in the
9570              * entire node. */
9571             for (len = 0, p = RExC_parse - 1;
9572                  len < 127 && p < RExC_end;
9573                  len++)
9574             {
9575                 char * const oldp = p;
9576
9577                 if (RExC_flags & RXf_PMf_EXTENDED)
9578                     p = regwhite( pRExC_state, p );
9579                 switch ((U8)*p) {
9580                 case '^':
9581                 case '$':
9582                 case '.':
9583                 case '[':
9584                 case '(':
9585                 case ')':
9586                 case '|':
9587                     goto loopdone;
9588                 case '\\':
9589                     /* Literal Escapes Switch
9590
9591                        This switch is meant to handle escape sequences that
9592                        resolve to a literal character.
9593
9594                        Every escape sequence that represents something
9595                        else, like an assertion or a char class, is handled
9596                        in the switch marked 'Special Escapes' above in this
9597                        routine, but also has an entry here as anything that
9598                        isn't explicitly mentioned here will be treated as
9599                        an unescaped equivalent literal.
9600                     */
9601
9602                     switch ((U8)*++p) {
9603                     /* These are all the special escapes. */
9604                     case 'A':             /* Start assertion */
9605                     case 'b': case 'B':   /* Word-boundary assertion*/
9606                     case 'C':             /* Single char !DANGEROUS! */
9607                     case 'd': case 'D':   /* digit class */
9608                     case 'g': case 'G':   /* generic-backref, pos assertion */
9609                     case 'h': case 'H':   /* HORIZWS */
9610                     case 'k': case 'K':   /* named backref, keep marker */
9611                     case 'N':             /* named char sequence */
9612                     case 'p': case 'P':   /* Unicode property */
9613                               case 'R':   /* LNBREAK */
9614                     case 's': case 'S':   /* space class */
9615                     case 'v': case 'V':   /* VERTWS */
9616                     case 'w': case 'W':   /* word class */
9617                     case 'X':             /* eXtended Unicode "combining character sequence" */
9618                     case 'z': case 'Z':   /* End of line/string assertion */
9619                         --p;
9620                         goto loopdone;
9621
9622                     /* Anything after here is an escape that resolves to a
9623                        literal. (Except digits, which may or may not)
9624                      */
9625                     case 'n':
9626                         ender = '\n';
9627                         p++;
9628                         break;
9629                     case 'r':
9630                         ender = '\r';
9631                         p++;
9632                         break;
9633                     case 't':
9634                         ender = '\t';
9635                         p++;
9636                         break;
9637                     case 'f':
9638                         ender = '\f';
9639                         p++;
9640                         break;
9641                     case 'e':
9642                           ender = ASCII_TO_NATIVE('\033');
9643                         p++;
9644                         break;
9645                     case 'a':
9646                           ender = ASCII_TO_NATIVE('\007');
9647                         p++;
9648                         break;
9649                     case 'o':
9650                         {
9651                             STRLEN brace_len = len;
9652                             UV result;
9653                             const char* error_msg;
9654
9655                             bool valid = grok_bslash_o(p,
9656                                                        &result,
9657                                                        &brace_len,
9658                                                        &error_msg,
9659                                                        1);
9660                             p += brace_len;
9661                             if (! valid) {
9662                                 RExC_parse = p; /* going to die anyway; point
9663                                                    to exact spot of failure */
9664                                 vFAIL(error_msg);
9665                             }
9666                             else
9667                             {
9668                                 ender = result;
9669                             }
9670                             if (PL_encoding && ender < 0x100) {
9671                                 goto recode_encoding;
9672                             }
9673                             if (ender > 0xff) {
9674                                 REQUIRE_UTF8;
9675                             }
9676                             break;
9677                         }
9678                     case 'x':
9679                         if (*++p == '{') {
9680                             char* const e = strchr(p, '}');
9681
9682                             if (!e) {
9683                                 RExC_parse = p + 1;
9684                                 vFAIL("Missing right brace on \\x{}");
9685                             }
9686                             else {
9687                                 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
9688                                     | PERL_SCAN_DISALLOW_PREFIX;
9689                                 STRLEN numlen = e - p - 1;
9690                                 ender = grok_hex(p + 1, &numlen, &flags, NULL);
9691                                 if (ender > 0xff)
9692                                     REQUIRE_UTF8;
9693                                 p = e + 1;
9694                             }
9695                         }
9696                         else {
9697                             I32 flags = PERL_SCAN_DISALLOW_PREFIX;
9698                             STRLEN numlen = 2;
9699                             ender = grok_hex(p, &numlen, &flags, NULL);
9700                             p += numlen;
9701                         }
9702                         if (PL_encoding && ender < 0x100)
9703                             goto recode_encoding;
9704                         break;
9705                     case 'c':
9706                         p++;
9707                         ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
9708                         break;
9709                     case '0': case '1': case '2': case '3':case '4':
9710                     case '5': case '6': case '7': case '8':case '9':
9711                         if (*p == '0' ||
9712                             (isDIGIT(p[1]) && atoi(p) >= RExC_npar))
9713                         {
9714                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
9715                             STRLEN numlen = 3;
9716                             ender = grok_oct(p, &numlen, &flags, NULL);
9717                             if (ender > 0xff) {
9718                                 REQUIRE_UTF8;
9719                             }
9720                             p += numlen;
9721                         }
9722                         else {
9723                             --p;
9724                             goto loopdone;
9725                         }
9726                         if (PL_encoding && ender < 0x100)
9727                             goto recode_encoding;
9728                         break;
9729                     recode_encoding:
9730                         if (! RExC_override_recoding) {
9731                             SV* enc = PL_encoding;
9732                             ender = reg_recode((const char)(U8)ender, &enc);
9733                             if (!enc && SIZE_ONLY)
9734                                 ckWARNreg(p, "Invalid escape in the specified encoding");
9735                             REQUIRE_UTF8;
9736                         }
9737                         break;
9738                     case '\0':
9739                         if (p >= RExC_end)
9740                             FAIL("Trailing \\");
9741                         /* FALL THROUGH */
9742                     default:
9743                         if (!SIZE_ONLY&& isALPHA(*p)) {
9744                             /* Include any { following the alpha to emphasize
9745                              * that it could be part of an escape at some point
9746                              * in the future */
9747                             int len = (*(p + 1) == '{') ? 2 : 1;
9748                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
9749                         }
9750                         goto normal_default;
9751                     }
9752                     break;
9753                 default:
9754                   normal_default:
9755                     if (UTF8_IS_START(*p) && UTF) {
9756                         STRLEN numlen;
9757                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
9758                                                &numlen, UTF8_ALLOW_DEFAULT);
9759                         p += numlen;
9760                     }
9761                     else
9762                         ender = (U8) *p++;
9763                     break;
9764                 } /* End of switch on the literal */
9765
9766                 is_exactfu_sharp_s = (node_type == EXACTFU
9767                                       && ender == LATIN_SMALL_LETTER_SHARP_S);
9768                 if ( RExC_flags & RXf_PMf_EXTENDED)
9769                     p = regwhite( pRExC_state, p );
9770                 if ((UTF && FOLD) || is_exactfu_sharp_s) {
9771                     /* Prime the casefolded buffer.  Locale rules, which apply
9772                      * only to code points < 256, aren't known until execution,
9773                      * so for them, just output the original character using
9774                      * utf8.  If we start to fold non-UTF patterns, be sure to
9775                      * update join_exact() */
9776                     if (LOC && ender < 256) {
9777                         if (UNI_IS_INVARIANT(ender)) {
9778                             *tmpbuf = (U8) ender;
9779                             foldlen = 1;
9780                         } else {
9781                             *tmpbuf = UTF8_TWO_BYTE_HI(ender);
9782                             *(tmpbuf + 1) = UTF8_TWO_BYTE_LO(ender);
9783                             foldlen = 2;
9784                         }
9785                     }
9786                     else if (isASCII(ender)) {  /* Note: Here can't also be LOC
9787                                                  */
9788                         ender = toLOWER(ender);
9789                         *tmpbuf = (U8) ender;
9790                         foldlen = 1;
9791                     }
9792                     else if (! MORE_ASCII_RESTRICTED && ! LOC) {
9793
9794                         /* Locale and /aa require more selectivity about the
9795                          * fold, so are handled below.  Otherwise, here, just
9796                          * use the fold */
9797                         ender = toFOLD_uni(ender, tmpbuf, &foldlen);
9798                     }
9799                     else {
9800                         /* Under locale rules or /aa we are not to mix,
9801                          * respectively, ords < 256 or ASCII with non-.  So
9802                          * reject folds that mix them, using only the
9803                          * non-folded code point.  So do the fold to a
9804                          * temporary, and inspect each character in it. */
9805                         U8 trialbuf[UTF8_MAXBYTES_CASE+1];
9806                         U8* s = trialbuf;
9807                         UV tmpender = toFOLD_uni(ender, trialbuf, &foldlen);
9808                         U8* e = s + foldlen;
9809                         bool fold_ok = TRUE;
9810
9811                         while (s < e) {
9812                             if (isASCII(*s)
9813                                 || (LOC && (UTF8_IS_INVARIANT(*s)
9814                                            || UTF8_IS_DOWNGRADEABLE_START(*s))))
9815                             {
9816                                 fold_ok = FALSE;
9817                                 break;
9818                             }
9819                             s += UTF8SKIP(s);
9820                         }
9821                         if (fold_ok) {
9822                             Copy(trialbuf, tmpbuf, foldlen, U8);
9823                             ender = tmpender;
9824                         }
9825                         else {
9826                             uvuni_to_utf8(tmpbuf, ender);
9827                             foldlen = UNISKIP(ender);
9828                         }
9829                     }
9830                 }
9831                 if (p < RExC_end && ISMULT2(p)) { /* Back off on ?+*. */
9832                     if (len)
9833                         p = oldp;
9834                     else if (UTF || is_exactfu_sharp_s) {
9835                          if (FOLD) {
9836                               /* Emit all the Unicode characters. */
9837                               STRLEN numlen;
9838                               for (foldbuf = tmpbuf;
9839                                    foldlen;
9840                                    foldlen -= numlen) {
9841
9842                                    /* tmpbuf has been constructed by us, so we
9843                                     * know it is valid utf8 */
9844                                    ender = valid_utf8_to_uvchr(foldbuf, &numlen);
9845                                    if (numlen > 0) {
9846                                         const STRLEN unilen = reguni(pRExC_state, ender, s);
9847                                         s       += unilen;
9848                                         len     += unilen;
9849                                         /* In EBCDIC the numlen
9850                                          * and unilen can differ. */
9851                                         foldbuf += numlen;
9852                                         if (numlen >= foldlen)
9853                                              break;
9854                                    }
9855                                    else
9856                                         break; /* "Can't happen." */
9857                               }
9858                          }
9859                          else {
9860                               const STRLEN unilen = reguni(pRExC_state, ender, s);
9861                               if (unilen > 0) {
9862                                    s   += unilen;
9863                                    len += unilen;
9864                               }
9865                          }
9866                     }
9867                     else {
9868                         len++;
9869                         REGC((char)ender, s++);
9870                     }
9871                     break;
9872                 }
9873                 if (UTF || is_exactfu_sharp_s) {
9874                      if (FOLD) {
9875                           /* Emit all the Unicode characters. */
9876                           STRLEN numlen;
9877                           for (foldbuf = tmpbuf;
9878                                foldlen;
9879                                foldlen -= numlen) {
9880                                ender = valid_utf8_to_uvchr(foldbuf, &numlen);
9881                                if (numlen > 0) {
9882                                     const STRLEN unilen = reguni(pRExC_state, ender, s);
9883                                     len     += unilen;
9884                                     s       += unilen;
9885                                     /* In EBCDIC the numlen
9886                                      * and unilen can differ. */
9887                                     foldbuf += numlen;
9888                                     if (numlen >= foldlen)
9889                                          break;
9890                                }
9891                                else
9892                                     break;
9893                           }
9894                      }
9895                      else {
9896                           const STRLEN unilen = reguni(pRExC_state, ender, s);
9897                           if (unilen > 0) {
9898                                s   += unilen;
9899                                len += unilen;
9900                           }
9901                      }
9902                      len--;
9903                 }
9904                 else {
9905                     REGC((char)ender, s++);
9906                 }
9907             }
9908         loopdone:   /* Jumped to when encounters something that shouldn't be in
9909                        the node */
9910             RExC_parse = p - 1;
9911             Set_Node_Cur_Length(ret); /* MJD */
9912             nextchar(pRExC_state);
9913             {
9914                 /* len is STRLEN which is unsigned, need to copy to signed */
9915                 IV iv = len;
9916                 if (iv < 0)
9917                     vFAIL("Internal disaster");
9918             }
9919             if (len > 0)
9920                 *flagp |= HASWIDTH;
9921             if (len == 1 && UNI_IS_INVARIANT(ender))
9922                 *flagp |= SIMPLE;
9923
9924             if (SIZE_ONLY)
9925                 RExC_size += STR_SZ(len);
9926             else {
9927                 STR_LEN(ret) = len;
9928                 RExC_emit += STR_SZ(len);
9929             }
9930         }
9931         break;
9932     }
9933
9934     return(ret);
9935
9936 /* Jumped to when an unrecognized character set is encountered */
9937 bad_charset:
9938     Perl_croak(aTHX_ "panic: Unknown regex character set encoding: %u", get_regex_charset(RExC_flags));
9939     return(NULL);
9940 }
9941
9942 STATIC char *
9943 S_regwhite( RExC_state_t *pRExC_state, char *p )
9944 {
9945     const char *e = RExC_end;
9946
9947     PERL_ARGS_ASSERT_REGWHITE;
9948
9949     while (p < e) {
9950         if (isSPACE(*p))
9951             ++p;
9952         else if (*p == '#') {
9953             bool ended = 0;
9954             do {
9955                 if (*p++ == '\n') {
9956                     ended = 1;
9957                     break;
9958                 }
9959             } while (p < e);
9960             if (!ended)
9961                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
9962         }
9963         else
9964             break;
9965     }
9966     return p;
9967 }
9968
9969 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
9970    Character classes ([:foo:]) can also be negated ([:^foo:]).
9971    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
9972    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
9973    but trigger failures because they are currently unimplemented. */
9974
9975 #define POSIXCC_DONE(c)   ((c) == ':')
9976 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
9977 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
9978
9979 STATIC I32
9980 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value)
9981 {
9982     dVAR;
9983     I32 namedclass = OOB_NAMEDCLASS;
9984
9985     PERL_ARGS_ASSERT_REGPPOSIXCC;
9986
9987     if (value == '[' && RExC_parse + 1 < RExC_end &&
9988         /* I smell either [: or [= or [. -- POSIX has been here, right? */
9989         POSIXCC(UCHARAT(RExC_parse))) {
9990         const char c = UCHARAT(RExC_parse);
9991         char* const s = RExC_parse++;
9992
9993         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
9994             RExC_parse++;
9995         if (RExC_parse == RExC_end)
9996             /* Grandfather lone [:, [=, [. */
9997             RExC_parse = s;
9998         else {
9999             const char* const t = RExC_parse++; /* skip over the c */
10000             assert(*t == c);
10001
10002             if (UCHARAT(RExC_parse) == ']') {
10003                 const char *posixcc = s + 1;
10004                 RExC_parse++; /* skip over the ending ] */
10005
10006                 if (*s == ':') {
10007                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
10008                     const I32 skip = t - posixcc;
10009
10010                     /* Initially switch on the length of the name.  */
10011                     switch (skip) {
10012                     case 4:
10013                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX, this is the Perl \w */
10014                             namedclass = complement ? ANYOF_NALNUM : ANYOF_ALNUM;
10015                         break;
10016                     case 5:
10017                         /* Names all of length 5.  */
10018                         /* alnum alpha ascii blank cntrl digit graph lower
10019                            print punct space upper  */
10020                         /* Offset 4 gives the best switch position.  */
10021                         switch (posixcc[4]) {
10022                         case 'a':
10023                             if (memEQ(posixcc, "alph", 4)) /* alpha */
10024                                 namedclass = complement ? ANYOF_NALPHA : ANYOF_ALPHA;
10025                             break;
10026                         case 'e':
10027                             if (memEQ(posixcc, "spac", 4)) /* space */
10028                                 namedclass = complement ? ANYOF_NPSXSPC : ANYOF_PSXSPC;
10029                             break;
10030                         case 'h':
10031                             if (memEQ(posixcc, "grap", 4)) /* graph */
10032                                 namedclass = complement ? ANYOF_NGRAPH : ANYOF_GRAPH;
10033                             break;
10034                         case 'i':
10035                             if (memEQ(posixcc, "asci", 4)) /* ascii */
10036                                 namedclass = complement ? ANYOF_NASCII : ANYOF_ASCII;
10037                             break;
10038                         case 'k':
10039                             if (memEQ(posixcc, "blan", 4)) /* blank */
10040                                 namedclass = complement ? ANYOF_NBLANK : ANYOF_BLANK;
10041                             break;
10042                         case 'l':
10043                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
10044                                 namedclass = complement ? ANYOF_NCNTRL : ANYOF_CNTRL;
10045                             break;
10046                         case 'm':
10047                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
10048                                 namedclass = complement ? ANYOF_NALNUMC : ANYOF_ALNUMC;
10049                             break;
10050                         case 'r':
10051                             if (memEQ(posixcc, "lowe", 4)) /* lower */
10052                                 namedclass = complement ? ANYOF_NLOWER : ANYOF_LOWER;
10053                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
10054                                 namedclass = complement ? ANYOF_NUPPER : ANYOF_UPPER;
10055                             break;
10056                         case 't':
10057                             if (memEQ(posixcc, "digi", 4)) /* digit */
10058                                 namedclass = complement ? ANYOF_NDIGIT : ANYOF_DIGIT;
10059                             else if (memEQ(posixcc, "prin", 4)) /* print */
10060                                 namedclass = complement ? ANYOF_NPRINT : ANYOF_PRINT;
10061                             else if (memEQ(posixcc, "punc", 4)) /* punct */
10062                                 namedclass = complement ? ANYOF_NPUNCT : ANYOF_PUNCT;
10063                             break;
10064                         }
10065                         break;
10066                     case 6:
10067                         if (memEQ(posixcc, "xdigit", 6))
10068                             namedclass = complement ? ANYOF_NXDIGIT : ANYOF_XDIGIT;
10069                         break;
10070                     }
10071
10072                     if (namedclass == OOB_NAMEDCLASS)
10073                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
10074                                       t - s - 1, s + 1);
10075                     assert (posixcc[skip] == ':');
10076                     assert (posixcc[skip+1] == ']');
10077                 } else if (!SIZE_ONLY) {
10078                     /* [[=foo=]] and [[.foo.]] are still future. */
10079
10080                     /* adjust RExC_parse so the warning shows after
10081                        the class closes */
10082                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
10083                         RExC_parse++;
10084                     Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
10085                 }
10086             } else {
10087                 /* Maternal grandfather:
10088                  * "[:" ending in ":" but not in ":]" */
10089                 RExC_parse = s;
10090             }
10091         }
10092     }
10093
10094     return namedclass;
10095 }
10096
10097 STATIC void
10098 S_checkposixcc(pTHX_ RExC_state_t *pRExC_state)
10099 {
10100     dVAR;
10101
10102     PERL_ARGS_ASSERT_CHECKPOSIXCC;
10103
10104     if (POSIXCC(UCHARAT(RExC_parse))) {
10105         const char *s = RExC_parse;
10106         const char  c = *s++;
10107
10108         while (isALNUM(*s))
10109             s++;
10110         if (*s && c == *s && s[1] == ']') {
10111             ckWARN3reg(s+2,
10112                        "POSIX syntax [%c %c] belongs inside character classes",
10113                        c, c);
10114
10115             /* [[=foo=]] and [[.foo.]] are still future. */
10116             if (POSIXCC_NOTYET(c)) {
10117                 /* adjust RExC_parse so the error shows after
10118                    the class closes */
10119                 while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse++) != ']')
10120                     NOOP;
10121                 Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
10122             }
10123         }
10124     }
10125 }
10126
10127 /* Generate the code to add a full posix character <class> to the bracketed
10128  * character class given by <node>.  (<node> is needed only under locale rules)
10129  * destlist     is the inversion list for non-locale rules that this class is
10130  *              to be added to
10131  * sourcelist   is the ASCII-range inversion list to add under /a rules
10132  * Xsourcelist  is the full Unicode range list to use otherwise. */
10133 #define DO_POSIX(node, class, destlist, sourcelist, Xsourcelist)           \
10134     if (LOC) {                                                             \
10135         SV* scratch_list = NULL;                                           \
10136                                                                            \
10137         /* Set this class in the node for runtime matching */              \
10138         ANYOF_CLASS_SET(node, class);                                      \
10139                                                                            \
10140         /* For above Latin1 code points, we use the full Unicode range */  \
10141         _invlist_intersection(PL_AboveLatin1,                              \
10142                               Xsourcelist,                                 \
10143                               &scratch_list);                              \
10144         /* And set the output to it, adding instead if there already is an \
10145          * output.  Checking if <destlist> is NULL first saves an extra    \
10146          * clone.  Its reference count will be decremented at the next     \
10147          * union, etc, or if this is the only instance, at the end of the  \
10148          * routine */                                                      \
10149         if (! destlist) {                                                  \
10150             destlist = scratch_list;                                       \
10151         }                                                                  \
10152         else {                                                             \
10153             _invlist_union(destlist, scratch_list, &destlist);             \
10154             SvREFCNT_dec(scratch_list);                                    \
10155         }                                                                  \
10156     }                                                                      \
10157     else {                                                                 \
10158         /* For non-locale, just add it to any existing list */             \
10159         _invlist_union(destlist,                                           \
10160                        (AT_LEAST_ASCII_RESTRICTED)                         \
10161                            ? sourcelist                                    \
10162                            : Xsourcelist,                                  \
10163                        &destlist);                                         \
10164     }
10165
10166 /* Like DO_POSIX, but matches the complement of <sourcelist> and <Xsourcelist>.
10167  */
10168 #define DO_N_POSIX(node, class, destlist, sourcelist, Xsourcelist)         \
10169     if (LOC) {                                                             \
10170         SV* scratch_list = NULL;                                           \
10171         ANYOF_CLASS_SET(node, class);                                      \
10172         _invlist_subtract(PL_AboveLatin1, Xsourcelist, &scratch_list);     \
10173         if (! destlist) {                                                  \
10174             destlist = scratch_list;                                       \
10175         }                                                                  \
10176         else {                                                             \
10177             _invlist_union(destlist, scratch_list, &destlist);             \
10178             SvREFCNT_dec(scratch_list);                                    \
10179         }                                                                  \
10180     }                                                                      \
10181     else {                                                                 \
10182         _invlist_union_complement_2nd(destlist,                            \
10183                                     (AT_LEAST_ASCII_RESTRICTED)            \
10184                                         ? sourcelist                       \
10185                                         : Xsourcelist,                     \
10186                                     &destlist);                            \
10187         /* Under /d, everything in the upper half of the Latin1 range      \
10188          * matches this complement */                                      \
10189         if (DEPENDS_SEMANTICS) {                                           \
10190             ANYOF_FLAGS(node) |= ANYOF_NON_UTF8_LATIN1_ALL;                \
10191         }                                                                  \
10192     }
10193
10194 /* Generate the code to add a posix character <class> to the bracketed
10195  * character class given by <node>.  (<node> is needed only under locale rules)
10196  * destlist       is the inversion list for non-locale rules that this class is
10197  *                to be added to
10198  * sourcelist     is the ASCII-range inversion list to add under /a rules
10199  * l1_sourcelist  is the Latin1 range list to use otherwise.
10200  * Xpropertyname  is the name to add to <run_time_list> of the property to
10201  *                specify the code points above Latin1 that will have to be
10202  *                determined at run-time
10203  * run_time_list  is a SV* that contains text names of properties that are to
10204  *                be computed at run time.  This concatenates <Xpropertyname>
10205  *                to it, apppropriately
10206  * This is essentially DO_POSIX, but we know only the Latin1 values at compile
10207  * time */
10208 #define DO_POSIX_LATIN1_ONLY_KNOWN(node, class, destlist, sourcelist,      \
10209                               l1_sourcelist, Xpropertyname, run_time_list) \
10210     /* If not /a matching, there are going to be code points we will have  \
10211      * to defer to runtime to look-up */                                   \
10212     if (! AT_LEAST_ASCII_RESTRICTED) {                                     \
10213         Perl_sv_catpvf(aTHX_ run_time_list, "+utf8::%s\n", Xpropertyname); \
10214     }                                                                      \
10215     if (LOC) {                                                             \
10216         ANYOF_CLASS_SET(node, class);                                      \
10217     }                                                                      \
10218     else {                                                                 \
10219         _invlist_union(destlist,                                           \
10220                        (AT_LEAST_ASCII_RESTRICTED)                         \
10221                            ? sourcelist                                    \
10222                            : l1_sourcelist,                                \
10223                        &destlist);                                         \
10224     }
10225
10226 /* Like DO_POSIX_LATIN1_ONLY_KNOWN, but for the complement.  A combination of
10227  * this and DO_N_POSIX */
10228 #define DO_N_POSIX_LATIN1_ONLY_KNOWN(node, class, destlist, sourcelist,    \
10229                               l1_sourcelist, Xpropertyname, run_time_list) \
10230     if (AT_LEAST_ASCII_RESTRICTED) {                                       \
10231         _invlist_union_complement_2nd(destlist, sourcelist, &destlist);    \
10232     }                                                                      \
10233     else {                                                                 \
10234         Perl_sv_catpvf(aTHX_ run_time_list, "!utf8::%s\n", Xpropertyname); \
10235         if (LOC) {                                                         \
10236             ANYOF_CLASS_SET(node, namedclass);                             \
10237         }                                                                  \
10238         else {                                                             \
10239             SV* scratch_list = NULL;                                       \
10240             _invlist_subtract(PL_Latin1, l1_sourcelist, &scratch_list);    \
10241             if (! destlist) {                                              \
10242                 destlist = scratch_list;                                   \
10243             }                                                              \
10244             else {                                                         \
10245                 _invlist_union(destlist, scratch_list, &destlist);         \
10246                 SvREFCNT_dec(scratch_list);                                \
10247             }                                                              \
10248             if (DEPENDS_SEMANTICS) {                                       \
10249                 ANYOF_FLAGS(node) |= ANYOF_NON_UTF8_LATIN1_ALL;            \
10250             }                                                              \
10251         }                                                                  \
10252     }
10253
10254 STATIC U8
10255 S_set_regclass_bit_fold(pTHX_ RExC_state_t *pRExC_state, regnode* node, const U8 value, SV** invlist_ptr, AV** alternate_ptr)
10256 {
10257
10258     /* Handle the setting of folds in the bitmap for non-locale ANYOF nodes.
10259      * Locale folding is done at run-time, so this function should not be
10260      * called for nodes that are for locales.
10261      *
10262      * This function sets the bit corresponding to the fold of the input
10263      * 'value', if not already set.  The fold of 'f' is 'F', and the fold of
10264      * 'F' is 'f'.
10265      *
10266      * It also knows about the characters that are in the bitmap that have
10267      * folds that are matchable only outside it, and sets the appropriate lists
10268      * and flags.
10269      *
10270      * It returns the number of bits that actually changed from 0 to 1 */
10271
10272     U8 stored = 0;
10273     U8 fold;
10274
10275     PERL_ARGS_ASSERT_SET_REGCLASS_BIT_FOLD;
10276
10277     fold = (AT_LEAST_UNI_SEMANTICS) ? PL_fold_latin1[value]
10278                                     : PL_fold[value];
10279
10280     /* It assumes the bit for 'value' has already been set */
10281     if (fold != value && ! ANYOF_BITMAP_TEST(node, fold)) {
10282         ANYOF_BITMAP_SET(node, fold);
10283         stored++;
10284     }
10285     if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(value) && (! isASCII(value) || ! MORE_ASCII_RESTRICTED)) {
10286         /* Certain Latin1 characters have matches outside the bitmap.  To get
10287          * here, 'value' is one of those characters.   None of these matches is
10288          * valid for ASCII characters under /aa, which have been excluded by
10289          * the 'if' above.  The matches fall into three categories:
10290          * 1) They are singly folded-to or -from an above 255 character, as
10291          *    LATIN SMALL LETTER Y WITH DIAERESIS and LATIN CAPITAL LETTER Y
10292          *    WITH DIAERESIS;
10293          * 2) They are part of a multi-char fold with another character in the
10294          *    bitmap, only LATIN SMALL LETTER SHARP S => "ss" fits that bill;
10295          * 3) They are part of a multi-char fold with a character not in the
10296          *    bitmap, such as various ligatures.
10297          * We aren't dealing fully with multi-char folds, except we do deal
10298          * with the pattern containing a character that has a multi-char fold
10299          * (not so much the inverse).
10300          * For types 1) and 3), the matches only happen when the target string
10301          * is utf8; that's not true for 2), and we set a flag for it.
10302          *
10303          * The code below adds to the passed in inversion list the single fold
10304          * closures for 'value'.  The values are hard-coded here so that an
10305          * innocent-looking character class, like /[ks]/i won't have to go out
10306          * to disk to find the possible matches.  XXX It would be better to
10307          * generate these via regen, in case a new version of the Unicode
10308          * standard adds new mappings, though that is not really likely. */
10309         switch (value) {
10310             case 'k':
10311             case 'K':
10312                 /* KELVIN SIGN */
10313                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr, 0x212A);
10314                 break;
10315             case 's':
10316             case 'S':
10317                 /* LATIN SMALL LETTER LONG S */
10318                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr, 0x017F);
10319                 break;
10320             case MICRO_SIGN:
10321                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10322                                                  GREEK_SMALL_LETTER_MU);
10323                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10324                                                  GREEK_CAPITAL_LETTER_MU);
10325                 break;
10326             case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
10327             case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
10328                 /* ANGSTROM SIGN */
10329                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr, 0x212B);
10330                 if (DEPENDS_SEMANTICS) {    /* See DEPENDS comment below */
10331                     *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10332                                                      PL_fold_latin1[value]);
10333                 }
10334                 break;
10335             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
10336                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10337                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
10338                 break;
10339             case LATIN_SMALL_LETTER_SHARP_S:
10340                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
10341                                         LATIN_CAPITAL_LETTER_SHARP_S);
10342
10343                 /* Under /a, /d, and /u, this can match the two chars "ss" */
10344                 if (! MORE_ASCII_RESTRICTED) {
10345                     add_alternate(alternate_ptr, (U8 *) "ss", 2);
10346
10347                     /* And under /u or /a, it can match even if the target is
10348                      * not utf8 */
10349                     if (AT_LEAST_UNI_SEMANTICS) {
10350                         ANYOF_FLAGS(node) |= ANYOF_NONBITMAP_NON_UTF8;
10351                     }
10352                 }
10353                 break;
10354             case 'F': case 'f':
10355             case 'I': case 'i':
10356             case 'L': case 'l':
10357             case 'T': case 't':
10358             case 'A': case 'a':
10359             case 'H': case 'h':
10360             case 'J': case 'j':
10361             case 'N': case 'n':
10362             case 'W': case 'w':
10363             case 'Y': case 'y':
10364                 /* These all are targets of multi-character folds from code
10365                  * points that require UTF8 to express, so they can't match
10366                  * unless the target string is in UTF-8, so no action here is
10367                  * necessary, as regexec.c properly handles the general case
10368                  * for UTF-8 matching */
10369                 break;
10370             default:
10371                 /* Use deprecated warning to increase the chances of this
10372                  * being output */
10373                 ckWARN2regdep(RExC_parse, "Perl folding rules are not up-to-date for 0x%x; please use the perlbug utility to report;", value);
10374                 break;
10375         }
10376     }
10377     else if (DEPENDS_SEMANTICS
10378             && ! isASCII(value)
10379             && PL_fold_latin1[value] != value)
10380     {
10381            /* Under DEPENDS rules, non-ASCII Latin1 characters match their
10382             * folds only when the target string is in UTF-8.  We add the fold
10383             * here to the list of things to match outside the bitmap, which
10384             * won't be looked at unless it is UTF8 (or else if something else
10385             * says to look even if not utf8, but those things better not happen
10386             * under DEPENDS semantics. */
10387         *invlist_ptr = add_cp_to_invlist(*invlist_ptr, PL_fold_latin1[value]);
10388     }
10389
10390     return stored;
10391 }
10392
10393
10394 PERL_STATIC_INLINE U8
10395 S_set_regclass_bit(pTHX_ RExC_state_t *pRExC_state, regnode* node, const U8 value, SV** invlist_ptr, AV** alternate_ptr)
10396 {
10397     /* This inline function sets a bit in the bitmap if not already set, and if
10398      * appropriate, its fold, returning the number of bits that actually
10399      * changed from 0 to 1 */
10400
10401     U8 stored;
10402
10403     PERL_ARGS_ASSERT_SET_REGCLASS_BIT;
10404
10405     if (ANYOF_BITMAP_TEST(node, value)) {   /* Already set */
10406         return 0;
10407     }
10408
10409     ANYOF_BITMAP_SET(node, value);
10410     stored = 1;
10411
10412     if (FOLD && ! LOC) {        /* Locale folds aren't known until runtime */
10413         stored += set_regclass_bit_fold(pRExC_state, node, value, invlist_ptr, alternate_ptr);
10414     }
10415
10416     return stored;
10417 }
10418
10419 STATIC void
10420 S_add_alternate(pTHX_ AV** alternate_ptr, U8* string, STRLEN len)
10421 {
10422     /* Adds input 'string' with length 'len' to the ANYOF node's unicode
10423      * alternate list, pointed to by 'alternate_ptr'.  This is an array of
10424      * the multi-character folds of characters in the node */
10425     SV *sv;
10426
10427     PERL_ARGS_ASSERT_ADD_ALTERNATE;
10428
10429     if (! *alternate_ptr) {
10430         *alternate_ptr = newAV();
10431     }
10432     sv = newSVpvn_utf8((char*)string, len, TRUE);
10433     av_push(*alternate_ptr, sv);
10434     return;
10435 }
10436
10437 /*
10438    parse a class specification and produce either an ANYOF node that
10439    matches the pattern or perhaps will be optimized into an EXACTish node
10440    instead. The node contains a bit map for the first 256 characters, with the
10441    corresponding bit set if that character is in the list.  For characters
10442    above 255, a range list is used */
10443
10444 STATIC regnode *
10445 S_regclass(pTHX_ RExC_state_t *pRExC_state, U32 depth)
10446 {
10447     dVAR;
10448     register UV nextvalue;
10449     register IV prevvalue = OOB_UNICODE;
10450     register IV range = 0;
10451     UV value = 0; /* XXX:dmq: needs to be referenceable (unfortunately) */
10452     register regnode *ret;
10453     STRLEN numlen;
10454     IV namedclass;
10455     char *rangebegin = NULL;
10456     bool need_class = 0;
10457     bool allow_full_fold = TRUE;   /* Assume wants multi-char folding */
10458     SV *listsv = NULL;
10459     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
10460                                       than just initialized.  */
10461     SV* properties = NULL;    /* Code points that match \p{} \P{} */
10462     UV element_count = 0;   /* Number of distinct elements in the class.
10463                                Optimizations may be possible if this is tiny */
10464     UV n;
10465
10466     /* Unicode properties are stored in a swash; this holds the current one
10467      * being parsed.  If this swash is the only above-latin1 component of the
10468      * character class, an optimization is to pass it directly on to the
10469      * execution engine.  Otherwise, it is set to NULL to indicate that there
10470      * are other things in the class that have to be dealt with at execution
10471      * time */
10472     SV* swash = NULL;           /* Code points that match \p{} \P{} */
10473
10474     /* Set if a component of this character class is user-defined; just passed
10475      * on to the engine */
10476     UV has_user_defined_property = 0;
10477
10478     /* code points this node matches that can't be stored in the bitmap */
10479     SV* nonbitmap = NULL;
10480
10481     /* The items that are to match that aren't stored in the bitmap, but are a
10482      * result of things that are stored there.  This is the fold closure of
10483      * such a character, either because it has DEPENDS semantics and shouldn't
10484      * be matched unless the target string is utf8, or is a code point that is
10485      * too large for the bit map, as for example, the fold of the MICRO SIGN is
10486      * above 255.  This all is solely for performance reasons.  By having this
10487      * code know the outside-the-bitmap folds that the bitmapped characters are
10488      * involved with, we don't have to go out to disk to find the list of
10489      * matches, unless the character class includes code points that aren't
10490      * storable in the bit map.  That means that a character class with an 's'
10491      * in it, for example, doesn't need to go out to disk to find everything
10492      * that matches.  A 2nd list is used so that the 'nonbitmap' list is kept
10493      * empty unless there is something whose fold we don't know about, and will
10494      * have to go out to the disk to find. */
10495     SV* l1_fold_invlist = NULL;
10496
10497     /* List of multi-character folds that are matched by this node */
10498     AV* unicode_alternate  = NULL;
10499 #ifdef EBCDIC
10500     UV literal_endpoint = 0;
10501 #endif
10502     UV stored = 0;  /* how many chars stored in the bitmap */
10503
10504     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
10505         case we need to change the emitted regop to an EXACT. */
10506     const char * orig_parse = RExC_parse;
10507     GET_RE_DEBUG_FLAGS_DECL;
10508
10509     PERL_ARGS_ASSERT_REGCLASS;
10510 #ifndef DEBUGGING
10511     PERL_UNUSED_ARG(depth);
10512 #endif
10513
10514     DEBUG_PARSE("clas");
10515
10516     /* Assume we are going to generate an ANYOF node. */
10517     ret = reganode(pRExC_state, ANYOF, 0);
10518
10519
10520     if (!SIZE_ONLY) {
10521         ANYOF_FLAGS(ret) = 0;
10522     }
10523
10524     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
10525         RExC_naughty++;
10526         RExC_parse++;
10527         if (!SIZE_ONLY)
10528             ANYOF_FLAGS(ret) |= ANYOF_INVERT;
10529
10530         /* We have decided to not allow multi-char folds in inverted character
10531          * classes, due to the confusion that can happen, especially with
10532          * classes that are designed for a non-Unicode world:  You have the
10533          * peculiar case that:
10534             "s s" =~ /^[^\xDF]+$/i => Y
10535             "ss"  =~ /^[^\xDF]+$/i => N
10536          *
10537          * See [perl #89750] */
10538         allow_full_fold = FALSE;
10539     }
10540
10541     if (SIZE_ONLY) {
10542         RExC_size += ANYOF_SKIP;
10543         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
10544     }
10545     else {
10546         RExC_emit += ANYOF_SKIP;
10547         if (LOC) {
10548             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
10549         }
10550         ANYOF_BITMAP_ZERO(ret);
10551         listsv = newSVpvs("# comment\n");
10552         initial_listsv_len = SvCUR(listsv);
10553     }
10554
10555     nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
10556
10557     if (!SIZE_ONLY && POSIXCC(nextvalue))
10558         checkposixcc(pRExC_state);
10559
10560     /* allow 1st char to be ] (allowing it to be - is dealt with later) */
10561     if (UCHARAT(RExC_parse) == ']')
10562         goto charclassloop;
10563
10564 parseit:
10565     while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
10566
10567     charclassloop:
10568
10569         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
10570
10571         if (!range) {
10572             rangebegin = RExC_parse;
10573             element_count++;
10574         }
10575         if (UTF) {
10576             value = utf8n_to_uvchr((U8*)RExC_parse,
10577                                    RExC_end - RExC_parse,
10578                                    &numlen, UTF8_ALLOW_DEFAULT);
10579             RExC_parse += numlen;
10580         }
10581         else
10582             value = UCHARAT(RExC_parse++);
10583
10584         nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
10585         if (value == '[' && POSIXCC(nextvalue))
10586             namedclass = regpposixcc(pRExC_state, value);
10587         else if (value == '\\') {
10588             if (UTF) {
10589                 value = utf8n_to_uvchr((U8*)RExC_parse,
10590                                    RExC_end - RExC_parse,
10591                                    &numlen, UTF8_ALLOW_DEFAULT);
10592                 RExC_parse += numlen;
10593             }
10594             else
10595                 value = UCHARAT(RExC_parse++);
10596             /* Some compilers cannot handle switching on 64-bit integer
10597              * values, therefore value cannot be an UV.  Yes, this will
10598              * be a problem later if we want switch on Unicode.
10599              * A similar issue a little bit later when switching on
10600              * namedclass. --jhi */
10601             switch ((I32)value) {
10602             case 'w':   namedclass = ANYOF_ALNUM;       break;
10603             case 'W':   namedclass = ANYOF_NALNUM;      break;
10604             case 's':   namedclass = ANYOF_SPACE;       break;
10605             case 'S':   namedclass = ANYOF_NSPACE;      break;
10606             case 'd':   namedclass = ANYOF_DIGIT;       break;
10607             case 'D':   namedclass = ANYOF_NDIGIT;      break;
10608             case 'v':   namedclass = ANYOF_VERTWS;      break;
10609             case 'V':   namedclass = ANYOF_NVERTWS;     break;
10610             case 'h':   namedclass = ANYOF_HORIZWS;     break;
10611             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
10612             case 'N':  /* Handle \N{NAME} in class */
10613                 {
10614                     /* We only pay attention to the first char of 
10615                     multichar strings being returned. I kinda wonder
10616                     if this makes sense as it does change the behaviour
10617                     from earlier versions, OTOH that behaviour was broken
10618                     as well. */
10619                     UV v; /* value is register so we cant & it /grrr */
10620                     if (reg_namedseq(pRExC_state, &v, NULL, depth)) {
10621                         goto parseit;
10622                     }
10623                     value= v; 
10624                 }
10625                 break;
10626             case 'p':
10627             case 'P':
10628                 {
10629                 char *e;
10630                 if (RExC_parse >= RExC_end)
10631                     vFAIL2("Empty \\%c{}", (U8)value);
10632                 if (*RExC_parse == '{') {
10633                     const U8 c = (U8)value;
10634                     e = strchr(RExC_parse++, '}');
10635                     if (!e)
10636                         vFAIL2("Missing right brace on \\%c{}", c);
10637                     while (isSPACE(UCHARAT(RExC_parse)))
10638                         RExC_parse++;
10639                     if (e == RExC_parse)
10640                         vFAIL2("Empty \\%c{}", c);
10641                     n = e - RExC_parse;
10642                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
10643                         n--;
10644                 }
10645                 else {
10646                     e = RExC_parse;
10647                     n = 1;
10648                 }
10649                 if (!SIZE_ONLY) {
10650                     SV** invlistsvp;
10651                     SV* invlist;
10652                     char* name;
10653                     if (UCHARAT(RExC_parse) == '^') {
10654                          RExC_parse++;
10655                          n--;
10656                          value = value == 'p' ? 'P' : 'p'; /* toggle */
10657                          while (isSPACE(UCHARAT(RExC_parse))) {
10658                               RExC_parse++;
10659                               n--;
10660                          }
10661                     }
10662                     /* Try to get the definition of the property into
10663                      * <invlist>.  If /i is in effect, the effective property
10664                      * will have its name be <__NAME_i>.  The design is
10665                      * discussed in commit
10666                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
10667                     Newx(name, n + sizeof("_i__\n"), char);
10668
10669                     sprintf(name, "%s%.*s%s\n",
10670                                     (FOLD) ? "__" : "",
10671                                     (int)n,
10672                                     RExC_parse,
10673                                     (FOLD) ? "_i" : ""
10674                     );
10675
10676                     /* Look up the property name, and get its swash and
10677                      * inversion list, if the property is found  */
10678                     if (swash) {
10679                         SvREFCNT_dec(swash);
10680                     }
10681                     swash = _core_swash_init("utf8", name, &PL_sv_undef,
10682                                              1, /* binary */
10683                                              0, /* not tr/// */
10684                                              TRUE, /* this routine will handle
10685                                                       undefined properties */
10686                                              NULL, FALSE /* No inversion list */
10687                                             );
10688                     if (   ! swash
10689                         || ! SvROK(swash)
10690                         || ! SvTYPE(SvRV(swash)) == SVt_PVHV
10691                         || ! (invlistsvp =
10692                                 hv_fetchs(MUTABLE_HV(SvRV(swash)),
10693                                 "INVLIST", FALSE))
10694                         || ! (invlist = *invlistsvp))
10695                     {
10696                         if (swash) {
10697                             SvREFCNT_dec(swash);
10698                             swash = NULL;
10699                         }
10700
10701                         /* Here didn't find it.  It could be a user-defined
10702                          * property that will be available at run-time.  Add it
10703                          * to the list to look up then */
10704                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
10705                                         (value == 'p' ? '+' : '!'),
10706                                         name);
10707                         has_user_defined_property = 1;
10708
10709                         /* We don't know yet, so have to assume that the
10710                          * property could match something in the Latin1 range,
10711                          * hence something that isn't utf8 */
10712                         ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
10713                     }
10714                     else {
10715
10716                         /* Here, did get the swash and its inversion list.  If
10717                          * the swash is from a user-defined property, then this
10718                          * whole character class should be regarded as such */
10719                         SV** user_defined_svp =
10720                                             hv_fetchs(MUTABLE_HV(SvRV(swash)),
10721                                                         "USER_DEFINED", FALSE);
10722                         if (user_defined_svp) {
10723                             has_user_defined_property
10724                                                     |= SvUV(*user_defined_svp);
10725                         }
10726
10727                         /* Invert if asking for the complement */
10728                         if (value == 'P') {
10729                             _invlist_union_complement_2nd(properties, invlist, &properties);
10730
10731                             /* The swash can't be used as-is, because we've
10732                              * inverted things; delay removing it to here after
10733                              * have copied its invlist above */
10734                             SvREFCNT_dec(swash);
10735                             swash = NULL;
10736                         }
10737                         else {
10738                             _invlist_union(properties, invlist, &properties);
10739                         }
10740                     }
10741                     Safefree(name);
10742                 }
10743                 RExC_parse = e + 1;
10744                 namedclass = ANYOF_MAX;  /* no official name, but it's named */
10745
10746                 /* \p means they want Unicode semantics */
10747                 RExC_uni_semantics = 1;
10748                 }
10749                 break;
10750             case 'n':   value = '\n';                   break;
10751             case 'r':   value = '\r';                   break;
10752             case 't':   value = '\t';                   break;
10753             case 'f':   value = '\f';                   break;
10754             case 'b':   value = '\b';                   break;
10755             case 'e':   value = ASCII_TO_NATIVE('\033');break;
10756             case 'a':   value = ASCII_TO_NATIVE('\007');break;
10757             case 'o':
10758                 RExC_parse--;   /* function expects to be pointed at the 'o' */
10759                 {
10760                     const char* error_msg;
10761                     bool valid = grok_bslash_o(RExC_parse,
10762                                                &value,
10763                                                &numlen,
10764                                                &error_msg,
10765                                                SIZE_ONLY);
10766                     RExC_parse += numlen;
10767                     if (! valid) {
10768                         vFAIL(error_msg);
10769                     }
10770                 }
10771                 if (PL_encoding && value < 0x100) {
10772                     goto recode_encoding;
10773                 }
10774                 break;
10775             case 'x':
10776                 if (*RExC_parse == '{') {
10777                     I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
10778                         | PERL_SCAN_DISALLOW_PREFIX;
10779                     char * const e = strchr(RExC_parse++, '}');
10780                     if (!e)
10781                         vFAIL("Missing right brace on \\x{}");
10782
10783                     numlen = e - RExC_parse;
10784                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
10785                     RExC_parse = e + 1;
10786                 }
10787                 else {
10788                     I32 flags = PERL_SCAN_DISALLOW_PREFIX;
10789                     numlen = 2;
10790                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
10791                     RExC_parse += numlen;
10792                 }
10793                 if (PL_encoding && value < 0x100)
10794                     goto recode_encoding;
10795                 break;
10796             case 'c':
10797                 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
10798                 break;
10799             case '0': case '1': case '2': case '3': case '4':
10800             case '5': case '6': case '7':
10801                 {
10802                     /* Take 1-3 octal digits */
10803                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10804                     numlen = 3;
10805                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
10806                     RExC_parse += numlen;
10807                     if (PL_encoding && value < 0x100)
10808                         goto recode_encoding;
10809                     break;
10810                 }
10811             recode_encoding:
10812                 if (! RExC_override_recoding) {
10813                     SV* enc = PL_encoding;
10814                     value = reg_recode((const char)(U8)value, &enc);
10815                     if (!enc && SIZE_ONLY)
10816                         ckWARNreg(RExC_parse,
10817                                   "Invalid escape in the specified encoding");
10818                     break;
10819                 }
10820             default:
10821                 /* Allow \_ to not give an error */
10822                 if (!SIZE_ONLY && isALNUM(value) && value != '_') {
10823                     ckWARN2reg(RExC_parse,
10824                                "Unrecognized escape \\%c in character class passed through",
10825                                (int)value);
10826                 }
10827                 break;
10828             }
10829         } /* end of \blah */
10830 #ifdef EBCDIC
10831         else
10832             literal_endpoint++;
10833 #endif
10834
10835         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
10836
10837             /* What matches in a locale is not known until runtime, so need to
10838              * (one time per class) allocate extra space to pass to regexec.
10839              * The space will contain a bit for each named class that is to be
10840              * matched against.  This isn't needed for \p{} and pseudo-classes,
10841              * as they are not affected by locale, and hence are dealt with
10842              * separately */
10843             if (LOC && namedclass < ANYOF_MAX && ! need_class) {
10844                 need_class = 1;
10845                 if (SIZE_ONLY) {
10846                     RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
10847                 }
10848                 else {
10849                     RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
10850                     ANYOF_CLASS_ZERO(ret);
10851                 }
10852                 ANYOF_FLAGS(ret) |= ANYOF_CLASS;
10853             }
10854
10855             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
10856              * literal, as is the character that began the false range, i.e.
10857              * the 'a' in the examples */
10858             if (range) {
10859                 if (!SIZE_ONLY) {
10860                     const int w =
10861                         RExC_parse >= rangebegin ?
10862                         RExC_parse - rangebegin : 0;
10863                     ckWARN4reg(RExC_parse,
10864                                "False [] range \"%*.*s\"",
10865                                w, w, rangebegin);
10866
10867                     stored +=
10868                          set_regclass_bit(pRExC_state, ret, '-', &l1_fold_invlist, &unicode_alternate);
10869                     if (prevvalue < 256) {
10870                         stored +=
10871                          set_regclass_bit(pRExC_state, ret, (U8) prevvalue, &l1_fold_invlist, &unicode_alternate);
10872                     }
10873                     else {
10874                         nonbitmap = add_cp_to_invlist(nonbitmap, prevvalue);
10875                     }
10876                 }
10877
10878                 range = 0; /* this was not a true range */
10879             }
10880
10881             if (!SIZE_ONLY) {
10882
10883                 /* Possible truncation here but in some 64-bit environments
10884                  * the compiler gets heartburn about switch on 64-bit values.
10885                  * A similar issue a little earlier when switching on value.
10886                  * --jhi */
10887                 switch ((I32)namedclass) {
10888
10889                 case ANYOF_ALNUMC: /* C's alnum, in contrast to \w */
10890                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10891                         PL_PosixAlnum, PL_L1PosixAlnum, "XPosixAlnum", listsv);
10892                     break;
10893                 case ANYOF_NALNUMC:
10894                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10895                         PL_PosixAlnum, PL_L1PosixAlnum, "XPosixAlnum", listsv);
10896                     break;
10897                 case ANYOF_ALPHA:
10898                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10899                         PL_PosixAlpha, PL_L1PosixAlpha, "XPosixAlpha", listsv);
10900                     break;
10901                 case ANYOF_NALPHA:
10902                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10903                         PL_PosixAlpha, PL_L1PosixAlpha, "XPosixAlpha", listsv);
10904                     break;
10905                 case ANYOF_ASCII:
10906                     if (LOC) {
10907                         ANYOF_CLASS_SET(ret, namedclass);
10908                     }
10909                     else {
10910                         _invlist_union(properties, PL_ASCII, &properties);
10911                     }
10912                     break;
10913                 case ANYOF_NASCII:
10914                     if (LOC) {
10915                         ANYOF_CLASS_SET(ret, namedclass);
10916                     }
10917                     else {
10918                         _invlist_union_complement_2nd(properties,
10919                                                     PL_ASCII, &properties);
10920                         if (DEPENDS_SEMANTICS) {
10921                             ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
10922                         }
10923                     }
10924                     break;
10925                 case ANYOF_BLANK:
10926                     DO_POSIX(ret, namedclass, properties,
10927                                             PL_PosixBlank, PL_XPosixBlank);
10928                     break;
10929                 case ANYOF_NBLANK:
10930                     DO_N_POSIX(ret, namedclass, properties,
10931                                             PL_PosixBlank, PL_XPosixBlank);
10932                     break;
10933                 case ANYOF_CNTRL:
10934                     DO_POSIX(ret, namedclass, properties,
10935                                             PL_PosixCntrl, PL_XPosixCntrl);
10936                     break;
10937                 case ANYOF_NCNTRL:
10938                     DO_N_POSIX(ret, namedclass, properties,
10939                                             PL_PosixCntrl, PL_XPosixCntrl);
10940                     break;
10941                 case ANYOF_DIGIT:
10942                     /* Ignore the compiler warning for this macro, planned to
10943                      * be eliminated later */
10944                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10945                         PL_PosixDigit, PL_PosixDigit, "XPosixDigit", listsv);
10946                     break;
10947                 case ANYOF_NDIGIT:
10948                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10949                         PL_PosixDigit, PL_PosixDigit, "XPosixDigit", listsv);
10950                     break;
10951                 case ANYOF_GRAPH:
10952                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10953                         PL_PosixGraph, PL_L1PosixGraph, "XPosixGraph", listsv);
10954                     break;
10955                 case ANYOF_NGRAPH:
10956                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10957                         PL_PosixGraph, PL_L1PosixGraph, "XPosixGraph", listsv);
10958                     break;
10959                 case ANYOF_HORIZWS:
10960                     /* For these, we use the nonbitmap, as /d doesn't make a
10961                      * difference in what these match.  There would be problems
10962                      * if these characters had folds other than themselves, as
10963                      * nonbitmap is subject to folding.  It turns out that \h
10964                      * is just a synonym for XPosixBlank */
10965                     _invlist_union(nonbitmap, PL_XPosixBlank, &nonbitmap);
10966                     break;
10967                 case ANYOF_NHORIZWS:
10968                     _invlist_union_complement_2nd(nonbitmap,
10969                                                  PL_XPosixBlank, &nonbitmap);
10970                     break;
10971                 case ANYOF_LOWER:
10972                 case ANYOF_NLOWER:
10973                 {   /* These require special handling, as they differ under
10974                        folding, matching Cased there (which in the ASCII range
10975                        is the same as Alpha */
10976
10977                     SV* ascii_source;
10978                     SV* l1_source;
10979                     const char *Xname;
10980
10981                     if (FOLD && ! LOC) {
10982                         ascii_source = PL_PosixAlpha;
10983                         l1_source = PL_L1Cased;
10984                         Xname = "Cased";
10985                     }
10986                     else {
10987                         ascii_source = PL_PosixLower;
10988                         l1_source = PL_L1PosixLower;
10989                         Xname = "XPosixLower";
10990                     }
10991                     if (namedclass == ANYOF_LOWER) {
10992                         DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
10993                                     ascii_source, l1_source, Xname, listsv);
10994                     }
10995                     else {
10996                         DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass,
10997                             properties, ascii_source, l1_source, Xname, listsv);
10998                     }
10999                     break;
11000                 }
11001                 case ANYOF_PRINT:
11002                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11003                         PL_PosixPrint, PL_L1PosixPrint, "XPosixPrint", listsv);
11004                     break;
11005                 case ANYOF_NPRINT:
11006                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11007                         PL_PosixPrint, PL_L1PosixPrint, "XPosixPrint", listsv);
11008                     break;
11009                 case ANYOF_PUNCT:
11010                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11011                         PL_PosixPunct, PL_L1PosixPunct, "XPosixPunct", listsv);
11012                     break;
11013                 case ANYOF_NPUNCT:
11014                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11015                         PL_PosixPunct, PL_L1PosixPunct, "XPosixPunct", listsv);
11016                     break;
11017                 case ANYOF_PSXSPC:
11018                     DO_POSIX(ret, namedclass, properties,
11019                                             PL_PosixSpace, PL_XPosixSpace);
11020                     break;
11021                 case ANYOF_NPSXSPC:
11022                     DO_N_POSIX(ret, namedclass, properties,
11023                                             PL_PosixSpace, PL_XPosixSpace);
11024                     break;
11025                 case ANYOF_SPACE:
11026                     DO_POSIX(ret, namedclass, properties,
11027                                             PL_PerlSpace, PL_XPerlSpace);
11028                     break;
11029                 case ANYOF_NSPACE:
11030                     DO_N_POSIX(ret, namedclass, properties,
11031                                             PL_PerlSpace, PL_XPerlSpace);
11032                     break;
11033                 case ANYOF_UPPER:   /* Same as LOWER, above */
11034                 case ANYOF_NUPPER:
11035                 {
11036                     SV* ascii_source;
11037                     SV* l1_source;
11038                     const char *Xname;
11039
11040                     if (FOLD && ! LOC) {
11041                         ascii_source = PL_PosixAlpha;
11042                         l1_source = PL_L1Cased;
11043                         Xname = "Cased";
11044                     }
11045                     else {
11046                         ascii_source = PL_PosixUpper;
11047                         l1_source = PL_L1PosixUpper;
11048                         Xname = "XPosixUpper";
11049                     }
11050                     if (namedclass == ANYOF_UPPER) {
11051                         DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11052                                     ascii_source, l1_source, Xname, listsv);
11053                     }
11054                     else {
11055                         DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass,
11056                         properties, ascii_source, l1_source, Xname, listsv);
11057                     }
11058                     break;
11059                 }
11060                 case ANYOF_ALNUM:   /* Really is 'Word' */
11061                     DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11062                             PL_PosixWord, PL_L1PosixWord, "XPosixWord", listsv);
11063                     break;
11064                 case ANYOF_NALNUM:
11065                     DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, properties,
11066                             PL_PosixWord, PL_L1PosixWord, "XPosixWord", listsv);
11067                     break;
11068                 case ANYOF_VERTWS:
11069                     /* For these, we use the nonbitmap, as /d doesn't make a
11070                      * difference in what these match.  There would be problems
11071                      * if these characters had folds other than themselves, as
11072                      * nonbitmap is subject to folding */
11073                     _invlist_union(nonbitmap, PL_VertSpace, &nonbitmap);
11074                     break;
11075                 case ANYOF_NVERTWS:
11076                     _invlist_union_complement_2nd(nonbitmap,
11077                                                     PL_VertSpace, &nonbitmap);
11078                     break;
11079                 case ANYOF_XDIGIT:
11080                     DO_POSIX(ret, namedclass, properties,
11081                                             PL_PosixXDigit, PL_XPosixXDigit);
11082                     break;
11083                 case ANYOF_NXDIGIT:
11084                     DO_N_POSIX(ret, namedclass, properties,
11085                                             PL_PosixXDigit, PL_XPosixXDigit);
11086                     break;
11087                 case ANYOF_MAX:
11088                     /* this is to handle \p and \P */
11089                     break;
11090                 default:
11091                     vFAIL("Invalid [::] class");
11092                     break;
11093                 }
11094
11095                 continue;
11096             }
11097         } /* end of namedclass \blah */
11098
11099         if (range) {
11100             if (prevvalue > (IV)value) /* b-a */ {
11101                 const int w = RExC_parse - rangebegin;
11102                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
11103                 range = 0; /* not a valid range */
11104             }
11105         }
11106         else {
11107             prevvalue = value; /* save the beginning of the range */
11108             if (RExC_parse+1 < RExC_end
11109                 && *RExC_parse == '-'
11110                 && RExC_parse[1] != ']')
11111             {
11112                 RExC_parse++;
11113
11114                 /* a bad range like \w-, [:word:]- ? */
11115                 if (namedclass > OOB_NAMEDCLASS) {
11116                     if (ckWARN(WARN_REGEXP)) {
11117                         const int w =
11118                             RExC_parse >= rangebegin ?
11119                             RExC_parse - rangebegin : 0;
11120                         vWARN4(RExC_parse,
11121                                "False [] range \"%*.*s\"",
11122                                w, w, rangebegin);
11123                     }
11124                     if (!SIZE_ONLY)
11125                         stored +=
11126                             set_regclass_bit(pRExC_state, ret, '-', &l1_fold_invlist, &unicode_alternate);
11127                 } else
11128                     range = 1;  /* yeah, it's a range! */
11129                 continue;       /* but do it the next time */
11130             }
11131         }
11132
11133         /* non-Latin1 code point implies unicode semantics.  Must be set in
11134          * pass1 so is there for the whole of pass 2 */
11135         if (value > 255) {
11136             RExC_uni_semantics = 1;
11137         }
11138
11139         /* now is the next time */
11140         if (!SIZE_ONLY) {
11141             if (prevvalue < 256) {
11142                 const IV ceilvalue = value < 256 ? value : 255;
11143                 IV i;
11144 #ifdef EBCDIC
11145                 /* In EBCDIC [\x89-\x91] should include
11146                  * the \x8e but [i-j] should not. */
11147                 if (literal_endpoint == 2 &&
11148                     ((isLOWER(prevvalue) && isLOWER(ceilvalue)) ||
11149                      (isUPPER(prevvalue) && isUPPER(ceilvalue))))
11150                 {
11151                     if (isLOWER(prevvalue)) {
11152                         for (i = prevvalue; i <= ceilvalue; i++)
11153                             if (isLOWER(i) && !ANYOF_BITMAP_TEST(ret,i)) {
11154                                 stored +=
11155                                   set_regclass_bit(pRExC_state, ret, (U8) i, &l1_fold_invlist, &unicode_alternate);
11156                             }
11157                     } else {
11158                         for (i = prevvalue; i <= ceilvalue; i++)
11159                             if (isUPPER(i) && !ANYOF_BITMAP_TEST(ret,i)) {
11160                                 stored +=
11161                                   set_regclass_bit(pRExC_state, ret, (U8) i, &l1_fold_invlist, &unicode_alternate);
11162                             }
11163                     }
11164                 }
11165                 else
11166 #endif
11167                       for (i = prevvalue; i <= ceilvalue; i++) {
11168                         stored += set_regclass_bit(pRExC_state, ret, (U8) i, &l1_fold_invlist, &unicode_alternate);
11169                       }
11170           }
11171           if (value > 255) {
11172             const UV prevnatvalue  = NATIVE_TO_UNI(prevvalue);
11173             const UV natvalue      = NATIVE_TO_UNI(value);
11174             nonbitmap = add_range_to_invlist(nonbitmap, prevnatvalue, natvalue);
11175         }
11176 #ifdef EBCDIC
11177             literal_endpoint = 0;
11178 #endif
11179         }
11180
11181         range = 0; /* this range (if it was one) is done now */
11182     }
11183
11184
11185
11186     if (SIZE_ONLY)
11187         return ret;
11188     /****** !SIZE_ONLY AFTER HERE *********/
11189
11190     /* If folding and there are code points above 255, we calculate all
11191      * characters that could fold to or from the ones already on the list */
11192     if (FOLD && nonbitmap) {
11193         UV start, end;  /* End points of code point ranges */
11194
11195         SV* fold_intersection = NULL;
11196
11197         /* This is a list of all the characters that participate in folds
11198             * (except marks, etc in multi-char folds */
11199         if (! PL_utf8_foldable) {
11200             SV* swash = swash_init("utf8", "Cased", &PL_sv_undef, 1, 0);
11201             PL_utf8_foldable = _swash_to_invlist(swash);
11202             SvREFCNT_dec(swash);
11203         }
11204
11205         /* This is a hash that for a particular fold gives all characters
11206             * that are involved in it */
11207         if (! PL_utf8_foldclosures) {
11208
11209             /* If we were unable to find any folds, then we likely won't be
11210              * able to find the closures.  So just create an empty list.
11211              * Folding will effectively be restricted to the non-Unicode rules
11212              * hard-coded into Perl.  (This case happens legitimately during
11213              * compilation of Perl itself before the Unicode tables are
11214              * generated) */
11215             if (invlist_len(PL_utf8_foldable) == 0) {
11216                 PL_utf8_foldclosures = newHV();
11217             } else {
11218                 /* If the folds haven't been read in, call a fold function
11219                     * to force that */
11220                 if (! PL_utf8_tofold) {
11221                     U8 dummy[UTF8_MAXBYTES+1];
11222                     STRLEN dummy_len;
11223
11224                     /* This particular string is above \xff in both UTF-8 and
11225                      * UTFEBCDIC */
11226                     to_utf8_fold((U8*) "\xC8\x80", dummy, &dummy_len);
11227                     assert(PL_utf8_tofold); /* Verify that worked */
11228                 }
11229                 PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
11230             }
11231         }
11232
11233         /* Only the characters in this class that participate in folds need be
11234          * checked.  Get the intersection of this class and all the possible
11235          * characters that are foldable.  This can quickly narrow down a large
11236          * class */
11237         _invlist_intersection(PL_utf8_foldable, nonbitmap, &fold_intersection);
11238
11239         /* Now look at the foldable characters in this class individually */
11240         invlist_iterinit(fold_intersection);
11241         while (invlist_iternext(fold_intersection, &start, &end)) {
11242             UV j;
11243
11244             /* Look at every character in the range */
11245             for (j = start; j <= end; j++) {
11246
11247                 /* Get its fold */
11248                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
11249                 STRLEN foldlen;
11250                 const UV f =
11251                     _to_uni_fold_flags(j, foldbuf, &foldlen, allow_full_fold);
11252
11253                 if (foldlen > (STRLEN)UNISKIP(f)) {
11254
11255                     /* Any multicharacter foldings (disallowed in lookbehind
11256                      * patterns) require the following transform: [ABCDEF] ->
11257                      * (?:[ABCabcDEFd]|pq|rst) where E folds into "pq" and F
11258                      * folds into "rst", all other characters fold to single
11259                      * characters.  We save away these multicharacter foldings,
11260                      * to be later saved as part of the additional "s" data. */
11261                     if (! RExC_in_lookbehind) {
11262                         U8* loc = foldbuf;
11263                         U8* e = foldbuf + foldlen;
11264
11265                         /* If any of the folded characters of this are in the
11266                          * Latin1 range, tell the regex engine that this can
11267                          * match a non-utf8 target string.  The only multi-byte
11268                          * fold whose source is in the Latin1 range (U+00DF)
11269                          * applies only when the target string is utf8, or
11270                          * under unicode rules */
11271                         if (j > 255 || AT_LEAST_UNI_SEMANTICS) {
11272                             while (loc < e) {
11273
11274                                 /* Can't mix ascii with non- under /aa */
11275                                 if (MORE_ASCII_RESTRICTED
11276                                     && (isASCII(*loc) != isASCII(j)))
11277                                 {
11278                                     goto end_multi_fold;
11279                                 }
11280                                 if (UTF8_IS_INVARIANT(*loc)
11281                                     || UTF8_IS_DOWNGRADEABLE_START(*loc))
11282                                 {
11283                                     /* Can't mix above and below 256 under LOC
11284                                      */
11285                                     if (LOC) {
11286                                         goto end_multi_fold;
11287                                     }
11288                                     ANYOF_FLAGS(ret)
11289                                             |= ANYOF_NONBITMAP_NON_UTF8;
11290                                     break;
11291                                 }
11292                                 loc += UTF8SKIP(loc);
11293                             }
11294                         }
11295
11296                         add_alternate(&unicode_alternate, foldbuf, foldlen);
11297                     end_multi_fold: ;
11298                     }
11299
11300                     /* This is special-cased, as it is the only letter which
11301                      * has both a multi-fold and single-fold in Latin1.  All
11302                      * the other chars that have single and multi-folds are
11303                      * always in utf8, and the utf8 folding algorithm catches
11304                      * them */
11305                     if (! LOC && j == LATIN_CAPITAL_LETTER_SHARP_S) {
11306                         stored += set_regclass_bit(pRExC_state,
11307                                         ret,
11308                                         LATIN_SMALL_LETTER_SHARP_S,
11309                                         &l1_fold_invlist, &unicode_alternate);
11310                     }
11311                 }
11312                 else {
11313                     /* Single character fold.  Add everything in its fold
11314                      * closure to the list that this node should match */
11315                     SV** listp;
11316
11317                     /* The fold closures data structure is a hash with the keys
11318                      * being every character that is folded to, like 'k', and
11319                      * the values each an array of everything that folds to its
11320                      * key.  e.g. [ 'k', 'K', KELVIN_SIGN ] */
11321                     if ((listp = hv_fetch(PL_utf8_foldclosures,
11322                                     (char *) foldbuf, foldlen, FALSE)))
11323                     {
11324                         AV* list = (AV*) *listp;
11325                         IV k;
11326                         for (k = 0; k <= av_len(list); k++) {
11327                             SV** c_p = av_fetch(list, k, FALSE);
11328                             UV c;
11329                             if (c_p == NULL) {
11330                                 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
11331                             }
11332                             c = SvUV(*c_p);
11333
11334                             /* /aa doesn't allow folds between ASCII and non-;
11335                              * /l doesn't allow them between above and below
11336                              * 256 */
11337                             if ((MORE_ASCII_RESTRICTED
11338                                  && (isASCII(c) != isASCII(j)))
11339                                     || (LOC && ((c < 256) != (j < 256))))
11340                             {
11341                                 continue;
11342                             }
11343
11344                             if (c < 256 && AT_LEAST_UNI_SEMANTICS) {
11345                                 stored += set_regclass_bit(pRExC_state,
11346                                         ret,
11347                                         (U8) c,
11348                                         &l1_fold_invlist, &unicode_alternate);
11349                             }
11350                                 /* It may be that the code point is already in
11351                                  * this range or already in the bitmap, in
11352                                  * which case we need do nothing */
11353                             else if ((c < start || c > end)
11354                                         && (c > 255
11355                                             || ! ANYOF_BITMAP_TEST(ret, c)))
11356                             {
11357                                 nonbitmap = add_cp_to_invlist(nonbitmap, c);
11358                             }
11359                         }
11360                     }
11361                 }
11362             }
11363         }
11364         SvREFCNT_dec(fold_intersection);
11365     }
11366
11367     /* Combine the two lists into one. */
11368     if (l1_fold_invlist) {
11369         if (nonbitmap) {
11370             _invlist_union(nonbitmap, l1_fold_invlist, &nonbitmap);
11371             SvREFCNT_dec(l1_fold_invlist);
11372         }
11373         else {
11374             nonbitmap = l1_fold_invlist;
11375         }
11376     }
11377
11378     /* And combine the result (if any) with any inversion list from properties.
11379      * The lists are kept separate up to now because we don't want to fold the
11380      * properties */
11381     if (properties) {
11382         if (nonbitmap) {
11383             _invlist_union(nonbitmap, properties, &nonbitmap);
11384             SvREFCNT_dec(properties);
11385         }
11386         else {
11387             nonbitmap = properties;
11388         }
11389     }
11390
11391     /* Here, <nonbitmap> contains all the code points we can determine at
11392      * compile time that we haven't put into the bitmap.  Go through it, and
11393      * for things that belong in the bitmap, put them there, and delete from
11394      * <nonbitmap> */
11395     if (nonbitmap) {
11396
11397         /* Above-ASCII code points in /d have to stay in <nonbitmap>, as they
11398          * possibly only should match when the target string is UTF-8 */
11399         UV max_cp_to_set = (DEPENDS_SEMANTICS) ? 127 : 255;
11400
11401         /* This gets set if we actually need to modify things */
11402         bool change_invlist = FALSE;
11403
11404         UV start, end;
11405
11406         /* Start looking through <nonbitmap> */
11407         invlist_iterinit(nonbitmap);
11408         while (invlist_iternext(nonbitmap, &start, &end)) {
11409             UV high;
11410             int i;
11411
11412             /* Quit if are above what we should change */
11413             if (start > max_cp_to_set) {
11414                 break;
11415             }
11416
11417             change_invlist = TRUE;
11418
11419             /* Set all the bits in the range, up to the max that we are doing */
11420             high = (end < max_cp_to_set) ? end : max_cp_to_set;
11421             for (i = start; i <= (int) high; i++) {
11422                 if (! ANYOF_BITMAP_TEST(ret, i)) {
11423                     ANYOF_BITMAP_SET(ret, i);
11424                     stored++;
11425                     prevvalue = value;
11426                     value = i;
11427                 }
11428             }
11429         }
11430
11431         /* Done with loop; remove any code points that are in the bitmap from
11432          * <nonbitmap> */
11433         if (change_invlist) {
11434             _invlist_subtract(nonbitmap,
11435                               (DEPENDS_SEMANTICS)
11436                                 ? PL_ASCII
11437                                 : PL_Latin1,
11438                               &nonbitmap);
11439         }
11440
11441         /* If have completely emptied it, remove it completely */
11442         if (invlist_len(nonbitmap) == 0) {
11443             SvREFCNT_dec(nonbitmap);
11444             nonbitmap = NULL;
11445         }
11446     }
11447
11448     /* Here, we have calculated what code points should be in the character
11449      * class.  <nonbitmap> does not overlap the bitmap except possibly in the
11450      * case of DEPENDS rules.
11451      *
11452      * Now we can see about various optimizations.  Fold calculation (which we
11453      * did above) needs to take place before inversion.  Otherwise /[^k]/i
11454      * would invert to include K, which under /i would match k, which it
11455      * shouldn't. */
11456
11457     /* Optimize inverted simple patterns (e.g. [^a-z]).  Note that we haven't
11458      * set the FOLD flag yet, so this does optimize those.  It doesn't
11459      * optimize locale.  Doing so perhaps could be done as long as there is
11460      * nothing like \w in it; some thought also would have to be given to the
11461      * interaction with above 0x100 chars */
11462     if ((ANYOF_FLAGS(ret) & ANYOF_INVERT)
11463         && ! LOC
11464         && ! unicode_alternate
11465         /* In case of /d, there are some things that should match only when in
11466          * not in the bitmap, i.e., they require UTF8 to match.  These are
11467          * listed in nonbitmap, but if ANYOF_NONBITMAP_NON_UTF8 is set in this
11468          * case, they don't require UTF8, so can invert here */
11469         && (! nonbitmap
11470             || ! DEPENDS_SEMANTICS
11471             || (ANYOF_FLAGS(ret) & ANYOF_NONBITMAP_NON_UTF8))
11472         && SvCUR(listsv) == initial_listsv_len)
11473     {
11474         int i;
11475         if (! nonbitmap) {
11476             for (i = 0; i < 256; ++i) {
11477                 if (ANYOF_BITMAP_TEST(ret, i)) {
11478                     ANYOF_BITMAP_CLEAR(ret, i);
11479                 }
11480                 else {
11481                     ANYOF_BITMAP_SET(ret, i);
11482                     prevvalue = value;
11483                     value = i;
11484                 }
11485             }
11486             /* The inversion means that everything above 255 is matched */
11487             ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
11488         }
11489         else {
11490             /* Here, also has things outside the bitmap that may overlap with
11491              * the bitmap.  We have to sync them up, so that they get inverted
11492              * in both places.  Earlier, we removed all overlaps except in the
11493              * case of /d rules, so no syncing is needed except for this case
11494              */
11495             SV *remove_list = NULL;
11496
11497             if (DEPENDS_SEMANTICS) {
11498                 UV start, end;
11499
11500                 /* Set the bits that correspond to the ones that aren't in the
11501                  * bitmap.  Otherwise, when we invert, we'll miss these.
11502                  * Earlier, we removed from the nonbitmap all code points
11503                  * < 128, so there is no extra work here */
11504                 invlist_iterinit(nonbitmap);
11505                 while (invlist_iternext(nonbitmap, &start, &end)) {
11506                     if (start > 255) {  /* The bit map goes to 255 */
11507                         break;
11508                     }
11509                     if (end > 255) {
11510                         end = 255;
11511                     }
11512                     for (i = start; i <= (int) end; ++i) {
11513                         ANYOF_BITMAP_SET(ret, i);
11514                         prevvalue = value;
11515                         value = i;
11516                     }
11517                 }
11518             }
11519
11520             /* Now invert both the bitmap and the nonbitmap.  Anything in the
11521              * bitmap has to also be removed from the non-bitmap, but again,
11522              * there should not be overlap unless is /d rules. */
11523             _invlist_invert(nonbitmap);
11524
11525             /* Any swash can't be used as-is, because we've inverted things */
11526             if (swash) {
11527                 SvREFCNT_dec(swash);
11528                 swash = NULL;
11529             }
11530
11531             for (i = 0; i < 256; ++i) {
11532                 if (ANYOF_BITMAP_TEST(ret, i)) {
11533                     ANYOF_BITMAP_CLEAR(ret, i);
11534                     if (DEPENDS_SEMANTICS) {
11535                         if (! remove_list) {
11536                             remove_list = _new_invlist(2);
11537                         }
11538                         remove_list = add_cp_to_invlist(remove_list, i);
11539                     }
11540                 }
11541                 else {
11542                     ANYOF_BITMAP_SET(ret, i);
11543                     prevvalue = value;
11544                     value = i;
11545                 }
11546             }
11547
11548             /* And do the removal */
11549             if (DEPENDS_SEMANTICS) {
11550                 if (remove_list) {
11551                     _invlist_subtract(nonbitmap, remove_list, &nonbitmap);
11552                     SvREFCNT_dec(remove_list);
11553                 }
11554             }
11555             else {
11556                 /* There is no overlap for non-/d, so just delete anything
11557                  * below 256 */
11558                 _invlist_intersection(nonbitmap, PL_AboveLatin1, &nonbitmap);
11559             }
11560         }
11561
11562         stored = 256 - stored;
11563
11564         /* Clear the invert flag since have just done it here */
11565         ANYOF_FLAGS(ret) &= ~ANYOF_INVERT;
11566     }
11567
11568     /* Folding in the bitmap is taken care of above, but not for locale (for
11569      * which we have to wait to see what folding is in effect at runtime), and
11570      * for some things not in the bitmap (only the upper latin folds in this
11571      * case, as all other single-char folding has been set above).  Set
11572      * run-time fold flag for these */
11573     if (FOLD && (LOC
11574                 || (DEPENDS_SEMANTICS
11575                     && nonbitmap
11576                     && ! (ANYOF_FLAGS(ret) & ANYOF_NONBITMAP_NON_UTF8))
11577                 || unicode_alternate))
11578     {
11579         ANYOF_FLAGS(ret) |= ANYOF_LOC_NONBITMAP_FOLD;
11580     }
11581
11582     /* A single character class can be "optimized" into an EXACTish node.
11583      * Note that since we don't currently count how many characters there are
11584      * outside the bitmap, we are XXX missing optimization possibilities for
11585      * them.  This optimization can't happen unless this is a truly single
11586      * character class, which means that it can't be an inversion into a
11587      * many-character class, and there must be no possibility of there being
11588      * things outside the bitmap.  'stored' (only) for locales doesn't include
11589      * \w, etc, so have to make a special test that they aren't present
11590      *
11591      * Similarly A 2-character class of the very special form like [bB] can be
11592      * optimized into an EXACTFish node, but only for non-locales, and for
11593      * characters which only have the two folds; so things like 'fF' and 'Ii'
11594      * wouldn't work because they are part of the fold of 'LATIN SMALL LIGATURE
11595      * FI'. */
11596     if (! nonbitmap
11597         && ! unicode_alternate
11598         && SvCUR(listsv) == initial_listsv_len
11599         && ! (ANYOF_FLAGS(ret) & (ANYOF_INVERT|ANYOF_UNICODE_ALL))
11600         && (((stored == 1 && ((! (ANYOF_FLAGS(ret) & ANYOF_LOCALE))
11601                               || (! ANYOF_CLASS_TEST_ANY_SET(ret)))))
11602             || (stored == 2 && ((! (ANYOF_FLAGS(ret) & ANYOF_LOCALE))
11603                                  && (! _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(value))
11604                                  /* If the latest code point has a fold whose
11605                                   * bit is set, it must be the only other one */
11606                                 && ((prevvalue = PL_fold_latin1[value]) != (IV)value)
11607                                  && ANYOF_BITMAP_TEST(ret, prevvalue)))))
11608     {
11609         /* Note that the information needed to decide to do this optimization
11610          * is not currently available until the 2nd pass, and that the actually
11611          * used EXACTish node takes less space than the calculated ANYOF node,
11612          * and hence the amount of space calculated in the first pass is larger
11613          * than actually used, so this optimization doesn't gain us any space.
11614          * But an EXACT node is faster than an ANYOF node, and can be combined
11615          * with any adjacent EXACT nodes later by the optimizer for further
11616          * gains.  The speed of executing an EXACTF is similar to an ANYOF
11617          * node, so the optimization advantage comes from the ability to join
11618          * it to adjacent EXACT nodes */
11619
11620         const char * cur_parse= RExC_parse;
11621         U8 op;
11622         RExC_emit = (regnode *)orig_emit;
11623         RExC_parse = (char *)orig_parse;
11624
11625         if (stored == 1) {
11626
11627             /* A locale node with one point can be folded; all the other cases
11628              * with folding will have two points, since we calculate them above
11629              */
11630             if (ANYOF_FLAGS(ret) & ANYOF_LOC_NONBITMAP_FOLD) {
11631                  op = EXACTFL;
11632             }
11633             else {
11634                 op = EXACT;
11635             }
11636         }
11637         else {   /* else 2 chars in the bit map: the folds of each other */
11638
11639             /* Use the folded value, which for the cases where we get here,
11640              * is just the lower case of the current one (which may resolve to
11641              * itself, or to the other one */
11642             value = toLOWER_LATIN1(value);
11643
11644             /* To join adjacent nodes, they must be the exact EXACTish type.
11645              * Try to use the most likely type, by using EXACTFA if possible,
11646              * then EXACTFU if the regex calls for it, or is required because
11647              * the character is non-ASCII.  (If <value> is ASCII, its fold is
11648              * also ASCII for the cases where we get here.) */
11649             if (MORE_ASCII_RESTRICTED && isASCII(value)) {
11650                 op = EXACTFA;
11651             }
11652             else if (AT_LEAST_UNI_SEMANTICS || !isASCII(value)) {
11653                 op = EXACTFU;
11654             }
11655             else {    /* Otherwise, more likely to be EXACTF type */
11656                 op = EXACTF;
11657             }
11658         }
11659
11660         ret = reg_node(pRExC_state, op);
11661         RExC_parse = (char *)cur_parse;
11662         if (UTF && ! NATIVE_IS_INVARIANT(value)) {
11663             *STRING(ret)= UTF8_EIGHT_BIT_HI((U8) value);
11664             *(STRING(ret) + 1)= UTF8_EIGHT_BIT_LO((U8) value);
11665             STR_LEN(ret)= 2;
11666             RExC_emit += STR_SZ(2);
11667         }
11668         else {
11669             *STRING(ret)= (char)value;
11670             STR_LEN(ret)= 1;
11671             RExC_emit += STR_SZ(1);
11672         }
11673         SvREFCNT_dec(listsv);
11674         return ret;
11675     }
11676
11677     /* If there is a swash and more than one element, we can't use the swash in
11678      * the optimization below. */
11679     if (swash && element_count > 1) {
11680         SvREFCNT_dec(swash);
11681         swash = NULL;
11682     }
11683     if (! nonbitmap
11684         && SvCUR(listsv) == initial_listsv_len
11685         && ! unicode_alternate)
11686     {
11687         ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
11688         SvREFCNT_dec(listsv);
11689         SvREFCNT_dec(unicode_alternate);
11690     }
11691     else {
11692         /* av[0] stores the character class description in its textual form:
11693          *       used later (regexec.c:Perl_regclass_swash()) to initialize the
11694          *       appropriate swash, and is also useful for dumping the regnode.
11695          * av[1] if NULL, is a placeholder to later contain the swash computed
11696          *       from av[0].  But if no further computation need be done, the
11697          *       swash is stored there now.
11698          * av[2] stores the multicharacter foldings, used later in
11699          *       regexec.c:S_reginclass().
11700          * av[3] stores the nonbitmap inversion list for use in addition or
11701          *       instead of av[0]; not used if av[1] isn't NULL
11702          * av[4] is set if any component of the class is from a user-defined
11703          *       property; not used if av[1] isn't NULL */
11704         AV * const av = newAV();
11705         SV *rv;
11706
11707         av_store(av, 0, (SvCUR(listsv) == initial_listsv_len)
11708                         ? &PL_sv_undef
11709                         : listsv);
11710         if (swash) {
11711             av_store(av, 1, swash);
11712             SvREFCNT_dec(nonbitmap);
11713         }
11714         else {
11715             av_store(av, 1, NULL);
11716             if (nonbitmap) {
11717                 av_store(av, 3, nonbitmap);
11718                 av_store(av, 4, newSVuv(has_user_defined_property));
11719             }
11720         }
11721
11722         /* Store any computed multi-char folds only if we are allowing
11723          * them */
11724         if (allow_full_fold) {
11725             av_store(av, 2, MUTABLE_SV(unicode_alternate));
11726             if (unicode_alternate) { /* This node is variable length */
11727                 OP(ret) = ANYOFV;
11728             }
11729         }
11730         else {
11731             av_store(av, 2, NULL);
11732         }
11733         rv = newRV_noinc(MUTABLE_SV(av));
11734         n = add_data(pRExC_state, 1, "s");
11735         RExC_rxi->data->data[n] = (void*)rv;
11736         ARG_SET(ret, n);
11737     }
11738     return ret;
11739 }
11740
11741
11742 /* reg_skipcomment()
11743
11744    Absorbs an /x style # comments from the input stream.
11745    Returns true if there is more text remaining in the stream.
11746    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
11747    terminates the pattern without including a newline.
11748
11749    Note its the callers responsibility to ensure that we are
11750    actually in /x mode
11751
11752 */
11753
11754 STATIC bool
11755 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
11756 {
11757     bool ended = 0;
11758
11759     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
11760
11761     while (RExC_parse < RExC_end)
11762         if (*RExC_parse++ == '\n') {
11763             ended = 1;
11764             break;
11765         }
11766     if (!ended) {
11767         /* we ran off the end of the pattern without ending
11768            the comment, so we have to add an \n when wrapping */
11769         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11770         return 0;
11771     } else
11772         return 1;
11773 }
11774
11775 /* nextchar()
11776
11777    Advances the parse position, and optionally absorbs
11778    "whitespace" from the inputstream.
11779
11780    Without /x "whitespace" means (?#...) style comments only,
11781    with /x this means (?#...) and # comments and whitespace proper.
11782
11783    Returns the RExC_parse point from BEFORE the scan occurs.
11784
11785    This is the /x friendly way of saying RExC_parse++.
11786 */
11787
11788 STATIC char*
11789 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
11790 {
11791     char* const retval = RExC_parse++;
11792
11793     PERL_ARGS_ASSERT_NEXTCHAR;
11794
11795     for (;;) {
11796         if (RExC_end - RExC_parse >= 3
11797             && *RExC_parse == '('
11798             && RExC_parse[1] == '?'
11799             && RExC_parse[2] == '#')
11800         {
11801             while (*RExC_parse != ')') {
11802                 if (RExC_parse == RExC_end)
11803                     FAIL("Sequence (?#... not terminated");
11804                 RExC_parse++;
11805             }
11806             RExC_parse++;
11807             continue;
11808         }
11809         if (RExC_flags & RXf_PMf_EXTENDED) {
11810             if (isSPACE(*RExC_parse)) {
11811                 RExC_parse++;
11812                 continue;
11813             }
11814             else if (*RExC_parse == '#') {
11815                 if ( reg_skipcomment( pRExC_state ) )
11816                     continue;
11817             }
11818         }
11819         return retval;
11820     }
11821 }
11822
11823 /*
11824 - reg_node - emit a node
11825 */
11826 STATIC regnode *                        /* Location. */
11827 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
11828 {
11829     dVAR;
11830     register regnode *ptr;
11831     regnode * const ret = RExC_emit;
11832     GET_RE_DEBUG_FLAGS_DECL;
11833
11834     PERL_ARGS_ASSERT_REG_NODE;
11835
11836     if (SIZE_ONLY) {
11837         SIZE_ALIGN(RExC_size);
11838         RExC_size += 1;
11839         return(ret);
11840     }
11841     if (RExC_emit >= RExC_emit_bound)
11842         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
11843                    op, RExC_emit, RExC_emit_bound);
11844
11845     NODE_ALIGN_FILL(ret);
11846     ptr = ret;
11847     FILL_ADVANCE_NODE(ptr, op);
11848     REH_CALL_REGCOMP_HOOK(pRExC_state->rx, (ptr) - 1);
11849 #ifdef RE_TRACK_PATTERN_OFFSETS
11850     if (RExC_offsets) {         /* MJD */
11851         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
11852               "reg_node", __LINE__, 
11853               PL_reg_name[op],
11854               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
11855                 ? "Overwriting end of array!\n" : "OK",
11856               (UV)(RExC_emit - RExC_emit_start),
11857               (UV)(RExC_parse - RExC_start),
11858               (UV)RExC_offsets[0])); 
11859         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
11860     }
11861 #endif
11862     RExC_emit = ptr;
11863     return(ret);
11864 }
11865
11866 /*
11867 - reganode - emit a node with an argument
11868 */
11869 STATIC regnode *                        /* Location. */
11870 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
11871 {
11872     dVAR;
11873     register regnode *ptr;
11874     regnode * const ret = RExC_emit;
11875     GET_RE_DEBUG_FLAGS_DECL;
11876
11877     PERL_ARGS_ASSERT_REGANODE;
11878
11879     if (SIZE_ONLY) {
11880         SIZE_ALIGN(RExC_size);
11881         RExC_size += 2;
11882         /* 
11883            We can't do this:
11884            
11885            assert(2==regarglen[op]+1); 
11886
11887            Anything larger than this has to allocate the extra amount.
11888            If we changed this to be:
11889            
11890            RExC_size += (1 + regarglen[op]);
11891            
11892            then it wouldn't matter. Its not clear what side effect
11893            might come from that so its not done so far.
11894            -- dmq
11895         */
11896         return(ret);
11897     }
11898     if (RExC_emit >= RExC_emit_bound)
11899         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
11900                    op, RExC_emit, RExC_emit_bound);
11901
11902     NODE_ALIGN_FILL(ret);
11903     ptr = ret;
11904     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
11905     REH_CALL_REGCOMP_HOOK(pRExC_state->rx, (ptr) - 2);
11906 #ifdef RE_TRACK_PATTERN_OFFSETS
11907     if (RExC_offsets) {         /* MJD */
11908         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
11909               "reganode",
11910               __LINE__,
11911               PL_reg_name[op],
11912               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
11913               "Overwriting end of array!\n" : "OK",
11914               (UV)(RExC_emit - RExC_emit_start),
11915               (UV)(RExC_parse - RExC_start),
11916               (UV)RExC_offsets[0])); 
11917         Set_Cur_Node_Offset;
11918     }
11919 #endif            
11920     RExC_emit = ptr;
11921     return(ret);
11922 }
11923
11924 /*
11925 - reguni - emit (if appropriate) a Unicode character
11926 */
11927 STATIC STRLEN
11928 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
11929 {
11930     dVAR;
11931
11932     PERL_ARGS_ASSERT_REGUNI;
11933
11934     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
11935 }
11936
11937 /*
11938 - reginsert - insert an operator in front of already-emitted operand
11939 *
11940 * Means relocating the operand.
11941 */
11942 STATIC void
11943 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
11944 {
11945     dVAR;
11946     register regnode *src;
11947     register regnode *dst;
11948     register regnode *place;
11949     const int offset = regarglen[(U8)op];
11950     const int size = NODE_STEP_REGNODE + offset;
11951     GET_RE_DEBUG_FLAGS_DECL;
11952
11953     PERL_ARGS_ASSERT_REGINSERT;
11954     PERL_UNUSED_ARG(depth);
11955 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
11956     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
11957     if (SIZE_ONLY) {
11958         RExC_size += size;
11959         return;
11960     }
11961
11962     src = RExC_emit;
11963     RExC_emit += size;
11964     dst = RExC_emit;
11965     if (RExC_open_parens) {
11966         int paren;
11967         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
11968         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
11969             if ( RExC_open_parens[paren] >= opnd ) {
11970                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
11971                 RExC_open_parens[paren] += size;
11972             } else {
11973                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
11974             }
11975             if ( RExC_close_parens[paren] >= opnd ) {
11976                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
11977                 RExC_close_parens[paren] += size;
11978             } else {
11979                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
11980             }
11981         }
11982     }
11983
11984     while (src > opnd) {
11985         StructCopy(--src, --dst, regnode);
11986 #ifdef RE_TRACK_PATTERN_OFFSETS
11987         if (RExC_offsets) {     /* MJD 20010112 */
11988             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
11989                   "reg_insert",
11990                   __LINE__,
11991                   PL_reg_name[op],
11992                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
11993                     ? "Overwriting end of array!\n" : "OK",
11994                   (UV)(src - RExC_emit_start),
11995                   (UV)(dst - RExC_emit_start),
11996                   (UV)RExC_offsets[0])); 
11997             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
11998             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
11999         }
12000 #endif
12001     }
12002     
12003
12004     place = opnd;               /* Op node, where operand used to be. */
12005 #ifdef RE_TRACK_PATTERN_OFFSETS
12006     if (RExC_offsets) {         /* MJD */
12007         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
12008               "reginsert",
12009               __LINE__,
12010               PL_reg_name[op],
12011               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
12012               ? "Overwriting end of array!\n" : "OK",
12013               (UV)(place - RExC_emit_start),
12014               (UV)(RExC_parse - RExC_start),
12015               (UV)RExC_offsets[0]));
12016         Set_Node_Offset(place, RExC_parse);
12017         Set_Node_Length(place, 1);
12018     }
12019 #endif    
12020     src = NEXTOPER(place);
12021     FILL_ADVANCE_NODE(place, op);
12022     REH_CALL_REGCOMP_HOOK(pRExC_state->rx, (place) - 1);
12023     Zero(src, offset, regnode);
12024 }
12025
12026 /*
12027 - regtail - set the next-pointer at the end of a node chain of p to val.
12028 - SEE ALSO: regtail_study
12029 */
12030 /* TODO: All three parms should be const */
12031 STATIC void
12032 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
12033 {
12034     dVAR;
12035     register regnode *scan;
12036     GET_RE_DEBUG_FLAGS_DECL;
12037
12038     PERL_ARGS_ASSERT_REGTAIL;
12039 #ifndef DEBUGGING
12040     PERL_UNUSED_ARG(depth);
12041 #endif
12042
12043     if (SIZE_ONLY)
12044         return;
12045
12046     /* Find last node. */
12047     scan = p;
12048     for (;;) {
12049         regnode * const temp = regnext(scan);
12050         DEBUG_PARSE_r({
12051             SV * const mysv=sv_newmortal();
12052             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
12053             regprop(RExC_rx, mysv, scan);
12054             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
12055                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
12056                     (temp == NULL ? "->" : ""),
12057                     (temp == NULL ? PL_reg_name[OP(val)] : "")
12058             );
12059         });
12060         if (temp == NULL)
12061             break;
12062         scan = temp;
12063     }
12064
12065     if (reg_off_by_arg[OP(scan)]) {
12066         ARG_SET(scan, val - scan);
12067     }
12068     else {
12069         NEXT_OFF(scan) = val - scan;
12070     }
12071 }
12072
12073 #ifdef DEBUGGING
12074 /*
12075 - regtail_study - set the next-pointer at the end of a node chain of p to val.
12076 - Look for optimizable sequences at the same time.
12077 - currently only looks for EXACT chains.
12078
12079 This is experimental code. The idea is to use this routine to perform 
12080 in place optimizations on branches and groups as they are constructed,
12081 with the long term intention of removing optimization from study_chunk so
12082 that it is purely analytical.
12083
12084 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
12085 to control which is which.
12086
12087 */
12088 /* TODO: All four parms should be const */
12089
12090 STATIC U8
12091 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
12092 {
12093     dVAR;
12094     register regnode *scan;
12095     U8 exact = PSEUDO;
12096 #ifdef EXPERIMENTAL_INPLACESCAN
12097     I32 min = 0;
12098 #endif
12099     GET_RE_DEBUG_FLAGS_DECL;
12100
12101     PERL_ARGS_ASSERT_REGTAIL_STUDY;
12102
12103
12104     if (SIZE_ONLY)
12105         return exact;
12106
12107     /* Find last node. */
12108
12109     scan = p;
12110     for (;;) {
12111         regnode * const temp = regnext(scan);
12112 #ifdef EXPERIMENTAL_INPLACESCAN
12113         if (PL_regkind[OP(scan)] == EXACT) {
12114             bool has_exactf_sharp_s;    /* Unexamined in this routine */
12115             if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
12116                 return EXACT;
12117         }
12118 #endif
12119         if ( exact ) {
12120             switch (OP(scan)) {
12121                 case EXACT:
12122                 case EXACTF:
12123                 case EXACTFA:
12124                 case EXACTFU:
12125                 case EXACTFU_SS:
12126                 case EXACTFU_TRICKYFOLD:
12127                 case EXACTFL:
12128                         if( exact == PSEUDO )
12129                             exact= OP(scan);
12130                         else if ( exact != OP(scan) )
12131                             exact= 0;
12132                 case NOTHING:
12133                     break;
12134                 default:
12135                     exact= 0;
12136             }
12137         }
12138         DEBUG_PARSE_r({
12139             SV * const mysv=sv_newmortal();
12140             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
12141             regprop(RExC_rx, mysv, scan);
12142             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
12143                 SvPV_nolen_const(mysv),
12144                 REG_NODE_NUM(scan),
12145                 PL_reg_name[exact]);
12146         });
12147         if (temp == NULL)
12148             break;
12149         scan = temp;
12150     }
12151     DEBUG_PARSE_r({
12152         SV * const mysv_val=sv_newmortal();
12153         DEBUG_PARSE_MSG("");
12154         regprop(RExC_rx, mysv_val, val);
12155         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
12156                       SvPV_nolen_const(mysv_val),
12157                       (IV)REG_NODE_NUM(val),
12158                       (IV)(val - scan)
12159         );
12160     });
12161     if (reg_off_by_arg[OP(scan)]) {
12162         ARG_SET(scan, val - scan);
12163     }
12164     else {
12165         NEXT_OFF(scan) = val - scan;
12166     }
12167
12168     return exact;
12169 }
12170 #endif
12171
12172 /*
12173  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
12174  */
12175 #ifdef DEBUGGING
12176 static void 
12177 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
12178 {
12179     int bit;
12180     int set=0;
12181     regex_charset cs;
12182
12183     for (bit=0; bit<32; bit++) {
12184         if (flags & (1<<bit)) {
12185             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
12186                 continue;
12187             }
12188             if (!set++ && lead) 
12189                 PerlIO_printf(Perl_debug_log, "%s",lead);
12190             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
12191         }               
12192     }      
12193     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
12194             if (!set++ && lead) {
12195                 PerlIO_printf(Perl_debug_log, "%s",lead);
12196             }
12197             switch (cs) {
12198                 case REGEX_UNICODE_CHARSET:
12199                     PerlIO_printf(Perl_debug_log, "UNICODE");
12200                     break;
12201                 case REGEX_LOCALE_CHARSET:
12202                     PerlIO_printf(Perl_debug_log, "LOCALE");
12203                     break;
12204                 case REGEX_ASCII_RESTRICTED_CHARSET:
12205                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
12206                     break;
12207                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
12208                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
12209                     break;
12210                 default:
12211                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
12212                     break;
12213             }
12214     }
12215     if (lead)  {
12216         if (set) 
12217             PerlIO_printf(Perl_debug_log, "\n");
12218         else 
12219             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
12220     }            
12221 }   
12222 #endif
12223
12224 void
12225 Perl_regdump(pTHX_ const regexp *r)
12226 {
12227 #ifdef DEBUGGING
12228     dVAR;
12229     SV * const sv = sv_newmortal();
12230     SV *dsv= sv_newmortal();
12231     RXi_GET_DECL(r,ri);
12232     GET_RE_DEBUG_FLAGS_DECL;
12233
12234     PERL_ARGS_ASSERT_REGDUMP;
12235
12236     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
12237
12238     /* Header fields of interest. */
12239     if (r->anchored_substr) {
12240         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
12241             RE_SV_DUMPLEN(r->anchored_substr), 30);
12242         PerlIO_printf(Perl_debug_log,
12243                       "anchored %s%s at %"IVdf" ",
12244                       s, RE_SV_TAIL(r->anchored_substr),
12245                       (IV)r->anchored_offset);
12246     } else if (r->anchored_utf8) {
12247         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
12248             RE_SV_DUMPLEN(r->anchored_utf8), 30);
12249         PerlIO_printf(Perl_debug_log,
12250                       "anchored utf8 %s%s at %"IVdf" ",
12251                       s, RE_SV_TAIL(r->anchored_utf8),
12252                       (IV)r->anchored_offset);
12253     }                 
12254     if (r->float_substr) {
12255         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
12256             RE_SV_DUMPLEN(r->float_substr), 30);
12257         PerlIO_printf(Perl_debug_log,
12258                       "floating %s%s at %"IVdf"..%"UVuf" ",
12259                       s, RE_SV_TAIL(r->float_substr),
12260                       (IV)r->float_min_offset, (UV)r->float_max_offset);
12261     } else if (r->float_utf8) {
12262         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
12263             RE_SV_DUMPLEN(r->float_utf8), 30);
12264         PerlIO_printf(Perl_debug_log,
12265                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
12266                       s, RE_SV_TAIL(r->float_utf8),
12267                       (IV)r->float_min_offset, (UV)r->float_max_offset);
12268     }
12269     if (r->check_substr || r->check_utf8)
12270         PerlIO_printf(Perl_debug_log,
12271                       (const char *)
12272                       (r->check_substr == r->float_substr
12273                        && r->check_utf8 == r->float_utf8
12274                        ? "(checking floating" : "(checking anchored"));
12275     if (r->extflags & RXf_NOSCAN)
12276         PerlIO_printf(Perl_debug_log, " noscan");
12277     if (r->extflags & RXf_CHECK_ALL)
12278         PerlIO_printf(Perl_debug_log, " isall");
12279     if (r->check_substr || r->check_utf8)
12280         PerlIO_printf(Perl_debug_log, ") ");
12281
12282     if (ri->regstclass) {
12283         regprop(r, sv, ri->regstclass);
12284         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
12285     }
12286     if (r->extflags & RXf_ANCH) {
12287         PerlIO_printf(Perl_debug_log, "anchored");
12288         if (r->extflags & RXf_ANCH_BOL)
12289             PerlIO_printf(Perl_debug_log, "(BOL)");
12290         if (r->extflags & RXf_ANCH_MBOL)
12291             PerlIO_printf(Perl_debug_log, "(MBOL)");
12292         if (r->extflags & RXf_ANCH_SBOL)
12293             PerlIO_printf(Perl_debug_log, "(SBOL)");
12294         if (r->extflags & RXf_ANCH_GPOS)
12295             PerlIO_printf(Perl_debug_log, "(GPOS)");
12296         PerlIO_putc(Perl_debug_log, ' ');
12297     }
12298     if (r->extflags & RXf_GPOS_SEEN)
12299         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
12300     if (r->intflags & PREGf_SKIP)
12301         PerlIO_printf(Perl_debug_log, "plus ");
12302     if (r->intflags & PREGf_IMPLICIT)
12303         PerlIO_printf(Perl_debug_log, "implicit ");
12304     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
12305     if (r->extflags & RXf_EVAL_SEEN)
12306         PerlIO_printf(Perl_debug_log, "with eval ");
12307     PerlIO_printf(Perl_debug_log, "\n");
12308     DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));            
12309 #else
12310     PERL_ARGS_ASSERT_REGDUMP;
12311     PERL_UNUSED_CONTEXT;
12312     PERL_UNUSED_ARG(r);
12313 #endif  /* DEBUGGING */
12314 }
12315
12316 /*
12317 - regprop - printable representation of opcode
12318 */
12319 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
12320 STMT_START { \
12321         if (do_sep) {                           \
12322             Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
12323             if (flags & ANYOF_INVERT)           \
12324                 /*make sure the invert info is in each */ \
12325                 sv_catpvs(sv, "^");             \
12326             do_sep = 0;                         \
12327         }                                       \
12328 } STMT_END
12329
12330 void
12331 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
12332 {
12333 #ifdef DEBUGGING
12334     dVAR;
12335     register int k;
12336     RXi_GET_DECL(prog,progi);
12337     GET_RE_DEBUG_FLAGS_DECL;
12338     
12339     PERL_ARGS_ASSERT_REGPROP;
12340
12341     sv_setpvs(sv, "");
12342
12343     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
12344         /* It would be nice to FAIL() here, but this may be called from
12345            regexec.c, and it would be hard to supply pRExC_state. */
12346         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
12347     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
12348
12349     k = PL_regkind[OP(o)];
12350
12351     if (k == EXACT) {
12352         sv_catpvs(sv, " ");
12353         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
12354          * is a crude hack but it may be the best for now since 
12355          * we have no flag "this EXACTish node was UTF-8" 
12356          * --jhi */
12357         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
12358                   PERL_PV_ESCAPE_UNI_DETECT |
12359                   PERL_PV_ESCAPE_NONASCII   |
12360                   PERL_PV_PRETTY_ELLIPSES   |
12361                   PERL_PV_PRETTY_LTGT       |
12362                   PERL_PV_PRETTY_NOCLEAR
12363                   );
12364     } else if (k == TRIE) {
12365         /* print the details of the trie in dumpuntil instead, as
12366          * progi->data isn't available here */
12367         const char op = OP(o);
12368         const U32 n = ARG(o);
12369         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
12370                (reg_ac_data *)progi->data->data[n] :
12371                NULL;
12372         const reg_trie_data * const trie
12373             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
12374         
12375         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
12376         DEBUG_TRIE_COMPILE_r(
12377             Perl_sv_catpvf(aTHX_ sv,
12378                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
12379                 (UV)trie->startstate,
12380                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
12381                 (UV)trie->wordcount,
12382                 (UV)trie->minlen,
12383                 (UV)trie->maxlen,
12384                 (UV)TRIE_CHARCOUNT(trie),
12385                 (UV)trie->uniquecharcount
12386             )
12387         );
12388         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
12389             int i;
12390             int rangestart = -1;
12391             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
12392             sv_catpvs(sv, "[");
12393             for (i = 0; i <= 256; i++) {
12394                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
12395                     if (rangestart == -1)
12396                         rangestart = i;
12397                 } else if (rangestart != -1) {
12398                     if (i <= rangestart + 3)
12399                         for (; rangestart < i; rangestart++)
12400                             put_byte(sv, rangestart);
12401                     else {
12402                         put_byte(sv, rangestart);
12403                         sv_catpvs(sv, "-");
12404                         put_byte(sv, i - 1);
12405                     }
12406                     rangestart = -1;
12407                 }
12408             }
12409             sv_catpvs(sv, "]");
12410         } 
12411          
12412     } else if (k == CURLY) {
12413         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
12414             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
12415         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
12416     }
12417     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
12418         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
12419     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
12420         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
12421         if ( RXp_PAREN_NAMES(prog) ) {
12422             if ( k != REF || (OP(o) < NREF)) {
12423                 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
12424                 SV **name= av_fetch(list, ARG(o), 0 );
12425                 if (name)
12426                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
12427             }       
12428             else {
12429                 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
12430                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
12431                 I32 *nums=(I32*)SvPVX(sv_dat);
12432                 SV **name= av_fetch(list, nums[0], 0 );
12433                 I32 n;
12434                 if (name) {
12435                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
12436                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
12437                                     (n ? "," : ""), (IV)nums[n]);
12438                     }
12439                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
12440                 }
12441             }
12442         }            
12443     } else if (k == GOSUB) 
12444         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
12445     else if (k == VERB) {
12446         if (!o->flags) 
12447             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
12448                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
12449     } else if (k == LOGICAL)
12450         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
12451     else if (k == ANYOF) {
12452         int i, rangestart = -1;
12453         const U8 flags = ANYOF_FLAGS(o);
12454         int do_sep = 0;
12455
12456         /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
12457         static const char * const anyofs[] = {
12458             "\\w",
12459             "\\W",
12460             "\\s",
12461             "\\S",
12462             "\\d",
12463             "\\D",
12464             "[:alnum:]",
12465             "[:^alnum:]",
12466             "[:alpha:]",
12467             "[:^alpha:]",
12468             "[:ascii:]",
12469             "[:^ascii:]",
12470             "[:cntrl:]",
12471             "[:^cntrl:]",
12472             "[:graph:]",
12473             "[:^graph:]",
12474             "[:lower:]",
12475             "[:^lower:]",
12476             "[:print:]",
12477             "[:^print:]",
12478             "[:punct:]",
12479             "[:^punct:]",
12480             "[:upper:]",
12481             "[:^upper:]",
12482             "[:xdigit:]",
12483             "[:^xdigit:]",
12484             "[:space:]",
12485             "[:^space:]",
12486             "[:blank:]",
12487             "[:^blank:]"
12488         };
12489
12490         if (flags & ANYOF_LOCALE)
12491             sv_catpvs(sv, "{loc}");
12492         if (flags & ANYOF_LOC_NONBITMAP_FOLD)
12493             sv_catpvs(sv, "{i}");
12494         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
12495         if (flags & ANYOF_INVERT)
12496             sv_catpvs(sv, "^");
12497
12498         /* output what the standard cp 0-255 bitmap matches */
12499         for (i = 0; i <= 256; i++) {
12500             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
12501                 if (rangestart == -1)
12502                     rangestart = i;
12503             } else if (rangestart != -1) {
12504                 if (i <= rangestart + 3)
12505                     for (; rangestart < i; rangestart++)
12506                         put_byte(sv, rangestart);
12507                 else {
12508                     put_byte(sv, rangestart);
12509                     sv_catpvs(sv, "-");
12510                     put_byte(sv, i - 1);
12511                 }
12512                 do_sep = 1;
12513                 rangestart = -1;
12514             }
12515         }
12516         
12517         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
12518         /* output any special charclass tests (used entirely under use locale) */
12519         if (ANYOF_CLASS_TEST_ANY_SET(o))
12520             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
12521                 if (ANYOF_CLASS_TEST(o,i)) {
12522                     sv_catpv(sv, anyofs[i]);
12523                     do_sep = 1;
12524                 }
12525         
12526         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
12527         
12528         if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
12529             sv_catpvs(sv, "{non-utf8-latin1-all}");
12530         }
12531
12532         /* output information about the unicode matching */
12533         if (flags & ANYOF_UNICODE_ALL)
12534             sv_catpvs(sv, "{unicode_all}");
12535         else if (ANYOF_NONBITMAP(o))
12536             sv_catpvs(sv, "{unicode}");
12537         if (flags & ANYOF_NONBITMAP_NON_UTF8)
12538             sv_catpvs(sv, "{outside bitmap}");
12539
12540         if (ANYOF_NONBITMAP(o)) {
12541             SV *lv; /* Set if there is something outside the bit map */
12542             SV * const sw = regclass_swash(prog, o, FALSE, &lv, 0);
12543             bool byte_output = FALSE;   /* If something in the bitmap has been
12544                                            output */
12545
12546             if (lv && lv != &PL_sv_undef) {
12547                 if (sw) {
12548                     U8 s[UTF8_MAXBYTES_CASE+1];
12549
12550                     for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
12551                         uvchr_to_utf8(s, i);
12552
12553                         if (i < 256
12554                             && ! ANYOF_BITMAP_TEST(o, i)    /* Don't duplicate
12555                                                                things already
12556                                                                output as part
12557                                                                of the bitmap */
12558                             && swash_fetch(sw, s, TRUE))
12559                         {
12560                             if (rangestart == -1)
12561                                 rangestart = i;
12562                         } else if (rangestart != -1) {
12563                             byte_output = TRUE;
12564                             if (i <= rangestart + 3)
12565                                 for (; rangestart < i; rangestart++) {
12566                                     put_byte(sv, rangestart);
12567                                 }
12568                             else {
12569                                 put_byte(sv, rangestart);
12570                                 sv_catpvs(sv, "-");
12571                                 put_byte(sv, i-1);
12572                             }
12573                             rangestart = -1;
12574                         }
12575                     }
12576                 }
12577
12578                 {
12579                     char *s = savesvpv(lv);
12580                     char * const origs = s;
12581
12582                     while (*s && *s != '\n')
12583                         s++;
12584
12585                     if (*s == '\n') {
12586                         const char * const t = ++s;
12587
12588                         if (byte_output) {
12589                             sv_catpvs(sv, " ");
12590                         }
12591
12592                         while (*s) {
12593                             if (*s == '\n') {
12594
12595                                 /* Truncate very long output */
12596                                 if (s - origs > 256) {
12597                                     Perl_sv_catpvf(aTHX_ sv,
12598                                                    "%.*s...",
12599                                                    (int) (s - origs - 1),
12600                                                    t);
12601                                     goto out_dump;
12602                                 }
12603                                 *s = ' ';
12604                             }
12605                             else if (*s == '\t') {
12606                                 *s = '-';
12607                             }
12608                             s++;
12609                         }
12610                         if (s[-1] == ' ')
12611                             s[-1] = 0;
12612
12613                         sv_catpv(sv, t);
12614                     }
12615
12616                 out_dump:
12617
12618                     Safefree(origs);
12619                 }
12620                 SvREFCNT_dec(lv);
12621             }
12622         }
12623
12624         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
12625     }
12626     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
12627         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
12628 #else
12629     PERL_UNUSED_CONTEXT;
12630     PERL_UNUSED_ARG(sv);
12631     PERL_UNUSED_ARG(o);
12632     PERL_UNUSED_ARG(prog);
12633 #endif  /* DEBUGGING */
12634 }
12635
12636 SV *
12637 Perl_re_intuit_string(pTHX_ REGEXP * const r)
12638 {                               /* Assume that RE_INTUIT is set */
12639     dVAR;
12640     struct regexp *const prog = (struct regexp *)SvANY(r);
12641     GET_RE_DEBUG_FLAGS_DECL;
12642
12643     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
12644     PERL_UNUSED_CONTEXT;
12645
12646     DEBUG_COMPILE_r(
12647         {
12648             const char * const s = SvPV_nolen_const(prog->check_substr
12649                       ? prog->check_substr : prog->check_utf8);
12650
12651             if (!PL_colorset) reginitcolors();
12652             PerlIO_printf(Perl_debug_log,
12653                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
12654                       PL_colors[4],
12655                       prog->check_substr ? "" : "utf8 ",
12656                       PL_colors[5],PL_colors[0],
12657                       s,
12658                       PL_colors[1],
12659                       (strlen(s) > 60 ? "..." : ""));
12660         } );
12661
12662     return prog->check_substr ? prog->check_substr : prog->check_utf8;
12663 }
12664
12665 /* 
12666    pregfree() 
12667    
12668    handles refcounting and freeing the perl core regexp structure. When 
12669    it is necessary to actually free the structure the first thing it 
12670    does is call the 'free' method of the regexp_engine associated to
12671    the regexp, allowing the handling of the void *pprivate; member 
12672    first. (This routine is not overridable by extensions, which is why 
12673    the extensions free is called first.)
12674    
12675    See regdupe and regdupe_internal if you change anything here. 
12676 */
12677 #ifndef PERL_IN_XSUB_RE
12678 void
12679 Perl_pregfree(pTHX_ REGEXP *r)
12680 {
12681     SvREFCNT_dec(r);
12682 }
12683
12684 void
12685 Perl_pregfree2(pTHX_ REGEXP *rx)
12686 {
12687     dVAR;
12688     struct regexp *const r = (struct regexp *)SvANY(rx);
12689     GET_RE_DEBUG_FLAGS_DECL;
12690
12691     PERL_ARGS_ASSERT_PREGFREE2;
12692
12693     if (r->mother_re) {
12694         ReREFCNT_dec(r->mother_re);
12695     } else {
12696         CALLREGFREE_PVT(rx); /* free the private data */
12697         SvREFCNT_dec(RXp_PAREN_NAMES(r));
12698     }        
12699     if (r->substrs) {
12700         SvREFCNT_dec(r->anchored_substr);
12701         SvREFCNT_dec(r->anchored_utf8);
12702         SvREFCNT_dec(r->float_substr);
12703         SvREFCNT_dec(r->float_utf8);
12704         Safefree(r->substrs);
12705     }
12706     RX_MATCH_COPY_FREE(rx);
12707 #ifdef PERL_OLD_COPY_ON_WRITE
12708     SvREFCNT_dec(r->saved_copy);
12709 #endif
12710     Safefree(r->offs);
12711 }
12712
12713 /*  reg_temp_copy()
12714     
12715     This is a hacky workaround to the structural issue of match results
12716     being stored in the regexp structure which is in turn stored in
12717     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
12718     could be PL_curpm in multiple contexts, and could require multiple
12719     result sets being associated with the pattern simultaneously, such
12720     as when doing a recursive match with (??{$qr})
12721     
12722     The solution is to make a lightweight copy of the regexp structure 
12723     when a qr// is returned from the code executed by (??{$qr}) this
12724     lightweight copy doesn't actually own any of its data except for
12725     the starp/end and the actual regexp structure itself. 
12726     
12727 */    
12728     
12729     
12730 REGEXP *
12731 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
12732 {
12733     struct regexp *ret;
12734     struct regexp *const r = (struct regexp *)SvANY(rx);
12735     register const I32 npar = r->nparens+1;
12736
12737     PERL_ARGS_ASSERT_REG_TEMP_COPY;
12738
12739     if (!ret_x)
12740         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
12741     ret = (struct regexp *)SvANY(ret_x);
12742     
12743     (void)ReREFCNT_inc(rx);
12744     /* We can take advantage of the existing "copied buffer" mechanism in SVs
12745        by pointing directly at the buffer, but flagging that the allocated
12746        space in the copy is zero. As we've just done a struct copy, it's now
12747        a case of zero-ing that, rather than copying the current length.  */
12748     SvPV_set(ret_x, RX_WRAPPED(rx));
12749     SvFLAGS(ret_x) |= SvFLAGS(rx) & (SVf_POK|SVp_POK|SVf_UTF8);
12750     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
12751            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
12752     SvLEN_set(ret_x, 0);
12753     SvSTASH_set(ret_x, NULL);
12754     SvMAGIC_set(ret_x, NULL);
12755     Newx(ret->offs, npar, regexp_paren_pair);
12756     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
12757     if (r->substrs) {
12758         Newx(ret->substrs, 1, struct reg_substr_data);
12759         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
12760
12761         SvREFCNT_inc_void(ret->anchored_substr);
12762         SvREFCNT_inc_void(ret->anchored_utf8);
12763         SvREFCNT_inc_void(ret->float_substr);
12764         SvREFCNT_inc_void(ret->float_utf8);
12765
12766         /* check_substr and check_utf8, if non-NULL, point to either their
12767            anchored or float namesakes, and don't hold a second reference.  */
12768     }
12769     RX_MATCH_COPIED_off(ret_x);
12770 #ifdef PERL_OLD_COPY_ON_WRITE
12771     ret->saved_copy = NULL;
12772 #endif
12773     ret->mother_re = rx;
12774     
12775     return ret_x;
12776 }
12777 #endif
12778
12779 /* regfree_internal() 
12780
12781    Free the private data in a regexp. This is overloadable by 
12782    extensions. Perl takes care of the regexp structure in pregfree(), 
12783    this covers the *pprivate pointer which technically perl doesn't 
12784    know about, however of course we have to handle the 
12785    regexp_internal structure when no extension is in use. 
12786    
12787    Note this is called before freeing anything in the regexp 
12788    structure. 
12789  */
12790  
12791 void
12792 Perl_regfree_internal(pTHX_ REGEXP * const rx)
12793 {
12794     dVAR;
12795     struct regexp *const r = (struct regexp *)SvANY(rx);
12796     RXi_GET_DECL(r,ri);
12797     GET_RE_DEBUG_FLAGS_DECL;
12798
12799     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
12800
12801     DEBUG_COMPILE_r({
12802         if (!PL_colorset)
12803             reginitcolors();
12804         {
12805             SV *dsv= sv_newmortal();
12806             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
12807                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
12808             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
12809                 PL_colors[4],PL_colors[5],s);
12810         }
12811     });
12812 #ifdef RE_TRACK_PATTERN_OFFSETS
12813     if (ri->u.offsets)
12814         Safefree(ri->u.offsets);             /* 20010421 MJD */
12815 #endif
12816     if (ri->data) {
12817         int n = ri->data->count;
12818         PAD* new_comppad = NULL;
12819         PAD* old_comppad;
12820         PADOFFSET refcnt;
12821
12822         while (--n >= 0) {
12823           /* If you add a ->what type here, update the comment in regcomp.h */
12824             switch (ri->data->what[n]) {
12825             case 'a':
12826             case 's':
12827             case 'S':
12828             case 'u':
12829                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
12830                 break;
12831             case 'f':
12832                 Safefree(ri->data->data[n]);
12833                 break;
12834             case 'p':
12835                 new_comppad = MUTABLE_AV(ri->data->data[n]);
12836                 break;
12837             case 'o':
12838                 if (new_comppad == NULL)
12839                     Perl_croak(aTHX_ "panic: pregfree comppad");
12840                 PAD_SAVE_LOCAL(old_comppad,
12841                     /* Watch out for global destruction's random ordering. */
12842                     (SvTYPE(new_comppad) == SVt_PVAV) ? new_comppad : NULL
12843                 );
12844                 OP_REFCNT_LOCK;
12845                 refcnt = OpREFCNT_dec((OP_4tree*)ri->data->data[n]);
12846                 OP_REFCNT_UNLOCK;
12847                 if (!refcnt)
12848                     op_free((OP_4tree*)ri->data->data[n]);
12849
12850                 PAD_RESTORE_LOCAL(old_comppad);
12851                 SvREFCNT_dec(MUTABLE_SV(new_comppad));
12852                 new_comppad = NULL;
12853                 break;
12854             case 'n':
12855                 break;
12856             case 'T':           
12857                 { /* Aho Corasick add-on structure for a trie node.
12858                      Used in stclass optimization only */
12859                     U32 refcount;
12860                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
12861                     OP_REFCNT_LOCK;
12862                     refcount = --aho->refcount;
12863                     OP_REFCNT_UNLOCK;
12864                     if ( !refcount ) {
12865                         PerlMemShared_free(aho->states);
12866                         PerlMemShared_free(aho->fail);
12867                          /* do this last!!!! */
12868                         PerlMemShared_free(ri->data->data[n]);
12869                         PerlMemShared_free(ri->regstclass);
12870                     }
12871                 }
12872                 break;
12873             case 't':
12874                 {
12875                     /* trie structure. */
12876                     U32 refcount;
12877                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
12878                     OP_REFCNT_LOCK;
12879                     refcount = --trie->refcount;
12880                     OP_REFCNT_UNLOCK;
12881                     if ( !refcount ) {
12882                         PerlMemShared_free(trie->charmap);
12883                         PerlMemShared_free(trie->states);
12884                         PerlMemShared_free(trie->trans);
12885                         if (trie->bitmap)
12886                             PerlMemShared_free(trie->bitmap);
12887                         if (trie->jump)
12888                             PerlMemShared_free(trie->jump);
12889                         PerlMemShared_free(trie->wordinfo);
12890                         /* do this last!!!! */
12891                         PerlMemShared_free(ri->data->data[n]);
12892                     }
12893                 }
12894                 break;
12895             default:
12896                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
12897             }
12898         }
12899         Safefree(ri->data->what);
12900         Safefree(ri->data);
12901     }
12902
12903     Safefree(ri);
12904 }
12905
12906 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
12907 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
12908 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
12909
12910 /* 
12911    re_dup - duplicate a regexp. 
12912    
12913    This routine is expected to clone a given regexp structure. It is only
12914    compiled under USE_ITHREADS.
12915
12916    After all of the core data stored in struct regexp is duplicated
12917    the regexp_engine.dupe method is used to copy any private data
12918    stored in the *pprivate pointer. This allows extensions to handle
12919    any duplication it needs to do.
12920
12921    See pregfree() and regfree_internal() if you change anything here. 
12922 */
12923 #if defined(USE_ITHREADS)
12924 #ifndef PERL_IN_XSUB_RE
12925 void
12926 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
12927 {
12928     dVAR;
12929     I32 npar;
12930     const struct regexp *r = (const struct regexp *)SvANY(sstr);
12931     struct regexp *ret = (struct regexp *)SvANY(dstr);
12932     
12933     PERL_ARGS_ASSERT_RE_DUP_GUTS;
12934
12935     npar = r->nparens+1;
12936     Newx(ret->offs, npar, regexp_paren_pair);
12937     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
12938     if(ret->swap) {
12939         /* no need to copy these */
12940         Newx(ret->swap, npar, regexp_paren_pair);
12941     }
12942
12943     if (ret->substrs) {
12944         /* Do it this way to avoid reading from *r after the StructCopy().
12945            That way, if any of the sv_dup_inc()s dislodge *r from the L1
12946            cache, it doesn't matter.  */
12947         const bool anchored = r->check_substr
12948             ? r->check_substr == r->anchored_substr
12949             : r->check_utf8 == r->anchored_utf8;
12950         Newx(ret->substrs, 1, struct reg_substr_data);
12951         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
12952
12953         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
12954         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
12955         ret->float_substr = sv_dup_inc(ret->float_substr, param);
12956         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
12957
12958         /* check_substr and check_utf8, if non-NULL, point to either their
12959            anchored or float namesakes, and don't hold a second reference.  */
12960
12961         if (ret->check_substr) {
12962             if (anchored) {
12963                 assert(r->check_utf8 == r->anchored_utf8);
12964                 ret->check_substr = ret->anchored_substr;
12965                 ret->check_utf8 = ret->anchored_utf8;
12966             } else {
12967                 assert(r->check_substr == r->float_substr);
12968                 assert(r->check_utf8 == r->float_utf8);
12969                 ret->check_substr = ret->float_substr;
12970                 ret->check_utf8 = ret->float_utf8;
12971             }
12972         } else if (ret->check_utf8) {
12973             if (anchored) {
12974                 ret->check_utf8 = ret->anchored_utf8;
12975             } else {
12976                 ret->check_utf8 = ret->float_utf8;
12977             }
12978         }
12979     }
12980
12981     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
12982
12983     if (ret->pprivate)
12984         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
12985
12986     if (RX_MATCH_COPIED(dstr))
12987         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
12988     else
12989         ret->subbeg = NULL;
12990 #ifdef PERL_OLD_COPY_ON_WRITE
12991     ret->saved_copy = NULL;
12992 #endif
12993
12994     if (ret->mother_re) {
12995         if (SvPVX_const(dstr) == SvPVX_const(ret->mother_re)) {
12996             /* Our storage points directly to our mother regexp, but that's
12997                1: a buffer in a different thread
12998                2: something we no longer hold a reference on
12999                so we need to copy it locally.  */
13000             /* Note we need to use SvCUR(), rather than
13001                SvLEN(), on our mother_re, because it, in
13002                turn, may well be pointing to its own mother_re.  */
13003             SvPV_set(dstr, SAVEPVN(SvPVX_const(ret->mother_re),
13004                                    SvCUR(ret->mother_re)+1));
13005             SvLEN_set(dstr, SvCUR(ret->mother_re)+1);
13006         }
13007         ret->mother_re      = NULL;
13008     }
13009     ret->gofs = 0;
13010 }
13011 #endif /* PERL_IN_XSUB_RE */
13012
13013 /*
13014    regdupe_internal()
13015    
13016    This is the internal complement to regdupe() which is used to copy
13017    the structure pointed to by the *pprivate pointer in the regexp.
13018    This is the core version of the extension overridable cloning hook.
13019    The regexp structure being duplicated will be copied by perl prior
13020    to this and will be provided as the regexp *r argument, however 
13021    with the /old/ structures pprivate pointer value. Thus this routine
13022    may override any copying normally done by perl.
13023    
13024    It returns a pointer to the new regexp_internal structure.
13025 */
13026
13027 void *
13028 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
13029 {
13030     dVAR;
13031     struct regexp *const r = (struct regexp *)SvANY(rx);
13032     regexp_internal *reti;
13033     int len;
13034     RXi_GET_DECL(r,ri);
13035
13036     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
13037     
13038     len = ProgLen(ri);
13039     
13040     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
13041     Copy(ri->program, reti->program, len+1, regnode);
13042     
13043
13044     reti->regstclass = NULL;
13045
13046     if (ri->data) {
13047         struct reg_data *d;
13048         const int count = ri->data->count;
13049         int i;
13050
13051         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
13052                 char, struct reg_data);
13053         Newx(d->what, count, U8);
13054
13055         d->count = count;
13056         for (i = 0; i < count; i++) {
13057             d->what[i] = ri->data->what[i];
13058             switch (d->what[i]) {
13059                 /* legal options are one of: sSfpontTua
13060                    see also regcomp.h and pregfree() */
13061             case 'a': /* actually an AV, but the dup function is identical.  */
13062             case 's':
13063             case 'S':
13064             case 'p': /* actually an AV, but the dup function is identical.  */
13065             case 'u': /* actually an HV, but the dup function is identical.  */
13066                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
13067                 break;
13068             case 'f':
13069                 /* This is cheating. */
13070                 Newx(d->data[i], 1, struct regnode_charclass_class);
13071                 StructCopy(ri->data->data[i], d->data[i],
13072                             struct regnode_charclass_class);
13073                 reti->regstclass = (regnode*)d->data[i];
13074                 break;
13075             case 'o':
13076                 /* Compiled op trees are readonly and in shared memory,
13077                    and can thus be shared without duplication. */
13078                 OP_REFCNT_LOCK;
13079                 d->data[i] = (void*)OpREFCNT_inc((OP*)ri->data->data[i]);
13080                 OP_REFCNT_UNLOCK;
13081                 break;
13082             case 'T':
13083                 /* Trie stclasses are readonly and can thus be shared
13084                  * without duplication. We free the stclass in pregfree
13085                  * when the corresponding reg_ac_data struct is freed.
13086                  */
13087                 reti->regstclass= ri->regstclass;
13088                 /* Fall through */
13089             case 't':
13090                 OP_REFCNT_LOCK;
13091                 ((reg_trie_data*)ri->data->data[i])->refcount++;
13092                 OP_REFCNT_UNLOCK;
13093                 /* Fall through */
13094             case 'n':
13095                 d->data[i] = ri->data->data[i];
13096                 break;
13097             default:
13098                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
13099             }
13100         }
13101
13102         reti->data = d;
13103     }
13104     else
13105         reti->data = NULL;
13106
13107     reti->name_list_idx = ri->name_list_idx;
13108
13109 #ifdef RE_TRACK_PATTERN_OFFSETS
13110     if (ri->u.offsets) {
13111         Newx(reti->u.offsets, 2*len+1, U32);
13112         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
13113     }
13114 #else
13115     SetProgLen(reti,len);
13116 #endif
13117
13118     return (void*)reti;
13119 }
13120
13121 #endif    /* USE_ITHREADS */
13122
13123 #ifndef PERL_IN_XSUB_RE
13124
13125 /*
13126  - regnext - dig the "next" pointer out of a node
13127  */
13128 regnode *
13129 Perl_regnext(pTHX_ register regnode *p)
13130 {
13131     dVAR;
13132     register I32 offset;
13133
13134     if (!p)
13135         return(NULL);
13136
13137     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
13138         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
13139     }
13140
13141     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
13142     if (offset == 0)
13143         return(NULL);
13144
13145     return(p+offset);
13146 }
13147 #endif
13148
13149 STATIC void
13150 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
13151 {
13152     va_list args;
13153     STRLEN l1 = strlen(pat1);
13154     STRLEN l2 = strlen(pat2);
13155     char buf[512];
13156     SV *msv;
13157     const char *message;
13158
13159     PERL_ARGS_ASSERT_RE_CROAK2;
13160
13161     if (l1 > 510)
13162         l1 = 510;
13163     if (l1 + l2 > 510)
13164         l2 = 510 - l1;
13165     Copy(pat1, buf, l1 , char);
13166     Copy(pat2, buf + l1, l2 , char);
13167     buf[l1 + l2] = '\n';
13168     buf[l1 + l2 + 1] = '\0';
13169 #ifdef I_STDARG
13170     /* ANSI variant takes additional second argument */
13171     va_start(args, pat2);
13172 #else
13173     va_start(args);
13174 #endif
13175     msv = vmess(buf, &args);
13176     va_end(args);
13177     message = SvPV_const(msv,l1);
13178     if (l1 > 512)
13179         l1 = 512;
13180     Copy(message, buf, l1 , char);
13181     buf[l1-1] = '\0';                   /* Overwrite \n */
13182     Perl_croak(aTHX_ "%s", buf);
13183 }
13184
13185 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
13186
13187 #ifndef PERL_IN_XSUB_RE
13188 void
13189 Perl_save_re_context(pTHX)
13190 {
13191     dVAR;
13192
13193     struct re_save_state *state;
13194
13195     SAVEVPTR(PL_curcop);
13196     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
13197
13198     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
13199     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
13200     SSPUSHUV(SAVEt_RE_STATE);
13201
13202     Copy(&PL_reg_state, state, 1, struct re_save_state);
13203
13204     PL_reg_start_tmp = 0;
13205     PL_reg_start_tmpl = 0;
13206     PL_reg_oldsaved = NULL;
13207     PL_reg_oldsavedlen = 0;
13208     PL_reg_maxiter = 0;
13209     PL_reg_leftiter = 0;
13210     PL_reg_poscache = NULL;
13211     PL_reg_poscache_size = 0;
13212 #ifdef PERL_OLD_COPY_ON_WRITE
13213     PL_nrs = NULL;
13214 #endif
13215
13216     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
13217     if (PL_curpm) {
13218         const REGEXP * const rx = PM_GETRE(PL_curpm);
13219         if (rx) {
13220             U32 i;
13221             for (i = 1; i <= RX_NPARENS(rx); i++) {
13222                 char digits[TYPE_CHARS(long)];
13223                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
13224                 GV *const *const gvp
13225                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
13226
13227                 if (gvp) {
13228                     GV * const gv = *gvp;
13229                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
13230                         save_scalar(gv);
13231                 }
13232             }
13233         }
13234     }
13235 }
13236 #endif
13237
13238 static void
13239 clear_re(pTHX_ void *r)
13240 {
13241     dVAR;
13242     ReREFCNT_dec((REGEXP *)r);
13243 }
13244
13245 #ifdef DEBUGGING
13246
13247 STATIC void
13248 S_put_byte(pTHX_ SV *sv, int c)
13249 {
13250     PERL_ARGS_ASSERT_PUT_BYTE;
13251
13252     /* Our definition of isPRINT() ignores locales, so only bytes that are
13253        not part of UTF-8 are considered printable. I assume that the same
13254        holds for UTF-EBCDIC.
13255        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
13256        which Wikipedia says:
13257
13258        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
13259        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
13260        identical, to the ASCII delete (DEL) or rubout control character.
13261        ) So the old condition can be simplified to !isPRINT(c)  */
13262     if (!isPRINT(c)) {
13263         if (c < 256) {
13264             Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
13265         }
13266         else {
13267             Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
13268         }
13269     }
13270     else {
13271         const char string = c;
13272         if (c == '-' || c == ']' || c == '\\' || c == '^')
13273             sv_catpvs(sv, "\\");
13274         sv_catpvn(sv, &string, 1);
13275     }
13276 }
13277
13278
13279 #define CLEAR_OPTSTART \
13280     if (optstart) STMT_START { \
13281             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
13282             optstart=NULL; \
13283     } STMT_END
13284
13285 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
13286
13287 STATIC const regnode *
13288 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
13289             const regnode *last, const regnode *plast, 
13290             SV* sv, I32 indent, U32 depth)
13291 {
13292     dVAR;
13293     register U8 op = PSEUDO;    /* Arbitrary non-END op. */
13294     register const regnode *next;
13295     const regnode *optstart= NULL;
13296     
13297     RXi_GET_DECL(r,ri);
13298     GET_RE_DEBUG_FLAGS_DECL;
13299
13300     PERL_ARGS_ASSERT_DUMPUNTIL;
13301
13302 #ifdef DEBUG_DUMPUNTIL
13303     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
13304         last ? last-start : 0,plast ? plast-start : 0);
13305 #endif
13306             
13307     if (plast && plast < last) 
13308         last= plast;
13309
13310     while (PL_regkind[op] != END && (!last || node < last)) {
13311         /* While that wasn't END last time... */
13312         NODE_ALIGN(node);
13313         op = OP(node);
13314         if (op == CLOSE || op == WHILEM)
13315             indent--;
13316         next = regnext((regnode *)node);
13317
13318         /* Where, what. */
13319         if (OP(node) == OPTIMIZED) {
13320             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
13321                 optstart = node;
13322             else
13323                 goto after_print;
13324         } else
13325             CLEAR_OPTSTART;
13326
13327         regprop(r, sv, node);
13328         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
13329                       (int)(2*indent + 1), "", SvPVX_const(sv));
13330         
13331         if (OP(node) != OPTIMIZED) {                  
13332             if (next == NULL)           /* Next ptr. */
13333                 PerlIO_printf(Perl_debug_log, " (0)");
13334             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
13335                 PerlIO_printf(Perl_debug_log, " (FAIL)");
13336             else 
13337                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
13338             (void)PerlIO_putc(Perl_debug_log, '\n'); 
13339         }
13340         
13341       after_print:
13342         if (PL_regkind[(U8)op] == BRANCHJ) {
13343             assert(next);
13344             {
13345                 register const regnode *nnode = (OP(next) == LONGJMP
13346                                              ? regnext((regnode *)next)
13347                                              : next);
13348                 if (last && nnode > last)
13349                     nnode = last;
13350                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
13351             }
13352         }
13353         else if (PL_regkind[(U8)op] == BRANCH) {
13354             assert(next);
13355             DUMPUNTIL(NEXTOPER(node), next);
13356         }
13357         else if ( PL_regkind[(U8)op]  == TRIE ) {
13358             const regnode *this_trie = node;
13359             const char op = OP(node);
13360             const U32 n = ARG(node);
13361             const reg_ac_data * const ac = op>=AHOCORASICK ?
13362                (reg_ac_data *)ri->data->data[n] :
13363                NULL;
13364             const reg_trie_data * const trie =
13365                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
13366 #ifdef DEBUGGING
13367             AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
13368 #endif
13369             const regnode *nextbranch= NULL;
13370             I32 word_idx;
13371             sv_setpvs(sv, "");
13372             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
13373                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
13374
13375                 PerlIO_printf(Perl_debug_log, "%*s%s ",
13376                    (int)(2*(indent+3)), "",
13377                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
13378                             PL_colors[0], PL_colors[1],
13379                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
13380                             PERL_PV_PRETTY_ELLIPSES    |
13381                             PERL_PV_PRETTY_LTGT
13382                             )
13383                             : "???"
13384                 );
13385                 if (trie->jump) {
13386                     U16 dist= trie->jump[word_idx+1];
13387                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
13388                                   (UV)((dist ? this_trie + dist : next) - start));
13389                     if (dist) {
13390                         if (!nextbranch)
13391                             nextbranch= this_trie + trie->jump[0];    
13392                         DUMPUNTIL(this_trie + dist, nextbranch);
13393                     }
13394                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
13395                         nextbranch= regnext((regnode *)nextbranch);
13396                 } else {
13397                     PerlIO_printf(Perl_debug_log, "\n");
13398                 }
13399             }
13400             if (last && next > last)
13401                 node= last;
13402             else
13403                 node= next;
13404         }
13405         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
13406             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
13407                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
13408         }
13409         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
13410             assert(next);
13411             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
13412         }
13413         else if ( op == PLUS || op == STAR) {
13414             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
13415         }
13416         else if (PL_regkind[(U8)op] == ANYOF) {
13417             /* arglen 1 + class block */
13418             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
13419                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
13420             node = NEXTOPER(node);
13421         }
13422         else if (PL_regkind[(U8)op] == EXACT) {
13423             /* Literal string, where present. */
13424             node += NODE_SZ_STR(node) - 1;
13425             node = NEXTOPER(node);
13426         }
13427         else {
13428             node = NEXTOPER(node);
13429             node += regarglen[(U8)op];
13430         }
13431         if (op == CURLYX || op == OPEN)
13432             indent++;
13433     }
13434     CLEAR_OPTSTART;
13435 #ifdef DEBUG_DUMPUNTIL    
13436     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
13437 #endif
13438     return node;
13439 }
13440
13441 #endif  /* DEBUGGING */
13442
13443 /*
13444  * Local variables:
13445  * c-indentation-style: bsd
13446  * c-basic-offset: 4
13447  * indent-tabs-mode: t
13448  * End:
13449  *
13450  * ex: set ts=8 sts=4 sw=4 noet:
13451  */