This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regcomp.c: Fix <if> condition
[perl5.git] / regcomp.c
CommitLineData
a0d0e21e
LW
1/* regcomp.c
2 */
3
4/*
4ac71550
TC
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"]
a0d0e21e
LW
8 */
9
61296642
DM
10/* This file contains functions for compiling a regular expression. See
11 * also regexec.c which funnily enough, contains functions for executing
166f8a29 12 * a regular expression.
e4a054ea
DM
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.
166f8a29
DM
18 */
19
a687059c
LW
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
e50aee73 29/* The names of the functions have been changed from regcomp and
3b753521 30 * regexec to pregcomp and pregexec in order to avoid conflicts
e50aee73
AD
31 * with the POSIX routines of the same names.
32*/
33
b9d5759e 34#ifdef PERL_EXT_RE_BUILD
54df2634 35#include "re_top.h"
b81d288d 36#endif
56953603 37
a687059c 38/*
e50aee73 39 * pregcomp and pregexec -- regsub and regerror are not used in perl
a687059c
LW
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 ****
4bb101f2 61 **** Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
1129b882
NC
62 **** 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63 **** by Larry Wall and others
a687059c 64 ****
9ef589d8
LW
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
a687059c
LW
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"
864dbfa3 74#define PERL_IN_REGCOMP_C
a687059c 75#include "perl.h"
d06ea78c 76
acfe0abc 77#ifndef PERL_IN_XSUB_RE
d06ea78c
GS
78# include "INTERN.h"
79#endif
c277df42
IZ
80
81#define REG_COMP_C
54df2634
NC
82#ifdef PERL_IN_XSUB_RE
83# include "re_comp.h"
84#else
85# include "regcomp.h"
86#endif
a687059c 87
04e98a4d 88#include "dquote_static.c"
370b8f2f
TC
89#ifndef PERL_IN_XSUB_RE
90# include "charclass_invlists.h"
91#endif
04e98a4d 92
94dc5c2d
KW
93#define HAS_NONLATIN1_FOLD_CLOSURE(i) _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
94
d4cce5f1 95#ifdef op
11343788 96#undef op
d4cce5f1 97#endif /* op */
11343788 98
fe14fcc3 99#ifdef MSDOS
7e4e8c89 100# if defined(BUGGY_MSC6)
fe14fcc3 101 /* MSC 6.00A breaks on op/regexp.t test 85 unless we turn this off */
7e4e8c89 102# pragma optimize("a",off)
fe14fcc3 103 /* But MSC 6.00A is happy with 'w', for aliases only across function calls*/
7e4e8c89
NC
104# pragma optimize("w",on )
105# endif /* BUGGY_MSC6 */
fe14fcc3
LW
106#endif /* MSDOS */
107
a687059c
LW
108#ifndef STATIC
109#define STATIC static
110#endif
111
b1603ef8 112
830247a4 113typedef struct RExC_state_t {
514a91f1
DM
114 U32 flags; /* RXf_* are we folding, multilining? */
115 U32 pm_flags; /* PMf_* stuff from the calling PMOP */
830247a4 116 char *precomp; /* uncompiled string. */
288b8c02 117 REGEXP *rx_sv; /* The SV that is the regexp. */
f8fc2ecf
YO
118 regexp *rx; /* perl core regexp structure */
119 regexp_internal *rxi; /* internal data for regexp object pprivate field */
fac92740 120 char *start; /* Start of input for compile */
830247a4
IZ
121 char *end; /* End of input for compile */
122 char *parse; /* Input-scan pointer. */
123 I32 whilem_seen; /* number of WHILEM in this expr */
fac92740 124 regnode *emit_start; /* Start of emitted-code area */
3b57cd43 125 regnode *emit_bound; /* First regnode outside of the allocated space */
ffc61ed2 126 regnode *emit; /* Code-emit pointer; &regdummy = don't = compiling */
830247a4
IZ
127 I32 naughty; /* How bad is this pattern? */
128 I32 sawback; /* Did we see \1, ...? */
129 U32 seen;
130 I32 size; /* Code size. */
c74340f9
YO
131 I32 npar; /* Capture buffer count, (OPEN). */
132 I32 cpar; /* Capture buffer count, (CLOSE). */
e2e6a0f1 133 I32 nestroot; /* root parens we are in - used by accept */
830247a4
IZ
134 I32 extralen;
135 I32 seen_zerolen;
40d049e4
YO
136 regnode **open_parens; /* pointers to open parens */
137 regnode **close_parens; /* pointers to close parens */
138 regnode *opend; /* END node in program */
02daf0ab
YO
139 I32 utf8; /* whether the pattern is utf8 or not */
140 I32 orig_utf8; /* whether the pattern was originally in utf8 */
141 /* XXX use this for future optimisation of case
142 * where pattern must be upgraded to utf8. */
e40e74fe
KW
143 I32 uni_semantics; /* If a d charset modifier should use unicode
144 rules, even if the pattern is not in
145 utf8 */
81714fb9 146 HV *paren_names; /* Paren names */
1f1031fe 147
40d049e4
YO
148 regnode **recurse; /* Recurse regops */
149 I32 recurse_count; /* Number of recurse regops */
b57e4118 150 I32 in_lookbehind;
4624b182 151 I32 contains_locale;
bb3f3ed2 152 I32 override_recoding;
3d2bd50a 153 struct reg_code_block *code_blocks; /* positions of literal (?{})
68e2671b 154 within pattern */
b1603ef8
DM
155 int num_code_blocks; /* size of code_blocks[] */
156 int code_index; /* next code_blocks[] slot */
830247a4
IZ
157#if ADD_TO_REGEXEC
158 char *starttry; /* -Dr: where regtry was called. */
159#define RExC_starttry (pRExC_state->starttry)
160#endif
d24ca0c5 161 SV *runtime_code_qr; /* qr with the runtime code blocks */
3dab1dad 162#ifdef DEBUGGING
be8e71aa 163 const char *lastparse;
3dab1dad 164 I32 lastnum;
1f1031fe 165 AV *paren_name_list; /* idx -> name */
3dab1dad
YO
166#define RExC_lastparse (pRExC_state->lastparse)
167#define RExC_lastnum (pRExC_state->lastnum)
1f1031fe 168#define RExC_paren_name_list (pRExC_state->paren_name_list)
3dab1dad 169#endif
830247a4
IZ
170} RExC_state_t;
171
e2509266 172#define RExC_flags (pRExC_state->flags)
514a91f1 173#define RExC_pm_flags (pRExC_state->pm_flags)
830247a4 174#define RExC_precomp (pRExC_state->precomp)
288b8c02 175#define RExC_rx_sv (pRExC_state->rx_sv)
830247a4 176#define RExC_rx (pRExC_state->rx)
f8fc2ecf 177#define RExC_rxi (pRExC_state->rxi)
fac92740 178#define RExC_start (pRExC_state->start)
830247a4
IZ
179#define RExC_end (pRExC_state->end)
180#define RExC_parse (pRExC_state->parse)
181#define RExC_whilem_seen (pRExC_state->whilem_seen)
7122b237
YO
182#ifdef RE_TRACK_PATTERN_OFFSETS
183#define RExC_offsets (pRExC_state->rxi->u.offsets) /* I am not like the others */
184#endif
830247a4 185#define RExC_emit (pRExC_state->emit)
fac92740 186#define RExC_emit_start (pRExC_state->emit_start)
3b57cd43 187#define RExC_emit_bound (pRExC_state->emit_bound)
830247a4
IZ
188#define RExC_naughty (pRExC_state->naughty)
189#define RExC_sawback (pRExC_state->sawback)
190#define RExC_seen (pRExC_state->seen)
191#define RExC_size (pRExC_state->size)
192#define RExC_npar (pRExC_state->npar)
e2e6a0f1 193#define RExC_nestroot (pRExC_state->nestroot)
830247a4
IZ
194#define RExC_extralen (pRExC_state->extralen)
195#define RExC_seen_zerolen (pRExC_state->seen_zerolen)
1aa99e6b 196#define RExC_utf8 (pRExC_state->utf8)
e40e74fe 197#define RExC_uni_semantics (pRExC_state->uni_semantics)
02daf0ab 198#define RExC_orig_utf8 (pRExC_state->orig_utf8)
40d049e4
YO
199#define RExC_open_parens (pRExC_state->open_parens)
200#define RExC_close_parens (pRExC_state->close_parens)
201#define RExC_opend (pRExC_state->opend)
81714fb9 202#define RExC_paren_names (pRExC_state->paren_names)
40d049e4
YO
203#define RExC_recurse (pRExC_state->recurse)
204#define RExC_recurse_count (pRExC_state->recurse_count)
b57e4118 205#define RExC_in_lookbehind (pRExC_state->in_lookbehind)
4624b182 206#define RExC_contains_locale (pRExC_state->contains_locale)
bb3f3ed2 207#define RExC_override_recoding (pRExC_state->override_recoding)
830247a4 208
cde0cee5 209
a687059c
LW
210#define ISMULT1(c) ((c) == '*' || (c) == '+' || (c) == '?')
211#define ISMULT2(s) ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
212 ((*s) == '{' && regcurly(s)))
a687059c 213
35c8bce7
LW
214#ifdef SPSTART
215#undef SPSTART /* dratted cpp namespace... */
216#endif
a687059c
LW
217/*
218 * Flags to be passed up and down.
219 */
a687059c 220#define WORST 0 /* Worst case. */
a3b492c3 221#define HASWIDTH 0x01 /* Known to match non-null strings. */
fda99bee 222
18890cbd 223/* Simple enough to be STAR/PLUS operand; in an EXACT node must be a single
cf8c372d
KW
224 * character, and if utf8, must be invariant. Note that this is not the same
225 * thing as REGNODE_SIMPLE */
fda99bee 226#define SIMPLE 0x02
a3b492c3
YO
227#define SPSTART 0x04 /* Starts with * or +. */
228#define TRYAGAIN 0x08 /* Weeded out a declaration. */
229#define POSTPONED 0x10 /* (?1),(?&name), (??{...}) or similar */
a687059c 230
3dab1dad
YO
231#define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
232
07be1b83
YO
233/* whether trie related optimizations are enabled */
234#if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
235#define TRIE_STUDY_OPT
786e8c11 236#define FULL_TRIE_STUDY
07be1b83
YO
237#define TRIE_STCLASS
238#endif
1de06328
YO
239
240
40d049e4
YO
241
242#define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
243#define PBITVAL(paren) (1 << ((paren) & 7))
244#define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
245#define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
246#define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
247
bbd61b5f
KW
248/* If not already in utf8, do a longjmp back to the beginning */
249#define UTF8_LONGJMP 42 /* Choose a value not likely to ever conflict */
250#define REQUIRE_UTF8 STMT_START { \
251 if (! UTF) JMPENV_JUMP(UTF8_LONGJMP); \
252 } STMT_END
40d049e4 253
1de06328
YO
254/* About scan_data_t.
255
256 During optimisation we recurse through the regexp program performing
257 various inplace (keyhole style) optimisations. In addition study_chunk
258 and scan_commit populate this data structure with information about
259 what strings MUST appear in the pattern. We look for the longest
3b753521 260 string that must appear at a fixed location, and we look for the
1de06328
YO
261 longest string that may appear at a floating location. So for instance
262 in the pattern:
263
264 /FOO[xX]A.*B[xX]BAR/
265
266 Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
267 strings (because they follow a .* construct). study_chunk will identify
268 both FOO and BAR as being the longest fixed and floating strings respectively.
269
270 The strings can be composites, for instance
271
272 /(f)(o)(o)/
273
274 will result in a composite fixed substring 'foo'.
275
276 For each string some basic information is maintained:
277
278 - offset or min_offset
279 This is the position the string must appear at, or not before.
280 It also implicitly (when combined with minlenp) tells us how many
3b753521
FN
281 characters must match before the string we are searching for.
282 Likewise when combined with minlenp and the length of the string it
1de06328
YO
283 tells us how many characters must appear after the string we have
284 found.
285
286 - max_offset
287 Only used for floating strings. This is the rightmost point that
3b753521 288 the string can appear at. If set to I32 max it indicates that the
1de06328
YO
289 string can occur infinitely far to the right.
290
291 - minlenp
292 A pointer to the minimum length of the pattern that the string
293 was found inside. This is important as in the case of positive
294 lookahead or positive lookbehind we can have multiple patterns
295 involved. Consider
296
297 /(?=FOO).*F/
298
299 The minimum length of the pattern overall is 3, the minimum length
300 of the lookahead part is 3, but the minimum length of the part that
301 will actually match is 1. So 'FOO's minimum length is 3, but the
302 minimum length for the F is 1. This is important as the minimum length
303 is used to determine offsets in front of and behind the string being
304 looked for. Since strings can be composites this is the length of the
486ec47a 305 pattern at the time it was committed with a scan_commit. Note that
1de06328
YO
306 the length is calculated by study_chunk, so that the minimum lengths
307 are not known until the full pattern has been compiled, thus the
308 pointer to the value.
309
310 - lookbehind
311
312 In the case of lookbehind the string being searched for can be
313 offset past the start point of the final matching string.
314 If this value was just blithely removed from the min_offset it would
315 invalidate some of the calculations for how many chars must match
316 before or after (as they are derived from min_offset and minlen and
317 the length of the string being searched for).
318 When the final pattern is compiled and the data is moved from the
319 scan_data_t structure into the regexp structure the information
320 about lookbehind is factored in, with the information that would
321 have been lost precalculated in the end_shift field for the
322 associated string.
323
324 The fields pos_min and pos_delta are used to store the minimum offset
325 and the delta to the maximum offset at the current point in the pattern.
326
327*/
2c2d71f5
JH
328
329typedef struct scan_data_t {
1de06328
YO
330 /*I32 len_min; unused */
331 /*I32 len_delta; unused */
2c2d71f5
JH
332 I32 pos_min;
333 I32 pos_delta;
334 SV *last_found;
1de06328 335 I32 last_end; /* min value, <0 unless valid. */
2c2d71f5
JH
336 I32 last_start_min;
337 I32 last_start_max;
1de06328
YO
338 SV **longest; /* Either &l_fixed, or &l_float. */
339 SV *longest_fixed; /* longest fixed string found in pattern */
340 I32 offset_fixed; /* offset where it starts */
486ec47a 341 I32 *minlen_fixed; /* pointer to the minlen relevant to the string */
1de06328
YO
342 I32 lookbehind_fixed; /* is the position of the string modfied by LB */
343 SV *longest_float; /* longest floating string found in pattern */
344 I32 offset_float_min; /* earliest point in string it can appear */
345 I32 offset_float_max; /* latest point in string it can appear */
486ec47a 346 I32 *minlen_float; /* pointer to the minlen relevant to the string */
1de06328 347 I32 lookbehind_float; /* is the position of the string modified by LB */
2c2d71f5
JH
348 I32 flags;
349 I32 whilem_c;
cb434fcc 350 I32 *last_closep;
653099ff 351 struct regnode_charclass_class *start_class;
2c2d71f5
JH
352} scan_data_t;
353
a687059c 354/*
e50aee73 355 * Forward declarations for pregcomp()'s friends.
a687059c 356 */
a0d0e21e 357
27da23d5 358static const scan_data_t zero_scan_data =
1de06328 359 { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
c277df42
IZ
360
361#define SF_BEFORE_EOL (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
07be1b83
YO
362#define SF_BEFORE_SEOL 0x0001
363#define SF_BEFORE_MEOL 0x0002
c277df42
IZ
364#define SF_FIX_BEFORE_EOL (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
365#define SF_FL_BEFORE_EOL (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
366
09b7f37c
CB
367#ifdef NO_UNARY_PLUS
368# define SF_FIX_SHIFT_EOL (0+2)
369# define SF_FL_SHIFT_EOL (0+4)
370#else
371# define SF_FIX_SHIFT_EOL (+2)
372# define SF_FL_SHIFT_EOL (+4)
373#endif
c277df42
IZ
374
375#define SF_FIX_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
376#define SF_FIX_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
377
378#define SF_FL_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
379#define SF_FL_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
07be1b83
YO
380#define SF_IS_INF 0x0040
381#define SF_HAS_PAR 0x0080
382#define SF_IN_PAR 0x0100
383#define SF_HAS_EVAL 0x0200
384#define SCF_DO_SUBSTR 0x0400
653099ff
GS
385#define SCF_DO_STCLASS_AND 0x0800
386#define SCF_DO_STCLASS_OR 0x1000
387#define SCF_DO_STCLASS (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
e1901655 388#define SCF_WHILEM_VISITED_POS 0x2000
c277df42 389
786e8c11 390#define SCF_TRIE_RESTUDY 0x4000 /* Do restudy? */
e2e6a0f1 391#define SCF_SEEN_ACCEPT 0x8000
07be1b83 392
43fead97 393#define UTF cBOOL(RExC_utf8)
00b27cfc
KW
394
395/* The enums for all these are ordered so things work out correctly */
a62b1201 396#define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
cfaf538b 397#define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_DEPENDS_CHARSET)
00b27cfc 398#define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
cfaf538b
KW
399#define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) >= REGEX_UNICODE_CHARSET)
400#define ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_RESTRICTED_CHARSET)
2f7f8cb1 401#define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) >= REGEX_ASCII_RESTRICTED_CHARSET)
a725e29c 402#define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
a62b1201 403
43fead97 404#define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
a0ed51b3 405
93733859 406#define OOB_NAMEDCLASS -1
b8c5462f 407
8e661ac5
KW
408/* There is no code point that is out-of-bounds, so this is problematic. But
409 * its only current use is to initialize a variable that is always set before
410 * looked at. */
411#define OOB_UNICODE 0xDEADBEEF
412
a0ed51b3
LW
413#define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
414#define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
415
8615cb43 416
b45f050a
JF
417/* length of regex to show in messages that don't mark a position within */
418#define RegexLengthToShowInErrorMessages 127
419
420/*
421 * If MARKER[12] are adjusted, be sure to adjust the constants at the top
422 * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
423 * op/pragma/warn/regcomp.
424 */
7253e4e3
RK
425#define MARKER1 "<-- HERE" /* marker as it appears in the description */
426#define MARKER2 " <-- HERE " /* marker as it appears within the regex */
b81d288d 427
7253e4e3 428#define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
b45f050a
JF
429
430/*
431 * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
432 * arg. Show regex, up to a maximum length. If it's too long, chop and add
433 * "...".
434 */
58e23c8d 435#define _FAIL(code) STMT_START { \
bfed75c6 436 const char *ellipses = ""; \
ccb2c380
MP
437 IV len = RExC_end - RExC_precomp; \
438 \
439 if (!SIZE_ONLY) \
288b8c02 440 SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv); \
ccb2c380
MP
441 if (len > RegexLengthToShowInErrorMessages) { \
442 /* chop 10 shorter than the max, to ensure meaning of "..." */ \
443 len = RegexLengthToShowInErrorMessages - 10; \
444 ellipses = "..."; \
445 } \
58e23c8d 446 code; \
ccb2c380 447} STMT_END
8615cb43 448
58e23c8d
YO
449#define FAIL(msg) _FAIL( \
450 Perl_croak(aTHX_ "%s in regex m/%.*s%s/", \
451 msg, (int)len, RExC_precomp, ellipses))
452
453#define FAIL2(msg,arg) _FAIL( \
454 Perl_croak(aTHX_ msg " in regex m/%.*s%s/", \
455 arg, (int)len, RExC_precomp, ellipses))
456
b45f050a 457/*
b45f050a
JF
458 * Simple_vFAIL -- like FAIL, but marks the current location in the scan
459 */
ccb2c380 460#define Simple_vFAIL(m) STMT_START { \
a28509cc 461 const IV offset = RExC_parse - RExC_precomp; \
ccb2c380
MP
462 Perl_croak(aTHX_ "%s" REPORT_LOCATION, \
463 m, (int)offset, RExC_precomp, RExC_precomp + offset); \
464} STMT_END
b45f050a
JF
465
466/*
467 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
468 */
ccb2c380
MP
469#define vFAIL(m) STMT_START { \
470 if (!SIZE_ONLY) \
288b8c02 471 SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv); \
ccb2c380
MP
472 Simple_vFAIL(m); \
473} STMT_END
b45f050a
JF
474
475/*
476 * Like Simple_vFAIL(), but accepts two arguments.
477 */
ccb2c380 478#define Simple_vFAIL2(m,a1) STMT_START { \
a28509cc 479 const IV offset = RExC_parse - RExC_precomp; \
ccb2c380
MP
480 S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, \
481 (int)offset, RExC_precomp, RExC_precomp + offset); \
482} STMT_END
b45f050a
JF
483
484/*
485 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
486 */
ccb2c380
MP
487#define vFAIL2(m,a1) STMT_START { \
488 if (!SIZE_ONLY) \
288b8c02 489 SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv); \
ccb2c380
MP
490 Simple_vFAIL2(m, a1); \
491} STMT_END
b45f050a
JF
492
493
494/*
495 * Like Simple_vFAIL(), but accepts three arguments.
496 */
ccb2c380 497#define Simple_vFAIL3(m, a1, a2) STMT_START { \
a28509cc 498 const IV offset = RExC_parse - RExC_precomp; \
ccb2c380
MP
499 S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, \
500 (int)offset, RExC_precomp, RExC_precomp + offset); \
501} STMT_END
b45f050a
JF
502
503/*
504 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
505 */
ccb2c380
MP
506#define vFAIL3(m,a1,a2) STMT_START { \
507 if (!SIZE_ONLY) \
288b8c02 508 SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv); \
ccb2c380
MP
509 Simple_vFAIL3(m, a1, a2); \
510} STMT_END
b45f050a
JF
511
512/*
513 * Like Simple_vFAIL(), but accepts four arguments.
514 */
ccb2c380 515#define Simple_vFAIL4(m, a1, a2, a3) STMT_START { \
a28509cc 516 const IV offset = RExC_parse - RExC_precomp; \
ccb2c380
MP
517 S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3, \
518 (int)offset, RExC_precomp, RExC_precomp + offset); \
519} STMT_END
b45f050a 520
668c081a 521#define ckWARNreg(loc,m) STMT_START { \
a28509cc 522 const IV offset = loc - RExC_precomp; \
f10f4c18
NC
523 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
524 (int)offset, RExC_precomp, RExC_precomp + offset); \
ccb2c380
MP
525} STMT_END
526
668c081a 527#define ckWARNregdep(loc,m) STMT_START { \
a28509cc 528 const IV offset = loc - RExC_precomp; \
d1d15184 529 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP), \
f10f4c18
NC
530 m REPORT_LOCATION, \
531 (int)offset, RExC_precomp, RExC_precomp + offset); \
ccb2c380
MP
532} STMT_END
533
2335b3d3
KW
534#define ckWARN2regdep(loc,m, a1) STMT_START { \
535 const IV offset = loc - RExC_precomp; \
536 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP), \
537 m REPORT_LOCATION, \
538 a1, (int)offset, RExC_precomp, RExC_precomp + offset); \
539} STMT_END
540
668c081a 541#define ckWARN2reg(loc, m, a1) STMT_START { \
a28509cc 542 const IV offset = loc - RExC_precomp; \
668c081a 543 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
ccb2c380
MP
544 a1, (int)offset, RExC_precomp, RExC_precomp + offset); \
545} STMT_END
546
547#define vWARN3(loc, m, a1, a2) STMT_START { \
a28509cc 548 const IV offset = loc - RExC_precomp; \
ccb2c380
MP
549 Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
550 a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset); \
551} STMT_END
552
668c081a
NC
553#define ckWARN3reg(loc, m, a1, a2) STMT_START { \
554 const IV offset = loc - RExC_precomp; \
555 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
556 a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset); \
557} STMT_END
558
ccb2c380 559#define vWARN4(loc, m, a1, a2, a3) STMT_START { \
a28509cc 560 const IV offset = loc - RExC_precomp; \
ccb2c380
MP
561 Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
562 a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
563} STMT_END
564
668c081a
NC
565#define ckWARN4reg(loc, m, a1, a2, a3) STMT_START { \
566 const IV offset = loc - RExC_precomp; \
567 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
568 a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
569} STMT_END
570
ccb2c380 571#define vWARN5(loc, m, a1, a2, a3, a4) STMT_START { \
a28509cc 572 const IV offset = loc - RExC_precomp; \
ccb2c380
MP
573 Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
574 a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
575} STMT_END
9d1d55b5 576
8615cb43 577
cd439c50 578/* Allow for side effects in s */
ccb2c380
MP
579#define REGC(c,s) STMT_START { \
580 if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
581} STMT_END
cd439c50 582
fac92740
MJD
583/* Macros for recording node offsets. 20001227 mjd@plover.com
584 * Nodes are numbered 1, 2, 3, 4. Node #n's position is recorded in
585 * element 2*n-1 of the array. Element #2n holds the byte length node #n.
586 * Element 0 holds the number n.
07be1b83 587 * Position is 1 indexed.
fac92740 588 */
7122b237
YO
589#ifndef RE_TRACK_PATTERN_OFFSETS
590#define Set_Node_Offset_To_R(node,byte)
591#define Set_Node_Offset(node,byte)
592#define Set_Cur_Node_Offset
593#define Set_Node_Length_To_R(node,len)
594#define Set_Node_Length(node,len)
595#define Set_Node_Cur_Length(node)
596#define Node_Offset(n)
597#define Node_Length(n)
598#define Set_Node_Offset_Length(node,offset,len)
599#define ProgLen(ri) ri->u.proglen
600#define SetProgLen(ri,x) ri->u.proglen = x
601#else
602#define ProgLen(ri) ri->u.offsets[0]
603#define SetProgLen(ri,x) ri->u.offsets[0] = x
ccb2c380
MP
604#define Set_Node_Offset_To_R(node,byte) STMT_START { \
605 if (! SIZE_ONLY) { \
606 MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n", \
2a49f0f5 607 __LINE__, (int)(node), (int)(byte))); \
ccb2c380 608 if((node) < 0) { \
551405c4 609 Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
ccb2c380
MP
610 } else { \
611 RExC_offsets[2*(node)-1] = (byte); \
612 } \
613 } \
614} STMT_END
615
616#define Set_Node_Offset(node,byte) \
617 Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
618#define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
619
620#define Set_Node_Length_To_R(node,len) STMT_START { \
621 if (! SIZE_ONLY) { \
622 MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n", \
551405c4 623 __LINE__, (int)(node), (int)(len))); \
ccb2c380 624 if((node) < 0) { \
551405c4 625 Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
ccb2c380
MP
626 } else { \
627 RExC_offsets[2*(node)] = (len); \
628 } \
629 } \
630} STMT_END
631
632#define Set_Node_Length(node,len) \
633 Set_Node_Length_To_R((node)-RExC_emit_start, len)
634#define Set_Cur_Node_Length(len) Set_Node_Length(RExC_emit, len)
635#define Set_Node_Cur_Length(node) \
636 Set_Node_Length(node, RExC_parse - parse_start)
fac92740
MJD
637
638/* Get offsets and lengths */
639#define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
640#define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
641
07be1b83
YO
642#define Set_Node_Offset_Length(node,offset,len) STMT_START { \
643 Set_Node_Offset_To_R((node)-RExC_emit_start, (offset)); \
644 Set_Node_Length_To_R((node)-RExC_emit_start, (len)); \
645} STMT_END
7122b237 646#endif
07be1b83
YO
647
648#if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
649#define EXPERIMENTAL_INPLACESCAN
f427392e 650#endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
07be1b83 651
304ee84b
YO
652#define DEBUG_STUDYDATA(str,data,depth) \
653DEBUG_OPTIMISE_MORE_r(if(data){ \
1de06328 654 PerlIO_printf(Perl_debug_log, \
304ee84b
YO
655 "%*s" str "Pos:%"IVdf"/%"IVdf \
656 " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s", \
1de06328
YO
657 (int)(depth)*2, "", \
658 (IV)((data)->pos_min), \
659 (IV)((data)->pos_delta), \
304ee84b 660 (UV)((data)->flags), \
1de06328 661 (IV)((data)->whilem_c), \
304ee84b
YO
662 (IV)((data)->last_closep ? *((data)->last_closep) : -1), \
663 is_inf ? "INF " : "" \
1de06328
YO
664 ); \
665 if ((data)->last_found) \
666 PerlIO_printf(Perl_debug_log, \
667 "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
668 " %sFloat: '%s' @ %"IVdf"/%"IVdf"", \
669 SvPVX_const((data)->last_found), \
670 (IV)((data)->last_end), \
671 (IV)((data)->last_start_min), \
672 (IV)((data)->last_start_max), \
673 ((data)->longest && \
674 (data)->longest==&((data)->longest_fixed)) ? "*" : "", \
675 SvPVX_const((data)->longest_fixed), \
676 (IV)((data)->offset_fixed), \
677 ((data)->longest && \
678 (data)->longest==&((data)->longest_float)) ? "*" : "", \
679 SvPVX_const((data)->longest_float), \
680 (IV)((data)->offset_float_min), \
681 (IV)((data)->offset_float_max) \
682 ); \
683 PerlIO_printf(Perl_debug_log,"\n"); \
684});
685
acfe0abc 686static void clear_re(pTHX_ void *r);
4327152a 687
653099ff 688/* Mark that we cannot extend a found fixed substring at this point.
786e8c11 689 Update the longest found anchored substring and the longest found
653099ff
GS
690 floating substrings if needed. */
691
4327152a 692STATIC void
304ee84b 693S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
c277df42 694{
e1ec3a88
AL
695 const STRLEN l = CHR_SVLEN(data->last_found);
696 const STRLEN old_l = CHR_SVLEN(*data->longest);
1de06328 697 GET_RE_DEBUG_FLAGS_DECL;
b81d288d 698
7918f24d
NC
699 PERL_ARGS_ASSERT_SCAN_COMMIT;
700
c277df42 701 if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
6b43b216 702 SvSetMagicSV(*data->longest, data->last_found);
c277df42
IZ
703 if (*data->longest == data->longest_fixed) {
704 data->offset_fixed = l ? data->last_start_min : data->pos_min;
705 if (data->flags & SF_BEFORE_EOL)
b81d288d 706 data->flags
c277df42
IZ
707 |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
708 else
709 data->flags &= ~SF_FIX_BEFORE_EOL;
686b73d4 710 data->minlen_fixed=minlenp;
1de06328 711 data->lookbehind_fixed=0;
a0ed51b3 712 }
304ee84b 713 else { /* *data->longest == data->longest_float */
c277df42 714 data->offset_float_min = l ? data->last_start_min : data->pos_min;
b81d288d
AB
715 data->offset_float_max = (l
716 ? data->last_start_max
c277df42 717 : data->pos_min + data->pos_delta);
304ee84b 718 if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
9051bda5 719 data->offset_float_max = I32_MAX;
c277df42 720 if (data->flags & SF_BEFORE_EOL)
b81d288d 721 data->flags
c277df42
IZ
722 |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
723 else
724 data->flags &= ~SF_FL_BEFORE_EOL;
1de06328
YO
725 data->minlen_float=minlenp;
726 data->lookbehind_float=0;
c277df42
IZ
727 }
728 }
729 SvCUR_set(data->last_found, 0);
0eda9292 730 {
a28509cc 731 SV * const sv = data->last_found;
097eb12c
AL
732 if (SvUTF8(sv) && SvMAGICAL(sv)) {
733 MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
734 if (mg)
735 mg->mg_len = 0;
736 }
0eda9292 737 }
c277df42
IZ
738 data->last_end = -1;
739 data->flags &= ~SF_BEFORE_EOL;
bcdf7404 740 DEBUG_STUDYDATA("commit: ",data,0);
c277df42
IZ
741}
742
653099ff
GS
743/* Can match anything (initialization) */
744STATIC void
3fffb88a 745S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
653099ff 746{
7918f24d
NC
747 PERL_ARGS_ASSERT_CL_ANYTHING;
748
f8bef550 749 ANYOF_BITMAP_SETALL(cl);
dd58aee1 750 cl->flags = ANYOF_CLASS|ANYOF_EOS|ANYOF_UNICODE_ALL
3ad98780 751 |ANYOF_LOC_NONBITMAP_FOLD|ANYOF_NON_UTF8_LATIN1_ALL;
3fffb88a
KW
752
753 /* If any portion of the regex is to operate under locale rules,
754 * initialization includes it. The reason this isn't done for all regexes
755 * is that the optimizer was written under the assumption that locale was
756 * all-or-nothing. Given the complexity and lack of documentation in the
757 * optimizer, and that there are inadequate test cases for locale, so many
758 * parts of it may not work properly, it is safest to avoid locale unless
759 * necessary. */
760 if (RExC_contains_locale) {
9d7a1e63 761 ANYOF_CLASS_SETALL(cl); /* /l uses class */
3fffb88a
KW
762 cl->flags |= ANYOF_LOCALE;
763 }
9d7a1e63
KW
764 else {
765 ANYOF_CLASS_ZERO(cl); /* Only /l uses class now */
766 }
653099ff
GS
767}
768
769/* Can match anything (initialization) */
770STATIC int
5f66b61c 771S_cl_is_anything(const struct regnode_charclass_class *cl)
653099ff
GS
772{
773 int value;
774
7918f24d
NC
775 PERL_ARGS_ASSERT_CL_IS_ANYTHING;
776
aaa51d5e 777 for (value = 0; value <= ANYOF_MAX; value += 2)
653099ff
GS
778 if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
779 return 1;
1aa99e6b
IH
780 if (!(cl->flags & ANYOF_UNICODE_ALL))
781 return 0;
10edeb5d 782 if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
f8bef550 783 return 0;
653099ff
GS
784 return 1;
785}
786
787/* Can match anything (initialization) */
788STATIC void
e755fd73 789S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
653099ff 790{
7918f24d
NC
791 PERL_ARGS_ASSERT_CL_INIT;
792
8ecf7187 793 Zero(cl, 1, struct regnode_charclass_class);
653099ff 794 cl->type = ANYOF;
3fffb88a 795 cl_anything(pRExC_state, cl);
1411dba4 796 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
653099ff
GS
797}
798
1051e1c4
KW
799/* These two functions currently do the exact same thing */
800#define cl_init_zero S_cl_init
653099ff 801
dd58aee1
KW
802/* 'AND' a given class with another one. Can create false positives. 'cl'
803 * should not be inverted. 'and_with->flags & ANYOF_CLASS' should be 0 if
804 * 'and_with' is a regnode_charclass instead of a regnode_charclass_class. */
653099ff 805STATIC void
5f66b61c 806S_cl_and(struct regnode_charclass_class *cl,
a28509cc 807 const struct regnode_charclass_class *and_with)
653099ff 808{
7918f24d 809 PERL_ARGS_ASSERT_CL_AND;
40d049e4
YO
810
811 assert(and_with->type == ANYOF);
1e6ade67 812
c6b76537 813 /* I (khw) am not sure all these restrictions are necessary XXX */
1e6ade67
KW
814 if (!(ANYOF_CLASS_TEST_ANY_SET(and_with))
815 && !(ANYOF_CLASS_TEST_ANY_SET(cl))
653099ff 816 && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
39065660
KW
817 && !(and_with->flags & ANYOF_LOC_NONBITMAP_FOLD)
818 && !(cl->flags & ANYOF_LOC_NONBITMAP_FOLD)) {
653099ff
GS
819 int i;
820
821 if (and_with->flags & ANYOF_INVERT)
822 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
823 cl->bitmap[i] &= ~and_with->bitmap[i];
824 else
825 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
826 cl->bitmap[i] &= and_with->bitmap[i];
827 } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
1aa99e6b 828
c6b76537 829 if (and_with->flags & ANYOF_INVERT) {
8951c461 830
c6b76537
KW
831 /* Here, the and'ed node is inverted. Get the AND of the flags that
832 * aren't affected by the inversion. Those that are affected are
833 * handled individually below */
834 U8 affected_flags = cl->flags & ~INVERSION_UNAFFECTED_FLAGS;
835 cl->flags &= (and_with->flags & INVERSION_UNAFFECTED_FLAGS);
836 cl->flags |= affected_flags;
837
838 /* We currently don't know how to deal with things that aren't in the
839 * bitmap, but we know that the intersection is no greater than what
840 * is already in cl, so let there be false positives that get sorted
841 * out after the synthetic start class succeeds, and the node is
842 * matched for real. */
843
844 /* The inversion of these two flags indicate that the resulting
845 * intersection doesn't have them */
846 if (and_with->flags & ANYOF_UNICODE_ALL) {
4713bfe1
KW
847 cl->flags &= ~ANYOF_UNICODE_ALL;
848 }
c6b76537
KW
849 if (and_with->flags & ANYOF_NON_UTF8_LATIN1_ALL) {
850 cl->flags &= ~ANYOF_NON_UTF8_LATIN1_ALL;
137165a6 851 }
1aa99e6b 852 }
c6b76537 853 else { /* and'd node is not inverted */
3ad98780
KW
854 U8 outside_bitmap_but_not_utf8; /* Temp variable */
855
137165a6 856 if (! ANYOF_NONBITMAP(and_with)) {
c6b76537
KW
857
858 /* Here 'and_with' doesn't match anything outside the bitmap
859 * (except possibly ANYOF_UNICODE_ALL), which means the
860 * intersection can't either, except for ANYOF_UNICODE_ALL, in
861 * which case we don't know what the intersection is, but it's no
862 * greater than what cl already has, so can just leave it alone,
863 * with possible false positives */
864 if (! (and_with->flags & ANYOF_UNICODE_ALL)) {
865 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
871d0d1a 866 cl->flags &= ~ANYOF_NONBITMAP_NON_UTF8;
c6b76537 867 }
137165a6 868 }
c6b76537
KW
869 else if (! ANYOF_NONBITMAP(cl)) {
870
871 /* Here, 'and_with' does match something outside the bitmap, and cl
872 * doesn't have a list of things to match outside the bitmap. If
873 * cl can match all code points above 255, the intersection will
3ad98780
KW
874 * be those above-255 code points that 'and_with' matches. If cl
875 * can't match all Unicode code points, it means that it can't
876 * match anything outside the bitmap (since the 'if' that got us
877 * into this block tested for that), so we leave the bitmap empty.
878 */
c6b76537
KW
879 if (cl->flags & ANYOF_UNICODE_ALL) {
880 ARG_SET(cl, ARG(and_with));
3ad98780
KW
881
882 /* and_with's ARG may match things that don't require UTF8.
883 * And now cl's will too, in spite of this being an 'and'. See
884 * the comments below about the kludge */
885 cl->flags |= and_with->flags & ANYOF_NONBITMAP_NON_UTF8;
c6b76537
KW
886 }
887 }
888 else {
889 /* Here, both 'and_with' and cl match something outside the
890 * bitmap. Currently we do not do the intersection, so just match
891 * whatever cl had at the beginning. */
892 }
893
894
3ad98780
KW
895 /* Take the intersection of the two sets of flags. However, the
896 * ANYOF_NONBITMAP_NON_UTF8 flag is treated as an 'or'. This is a
897 * kludge around the fact that this flag is not treated like the others
898 * which are initialized in cl_anything(). The way the optimizer works
899 * is that the synthetic start class (SSC) is initialized to match
900 * anything, and then the first time a real node is encountered, its
901 * values are AND'd with the SSC's with the result being the values of
902 * the real node. However, there are paths through the optimizer where
903 * the AND never gets called, so those initialized bits are set
904 * inappropriately, which is not usually a big deal, as they just cause
905 * false positives in the SSC, which will just mean a probably
906 * imperceptible slow down in execution. However this bit has a
907 * higher false positive consequence in that it can cause utf8.pm,
908 * utf8_heavy.pl ... to be loaded when not necessary, which is a much
909 * bigger slowdown and also causes significant extra memory to be used.
910 * In order to prevent this, the code now takes a different tack. The
911 * bit isn't set unless some part of the regular expression needs it,
912 * but once set it won't get cleared. This means that these extra
913 * modules won't get loaded unless there was some path through the
914 * pattern that would have required them anyway, and so any false
915 * positives that occur by not ANDing them out when they could be
916 * aren't as severe as they would be if we treated this bit like all
917 * the others */
918 outside_bitmap_but_not_utf8 = (cl->flags | and_with->flags)
919 & ANYOF_NONBITMAP_NON_UTF8;
c6b76537 920 cl->flags &= and_with->flags;
3ad98780 921 cl->flags |= outside_bitmap_but_not_utf8;
137165a6 922 }
653099ff
GS
923}
924
dd58aee1
KW
925/* 'OR' a given class with another one. Can create false positives. 'cl'
926 * should not be inverted. 'or_with->flags & ANYOF_CLASS' should be 0 if
927 * 'or_with' is a regnode_charclass instead of a regnode_charclass_class. */
653099ff 928STATIC void
3fffb88a 929S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
653099ff 930{
7918f24d
NC
931 PERL_ARGS_ASSERT_CL_OR;
932
653099ff 933 if (or_with->flags & ANYOF_INVERT) {
c6b76537
KW
934
935 /* Here, the or'd node is to be inverted. This means we take the
936 * complement of everything not in the bitmap, but currently we don't
937 * know what that is, so give up and match anything */
938 if (ANYOF_NONBITMAP(or_with)) {
3fffb88a 939 cl_anything(pRExC_state, cl);
c6b76537 940 }
653099ff
GS
941 /* We do not use
942 * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
943 * <= (B1 | !B2) | (CL1 | !CL2)
944 * which is wasteful if CL2 is small, but we ignore CL2:
945 * (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
946 * XXXX Can we handle case-fold? Unclear:
947 * (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
948 * (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
949 */
c6b76537 950 else if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
39065660
KW
951 && !(or_with->flags & ANYOF_LOC_NONBITMAP_FOLD)
952 && !(cl->flags & ANYOF_LOC_NONBITMAP_FOLD) ) {
653099ff
GS
953 int i;
954
955 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
956 cl->bitmap[i] |= ~or_with->bitmap[i];
957 } /* XXXX: logic is complicated otherwise */
958 else {
3fffb88a 959 cl_anything(pRExC_state, cl);
653099ff 960 }
c6b76537
KW
961
962 /* And, we can just take the union of the flags that aren't affected
963 * by the inversion */
964 cl->flags |= or_with->flags & INVERSION_UNAFFECTED_FLAGS;
965
966 /* For the remaining flags:
967 ANYOF_UNICODE_ALL and inverted means to not match anything above
968 255, which means that the union with cl should just be
969 what cl has in it, so can ignore this flag
970 ANYOF_NON_UTF8_LATIN1_ALL and inverted means if not utf8 and ord
971 is 127-255 to match them, but then invert that, so the
972 union with cl should just be what cl has in it, so can
973 ignore this flag
974 */
975 } else { /* 'or_with' is not inverted */
653099ff
GS
976 /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
977 if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
39065660
KW
978 && (!(or_with->flags & ANYOF_LOC_NONBITMAP_FOLD)
979 || (cl->flags & ANYOF_LOC_NONBITMAP_FOLD)) ) {
653099ff
GS
980 int i;
981
982 /* OR char bitmap and class bitmap separately */
983 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
984 cl->bitmap[i] |= or_with->bitmap[i];
1e6ade67 985 if (ANYOF_CLASS_TEST_ANY_SET(or_with)) {
653099ff
GS
986 for (i = 0; i < ANYOF_CLASSBITMAP_SIZE; i++)
987 cl->classflags[i] |= or_with->classflags[i];
988 cl->flags |= ANYOF_CLASS;
989 }
990 }
991 else { /* XXXX: logic is complicated, leave it along for a moment. */
3fffb88a 992 cl_anything(pRExC_state, cl);
653099ff 993 }
9826f543 994
c6b76537
KW
995 if (ANYOF_NONBITMAP(or_with)) {
996
997 /* Use the added node's outside-the-bit-map match if there isn't a
998 * conflict. If there is a conflict (both nodes match something
999 * outside the bitmap, but what they match outside is not the same
1000 * pointer, and hence not easily compared until XXX we extend
1001 * inversion lists this far), give up and allow the start class to
d94b1d13
KW
1002 * match everything outside the bitmap. If that stuff is all above
1003 * 255, can just set UNICODE_ALL, otherwise caould be anything. */
c6b76537
KW
1004 if (! ANYOF_NONBITMAP(cl)) {
1005 ARG_SET(cl, ARG(or_with));
1006 }
1007 else if (ARG(cl) != ARG(or_with)) {
d94b1d13
KW
1008
1009 if ((or_with->flags & ANYOF_NONBITMAP_NON_UTF8)) {
1010 cl_anything(pRExC_state, cl);
1011 }
1012 else {
1013 cl->flags |= ANYOF_UNICODE_ALL;
1014 }
c6b76537 1015 }
4c34a693 1016 }
0b9668ee
KW
1017
1018 /* Take the union */
1019 cl->flags |= or_with->flags;
1aa99e6b 1020 }
653099ff
GS
1021}
1022
a3621e74
YO
1023#define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1024#define TRIE_LIST_CUR(state) ( TRIE_LIST_ITEM( state, 0 ).forid )
1025#define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1026#define TRIE_LIST_USED(idx) ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
1027
3dab1dad
YO
1028
1029#ifdef DEBUGGING
07be1b83 1030/*
2b8b4781
NC
1031 dump_trie(trie,widecharmap,revcharmap)
1032 dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1033 dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
3dab1dad
YO
1034
1035 These routines dump out a trie in a somewhat readable format.
07be1b83
YO
1036 The _interim_ variants are used for debugging the interim
1037 tables that are used to generate the final compressed
1038 representation which is what dump_trie expects.
1039
486ec47a 1040 Part of the reason for their existence is to provide a form
3dab1dad 1041 of documentation as to how the different representations function.
07be1b83
YO
1042
1043*/
3dab1dad
YO
1044
1045/*
3dab1dad
YO
1046 Dumps the final compressed table form of the trie to Perl_debug_log.
1047 Used for debugging make_trie().
1048*/
b9a59e08 1049
3dab1dad 1050STATIC void
2b8b4781
NC
1051S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1052 AV *revcharmap, U32 depth)
3dab1dad
YO
1053{
1054 U32 state;
ab3bbdeb 1055 SV *sv=sv_newmortal();
55eed653 1056 int colwidth= widecharmap ? 6 : 4;
2e64971a 1057 U16 word;
3dab1dad
YO
1058 GET_RE_DEBUG_FLAGS_DECL;
1059
7918f24d 1060 PERL_ARGS_ASSERT_DUMP_TRIE;
ab3bbdeb 1061
3dab1dad
YO
1062 PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1063 (int)depth * 2 + 2,"",
1064 "Match","Base","Ofs" );
1065
1066 for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
2b8b4781 1067 SV ** const tmp = av_fetch( revcharmap, state, 0);
3dab1dad 1068 if ( tmp ) {
ab3bbdeb
YO
1069 PerlIO_printf( Perl_debug_log, "%*s",
1070 colwidth,
ddc5bc0f 1071 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
ab3bbdeb
YO
1072 PL_colors[0], PL_colors[1],
1073 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1074 PERL_PV_ESCAPE_FIRSTCHAR
1075 )
1076 );
3dab1dad
YO
1077 }
1078 }
1079 PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1080 (int)depth * 2 + 2,"");
1081
1082 for( state = 0 ; state < trie->uniquecharcount ; state++ )
ab3bbdeb 1083 PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
3dab1dad
YO
1084 PerlIO_printf( Perl_debug_log, "\n");
1085
1e2e3d02 1086 for( state = 1 ; state < trie->statecount ; state++ ) {
be8e71aa 1087 const U32 base = trie->states[ state ].trans.base;
3dab1dad
YO
1088
1089 PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
1090
1091 if ( trie->states[ state ].wordnum ) {
1092 PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
1093 } else {
1094 PerlIO_printf( Perl_debug_log, "%6s", "" );
1095 }
1096
1097 PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1098
1099 if ( base ) {
1100 U32 ofs = 0;
1101
1102 while( ( base + ofs < trie->uniquecharcount ) ||
1103 ( base + ofs - trie->uniquecharcount < trie->lasttrans
1104 && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
1105 ofs++;
1106
1107 PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1108
1109 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1110 if ( ( base + ofs >= trie->uniquecharcount ) &&
1111 ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1112 trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1113 {
ab3bbdeb
YO
1114 PerlIO_printf( Perl_debug_log, "%*"UVXf,
1115 colwidth,
3dab1dad
YO
1116 (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
1117 } else {
ab3bbdeb 1118 PerlIO_printf( Perl_debug_log, "%*s",colwidth," ." );
3dab1dad
YO
1119 }
1120 }
1121
1122 PerlIO_printf( Perl_debug_log, "]");
1123
1124 }
1125 PerlIO_printf( Perl_debug_log, "\n" );
1126 }
2e64971a
DM
1127 PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=", (int)depth*2, "");
1128 for (word=1; word <= trie->wordcount; word++) {
1129 PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1130 (int)word, (int)(trie->wordinfo[word].prev),
1131 (int)(trie->wordinfo[word].len));
1132 }
1133 PerlIO_printf(Perl_debug_log, "\n" );
3dab1dad
YO
1134}
1135/*
3dab1dad
YO
1136 Dumps a fully constructed but uncompressed trie in list form.
1137 List tries normally only are used for construction when the number of
1138 possible chars (trie->uniquecharcount) is very high.
1139 Used for debugging make_trie().
1140*/
1141STATIC void
55eed653 1142S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
2b8b4781
NC
1143 HV *widecharmap, AV *revcharmap, U32 next_alloc,
1144 U32 depth)
3dab1dad
YO
1145{
1146 U32 state;
ab3bbdeb 1147 SV *sv=sv_newmortal();
55eed653 1148 int colwidth= widecharmap ? 6 : 4;
3dab1dad 1149 GET_RE_DEBUG_FLAGS_DECL;
7918f24d
NC
1150
1151 PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1152
3dab1dad 1153 /* print out the table precompression. */
ab3bbdeb
YO
1154 PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1155 (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1156 "------:-----+-----------------\n" );
3dab1dad
YO
1157
1158 for( state=1 ; state < next_alloc ; state ++ ) {
1159 U16 charid;
1160
ab3bbdeb 1161 PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
3dab1dad
YO
1162 (int)depth * 2 + 2,"", (UV)state );
1163 if ( ! trie->states[ state ].wordnum ) {
1164 PerlIO_printf( Perl_debug_log, "%5s| ","");
1165 } else {
1166 PerlIO_printf( Perl_debug_log, "W%4x| ",
1167 trie->states[ state ].wordnum
1168 );
1169 }
1170 for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
2b8b4781 1171 SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
ab3bbdeb
YO
1172 if ( tmp ) {
1173 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1174 colwidth,
ddc5bc0f 1175 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
ab3bbdeb
YO
1176 PL_colors[0], PL_colors[1],
1177 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1178 PERL_PV_ESCAPE_FIRSTCHAR
1179 ) ,
1e2e3d02
YO
1180 TRIE_LIST_ITEM(state,charid).forid,
1181 (UV)TRIE_LIST_ITEM(state,charid).newstate
1182 );
1183 if (!(charid % 10))
664e119d
RGS
1184 PerlIO_printf(Perl_debug_log, "\n%*s| ",
1185 (int)((depth * 2) + 14), "");
1e2e3d02 1186 }
ab3bbdeb
YO
1187 }
1188 PerlIO_printf( Perl_debug_log, "\n");
3dab1dad
YO
1189 }
1190}
1191
1192/*
3dab1dad
YO
1193 Dumps a fully constructed but uncompressed trie in table form.
1194 This is the normal DFA style state transition table, with a few
1195 twists to facilitate compression later.
1196 Used for debugging make_trie().
1197*/
1198STATIC void
55eed653 1199S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
2b8b4781
NC
1200 HV *widecharmap, AV *revcharmap, U32 next_alloc,
1201 U32 depth)
3dab1dad
YO
1202{
1203 U32 state;
1204 U16 charid;
ab3bbdeb 1205 SV *sv=sv_newmortal();
55eed653 1206 int colwidth= widecharmap ? 6 : 4;
3dab1dad 1207 GET_RE_DEBUG_FLAGS_DECL;
7918f24d
NC
1208
1209 PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
3dab1dad
YO
1210
1211 /*
1212 print out the table precompression so that we can do a visual check
1213 that they are identical.
1214 */
1215
1216 PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1217
1218 for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2b8b4781 1219 SV ** const tmp = av_fetch( revcharmap, charid, 0);
3dab1dad 1220 if ( tmp ) {
ab3bbdeb
YO
1221 PerlIO_printf( Perl_debug_log, "%*s",
1222 colwidth,
ddc5bc0f 1223 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
ab3bbdeb
YO
1224 PL_colors[0], PL_colors[1],
1225 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1226 PERL_PV_ESCAPE_FIRSTCHAR
1227 )
1228 );
3dab1dad
YO
1229 }
1230 }
1231
1232 PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1233
1234 for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
ab3bbdeb 1235 PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
3dab1dad
YO
1236 }
1237
1238 PerlIO_printf( Perl_debug_log, "\n" );
1239
1240 for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1241
1242 PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ",
1243 (int)depth * 2 + 2,"",
1244 (UV)TRIE_NODENUM( state ) );
1245
1246 for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
ab3bbdeb
YO
1247 UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1248 if (v)
1249 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1250 else
1251 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
3dab1dad
YO
1252 }
1253 if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1254 PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1255 } else {
1256 PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1257 trie->states[ TRIE_NODENUM( state ) ].wordnum );
1258 }
1259 }
07be1b83 1260}
3dab1dad
YO
1261
1262#endif
1263
2e64971a 1264
786e8c11
YO
1265/* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1266 startbranch: the first branch in the whole branch sequence
1267 first : start branch of sequence of branch-exact nodes.
1268 May be the same as startbranch
1269 last : Thing following the last branch.
1270 May be the same as tail.
1271 tail : item following the branch sequence
1272 count : words in the sequence
1273 flags : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1274 depth : indent depth
3dab1dad 1275
786e8c11 1276Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
07be1b83 1277
786e8c11
YO
1278A trie is an N'ary tree where the branches are determined by digital
1279decomposition of the key. IE, at the root node you look up the 1st character and
1280follow that branch repeat until you find the end of the branches. Nodes can be
1281marked as "accepting" meaning they represent a complete word. Eg:
07be1b83 1282
786e8c11 1283 /he|she|his|hers/
72f13be8 1284
786e8c11
YO
1285would convert into the following structure. Numbers represent states, letters
1286following numbers represent valid transitions on the letter from that state, if
1287the number is in square brackets it represents an accepting state, otherwise it
1288will be in parenthesis.
07be1b83 1289
786e8c11
YO
1290 +-h->+-e->[3]-+-r->(8)-+-s->[9]
1291 | |
1292 | (2)
1293 | |
1294 (1) +-i->(6)-+-s->[7]
1295 |
1296 +-s->(3)-+-h->(4)-+-e->[5]
07be1b83 1297
786e8c11
YO
1298 Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1299
1300This shows that when matching against the string 'hers' we will begin at state 1
1301read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1302then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1303is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1304single traverse. We store a mapping from accepting to state to which word was
1305matched, and then when we have multiple possibilities we try to complete the
1306rest of the regex in the order in which they occured in the alternation.
1307
1308The only prior NFA like behaviour that would be changed by the TRIE support is
1309the silent ignoring of duplicate alternations which are of the form:
1310
1311 / (DUPE|DUPE) X? (?{ ... }) Y /x
1312
4b714af6 1313Thus EVAL blocks following a trie may be called a different number of times with
786e8c11 1314and without the optimisation. With the optimisations dupes will be silently
486ec47a 1315ignored. This inconsistent behaviour of EVAL type nodes is well established as
786e8c11
YO
1316the following demonstrates:
1317
1318 'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1319
1320which prints out 'word' three times, but
1321
1322 'words'=~/(word|word|word)(?{ print $1 })S/
1323
1324which doesnt print it out at all. This is due to other optimisations kicking in.
1325
1326Example of what happens on a structural level:
1327
486ec47a 1328The regexp /(ac|ad|ab)+/ will produce the following debug output:
786e8c11
YO
1329
1330 1: CURLYM[1] {1,32767}(18)
1331 5: BRANCH(8)
1332 6: EXACT <ac>(16)
1333 8: BRANCH(11)
1334 9: EXACT <ad>(16)
1335 11: BRANCH(14)
1336 12: EXACT <ab>(16)
1337 16: SUCCEED(0)
1338 17: NOTHING(18)
1339 18: END(0)
1340
1341This would be optimizable with startbranch=5, first=5, last=16, tail=16
1342and should turn into:
1343
1344 1: CURLYM[1] {1,32767}(18)
1345 5: TRIE(16)
1346 [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1347 <ac>
1348 <ad>
1349 <ab>
1350 16: SUCCEED(0)
1351 17: NOTHING(18)
1352 18: END(0)
1353
1354Cases where tail != last would be like /(?foo|bar)baz/:
1355
1356 1: BRANCH(4)
1357 2: EXACT <foo>(8)
1358 4: BRANCH(7)
1359 5: EXACT <bar>(8)
1360 7: TAIL(8)
1361 8: EXACT <baz>(10)
1362 10: END(0)
1363
1364which would be optimizable with startbranch=1, first=1, last=7, tail=8
1365and would end up looking like:
1366
1367 1: TRIE(8)
1368 [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1369 <foo>
1370 <bar>
1371 7: TAIL(8)
1372 8: EXACT <baz>(10)
1373 10: END(0)
1374
1375 d = uvuni_to_utf8_flags(d, uv, 0);
1376
1377is the recommended Unicode-aware way of saying
1378
1379 *(d++) = uv;
1380*/
1381
fab2782b 1382#define TRIE_STORE_REVCHAR(val) \
786e8c11 1383 STMT_START { \
73031816 1384 if (UTF) { \
fab2782b 1385 SV *zlopp = newSV(7); /* XXX: optimize me */ \
88c9ea1e 1386 unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp); \
fab2782b 1387 unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, val); \
73031816
NC
1388 SvCUR_set(zlopp, kapow - flrbbbbb); \
1389 SvPOK_on(zlopp); \
1390 SvUTF8_on(zlopp); \
1391 av_push(revcharmap, zlopp); \
1392 } else { \
fab2782b 1393 char ooooff = (char)val; \
73031816
NC
1394 av_push(revcharmap, newSVpvn(&ooooff, 1)); \
1395 } \
1396 } STMT_END
786e8c11 1397
fab2782b
YO
1398#define TRIE_READ_CHAR STMT_START { \
1399 wordlen++; \
1400 if ( UTF ) { \
1401 /* if it is UTF then it is either already folded, or does not need folding */ \
1402 uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags); \
1403 } \
1404 else if (folder == PL_fold_latin1) { \
1405 /* if we use this folder we have to obey unicode rules on latin-1 data */ \
1406 if ( foldlen > 0 ) { \
1407 uvc = utf8n_to_uvuni( (const U8*) scan, UTF8_MAXLEN, &len, uniflags ); \
1408 foldlen -= len; \
1409 scan += len; \
1410 len = 0; \
1411 } else { \
1412 len = 1; \
1413 uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, 1); \
1414 skiplen = UNISKIP(uvc); \
1415 foldlen -= skiplen; \
1416 scan = foldbuf + skiplen; \
1417 } \
1418 } else { \
1419 /* raw data, will be folded later if needed */ \
1420 uvc = (U32)*uc; \
1421 len = 1; \
1422 } \
786e8c11
YO
1423} STMT_END
1424
1425
1426
1427#define TRIE_LIST_PUSH(state,fid,ns) STMT_START { \
1428 if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) { \
f9003953
NC
1429 U32 ging = TRIE_LIST_LEN( state ) *= 2; \
1430 Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
786e8c11
YO
1431 } \
1432 TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid; \
1433 TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns; \
1434 TRIE_LIST_CUR( state )++; \
1435} STMT_END
07be1b83 1436
786e8c11
YO
1437#define TRIE_LIST_NEW(state) STMT_START { \
1438 Newxz( trie->states[ state ].trans.list, \
1439 4, reg_trie_trans_le ); \
1440 TRIE_LIST_CUR( state ) = 1; \
1441 TRIE_LIST_LEN( state ) = 4; \
1442} STMT_END
07be1b83 1443
786e8c11
YO
1444#define TRIE_HANDLE_WORD(state) STMT_START { \
1445 U16 dupe= trie->states[ state ].wordnum; \
1446 regnode * const noper_next = regnext( noper ); \
1447 \
786e8c11
YO
1448 DEBUG_r({ \
1449 /* store the word for dumping */ \
1450 SV* tmp; \
1451 if (OP(noper) != NOTHING) \
740cce10 1452 tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF); \
786e8c11 1453 else \
740cce10 1454 tmp = newSVpvn_utf8( "", 0, UTF ); \
2b8b4781 1455 av_push( trie_words, tmp ); \
786e8c11
YO
1456 }); \
1457 \
1458 curword++; \
2e64971a
DM
1459 trie->wordinfo[curword].prev = 0; \
1460 trie->wordinfo[curword].len = wordlen; \
1461 trie->wordinfo[curword].accept = state; \
786e8c11
YO
1462 \
1463 if ( noper_next < tail ) { \
1464 if (!trie->jump) \
c944940b 1465 trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
7f69552c 1466 trie->jump[curword] = (U16)(noper_next - convert); \
786e8c11
YO
1467 if (!jumper) \
1468 jumper = noper_next; \
1469 if (!nextbranch) \
1470 nextbranch= regnext(cur); \
1471 } \
1472 \
1473 if ( dupe ) { \
2e64971a
DM
1474 /* It's a dupe. Pre-insert into the wordinfo[].prev */\
1475 /* chain, so that when the bits of chain are later */\
1476 /* linked together, the dups appear in the chain */\
1477 trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1478 trie->wordinfo[dupe].prev = curword; \
786e8c11
YO
1479 } else { \
1480 /* we haven't inserted this word yet. */ \
1481 trie->states[ state ].wordnum = curword; \
1482 } \
1483} STMT_END
07be1b83 1484
3dab1dad 1485
786e8c11
YO
1486#define TRIE_TRANS_STATE(state,base,ucharcount,charid,special) \
1487 ( ( base + charid >= ucharcount \
1488 && base + charid < ubound \
1489 && state == trie->trans[ base - ucharcount + charid ].check \
1490 && trie->trans[ base - ucharcount + charid ].next ) \
1491 ? trie->trans[ base - ucharcount + charid ].next \
1492 : ( state==1 ? special : 0 ) \
1493 )
3dab1dad 1494
786e8c11
YO
1495#define MADE_TRIE 1
1496#define MADE_JUMP_TRIE 2
1497#define MADE_EXACT_TRIE 4
3dab1dad 1498
a3621e74 1499STATIC I32
786e8c11 1500S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
a3621e74 1501{
27da23d5 1502 dVAR;
a3621e74
YO
1503 /* first pass, loop through and scan words */
1504 reg_trie_data *trie;
55eed653 1505 HV *widecharmap = NULL;
2b8b4781 1506 AV *revcharmap = newAV();
a3621e74 1507 regnode *cur;
9f7f3913 1508 const U32 uniflags = UTF8_ALLOW_DEFAULT;
a3621e74
YO
1509 STRLEN len = 0;
1510 UV uvc = 0;
1511 U16 curword = 0;
1512 U32 next_alloc = 0;
786e8c11
YO
1513 regnode *jumper = NULL;
1514 regnode *nextbranch = NULL;
7f69552c 1515 regnode *convert = NULL;
2e64971a 1516 U32 *prev_states; /* temp array mapping each state to previous one */
a3621e74 1517 /* we just use folder as a flag in utf8 */
1e696034 1518 const U8 * folder = NULL;
a3621e74 1519
2b8b4781
NC
1520#ifdef DEBUGGING
1521 const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1522 AV *trie_words = NULL;
1523 /* along with revcharmap, this only used during construction but both are
1524 * useful during debugging so we store them in the struct when debugging.
8e11feef 1525 */
2b8b4781
NC
1526#else
1527 const U32 data_slot = add_data( pRExC_state, 2, "tu" );
3dab1dad 1528 STRLEN trie_charcount=0;
3dab1dad 1529#endif
2b8b4781 1530 SV *re_trie_maxbuff;
a3621e74 1531 GET_RE_DEBUG_FLAGS_DECL;
7918f24d
NC
1532
1533 PERL_ARGS_ASSERT_MAKE_TRIE;
72f13be8
YO
1534#ifndef DEBUGGING
1535 PERL_UNUSED_ARG(depth);
1536#endif
a3621e74 1537
1e696034 1538 switch (flags) {
c46d03cf 1539 case EXACT: break;
2f7f8cb1 1540 case EXACTFA:
fab2782b
YO
1541 case EXACTFU_SS:
1542 case EXACTFU_TRICKYFOLD:
1e696034
KW
1543 case EXACTFU: folder = PL_fold_latin1; break;
1544 case EXACTF: folder = PL_fold; break;
1545 case EXACTFL: folder = PL_fold_locale; break;
fab2782b 1546 default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1e696034
KW
1547 }
1548
c944940b 1549 trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
a3621e74 1550 trie->refcount = 1;
3dab1dad 1551 trie->startstate = 1;
786e8c11 1552 trie->wordcount = word_count;
f8fc2ecf 1553 RExC_rxi->data->data[ data_slot ] = (void*)trie;
c944940b 1554 trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
fab2782b 1555 if (flags == EXACT)
c944940b 1556 trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2e64971a
DM
1557 trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
1558 trie->wordcount+1, sizeof(reg_trie_wordinfo));
1559
a3621e74 1560 DEBUG_r({
2b8b4781 1561 trie_words = newAV();
a3621e74 1562 });
a3621e74 1563
0111c4fd 1564 re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
a3621e74 1565 if (!SvIOK(re_trie_maxbuff)) {
0111c4fd 1566 sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
a3621e74 1567 }
df826430 1568 DEBUG_TRIE_COMPILE_r({
3dab1dad 1569 PerlIO_printf( Perl_debug_log,
786e8c11 1570 "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
3dab1dad
YO
1571 (int)depth * 2 + 2, "",
1572 REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
786e8c11 1573 REG_NODE_NUM(last), REG_NODE_NUM(tail),
85c3142d 1574 (int)depth);
3dab1dad 1575 });
7f69552c
YO
1576
1577 /* Find the node we are going to overwrite */
1578 if ( first == startbranch && OP( last ) != BRANCH ) {
1579 /* whole branch chain */
1580 convert = first;
1581 } else {
1582 /* branch sub-chain */
1583 convert = NEXTOPER( first );
1584 }
1585
a3621e74
YO
1586 /* -- First loop and Setup --
1587
1588 We first traverse the branches and scan each word to determine if it
1589 contains widechars, and how many unique chars there are, this is
1590 important as we have to build a table with at least as many columns as we
1591 have unique chars.
1592
1593 We use an array of integers to represent the character codes 0..255
38a44b82 1594 (trie->charmap) and we use a an HV* to store Unicode characters. We use the
a3621e74
YO
1595 native representation of the character value as the key and IV's for the
1596 coded index.
1597
1598 *TODO* If we keep track of how many times each character is used we can
1599 remap the columns so that the table compression later on is more
3b753521 1600 efficient in terms of memory by ensuring the most common value is in the
a3621e74
YO
1601 middle and the least common are on the outside. IMO this would be better
1602 than a most to least common mapping as theres a decent chance the most
1603 common letter will share a node with the least common, meaning the node
486ec47a 1604 will not be compressible. With a middle is most common approach the worst
a3621e74
YO
1605 case is when we have the least common nodes twice.
1606
1607 */
1608
a3621e74 1609 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
df826430 1610 regnode *noper = NEXTOPER( cur );
e1ec3a88 1611 const U8 *uc = (U8*)STRING( noper );
df826430 1612 const U8 *e = uc + STR_LEN( noper );
a3621e74
YO
1613 STRLEN foldlen = 0;
1614 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
fab2782b 1615 STRLEN skiplen = 0;
2af232bd 1616 const U8 *scan = (U8*)NULL;
07be1b83 1617 U32 wordlen = 0; /* required init */
02daf0ab
YO
1618 STRLEN chars = 0;
1619 bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
a3621e74 1620
3dab1dad 1621 if (OP(noper) == NOTHING) {
df826430
YO
1622 regnode *noper_next= regnext(noper);
1623 if (noper_next != tail && OP(noper_next) == flags) {
1624 noper = noper_next;
1625 uc= (U8*)STRING(noper);
1626 e= uc + STR_LEN(noper);
1627 trie->minlen= STR_LEN(noper);
1628 } else {
1629 trie->minlen= 0;
1630 continue;
1631 }
3dab1dad 1632 }
df826430 1633
fab2782b 1634 if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
02daf0ab
YO
1635 TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1636 regardless of encoding */
fab2782b
YO
1637 if (OP( noper ) == EXACTFU_SS) {
1638 /* false positives are ok, so just set this */
1639 TRIE_BITMAP_SET(trie,0xDF);
1640 }
1641 }
a3621e74 1642 for ( ; uc < e ; uc += len ) {
3dab1dad 1643 TRIE_CHARCOUNT(trie)++;
a3621e74 1644 TRIE_READ_CHAR;
3dab1dad 1645 chars++;
a3621e74 1646 if ( uvc < 256 ) {
fab2782b
YO
1647 if ( folder ) {
1648 U8 folded= folder[ (U8) uvc ];
1649 if ( !trie->charmap[ folded ] ) {
1650 trie->charmap[ folded ]=( ++trie->uniquecharcount );
1651 TRIE_STORE_REVCHAR( folded );
1652 }
1653 }
a3621e74
YO
1654 if ( !trie->charmap[ uvc ] ) {
1655 trie->charmap[ uvc ]=( ++trie->uniquecharcount );
fab2782b 1656 TRIE_STORE_REVCHAR( uvc );
a3621e74 1657 }
02daf0ab 1658 if ( set_bit ) {
62012aee
KW
1659 /* store the codepoint in the bitmap, and its folded
1660 * equivalent. */
fab2782b 1661 TRIE_BITMAP_SET(trie, uvc);
0921ee73
T
1662
1663 /* store the folded codepoint */
fab2782b 1664 if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
0921ee73
T
1665
1666 if ( !UTF ) {
1667 /* store first byte of utf8 representation of
acdf4139
KW
1668 variant codepoints */
1669 if (! UNI_IS_INVARIANT(uvc)) {
1670 TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
0921ee73
T
1671 }
1672 }
02daf0ab
YO
1673 set_bit = 0; /* We've done our bit :-) */
1674 }
a3621e74
YO
1675 } else {
1676 SV** svpp;
55eed653
NC
1677 if ( !widecharmap )
1678 widecharmap = newHV();
a3621e74 1679
55eed653 1680 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
a3621e74
YO
1681
1682 if ( !svpp )
e4584336 1683 Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
a3621e74
YO
1684
1685 if ( !SvTRUE( *svpp ) ) {
1686 sv_setiv( *svpp, ++trie->uniquecharcount );
fab2782b 1687 TRIE_STORE_REVCHAR(uvc);
a3621e74
YO
1688 }
1689 }
1690 }
3dab1dad 1691 if( cur == first ) {
fab2782b
YO
1692 trie->minlen = chars;
1693 trie->maxlen = chars;
3dab1dad 1694 } else if (chars < trie->minlen) {
fab2782b 1695 trie->minlen = chars;
3dab1dad 1696 } else if (chars > trie->maxlen) {
fab2782b
YO
1697 trie->maxlen = chars;
1698 }
1699 if (OP( noper ) == EXACTFU_SS) {
1700 /* XXX: workaround - 'ss' could match "\x{DF}" so minlen could be 1 and not 2*/
1701 if (trie->minlen > 1)
1702 trie->minlen= 1;
1703 }
1704 if (OP( noper ) == EXACTFU_TRICKYFOLD) {
1705 /* XXX: workround - things like "\x{1FBE}\x{0308}\x{0301}" can match "\x{0390}"
1706 * - We assume that any such sequence might match a 2 byte string */
1707 if (trie->minlen > 2 )
1708 trie->minlen= 2;
3dab1dad
YO
1709 }
1710
a3621e74
YO
1711 } /* end first pass */
1712 DEBUG_TRIE_COMPILE_r(
3dab1dad
YO
1713 PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1714 (int)depth * 2 + 2,"",
55eed653 1715 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
be8e71aa
YO
1716 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1717 (int)trie->minlen, (int)trie->maxlen )
a3621e74 1718 );
a3621e74
YO
1719
1720 /*
1721 We now know what we are dealing with in terms of unique chars and
1722 string sizes so we can calculate how much memory a naive
0111c4fd
RGS
1723 representation using a flat table will take. If it's over a reasonable
1724 limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
a3621e74
YO
1725 conservative but potentially much slower representation using an array
1726 of lists.
1727
1728 At the end we convert both representations into the same compressed
1729 form that will be used in regexec.c for matching with. The latter
1730 is a form that cannot be used to construct with but has memory
1731 properties similar to the list form and access properties similar
1732 to the table form making it both suitable for fast searches and
1733 small enough that its feasable to store for the duration of a program.
1734
1735 See the comment in the code where the compressed table is produced
1736 inplace from the flat tabe representation for an explanation of how
1737 the compression works.
1738
1739 */
1740
1741
2e64971a
DM
1742 Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
1743 prev_states[1] = 0;
1744
3dab1dad 1745 if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
a3621e74
YO
1746 /*
1747 Second Pass -- Array Of Lists Representation
1748
1749 Each state will be represented by a list of charid:state records
1750 (reg_trie_trans_le) the first such element holds the CUR and LEN
1751 points of the allocated array. (See defines above).
1752
1753 We build the initial structure using the lists, and then convert
1754 it into the compressed table form which allows faster lookups
1755 (but cant be modified once converted).
a3621e74
YO
1756 */
1757
a3621e74
YO
1758 STRLEN transcount = 1;
1759
1e2e3d02
YO
1760 DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
1761 "%*sCompiling trie using list compiler\n",
1762 (int)depth * 2 + 2, ""));
686b73d4 1763
c944940b
JH
1764 trie->states = (reg_trie_state *)
1765 PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1766 sizeof(reg_trie_state) );
a3621e74
YO
1767 TRIE_LIST_NEW(1);
1768 next_alloc = 2;
1769
1770 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1771
df826430 1772 regnode *noper = NEXTOPER( cur );
c445ea15 1773 U8 *uc = (U8*)STRING( noper );
df826430 1774 const U8 *e = uc + STR_LEN( noper );
c445ea15
AL
1775 U32 state = 1; /* required init */
1776 U16 charid = 0; /* sanity init */
1777 U8 *scan = (U8*)NULL; /* sanity init */
1778 STRLEN foldlen = 0; /* required init */
07be1b83 1779 U32 wordlen = 0; /* required init */
c445ea15 1780 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
fab2782b 1781 STRLEN skiplen = 0;
c445ea15 1782
df826430
YO
1783 if (OP(noper) == NOTHING) {
1784 regnode *noper_next= regnext(noper);
1785 if (noper_next != tail && OP(noper_next) == flags) {
1786 noper = noper_next;
1787 uc= (U8*)STRING(noper);
1788 e= uc + STR_LEN(noper);
1789 }
1790 }
1791
3dab1dad 1792 if (OP(noper) != NOTHING) {
786e8c11 1793 for ( ; uc < e ; uc += len ) {
c445ea15 1794
786e8c11 1795 TRIE_READ_CHAR;
c445ea15 1796
786e8c11
YO
1797 if ( uvc < 256 ) {
1798 charid = trie->charmap[ uvc ];
c445ea15 1799 } else {
55eed653 1800 SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
786e8c11
YO
1801 if ( !svpp ) {
1802 charid = 0;
1803 } else {
1804 charid=(U16)SvIV( *svpp );
1805 }
c445ea15 1806 }
786e8c11
YO
1807 /* charid is now 0 if we dont know the char read, or nonzero if we do */
1808 if ( charid ) {
a3621e74 1809
786e8c11
YO
1810 U16 check;
1811 U32 newstate = 0;
a3621e74 1812
786e8c11
YO
1813 charid--;
1814 if ( !trie->states[ state ].trans.list ) {
1815 TRIE_LIST_NEW( state );
c445ea15 1816 }
786e8c11
YO
1817 for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1818 if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1819 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1820 break;
1821 }
1822 }
1823 if ( ! newstate ) {
1824 newstate = next_alloc++;
2e64971a 1825 prev_states[newstate] = state;
786e8c11
YO
1826 TRIE_LIST_PUSH( state, charid, newstate );
1827 transcount++;
1828 }
1829 state = newstate;
1830 } else {
1831 Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
c445ea15 1832 }
a28509cc 1833 }
c445ea15 1834 }
3dab1dad 1835 TRIE_HANDLE_WORD(state);
a3621e74
YO
1836
1837 } /* end second pass */
1838
1e2e3d02
YO
1839 /* next alloc is the NEXT state to be allocated */
1840 trie->statecount = next_alloc;
c944940b
JH
1841 trie->states = (reg_trie_state *)
1842 PerlMemShared_realloc( trie->states,
1843 next_alloc
1844 * sizeof(reg_trie_state) );
a3621e74 1845
3dab1dad 1846 /* and now dump it out before we compress it */
2b8b4781
NC
1847 DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1848 revcharmap, next_alloc,
1849 depth+1)
1e2e3d02 1850 );
a3621e74 1851
c944940b
JH
1852 trie->trans = (reg_trie_trans *)
1853 PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
a3621e74
YO
1854 {
1855 U32 state;
a3621e74
YO
1856 U32 tp = 0;
1857 U32 zp = 0;
1858
1859
1860 for( state=1 ; state < next_alloc ; state ++ ) {
1861 U32 base=0;
1862
1863 /*
1864 DEBUG_TRIE_COMPILE_MORE_r(
1865 PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1866 );
1867 */
1868
1869 if (trie->states[state].trans.list) {
1870 U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1871 U16 maxid=minid;
a28509cc 1872 U16 idx;
a3621e74
YO
1873
1874 for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
c445ea15
AL
1875 const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1876 if ( forid < minid ) {
1877 minid=forid;
1878 } else if ( forid > maxid ) {
1879 maxid=forid;
1880 }
a3621e74
YO
1881 }
1882 if ( transcount < tp + maxid - minid + 1) {
1883 transcount *= 2;
c944940b
JH
1884 trie->trans = (reg_trie_trans *)
1885 PerlMemShared_realloc( trie->trans,
446bd890
NC
1886 transcount
1887 * sizeof(reg_trie_trans) );
a3621e74
YO
1888 Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1889 }
1890 base = trie->uniquecharcount + tp - minid;
1891 if ( maxid == minid ) {
1892 U32 set = 0;
1893 for ( ; zp < tp ; zp++ ) {
1894 if ( ! trie->trans[ zp ].next ) {
1895 base = trie->uniquecharcount + zp - minid;
1896 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1897 trie->trans[ zp ].check = state;
1898 set = 1;
1899 break;
1900 }
1901 }
1902 if ( !set ) {
1903 trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1904 trie->trans[ tp ].check = state;
1905 tp++;
1906 zp = tp;
1907 }
1908 } else {
1909 for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
c445ea15 1910 const U32 tid = base - trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
a3621e74
YO
1911 trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1912 trie->trans[ tid ].check = state;
1913 }
1914 tp += ( maxid - minid + 1 );
1915 }
1916 Safefree(trie->states[ state ].trans.list);
1917 }
1918 /*
1919 DEBUG_TRIE_COMPILE_MORE_r(
1920 PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1921 );
1922 */
1923 trie->states[ state ].trans.base=base;
1924 }
cc601c31 1925 trie->lasttrans = tp + 1;
a3621e74
YO
1926 }
1927 } else {
1928 /*
1929 Second Pass -- Flat Table Representation.
1930
1931 we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1932 We know that we will need Charcount+1 trans at most to store the data
1933 (one row per char at worst case) So we preallocate both structures
1934 assuming worst case.
1935
1936 We then construct the trie using only the .next slots of the entry
1937 structs.
1938
3b753521 1939 We use the .check field of the first entry of the node temporarily to
a3621e74
YO
1940 make compression both faster and easier by keeping track of how many non
1941 zero fields are in the node.
1942
1943 Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1944 transition.
1945
1946 There are two terms at use here: state as a TRIE_NODEIDX() which is a
1947 number representing the first entry of the node, and state as a
1948 TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1949 TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1950 are 2 entrys per node. eg:
1951
1952 A B A B
1953 1. 2 4 1. 3 7
1954 2. 0 3 3. 0 5
1955 3. 0 0 5. 0 0
1956 4. 0 0 7. 0 0
1957
1958 The table is internally in the right hand, idx form. However as we also
1959 have to deal with the states array which is indexed by nodenum we have to
1960 use TRIE_NODENUM() to convert.
1961
1962 */
1e2e3d02
YO
1963 DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
1964 "%*sCompiling trie using table compiler\n",
1965 (int)depth * 2 + 2, ""));
3dab1dad 1966
c944940b
JH
1967 trie->trans = (reg_trie_trans *)
1968 PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
1969 * trie->uniquecharcount + 1,
1970 sizeof(reg_trie_trans) );
1971 trie->states = (reg_trie_state *)
1972 PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1973 sizeof(reg_trie_state) );
a3621e74
YO
1974 next_alloc = trie->uniquecharcount + 1;
1975
3dab1dad 1976
a3621e74
YO
1977 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1978
df826430 1979 regnode *noper = NEXTOPER( cur );
a28509cc 1980 const U8 *uc = (U8*)STRING( noper );
df826430 1981 const U8 *e = uc + STR_LEN( noper );
a3621e74
YO
1982
1983 U32 state = 1; /* required init */
1984
1985 U16 charid = 0; /* sanity init */
1986 U32 accept_state = 0; /* sanity init */
1987 U8 *scan = (U8*)NULL; /* sanity init */
1988
1989 STRLEN foldlen = 0; /* required init */
07be1b83 1990 U32 wordlen = 0; /* required init */
fab2782b 1991 STRLEN skiplen = 0;
a3621e74
YO
1992 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1993
df826430
YO
1994 if (OP(noper) == NOTHING) {
1995 regnode *noper_next= regnext(noper);
1996 if (noper_next != tail && OP(noper_next) == flags) {
1997 noper = noper_next;
1998 uc= (U8*)STRING(noper);
1999 e= uc + STR_LEN(noper);
2000 }
2001 }
fab2782b 2002
3dab1dad 2003 if ( OP(noper) != NOTHING ) {
786e8c11 2004 for ( ; uc < e ; uc += len ) {
a3621e74 2005
786e8c11 2006 TRIE_READ_CHAR;
a3621e74 2007
786e8c11
YO
2008 if ( uvc < 256 ) {
2009 charid = trie->charmap[ uvc ];
2010 } else {
55eed653 2011 SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
786e8c11 2012 charid = svpp ? (U16)SvIV(*svpp) : 0;
a3621e74 2013 }
786e8c11
YO
2014 if ( charid ) {
2015 charid--;
2016 if ( !trie->trans[ state + charid ].next ) {
2017 trie->trans[ state + charid ].next = next_alloc;
2018 trie->trans[ state ].check++;
2e64971a
DM
2019 prev_states[TRIE_NODENUM(next_alloc)]
2020 = TRIE_NODENUM(state);
786e8c11
YO
2021 next_alloc += trie->uniquecharcount;
2022 }
2023 state = trie->trans[ state + charid ].next;
2024 } else {
2025 Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2026 }
2027 /* charid is now 0 if we dont know the char read, or nonzero if we do */
a3621e74 2028 }
a3621e74 2029 }
3dab1dad
YO
2030 accept_state = TRIE_NODENUM( state );
2031 TRIE_HANDLE_WORD(accept_state);
a3621e74
YO
2032
2033 } /* end second pass */
2034
3dab1dad 2035 /* and now dump it out before we compress it */
2b8b4781
NC
2036 DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2037 revcharmap,
2038 next_alloc, depth+1));
a3621e74 2039
a3621e74
YO
2040 {
2041 /*
2042 * Inplace compress the table.*
2043
2044 For sparse data sets the table constructed by the trie algorithm will
2045 be mostly 0/FAIL transitions or to put it another way mostly empty.
2046 (Note that leaf nodes will not contain any transitions.)
2047
2048 This algorithm compresses the tables by eliminating most such
2049 transitions, at the cost of a modest bit of extra work during lookup:
2050
2051 - Each states[] entry contains a .base field which indicates the
2052 index in the state[] array wheres its transition data is stored.
2053
3b753521 2054 - If .base is 0 there are no valid transitions from that node.
a3621e74
YO
2055
2056 - If .base is nonzero then charid is added to it to find an entry in
2057 the trans array.
2058
2059 -If trans[states[state].base+charid].check!=state then the
2060 transition is taken to be a 0/Fail transition. Thus if there are fail
2061 transitions at the front of the node then the .base offset will point
2062 somewhere inside the previous nodes data (or maybe even into a node
2063 even earlier), but the .check field determines if the transition is
2064 valid.
2065
786e8c11 2066 XXX - wrong maybe?
a3621e74 2067 The following process inplace converts the table to the compressed
3b753521 2068 table: We first do not compress the root node 1,and mark all its
a3621e74 2069 .check pointers as 1 and set its .base pointer as 1 as well. This
3b753521
FN
2070 allows us to do a DFA construction from the compressed table later,
2071 and ensures that any .base pointers we calculate later are greater
2072 than 0.
a3621e74
YO
2073
2074 - We set 'pos' to indicate the first entry of the second node.
2075
2076 - We then iterate over the columns of the node, finding the first and
2077 last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2078 and set the .check pointers accordingly, and advance pos
2079 appropriately and repreat for the next node. Note that when we copy
2080 the next pointers we have to convert them from the original
2081 NODEIDX form to NODENUM form as the former is not valid post
2082 compression.
2083
2084 - If a node has no transitions used we mark its base as 0 and do not
2085 advance the pos pointer.
2086
2087 - If a node only has one transition we use a second pointer into the
2088 structure to fill in allocated fail transitions from other states.
2089 This pointer is independent of the main pointer and scans forward
2090 looking for null transitions that are allocated to a state. When it
2091 finds one it writes the single transition into the "hole". If the
786e8c11 2092 pointer doesnt find one the single transition is appended as normal.
a3621e74
YO
2093
2094 - Once compressed we can Renew/realloc the structures to release the
2095 excess space.
2096
2097 See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2098 specifically Fig 3.47 and the associated pseudocode.
2099
2100 demq
2101 */
a3b680e6 2102 const U32 laststate = TRIE_NODENUM( next_alloc );
a28509cc 2103 U32 state, charid;
a3621e74 2104 U32 pos = 0, zp=0;
1e2e3d02 2105 trie->statecount = laststate;
a3621e74
YO
2106
2107 for ( state = 1 ; state < laststate ; state++ ) {
2108 U8 flag = 0;
a28509cc
AL
2109 const U32 stateidx = TRIE_NODEIDX( state );
2110 const U32 o_used = trie->trans[ stateidx ].check;
2111 U32 used = trie->trans[ stateidx ].check;
a3621e74
YO
2112 trie->trans[ stateidx ].check = 0;
2113
2114 for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
2115 if ( flag || trie->trans[ stateidx + charid ].next ) {
2116 if ( trie->trans[ stateidx + charid ].next ) {
2117 if (o_used == 1) {
2118 for ( ; zp < pos ; zp++ ) {
2119 if ( ! trie->trans[ zp ].next ) {
2120 break;
2121 }
2122 }
2123 trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
2124 trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2125 trie->trans[ zp ].check = state;
2126 if ( ++zp > pos ) pos = zp;
2127 break;
2128 }
2129 used--;
2130 }
2131 if ( !flag ) {
2132 flag = 1;
2133 trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
2134 }
2135 trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2136 trie->trans[ pos ].check = state;
2137 pos++;
2138 }
2139 }
2140 }
cc601c31 2141 trie->lasttrans = pos + 1;
c944940b
JH
2142 trie->states = (reg_trie_state *)
2143 PerlMemShared_realloc( trie->states, laststate
2144 * sizeof(reg_trie_state) );
a3621e74 2145 DEBUG_TRIE_COMPILE_MORE_r(
e4584336 2146 PerlIO_printf( Perl_debug_log,
3dab1dad
YO
2147 "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2148 (int)depth * 2 + 2,"",
2149 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
5d7488b2
AL
2150 (IV)next_alloc,
2151 (IV)pos,
a3621e74
YO
2152 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2153 );
2154
2155 } /* end table compress */
2156 }
1e2e3d02
YO
2157 DEBUG_TRIE_COMPILE_MORE_r(
2158 PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2159 (int)depth * 2 + 2, "",
2160 (UV)trie->statecount,
2161 (UV)trie->lasttrans)
2162 );
cc601c31 2163 /* resize the trans array to remove unused space */
c944940b
JH
2164 trie->trans = (reg_trie_trans *)
2165 PerlMemShared_realloc( trie->trans, trie->lasttrans
2166 * sizeof(reg_trie_trans) );
a3621e74 2167
3b753521 2168 { /* Modify the program and insert the new TRIE node */
3dab1dad
YO
2169 U8 nodetype =(U8)(flags & 0xFF);
2170 char *str=NULL;
786e8c11 2171
07be1b83 2172#ifdef DEBUGGING
e62cc96a 2173 regnode *optimize = NULL;
7122b237
YO
2174#ifdef RE_TRACK_PATTERN_OFFSETS
2175
b57a0404
JH
2176 U32 mjd_offset = 0;
2177 U32 mjd_nodelen = 0;
7122b237
YO
2178#endif /* RE_TRACK_PATTERN_OFFSETS */
2179#endif /* DEBUGGING */
a3621e74 2180 /*
3dab1dad
YO
2181 This means we convert either the first branch or the first Exact,
2182 depending on whether the thing following (in 'last') is a branch
2183 or not and whther first is the startbranch (ie is it a sub part of
2184 the alternation or is it the whole thing.)
3b753521 2185 Assuming its a sub part we convert the EXACT otherwise we convert
3dab1dad 2186 the whole branch sequence, including the first.
a3621e74 2187 */
3dab1dad 2188 /* Find the node we are going to overwrite */
7f69552c 2189 if ( first != startbranch || OP( last ) == BRANCH ) {
07be1b83 2190 /* branch sub-chain */
3dab1dad 2191 NEXT_OFF( first ) = (U16)(last - first);
7122b237 2192#ifdef RE_TRACK_PATTERN_OFFSETS
07be1b83
YO
2193 DEBUG_r({
2194 mjd_offset= Node_Offset((convert));
2195 mjd_nodelen= Node_Length((convert));
2196 });
7122b237 2197#endif
7f69552c 2198 /* whole branch chain */
7122b237
YO
2199 }
2200#ifdef RE_TRACK_PATTERN_OFFSETS
2201 else {
7f69552c
YO
2202 DEBUG_r({
2203 const regnode *nop = NEXTOPER( convert );
2204 mjd_offset= Node_Offset((nop));
2205 mjd_nodelen= Node_Length((nop));
2206 });
07be1b83
YO
2207 }
2208 DEBUG_OPTIMISE_r(
2209 PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2210 (int)depth * 2 + 2, "",
786e8c11 2211 (UV)mjd_offset, (UV)mjd_nodelen)
07be1b83 2212 );
7122b237 2213#endif
3dab1dad
YO
2214 /* But first we check to see if there is a common prefix we can
2215 split out as an EXACT and put in front of the TRIE node. */
2216 trie->startstate= 1;
55eed653 2217 if ( trie->bitmap && !widecharmap && !trie->jump ) {
3dab1dad 2218 U32 state;
1e2e3d02 2219 for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
a3621e74 2220 U32 ofs = 0;
8e11feef
RGS
2221 I32 idx = -1;
2222 U32 count = 0;
2223 const U32 base = trie->states[ state ].trans.base;
a3621e74 2224
3dab1dad 2225 if ( trie->states[state].wordnum )
8e11feef 2226 count = 1;
a3621e74 2227
8e11feef 2228 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
cc601c31
YO
2229 if ( ( base + ofs >= trie->uniquecharcount ) &&
2230 ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
a3621e74
YO
2231 trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2232 {
3dab1dad 2233 if ( ++count > 1 ) {
2b8b4781 2234 SV **tmp = av_fetch( revcharmap, ofs, 0);
07be1b83 2235 const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
8e11feef 2236 if ( state == 1 ) break;
3dab1dad
YO
2237 if ( count == 2 ) {
2238 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2239 DEBUG_OPTIMISE_r(
8e11feef
RGS
2240 PerlIO_printf(Perl_debug_log,
2241 "%*sNew Start State=%"UVuf" Class: [",
2242 (int)depth * 2 + 2, "",
786e8c11 2243 (UV)state));
be8e71aa 2244 if (idx >= 0) {
2b8b4781 2245 SV ** const tmp = av_fetch( revcharmap, idx, 0);
be8e71aa 2246 const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
8e11feef 2247
3dab1dad 2248 TRIE_BITMAP_SET(trie,*ch);
8e11feef
RGS
2249 if ( folder )
2250 TRIE_BITMAP_SET(trie, folder[ *ch ]);
3dab1dad 2251 DEBUG_OPTIMISE_r(
f1f66076 2252 PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
3dab1dad 2253 );
8e11feef
RGS
2254 }
2255 }
2256 TRIE_BITMAP_SET(trie,*ch);
2257 if ( folder )
2258 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2259 DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2260 }
2261 idx = ofs;
2262 }
3dab1dad
YO
2263 }
2264 if ( count == 1 ) {
2b8b4781 2265 SV **tmp = av_fetch( revcharmap, idx, 0);
c490c714
YO
2266 STRLEN len;
2267 char *ch = SvPV( *tmp, len );
de734bd5
A
2268 DEBUG_OPTIMISE_r({
2269 SV *sv=sv_newmortal();
8e11feef
RGS
2270 PerlIO_printf( Perl_debug_log,
2271 "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2272 (int)depth * 2 + 2, "",
de734bd5
A
2273 (UV)state, (UV)idx,
2274 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
2275 PL_colors[0], PL_colors[1],
2276 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2277 PERL_PV_ESCAPE_FIRSTCHAR
2278 )
2279 );
2280 });
3dab1dad
YO
2281 if ( state==1 ) {
2282 OP( convert ) = nodetype;
2283 str=STRING(convert);
2284 STR_LEN(convert)=0;
2285 }
c490c714
YO
2286 STR_LEN(convert) += len;
2287 while (len--)
de734bd5 2288 *str++ = *ch++;
8e11feef 2289 } else {
f9049ba1 2290#ifdef DEBUGGING
8e11feef
RGS
2291 if (state>1)
2292 DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
f9049ba1 2293#endif
8e11feef
RGS
2294 break;
2295 }
2296 }
2e64971a 2297 trie->prefixlen = (state-1);
3dab1dad 2298 if (str) {
8e11feef 2299 regnode *n = convert+NODE_SZ_STR(convert);
07be1b83 2300 NEXT_OFF(convert) = NODE_SZ_STR(convert);
8e11feef 2301 trie->startstate = state;
07be1b83
YO
2302 trie->minlen -= (state - 1);
2303 trie->maxlen -= (state - 1);
33809eae
JH
2304#ifdef DEBUGGING
2305 /* At least the UNICOS C compiler choked on this
2306 * being argument to DEBUG_r(), so let's just have
2307 * it right here. */
2308 if (
2309#ifdef PERL_EXT_RE_BUILD
2310 1
2311#else
2312 DEBUG_r_TEST
2313#endif
2314 ) {
2315 regnode *fix = convert;
2316 U32 word = trie->wordcount;
2317 mjd_nodelen++;
2318 Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2319 while( ++fix < n ) {
2320 Set_Node_Offset_Length(fix, 0, 0);
2321 }
2322 while (word--) {
2323 SV ** const tmp = av_fetch( trie_words, word, 0 );
2324 if (tmp) {
2325 if ( STR_LEN(convert) <= SvCUR(*tmp) )
2326 sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2327 else
2328 sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2329 }
2330 }
2331 }
2332#endif
8e11feef
RGS
2333 if (trie->maxlen) {
2334 convert = n;
2335 } else {
3dab1dad 2336 NEXT_OFF(convert) = (U16)(tail - convert);
a5ca303d 2337 DEBUG_r(optimize= n);
3dab1dad
YO
2338 }
2339 }
2340 }
a5ca303d
YO
2341 if (!jumper)
2342 jumper = last;
3dab1dad 2343 if ( trie->maxlen ) {
8e11feef
RGS
2344 NEXT_OFF( convert ) = (U16)(tail - convert);
2345 ARG_SET( convert, data_slot );
786e8c11
YO
2346 /* Store the offset to the first unabsorbed branch in
2347 jump[0], which is otherwise unused by the jump logic.
2348 We use this when dumping a trie and during optimisation. */
2349 if (trie->jump)
7f69552c 2350 trie->jump[0] = (U16)(nextbranch - convert);
a5ca303d 2351
6c48061a
YO
2352 /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2353 * and there is a bitmap
2354 * and the first "jump target" node we found leaves enough room
2355 * then convert the TRIE node into a TRIEC node, with the bitmap
2356 * embedded inline in the opcode - this is hypothetically faster.
2357 */
2358 if ( !trie->states[trie->startstate].wordnum
2359 && trie->bitmap
2360 && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
786e8c11
YO
2361 {
2362 OP( convert ) = TRIEC;
2363 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
446bd890 2364 PerlMemShared_free(trie->bitmap);
786e8c11
YO
2365 trie->bitmap= NULL;
2366 } else
2367 OP( convert ) = TRIE;
a3621e74 2368
3dab1dad
YO
2369 /* store the type in the flags */
2370 convert->flags = nodetype;
a5ca303d
YO
2371 DEBUG_r({
2372 optimize = convert
2373 + NODE_STEP_REGNODE
2374 + regarglen[ OP( convert ) ];
2375 });
2376 /* XXX We really should free up the resource in trie now,
2377 as we won't use them - (which resources?) dmq */
3dab1dad 2378 }
a3621e74 2379 /* needed for dumping*/
e62cc96a 2380 DEBUG_r(if (optimize) {
07be1b83 2381 regnode *opt = convert;
bcdf7404 2382
e62cc96a 2383 while ( ++opt < optimize) {
07be1b83
YO
2384 Set_Node_Offset_Length(opt,0,0);
2385 }
786e8c11
YO
2386 /*
2387 Try to clean up some of the debris left after the
2388 optimisation.
a3621e74 2389 */
786e8c11 2390 while( optimize < jumper ) {
07be1b83 2391 mjd_nodelen += Node_Length((optimize));
a3621e74 2392 OP( optimize ) = OPTIMIZED;
07be1b83 2393 Set_Node_Offset_Length(optimize,0,0);
a3621e74
YO
2394 optimize++;
2395 }
07be1b83 2396 Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
a3621e74
YO
2397 });
2398 } /* end node insert */
2e64971a
DM
2399
2400 /* Finish populating the prev field of the wordinfo array. Walk back
2401 * from each accept state until we find another accept state, and if
2402 * so, point the first word's .prev field at the second word. If the
2403 * second already has a .prev field set, stop now. This will be the
2404 * case either if we've already processed that word's accept state,
3b753521
FN
2405 * or that state had multiple words, and the overspill words were
2406 * already linked up earlier.
2e64971a
DM
2407 */
2408 {
2409 U16 word;
2410 U32 state;
2411 U16 prev;
2412
2413 for (word=1; word <= trie->wordcount; word++) {
2414 prev = 0;
2415 if (trie->wordinfo[word].prev)
2416 continue;
2417 state = trie->wordinfo[word].accept;
2418 while (state) {
2419 state = prev_states[state];
2420 if (!state)
2421 break;
2422 prev = trie->states[state].wordnum;
2423 if (prev)
2424 break;
2425 }
2426 trie->wordinfo[word].prev = prev;
2427 }
2428 Safefree(prev_states);
2429 }
2430
2431
2432 /* and now dump out the compressed format */
2433 DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2434
55eed653 2435 RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2b8b4781
NC
2436#ifdef DEBUGGING
2437 RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2438 RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2439#else
2440 SvREFCNT_dec(revcharmap);
07be1b83 2441#endif
786e8c11
YO
2442 return trie->jump
2443 ? MADE_JUMP_TRIE
2444 : trie->startstate>1
2445 ? MADE_EXACT_TRIE
2446 : MADE_TRIE;
2447}
2448
2449STATIC void
2450S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source, regnode *stclass, U32 depth)
2451{
3b753521 2452/* The Trie is constructed and compressed now so we can build a fail array if it's needed
786e8c11
YO
2453
2454 This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2455 "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2456 ISBN 0-201-10088-6
2457
2458 We find the fail state for each state in the trie, this state is the longest proper
3b753521
FN
2459 suffix of the current state's 'word' that is also a proper prefix of another word in our
2460 trie. State 1 represents the word '' and is thus the default fail state. This allows
786e8c11
YO
2461 the DFA not to have to restart after its tried and failed a word at a given point, it
2462 simply continues as though it had been matching the other word in the first place.
2463 Consider
2464 'abcdgu'=~/abcdefg|cdgu/
2465 When we get to 'd' we are still matching the first word, we would encounter 'g' which would
3b753521
FN
2466 fail, which would bring us to the state representing 'd' in the second word where we would
2467 try 'g' and succeed, proceeding to match 'cdgu'.
786e8c11
YO
2468 */
2469 /* add a fail transition */
3251b653
NC
2470 const U32 trie_offset = ARG(source);
2471 reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
786e8c11
YO
2472 U32 *q;
2473 const U32 ucharcount = trie->uniquecharcount;
1e2e3d02 2474 const U32 numstates = trie->statecount;
786e8c11
YO
2475 const U32 ubound = trie->lasttrans + ucharcount;
2476 U32 q_read = 0;
2477 U32 q_write = 0;
2478 U32 charid;
2479 U32 base = trie->states[ 1 ].trans.base;
2480 U32 *fail;
2481 reg_ac_data *aho;
2482 const U32 data_slot = add_data( pRExC_state, 1, "T" );
2483 GET_RE_DEBUG_FLAGS_DECL;
7918f24d
NC
2484
2485 PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
786e8c11
YO
2486#ifndef DEBUGGING
2487 PERL_UNUSED_ARG(depth);
2488#endif
2489
2490
2491 ARG_SET( stclass, data_slot );
c944940b 2492 aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
f8fc2ecf 2493 RExC_rxi->data->data[ data_slot ] = (void*)aho;
3251b653 2494 aho->trie=trie_offset;
446bd890
NC
2495 aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2496 Copy( trie->states, aho->states, numstates, reg_trie_state );
786e8c11 2497 Newxz( q, numstates, U32);
c944940b 2498 aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
786e8c11
YO
2499 aho->refcount = 1;
2500 fail = aho->fail;
2501 /* initialize fail[0..1] to be 1 so that we always have
2502 a valid final fail state */
2503 fail[ 0 ] = fail[ 1 ] = 1;
2504
2505 for ( charid = 0; charid < ucharcount ; charid++ ) {
2506 const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2507 if ( newstate ) {
2508 q[ q_write ] = newstate;
2509 /* set to point at the root */
2510 fail[ q[ q_write++ ] ]=1;
2511 }
2512 }
2513 while ( q_read < q_write) {
2514 const U32 cur = q[ q_read++ % numstates ];
2515 base = trie->states[ cur ].trans.base;
2516
2517 for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2518 const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2519 if (ch_state) {
2520 U32 fail_state = cur;
2521 U32 fail_base;
2522 do {
2523 fail_state = fail[ fail_state ];
2524 fail_base = aho->states[ fail_state ].trans.base;
2525 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2526
2527 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2528 fail[ ch_state ] = fail_state;
2529 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2530 {
2531 aho->states[ ch_state ].wordnum = aho->states[ fail_state ].wordnum;
2532 }
2533 q[ q_write++ % numstates] = ch_state;
2534 }
2535 }
2536 }
2537 /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2538 when we fail in state 1, this allows us to use the
2539 charclass scan to find a valid start char. This is based on the principle
2540 that theres a good chance the string being searched contains lots of stuff
2541 that cant be a start char.
2542 */
2543 fail[ 0 ] = fail[ 1 ] = 0;
2544 DEBUG_TRIE_COMPILE_r({
6d99fb9b
JH
2545 PerlIO_printf(Perl_debug_log,
2546 "%*sStclass Failtable (%"UVuf" states): 0",
2547 (int)(depth * 2), "", (UV)numstates
1e2e3d02 2548 );
786e8c11
YO
2549 for( q_read=1; q_read<numstates; q_read++ ) {
2550 PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2551 }
2552 PerlIO_printf(Perl_debug_log, "\n");
2553 });
2554 Safefree(q);
2555 /*RExC_seen |= REG_SEEN_TRIEDFA;*/
a3621e74
YO
2556}
2557
786e8c11 2558
a3621e74 2559/*
5d1c421c
JH
2560 * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2561 * These need to be revisited when a newer toolchain becomes available.
2562 */
2563#if defined(__sparc64__) && defined(__GNUC__)
2564# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2565# undef SPARC64_GCC_WORKAROUND
2566# define SPARC64_GCC_WORKAROUND 1
2567# endif
2568#endif
2569
07be1b83 2570#define DEBUG_PEEP(str,scan,depth) \
b515a41d 2571 DEBUG_OPTIMISE_r({if (scan){ \
07be1b83
YO
2572 SV * const mysv=sv_newmortal(); \
2573 regnode *Next = regnext(scan); \
2574 regprop(RExC_rx, mysv, scan); \
7f69552c 2575 PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
07be1b83
YO
2576 (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2577 Next ? (REG_NODE_NUM(Next)) : 0 ); \
b515a41d 2578 }});
07be1b83 2579
1de06328 2580
bb914485
KW
2581/* The below joins as many adjacent EXACTish nodes as possible into a single
2582 * one, and looks for problematic sequences of characters whose folds vs.
2583 * non-folds have sufficiently different lengths, that the optimizer would be
2584 * fooled into rejecting legitimate matches of them, and the trie construction
2585 * code can't cope with them. The joining is only done if:
2586 * 1) there is room in the current conglomerated node to entirely contain the
2587 * next one.
2588 * 2) they are the exact same node type
2589 *
2590 * The adjacent nodes actually may be separated by NOTHING kind nodes, and
2591 * these get optimized out
2592 *
9d071ca8
KW
2593 * If there are problematic code sequences, *min_subtract is set to the delta
2594 * that the minimum size of the node can be less than its actual size. And,
2595 * the node type of the result is changed to reflect that it contains these
bb914485
KW
2596 * sequences.
2597 *
a0c4c608
KW
2598 * And *has_exactf_sharp_s is set to indicate whether or not the node is EXACTF
2599 * and contains LATIN SMALL LETTER SHARP S
f758bddf 2600 *
bb914485
KW
2601 * This is as good a place as any to discuss the design of handling these
2602 * problematic sequences. It's been wrong in Perl for a very long time. There
2603 * are three code points in Unicode whose folded lengths differ so much from
2604 * the un-folded lengths that it causes problems for the optimizer and trie
2605 * construction. Why only these are problematic, and not others where lengths
2606 * also differ is something I (khw) do not understand. New versions of Unicode
2607 * might add more such code points. Hopefully the logic in fold_grind.t that
287722f3 2608 * figures out what to test (in part by verifying that each size-combination
bb914485 2609 * gets tested) will catch any that do come along, so they can be added to the
287722f3
KW
2610 * special handling below. The chances of new ones are actually rather small,
2611 * as most, if not all, of the world's scripts that have casefolding have
2612 * already been encoded by Unicode. Also, a number of Unicode's decisions were
2613 * made to allow compatibility with pre-existing standards, and almost all of
2614 * those have already been dealt with. These would otherwise be the most
2615 * likely candidates for generating further tricky sequences. In other words,
2616 * Unicode by itself is unlikely to add new ones unless it is for compatibility
a0c4c608 2617 * with pre-existing standards, and there aren't many of those left.
bb914485
KW
2618 *
2619 * The previous designs for dealing with these involved assigning a special
2620 * node for them. This approach doesn't work, as evidenced by this example:
a0c4c608 2621 * "\xDFs" =~ /s\xDF/ui # Used to fail before these patches
bb914485
KW
2622 * Both these fold to "sss", but if the pattern is parsed to create a node of
2623 * that would match just the \xDF, it won't be able to handle the case where a
2624 * successful match would have to cross the node's boundary. The new approach
2625 * that hopefully generally solves the problem generates an EXACTFU_SS node
2626 * that is "sss".
2627 *
2628 * There are a number of components to the approach (a lot of work for just
2629 * three code points!):
2630 * 1) This routine examines each EXACTFish node that could contain the
9d071ca8
KW
2631 * problematic sequences. It returns in *min_subtract how much to
2632 * subtract from the the actual length of the string to get a real minimum
2633 * for one that could match it. This number is usually 0 except for the
2634 * problematic sequences. This delta is used by the caller to adjust the
2635 * min length of the match, and the delta between min and max, so that the
2636 * optimizer doesn't reject these possibilities based on size constraints.
f7926742
KW
2637 * 2) These sequences require special handling by the trie code, so it
2638 * changes the joined node type to ops for the trie's benefit, those new
2639 * ops being EXACTFU_SS and EXACTFU_TRICKYFOLD.
bb914485
KW
2640 * 3) This is sufficient for the two Greek sequences (described below), but
2641 * the one involving the Sharp s (\xDF) needs more. The node type
2642 * EXACTFU_SS is used for an EXACTFU node that contains at least one "ss"
2643 * sequence in it. For non-UTF-8 patterns and strings, this is the only
2644 * case where there is a possible fold length change. That means that a
2645 * regular EXACTFU node without UTF-8 involvement doesn't have to concern
2646 * itself with length changes, and so can be processed faster. regexec.c
2647 * takes advantage of this. Generally, an EXACTFish node that is in UTF-8
2648 * is pre-folded by regcomp.c. This saves effort in regex matching.
2649 * However, probably mostly for historical reasons, the pre-folding isn't
a0c4c608
KW
2650 * done for non-UTF8 patterns (and it can't be for EXACTF and EXACTFL
2651 * nodes, as what they fold to isn't known until runtime.) The fold
2652 * possibilities for the non-UTF8 patterns are quite simple, except for
2653 * the sharp s. All the ones that don't involve a UTF-8 target string
2654 * are members of a fold-pair, and arrays are set up for all of them
2655 * that quickly find the other member of the pair. It might actually
2656 * be faster to pre-fold these, but it isn't currently done, except for
2657 * the sharp s. Code elsewhere in this file makes sure that it gets
2658 * folded to 'ss', even if the pattern isn't UTF-8. This avoids the
2659 * issues described in the next item.
bb914485
KW
2660 * 4) A problem remains for the sharp s in EXACTF nodes. Whether it matches
2661 * 'ss' or not is not knowable at compile time. It will match iff the
2662 * target string is in UTF-8, unlike the EXACTFU nodes, where it always
2663 * matches; and the EXACTFL and EXACTFA nodes where it never does. Thus
2664 * it can't be folded to "ss" at compile time, unlike EXACTFU does as
2665 * described in item 3). An assumption that the optimizer part of
2666 * regexec.c (probably unwittingly) makes is that a character in the
2667 * pattern corresponds to at most a single character in the target string.
2668 * (And I do mean character, and not byte here, unlike other parts of the
2669 * documentation that have never been updated to account for multibyte
2670 * Unicode.) This assumption is wrong only in this case, as all other
2671 * cases are either 1-1 folds when no UTF-8 is involved; or is true by
2672 * virtue of having this file pre-fold UTF-8 patterns. I'm
2673 * reluctant to try to change this assumption, so instead the code punts.
9d071ca8
KW
2674 * This routine examines EXACTF nodes for the sharp s, and returns a
2675 * boolean indicating whether or not the node is an EXACTF node that
2676 * contains a sharp s. When it is true, the caller sets a flag that later
2677 * causes the optimizer in this file to not set values for the floating
2678 * and fixed string lengths, and thus avoids the optimizer code in
2679 * regexec.c that makes the invalid assumption. Thus, there is no
2680 * optimization based on string lengths for EXACTF nodes that contain the
2681 * sharp s. This only happens for /id rules (which means the pattern
2682 * isn't in UTF-8).
bb914485 2683 */
1de06328 2684
9d071ca8 2685#define JOIN_EXACT(scan,min_subtract,has_exactf_sharp_s, flags) \
07be1b83 2686 if (PL_regkind[OP(scan)] == EXACT) \
9d071ca8 2687 join_exact(pRExC_state,(scan),(min_subtract),has_exactf_sharp_s, (flags),NULL,depth+1)
07be1b83 2688
be8e71aa 2689STATIC U32
9d071ca8 2690S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan, UV *min_subtract, bool *has_exactf_sharp_s, U32 flags,regnode *val, U32 depth) {
07be1b83
YO
2691 /* Merge several consecutive EXACTish nodes into one. */
2692 regnode *n = regnext(scan);
2693 U32 stringok = 1;
2694 regnode *next = scan + NODE_SZ_STR(scan);
2695 U32 merged = 0;
2696 U32 stopnow = 0;
2697#ifdef DEBUGGING
2698 regnode *stop = scan;
72f13be8 2699 GET_RE_DEBUG_FLAGS_DECL;
f9049ba1 2700#else
d47053eb
RGS
2701 PERL_UNUSED_ARG(depth);
2702#endif
7918f24d
NC
2703
2704 PERL_ARGS_ASSERT_JOIN_EXACT;
d47053eb 2705#ifndef EXPERIMENTAL_INPLACESCAN
f9049ba1
SP
2706 PERL_UNUSED_ARG(flags);
2707 PERL_UNUSED_ARG(val);
07be1b83 2708#endif
07be1b83 2709 DEBUG_PEEP("join",scan,depth);
bb914485 2710
3f410cf6
KW
2711 /* Look through the subsequent nodes in the chain. Skip NOTHING, merge
2712 * EXACT ones that are mergeable to the current one. */
2713 while (n
2714 && (PL_regkind[OP(n)] == NOTHING
2715 || (stringok && OP(n) == OP(scan)))
07be1b83 2716 && NEXT_OFF(n)
3f410cf6
KW
2717 && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
2718 {
07be1b83
YO
2719
2720 if (OP(n) == TAIL || n > next)
2721 stringok = 0;
2722 if (PL_regkind[OP(n)] == NOTHING) {
07be1b83
YO
2723 DEBUG_PEEP("skip:",n,depth);
2724 NEXT_OFF(scan) += NEXT_OFF(n);
2725 next = n + NODE_STEP_REGNODE;
2726#ifdef DEBUGGING
2727 if (stringok)
2728 stop = n;
2729#endif
2730 n = regnext(n);
2731 }
2732 else if (stringok) {
786e8c11 2733 const unsigned int oldl = STR_LEN(scan);
07be1b83 2734 regnode * const nnext = regnext(n);
b2230d39
KW
2735
2736 if (oldl + STR_LEN(n) > U8_MAX)
2737 break;
07be1b83
YO
2738
2739 DEBUG_PEEP("merg",n,depth);
07be1b83 2740 merged++;
b2230d39 2741
07be1b83
YO
2742 NEXT_OFF(scan) += NEXT_OFF(n);
2743 STR_LEN(scan) += STR_LEN(n);
2744 next = n + NODE_SZ_STR(n);
2745 /* Now we can overwrite *n : */
2746 Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2747#ifdef DEBUGGING
2748 stop = next - 1;
2749#endif
2750 n = nnext;
2751 if (stopnow) break;
2752 }
2753
d47053eb
RGS
2754#ifdef EXPERIMENTAL_INPLACESCAN
2755 if (flags && !NEXT_OFF(n)) {
2756 DEBUG_PEEP("atch", val, depth);
2757 if (reg_off_by_arg[OP(n)]) {
2758 ARG_SET(n, val - n);
2759 }
2760 else {
2761 NEXT_OFF(n) = val - n;
2762 }
2763 stopnow = 1;
2764 }
07be1b83
YO
2765#endif
2766 }
2c2b7f86 2767
9d071ca8 2768 *min_subtract = 0;
f758bddf 2769 *has_exactf_sharp_s = FALSE;
f646642f 2770
3f410cf6
KW
2771 /* Here, all the adjacent mergeable EXACTish nodes have been merged. We
2772 * can now analyze for sequences of problematic code points. (Prior to
2773 * this final joining, sequences could have been split over boundaries, and
a0c4c608
KW
2774 * hence missed). The sequences only happen in folding, hence for any
2775 * non-EXACT EXACTish node */
86d6fcad 2776 if (OP(scan) != EXACT) {
f758bddf
KW
2777 U8 *s;
2778 U8 * s0 = (U8*) STRING(scan);
2779 U8 * const s_end = s0 + STR_LEN(scan);
2780
2781 /* The below is perhaps overboard, but this allows us to save a test
2782 * each time through the loop at the expense of a mask. This is
2783 * because on both EBCDIC and ASCII machines, 'S' and 's' differ by a
2784 * single bit. On ASCII they are 32 apart; on EBCDIC, they are 64.
2785 * This uses an exclusive 'or' to find that bit and then inverts it to
2786 * form a mask, with just a single 0, in the bit position where 'S' and
2787 * 's' differ. */
dbeb8947 2788 const U8 S_or_s_mask = (U8) ~ ('S' ^ 's');
f758bddf
KW
2789 const U8 s_masked = 's' & S_or_s_mask;
2790
2791 /* One pass is made over the node's string looking for all the
2792 * possibilities. to avoid some tests in the loop, there are two main
2793 * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
2794 * non-UTF-8 */
2795 if (UTF) {
86d6fcad 2796
f758bddf
KW
2797 /* There are two problematic Greek code points in Unicode
2798 * casefolding
86d6fcad
KW
2799 *
2800 * U+0390 - GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS
2801 * U+03B0 - GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS
2802 *
2803 * which casefold to
2804 *
2805 * Unicode UTF-8
2806 *
2807 * U+03B9 U+0308 U+0301 0xCE 0xB9 0xCC 0x88 0xCC 0x81
2808 * U+03C5 U+0308 U+0301 0xCF 0x85 0xCC 0x88 0xCC 0x81
2809 *
2810 * This means that in case-insensitive matching (or "loose
2811 * matching", as Unicode calls it), an EXACTF of length six (the
2812 * UTF-8 encoded byte length of the above casefolded versions) can
2813 * match a target string of length two (the byte length of UTF-8
2814 * encoded U+0390 or U+03B0). This would rather mess up the
2815 * minimum length computation. (there are other code points that
2816 * also fold to these two sequences, but the delta is smaller)
2817 *
f758bddf
KW
2818 * If these sequences are found, the minimum length is decreased by
2819 * four (six minus two).
86d6fcad 2820 *
f758bddf
KW
2821 * Similarly, 'ss' may match the single char and byte LATIN SMALL
2822 * LETTER SHARP S. We decrease the min length by 1 for each
2823 * occurrence of 'ss' found */
3f410cf6 2824
e294cc5d 2825#ifdef EBCDIC /* RD tunifold greek 0390 and 03B0 */
f758bddf
KW
2826# define U390_first_byte 0xb4
2827 const U8 U390_tail[] = "\x68\xaf\x49\xaf\x42";
2828# define U3B0_first_byte 0xb5
2829 const U8 U3B0_tail[] = "\x46\xaf\x49\xaf\x42";
e294cc5d 2830#else
f758bddf
KW
2831# define U390_first_byte 0xce
2832 const U8 U390_tail[] = "\xb9\xcc\x88\xcc\x81";
2833# define U3B0_first_byte 0xcf
2834 const U8 U3B0_tail[] = "\x85\xcc\x88\xcc\x81";
e294cc5d 2835#endif
f758bddf
KW
2836 const U8 len = sizeof(U390_tail); /* (-1 for NUL; +1 for 1st byte;
2837 yields a net of 0 */
2838 /* Examine the string for one of the problematic sequences */
2839 for (s = s0;
2840 s < s_end - 1; /* Can stop 1 before the end, as minimum length
2841 * sequence we are looking for is 2 */
2842 s += UTF8SKIP(s))
86d6fcad 2843 {
bb914485 2844
f758bddf
KW
2845 /* Look for the first byte in each problematic sequence */
2846 switch (*s) {
2847 /* We don't have to worry about other things that fold to
2848 * 's' (such as the long s, U+017F), as all above-latin1
2849 * code points have been pre-folded */
2850 case 's':
2851 case 'S':
2852
a0c4c608
KW
2853 /* Current character is an 's' or 'S'. If next one is
2854 * as well, we have the dreaded sequence */
f758bddf
KW
2855 if (((*(s+1) & S_or_s_mask) == s_masked)
2856 /* These two node types don't have special handling
2857 * for 'ss' */
2858 && OP(scan) != EXACTFL && OP(scan) != EXACTFA)
2859 {
9d071ca8 2860 *min_subtract += 1;
f758bddf
KW
2861 OP(scan) = EXACTFU_SS;
2862 s++; /* No need to look at this character again */
2863 }
2864 break;
2865
2866 case U390_first_byte:
2867 if (s_end - s >= len
2868
2869 /* The 1's are because are skipping comparing the
2870 * first byte */
2871 && memEQ(s + 1, U390_tail, len - 1))
2872 {
2873 goto greek_sequence;
2874 }
2875 break;
2876
2877 case U3B0_first_byte:
2878 if (! (s_end - s >= len
2879 && memEQ(s + 1, U3B0_tail, len - 1)))
2880 {
2881 break;
2882 }
2883 greek_sequence:
9d071ca8 2884 *min_subtract += 4;
f758bddf
KW
2885
2886 /* This can't currently be handled by trie's, so change
2887 * the node type to indicate this. If EXACTFA and
2888 * EXACTFL were ever to be handled by trie's, this
2889 * would have to be changed. If this node has already
2890 * been changed to EXACTFU_SS in this loop, leave it as
2891 * is. (I (khw) think it doesn't matter in regexec.c
2892 * for UTF patterns, but no need to change it */
2893 if (OP(scan) == EXACTFU) {
fab2782b 2894 OP(scan) = EXACTFU_TRICKYFOLD;
f758bddf
KW
2895 }
2896 s += 6; /* We already know what this sequence is. Skip
2897 the rest of it */
2898 break;
bb914485
KW
2899 }
2900 }
2901 }
f758bddf 2902 else if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
bb914485 2903
f758bddf
KW
2904 /* Here, the pattern is not UTF-8. We need to look only for the
2905 * 'ss' sequence, and in the EXACTF case, the sharp s, which can be
2906 * in the final position. Otherwise we can stop looking 1 byte
2907 * earlier because have to find both the first and second 's' */
2908 const U8* upper = (OP(scan) == EXACTF) ? s_end : s_end -1;
2909
2910 for (s = s0; s < upper; s++) {
2911 switch (*s) {
2912 case 'S':
2913 case 's':
2914 if (s_end - s > 1
2915 && ((*(s+1) & S_or_s_mask) == s_masked))
2916 {
9d071ca8 2917 *min_subtract += 1;
f758bddf
KW
2918
2919 /* EXACTF nodes need to know that the minimum
2920 * length changed so that a sharp s in the string
2921 * can match this ss in the pattern, but they
2922 * remain EXACTF nodes, as they are not trie'able,
2923 * so don't have to invent a new node type to
2924 * exclude them from the trie code */
2925 if (OP(scan) != EXACTF) {
2926 OP(scan) = EXACTFU_SS;
2927 }
2928 s++;
2929 }
2930 break;
2931 case LATIN_SMALL_LETTER_SHARP_S:
2932 if (OP(scan) == EXACTF) {
2933 *has_exactf_sharp_s = TRUE;
2934 }
2935 break;
86d6fcad
KW
2936 }
2937 }
2938 }
07be1b83 2939 }
3f410cf6 2940
07be1b83 2941#ifdef DEBUGGING
bb789b09
DM
2942 /* Allow dumping but overwriting the collection of skipped
2943 * ops and/or strings with fake optimized ops */
07be1b83
YO
2944 n = scan + NODE_SZ_STR(scan);
2945 while (n <= stop) {
bb789b09
DM
2946 OP(n) = OPTIMIZED;
2947 FLAGS(n) = 0;
2948 NEXT_OFF(n) = 0;
07be1b83
YO
2949 n++;
2950 }
2951#endif
2952 DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2953 return stopnow;
2954}
2955
486ec47a 2956/* REx optimizer. Converts nodes into quicker variants "in place".
653099ff
GS
2957 Finds fixed substrings. */
2958
a0288114 2959/* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
c277df42
IZ
2960 to the position after last scanned or to NULL. */
2961
40d049e4
YO
2962#define INIT_AND_WITHP \
2963 assert(!and_withp); \
2964 Newx(and_withp,1,struct regnode_charclass_class); \
2965 SAVEFREEPV(and_withp)
07be1b83 2966
b515a41d 2967/* this is a chain of data about sub patterns we are processing that
486ec47a 2968 need to be handled separately/specially in study_chunk. Its so
b515a41d
YO
2969 we can simulate recursion without losing state. */
2970struct scan_frame;
2971typedef struct scan_frame {
2972 regnode *last; /* last node to process in this frame */
2973 regnode *next; /* next node to process when last is reached */
2974 struct scan_frame *prev; /*previous frame*/
2975 I32 stop; /* what stopparen do we use */
2976} scan_frame;
2977
304ee84b
YO
2978
2979#define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
2980
e1d1eefb
YO
2981#define CASE_SYNST_FNC(nAmE) \
2982case nAmE: \
2983 if (flags & SCF_DO_STCLASS_AND) { \
2984 for (value = 0; value < 256; value++) \
2985 if (!is_ ## nAmE ## _cp(value)) \
2986 ANYOF_BITMAP_CLEAR(data->start_class, value); \
2987 } \
2988 else { \
2989 for (value = 0; value < 256; value++) \
2990 if (is_ ## nAmE ## _cp(value)) \
2991 ANYOF_BITMAP_SET(data->start_class, value); \
2992 } \
2993 break; \
2994case N ## nAmE: \
2995 if (flags & SCF_DO_STCLASS_AND) { \
2996 for (value = 0; value < 256; value++) \
2997 if (is_ ## nAmE ## _cp(value)) \
2998 ANYOF_BITMAP_CLEAR(data->start_class, value); \
2999 } \
3000 else { \
3001 for (value = 0; value < 256; value++) \
3002 if (!is_ ## nAmE ## _cp(value)) \
3003 ANYOF_BITMAP_SET(data->start_class, value); \
3004 } \
3005 break
3006
3007
3008
76e3520e 3009STATIC I32
40d049e4 3010S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
1de06328 3011 I32 *minlenp, I32 *deltap,
40d049e4
YO
3012 regnode *last,
3013 scan_data_t *data,
3014 I32 stopparen,
3015 U8* recursed,
3016 struct regnode_charclass_class *and_withp,
3017 U32 flags, U32 depth)
c277df42
IZ
3018 /* scanp: Start here (read-write). */
3019 /* deltap: Write maxlen-minlen here. */
3020 /* last: Stop before this one. */
40d049e4
YO
3021 /* data: string data about the pattern */
3022 /* stopparen: treat close N as END */
3023 /* recursed: which subroutines have we recursed into */
3024 /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
c277df42 3025{
97aff369 3026 dVAR;
c277df42
IZ
3027 I32 min = 0, pars = 0, code;
3028 regnode *scan = *scanp, *next;
3029 I32 delta = 0;
3030 int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
aca2d497 3031 int is_inf_internal = 0; /* The studied chunk is infinite */
c277df42
IZ
3032 I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3033 scan_data_t data_fake;
a3621e74 3034 SV *re_trie_maxbuff = NULL;
786e8c11 3035 regnode *first_non_open = scan;
e2e6a0f1 3036 I32 stopmin = I32_MAX;
8aa23a47 3037 scan_frame *frame = NULL;
a3621e74 3038 GET_RE_DEBUG_FLAGS_DECL;
8aa23a47 3039
7918f24d
NC
3040 PERL_ARGS_ASSERT_STUDY_CHUNK;
3041
13a24bad 3042#ifdef DEBUGGING
40d049e4 3043 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
13a24bad 3044#endif
40d049e4 3045
786e8c11 3046 if ( depth == 0 ) {
40d049e4 3047 while (first_non_open && OP(first_non_open) == OPEN)
786e8c11
YO
3048 first_non_open=regnext(first_non_open);
3049 }
3050
b81d288d 3051
8aa23a47
YO
3052 fake_study_recurse:
3053 while ( scan && OP(scan) != END && scan < last ){
9d071ca8
KW
3054 UV min_subtract = 0; /* How much to subtract from the minimum node
3055 length to get a real minimum (because the
3056 folded version may be shorter) */
f758bddf 3057 bool has_exactf_sharp_s = FALSE;
8aa23a47 3058 /* Peephole optimizer: */
304ee84b 3059 DEBUG_STUDYDATA("Peep:", data,depth);
8aa23a47 3060 DEBUG_PEEP("Peep",scan,depth);
a0c4c608
KW
3061
3062 /* Its not clear to khw or hv why this is done here, and not in the
3063 * clauses that deal with EXACT nodes. khw's guess is that it's
3064 * because of a previous design */
9d071ca8 3065 JOIN_EXACT(scan,&min_subtract, &has_exactf_sharp_s, 0);
8aa23a47
YO
3066
3067 /* Follow the next-chain of the current node and optimize
3068 away all the NOTHINGs from it. */
3069 if (OP(scan) != CURLYX) {
3070 const int max = (reg_off_by_arg[OP(scan)]
3071 ? I32_MAX
3072 /* I32 may be smaller than U16 on CRAYs! */
3073 : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3074 int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3075 int noff;
3076 regnode *n = scan;
686b73d4 3077
8aa23a47
YO
3078 /* Skip NOTHING and LONGJMP. */
3079 while ((n = regnext(n))
3080 && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3081 || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3082 && off + noff < max)
3083 off += noff;
3084 if (reg_off_by_arg[OP(scan)])
3085 ARG(scan) = off;
3086 else
3087 NEXT_OFF(scan) = off;
3088 }
a3621e74 3089
c277df42 3090
8aa23a47
YO
3091
3092 /* The principal pseudo-switch. Cannot be a switch, since we
3093 look into several different things. */
3094 if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3095 || OP(scan) == IFTHEN) {
3096 next = regnext(scan);
3097 code = OP(scan);
3098 /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
686b73d4 3099
8aa23a47
YO
3100 if (OP(next) == code || code == IFTHEN) {
3101 /* NOTE - There is similar code to this block below for handling
3102 TRIE nodes on a re-study. If you change stuff here check there
3103 too. */
3104 I32 max1 = 0, min1 = I32_MAX, num = 0;
3105 struct regnode_charclass_class accum;
3106 regnode * const startbranch=scan;
686b73d4 3107
8aa23a47 3108 if (flags & SCF_DO_SUBSTR)
304ee84b 3109 SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
8aa23a47 3110 if (flags & SCF_DO_STCLASS)
e755fd73 3111 cl_init_zero(pRExC_state, &accum);
8aa23a47
YO
3112
3113 while (OP(scan) == code) {
3114 I32 deltanext, minnext, f = 0, fake;
3115 struct regnode_charclass_class this_class;
3116
3117 num++;
3118 data_fake.flags = 0;
3119 if (data) {
3120 data_fake.whilem_c = data->whilem_c;
3121 data_fake.last_closep = data->last_closep;
3122 }
3123 else
3124 data_fake.last_closep = &fake;
58e23c8d
YO
3125
3126 data_fake.pos_delta = delta;
8aa23a47
YO
3127 next = regnext(scan);
3128 scan = NEXTOPER(scan);
3129 if (code != BRANCH)
c277df42 3130 scan = NEXTOPER(scan);
8aa23a47 3131 if (flags & SCF_DO_STCLASS) {
e755fd73 3132 cl_init(pRExC_state, &this_class);
8aa23a47
YO
3133 data_fake.start_class = &this_class;
3134 f = SCF_DO_STCLASS_AND;
58e23c8d 3135 }
8aa23a47
YO
3136 if (flags & SCF_WHILEM_VISITED_POS)
3137 f |= SCF_WHILEM_VISITED_POS;
3138
3139 /* we suppose the run is continuous, last=next...*/
3140 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3141 next, &data_fake,
3142 stopparen, recursed, NULL, f,depth+1);
3143 if (min1 > minnext)
3144 min1 = minnext;
3145 if (max1 < minnext + deltanext)
3146 max1 = minnext + deltanext;
3147 if (deltanext == I32_MAX)
3148 is_inf = is_inf_internal = 1;
3149 scan = next;
3150 if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3151 pars++;
3152 if (data_fake.flags & SCF_SEEN_ACCEPT) {
3153 if ( stopmin > minnext)
3154 stopmin = min + min1;
3155 flags &= ~SCF_DO_SUBSTR;
3156 if (data)
3157 data->flags |= SCF_SEEN_ACCEPT;
3158 }
3159 if (data) {
3160 if (data_fake.flags & SF_HAS_EVAL)
3161 data->flags |= SF_HAS_EVAL;
3162 data->whilem_c = data_fake.whilem_c;
3dab1dad 3163 }
8aa23a47 3164 if (flags & SCF_DO_STCLASS)
3fffb88a 3165 cl_or(pRExC_state, &accum, &this_class);
8aa23a47
YO
3166 }
3167 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3168 min1 = 0;
3169 if (flags & SCF_DO_SUBSTR) {
3170 data->pos_min += min1;
3171 data->pos_delta += max1 - min1;
3172 if (max1 != min1 || is_inf)
3173 data->longest = &(data->longest_float);
3174 }
3175 min += min1;
3176 delta += max1 - min1;
3177 if (flags & SCF_DO_STCLASS_OR) {
3fffb88a 3178 cl_or(pRExC_state, data->start_class, &accum);
8aa23a47
YO
3179 if (min1) {
3180 cl_and(data->start_class, and_withp);
3181 flags &= ~SCF_DO_STCLASS;
653099ff 3182 }
8aa23a47
YO
3183 }
3184 else if (flags & SCF_DO_STCLASS_AND) {
3185 if (min1) {
3186 cl_and(data->start_class, &accum);
3187 flags &= ~SCF_DO_STCLASS;
de0c8cb8 3188 }
8aa23a47
YO
3189 else {
3190 /* Switch to OR mode: cache the old value of
3191 * data->start_class */
3192 INIT_AND_WITHP;
3193 StructCopy(data->start_class, and_withp,
3194 struct regnode_charclass_class);
3195 flags &= ~SCF_DO_STCLASS_AND;
3196 StructCopy(&accum, data->start_class,
3197 struct regnode_charclass_class);
3198 flags |= SCF_DO_STCLASS_OR;
3199 data->start_class->flags |= ANYOF_EOS;
de0c8cb8 3200 }
8aa23a47 3201 }
a3621e74 3202
8aa23a47
YO
3203 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
3204 /* demq.
a3621e74 3205
8aa23a47
YO
3206 Assuming this was/is a branch we are dealing with: 'scan' now
3207 points at the item that follows the branch sequence, whatever
3208 it is. We now start at the beginning of the sequence and look
3209 for subsequences of
a3621e74 3210
8aa23a47
YO
3211 BRANCH->EXACT=>x1
3212 BRANCH->EXACT=>x2
3213 tail
a3621e74 3214
8aa23a47 3215 which would be constructed from a pattern like /A|LIST|OF|WORDS/
a3621e74 3216
486ec47a 3217 If we can find such a subsequence we need to turn the first
8aa23a47
YO
3218 element into a trie and then add the subsequent branch exact
3219 strings to the trie.
a3621e74 3220
8aa23a47 3221 We have two cases
a3621e74 3222
3b753521 3223 1. patterns where the whole set of branches can be converted.
a3621e74 3224
8aa23a47 3225 2. patterns where only a subset can be converted.
a3621e74 3226
8aa23a47
YO
3227 In case 1 we can replace the whole set with a single regop
3228 for the trie. In case 2 we need to keep the start and end
3b753521 3229 branches so
a3621e74 3230
8aa23a47
YO
3231 'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3232 becomes BRANCH TRIE; BRANCH X;
786e8c11 3233
8aa23a47
YO
3234 There is an additional case, that being where there is a
3235 common prefix, which gets split out into an EXACT like node
3236 preceding the TRIE node.
a3621e74 3237
8aa23a47
YO
3238 If x(1..n)==tail then we can do a simple trie, if not we make
3239 a "jump" trie, such that when we match the appropriate word
486ec47a 3240 we "jump" to the appropriate tail node. Essentially we turn
8aa23a47 3241 a nested if into a case structure of sorts.
b515a41d 3242
8aa23a47 3243 */
686b73d4 3244
8aa23a47
YO
3245 int made=0;
3246 if (!re_trie_maxbuff) {
3247 re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3248 if (!SvIOK(re_trie_maxbuff))
3249 sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3250 }
3251 if ( SvIV(re_trie_maxbuff)>=0 ) {
3252 regnode *cur;
3253 regnode *first = (regnode *)NULL;
3254 regnode *last = (regnode *)NULL;
3255 regnode *tail = scan;
fab2782b 3256 U8 trietype = 0;
8aa23a47 3257 U32 count=0;
a3621e74
YO
3258
3259#ifdef DEBUGGING
8aa23a47 3260 SV * const mysv = sv_newmortal(); /* for dumping */
a3621e74 3261#endif
8aa23a47
YO
3262 /* var tail is used because there may be a TAIL
3263 regop in the way. Ie, the exacts will point to the
3264 thing following the TAIL, but the last branch will
3265 point at the TAIL. So we advance tail. If we
3266 have nested (?:) we may have to move through several
3267 tails.
3268 */
3269
3270 while ( OP( tail ) == TAIL ) {
3271 /* this is the TAIL generated by (?:) */
3272 tail = regnext( tail );
3273 }
a3621e74 3274
8aa23a47 3275
df826430 3276 DEBUG_TRIE_COMPILE_r({
8aa23a47
YO
3277 regprop(RExC_rx, mysv, tail );
3278 PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3279 (int)depth * 2 + 2, "",
3280 "Looking for TRIE'able sequences. Tail node is: ",
3281 SvPV_nolen_const( mysv )
3282 );
3283 });
3284
3285 /*
3286
fab2782b
YO
3287 Step through the branches
3288 cur represents each branch,
3289 noper is the first thing to be matched as part of that branch
3290 noper_next is the regnext() of that node.
3291
3292 We normally handle a case like this /FOO[xyz]|BAR[pqr]/
3293 via a "jump trie" but we also support building with NOJUMPTRIE,
3294 which restricts the trie logic to structures like /FOO|BAR/.
3295
3296 If noper is a trieable nodetype then the branch is a possible optimization
3297 target. If we are building under NOJUMPTRIE then we require that noper_next
3298 is the same as scan (our current position in the regex program).
3299
3300 Once we have two or more consecutive such branches we can create a
3301 trie of the EXACT's contents and stitch it in place into the program.
3302
3303 If the sequence represents all of the branches in the alternation we
3304 replace the entire thing with a single TRIE node.
3305
3306 Otherwise when it is a subsequence we need to stitch it in place and
3307 replace only the relevant branches. This means the first branch has
3308 to remain as it is used by the alternation logic, and its next pointer,
3309 and needs to be repointed at the item on the branch chain following
3310 the last branch we have optimized away.
3311
3312 This could be either a BRANCH, in which case the subsequence is internal,
3313 or it could be the item following the branch sequence in which case the
3314 subsequence is at the end (which does not necessarily mean the first node
3315 is the start of the alternation).
3316
3317 TRIE_TYPE(X) is a define which maps the optype to a trietype.
3318
3319 optype | trietype
3320 ----------------+-----------
3321 NOTHING | NOTHING
3322 EXACT | EXACT
3323 EXACTFU | EXACTFU
3324 EXACTFU_SS | EXACTFU
3325 EXACTFU_TRICKYFOLD | EXACTFU
3326 EXACTFA | 0
3327
8aa23a47
YO
3328
3329 */
fab2782b
YO
3330#define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING : \
3331 ( EXACT == (X) ) ? EXACT : \
3332 ( EXACTFU == (X) || EXACTFU_SS == (X) || EXACTFU_TRICKYFOLD == (X) ) ? EXACTFU : \
3333 0 )
8aa23a47
YO
3334
3335 /* dont use tail as the end marker for this traverse */
3336 for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3337 regnode * const noper = NEXTOPER( cur );
fab2782b
YO
3338 U8 noper_type = OP( noper );
3339 U8 noper_trietype = TRIE_TYPE( noper_type );
b515a41d 3340#if defined(DEBUGGING) || defined(NOJUMPTRIE)
8aa23a47 3341 regnode * const noper_next = regnext( noper );
df826430
YO
3342 U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
3343 U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
b515a41d
YO
3344#endif
3345
df826430 3346 DEBUG_TRIE_COMPILE_r({
8aa23a47
YO
3347 regprop(RExC_rx, mysv, cur);
3348 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3349 (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3350
3351 regprop(RExC_rx, mysv, noper);
3352 PerlIO_printf( Perl_debug_log, " -> %s",
3353 SvPV_nolen_const(mysv));
3354
3355 if ( noper_next ) {
3356 regprop(RExC_rx, mysv, noper_next );
3357 PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3358 SvPV_nolen_const(mysv));
3359 }
df826430
YO
3360 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
3361 REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
3362 PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
3363 );
8aa23a47 3364 });
fab2782b
YO
3365
3366 /* Is noper a trieable nodetype that can be merged with the
3367 * current trie (if there is one)? */
3368 if ( noper_trietype
3369 &&
3370 (
df826430
YO
3371 ( noper_trietype == NOTHING)
3372 || ( trietype == NOTHING )
a40630bf 3373 || ( trietype == noper_trietype )
fab2782b 3374 )
786e8c11 3375#ifdef NOJUMPTRIE
8aa23a47 3376 && noper_next == tail
786e8c11 3377#endif
8aa23a47
YO
3378 && count < U16_MAX)
3379 {
fab2782b
YO
3380 /* Handle mergable triable node
3381 * Either we are the first node in a new trieable sequence,
3382 * in which case we do some bookkeeping, otherwise we update
3383 * the end pointer. */
fab2782b 3384 if ( !first ) {
3b6759a6 3385 first = cur;
df826430
YO
3386 if ( noper_trietype == NOTHING ) {
3387#if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
3388 regnode * const noper_next = regnext( noper );
3b6759a6 3389 U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
df826430
YO
3390 U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
3391#endif
3392
190c1910 3393 if ( noper_next_trietype ) {
df826430 3394 trietype = noper_next_trietype;
190c1910
YO
3395 } else if (noper_next_type) {
3396 /* a NOTHING regop is 1 regop wide. We need at least two
3397 * for a trie so we can't merge this in */
3398 first = NULL;
3399 }
3400 } else {
3401 trietype = noper_trietype;
3b6759a6 3402 }
8aa23a47 3403 } else {
fab2782b
YO
3404 if ( trietype == NOTHING )
3405 trietype = noper_trietype;
8aa23a47
YO
3406 last = cur;
3407 }
df826430
YO
3408 if (first)
3409 count++;
fab2782b
YO
3410 } /* end handle mergable triable node */
3411 else {
3412 /* handle unmergable node -
3413 * noper may either be a triable node which can not be tried
3414 * together with the current trie, or a non triable node */
729aaeb5
YO
3415 if ( last ) {
3416 /* If last is set and trietype is not NOTHING then we have found
3417 * at least two triable branch sequences in a row of a similar
3418 * trietype so we can turn them into a trie. If/when we
3419 * allow NOTHING to start a trie sequence this condition will be
3420 * required, and it isn't expensive so we leave it in for now. */
3421 if ( trietype != NOTHING )
3422 make_trie( pRExC_state,
3423 startbranch, first, cur, tail, count,
3424 trietype, depth+1 );
fab2782b 3425 last = NULL; /* note: we clear/update first, trietype etc below, so we dont do it here */
8aa23a47 3426 }
fab2782b 3427 if ( noper_trietype
786e8c11 3428#ifdef NOJUMPTRIE
8aa23a47 3429 && noper_next == tail
786e8c11 3430#endif
8aa23a47 3431 ){
fab2782b 3432 /* noper is triable, so we can start a new trie sequence */
8aa23a47
YO
3433 count = 1;
3434 first = cur;
fab2782b
YO
3435 trietype = noper_trietype;
3436 } else if (first) {
3437 /* if we already saw a first but the current node is not triable then we have
3438 * to reset the first information. */
8aa23a47
YO
3439 count = 0;
3440 first = NULL;
fab2782b 3441 trietype = 0;
8aa23a47 3442 }
fab2782b
YO
3443 } /* end handle unmergable node */
3444 } /* loop over branches */
df826430 3445 DEBUG_TRIE_COMPILE_r({
8aa23a47
YO
3446 regprop(RExC_rx, mysv, cur);
3447 PerlIO_printf( Perl_debug_log,
3448 "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3449 "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3450
3451 });
3b6759a6
YO
3452 if ( last ) {
3453 if ( trietype != NOTHING ) {
3454 /* the last branch of the sequence was part of a trie,
3455 * so we have to construct it here outside of the loop
3456 */
3457 made= make_trie( pRExC_state, startbranch, first, scan, tail, count, trietype, depth+1 );
686b73d4 3458#ifdef TRIE_STUDY_OPT
3b6759a6
YO
3459 if ( ((made == MADE_EXACT_TRIE &&
3460 startbranch == first)
3461 || ( first_non_open == first )) &&
3462 depth==0 ) {
3463 flags |= SCF_TRIE_RESTUDY;
3464 if ( startbranch == first
3465 && scan == tail )
3466 {
3467 RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3468 }
8aa23a47 3469 }
3dab1dad 3470#endif
3b6759a6
YO
3471 } else {
3472 /* at this point we know whatever we have is a NOTHING sequence/branch
3473 * AND if 'startbranch' is 'first' then we can turn the whole thing into a NOTHING
3474 */
3475 if ( startbranch == first ) {
3476 regnode *opt;
3477 /* the entire thing is a NOTHING sequence, something like this:
3478 * (?:|) So we can turn it into a plain NOTHING op. */
3479 DEBUG_TRIE_COMPILE_r({
3480 regprop(RExC_rx, mysv, cur);
3481 PerlIO_printf( Perl_debug_log,
3482 "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
3483 "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3484
3485 });
3486 OP(startbranch)= NOTHING;
3487 NEXT_OFF(startbranch)= tail - startbranch;
3488 for ( opt= startbranch + 1; opt < tail ; opt++ )
3489 OP(opt)= OPTIMIZED;
3490 }
3491 }
fab2782b
YO
3492 } /* end if ( last) */
3493 } /* TRIE_MAXBUF is non zero */
8aa23a47
YO
3494
3495 } /* do trie */
3496
653099ff 3497 }
8aa23a47
YO
3498 else if ( code == BRANCHJ ) { /* single branch is optimized. */
3499 scan = NEXTOPER(NEXTOPER(scan));
3500 } else /* single branch is optimized. */
3501 scan = NEXTOPER(scan);
3502 continue;
3503 } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3504 scan_frame *newframe = NULL;
3505 I32 paren;
3506 regnode *start;
3507 regnode *end;
3508
3509 if (OP(scan) != SUSPEND) {
3510 /* set the pointer */
3511 if (OP(scan) == GOSUB) {
3512 paren = ARG(scan);
3513 RExC_recurse[ARG2L(scan)] = scan;
3514 start = RExC_open_parens[paren-1];
3515 end = RExC_close_parens[paren-1];
3516 } else {
3517 paren = 0;
f8fc2ecf 3518 start = RExC_rxi->program + 1;
8aa23a47
YO
3519 end = RExC_opend;
3520 }
3521 if (!recursed) {
3522 Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3523 SAVEFREEPV(recursed);
3524 }
3525 if (!PAREN_TEST(recursed,paren+1)) {
3526 PAREN_SET(recursed,paren+1);
3527 Newx(newframe,1,scan_frame);
3528 } else {
3529 if (flags & SCF_DO_SUBSTR) {
304ee84b 3530 SCAN_COMMIT(pRExC_state,data,minlenp);
8aa23a47
YO
3531 data->longest = &(data->longest_float);
3532 }
3533 is_inf = is_inf_internal = 1;
3534 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3fffb88a 3535 cl_anything(pRExC_state, data->start_class);
8aa23a47
YO
3536 flags &= ~SCF_DO_STCLASS;
3537 }
3538 } else {
3539 Newx(newframe,1,scan_frame);
3540 paren = stopparen;
3541 start = scan+2;
3542 end = regnext(scan);
3543 }
3544 if (newframe) {
3545 assert(start);
3546 assert(end);
3547 SAVEFREEPV(newframe);
3548 newframe->next = regnext(scan);
3549 newframe->last = last;
3550 newframe->stop = stopparen;
3551 newframe->prev = frame;
3552
3553 frame = newframe;
3554 scan = start;
3555 stopparen = paren;
3556 last = end;
3557
3558 continue;
3559 }
3560 }
3561 else if (OP(scan) == EXACT) {
3562 I32 l = STR_LEN(scan);
3563 UV uc;
3564 if (UTF) {
3565 const U8 * const s = (U8*)STRING(scan);
4b88fb76 3566 uc = utf8_to_uvchr_buf(s, s + l, NULL);
8aa23a47 3567 l = utf8_length(s, s + l);
8aa23a47
YO
3568 } else {
3569 uc = *((U8*)STRING(scan));
3570 }
3571 min += l;
3572 if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3573 /* The code below prefers earlier match for fixed
3574 offset, later match for variable offset. */
3575 if (data->last_end == -1) { /* Update the start info. */
3576 data->last_start_min = data->pos_min;
3577 data->last_start_max = is_inf
3578 ? I32_MAX : data->pos_min + data->pos_delta;
b515a41d 3579 }
8aa23a47
YO
3580 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3581 if (UTF)
3582 SvUTF8_on(data->last_found);
3583 {
3584 SV * const sv = data->last_found;
3585 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3586 mg_find(sv, PERL_MAGIC_utf8) : NULL;
3587 if (mg && mg->mg_len >= 0)
3588 mg->mg_len += utf8_length((U8*)STRING(scan),
3589 (U8*)STRING(scan)+STR_LEN(scan));
b515a41d 3590 }
8aa23a47
YO
3591 data->last_end = data->pos_min + l;
3592 data->pos_min += l; /* As in the first entry. */
3593 data->flags &= ~SF_BEFORE_EOL;
3594 }
3595 if (flags & SCF_DO_STCLASS_AND) {
3596 /* Check whether it is compatible with what we know already! */
3597 int compat = 1;
3598
54251c2e 3599
486ec47a 3600<