This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Removed unused CHR_DIST macro from a second file (RT 130519).
[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"
afda64e8 84EXTERN_C const struct regexp_engine my_reg_engine;
54df2634
NC
85#else
86# include "regcomp.h"
87#endif
a687059c 88
f7e03a10 89#include "dquote_inline.h"
b992490d 90#include "invlist_inline.h"
1b0f46bf 91#include "unicode_constants.h"
04e98a4d 92
538e84ed
KW
93#define HAS_NONLATIN1_FOLD_CLOSURE(i) \
94 _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
f12c0118
KW
95#define HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(i) \
96 _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
26faadbd 97#define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
2c61f163 98#define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
94dc5c2d 99
a687059c
LW
100#ifndef STATIC
101#define STATIC static
102#endif
103
3f910e62
YO
104/* this is a chain of data about sub patterns we are processing that
105 need to be handled separately/specially in study_chunk. Its so
106 we can simulate recursion without losing state. */
107struct scan_frame;
108typedef struct scan_frame {
109 regnode *last_regnode; /* last node to process in this frame */
110 regnode *next_regnode; /* next node to process when last is reached */
111 U32 prev_recursed_depth;
112 I32 stopparen; /* what stopparen do we use */
113 U32 is_top_frame; /* what flags do we use? */
114
115 struct scan_frame *this_prev_frame; /* this previous frame */
116 struct scan_frame *prev_frame; /* previous frame */
117 struct scan_frame *next_frame; /* next frame */
118} scan_frame;
119
f4ae5a27
KW
120/* Certain characters are output as a sequence with the first being a
121 * backslash. */
122#define isBACKSLASHED_PUNCT(c) \
123 ((c) == '-' || (c) == ']' || (c) == '\\' || (c) == '^')
124
125
09b2b2e6 126struct RExC_state_t {
514a91f1
DM
127 U32 flags; /* RXf_* are we folding, multilining? */
128 U32 pm_flags; /* PMf_* stuff from the calling PMOP */
830247a4 129 char *precomp; /* uncompiled string. */
711b303b 130 char *precomp_end; /* pointer to end of uncompiled string. */
288b8c02 131 REGEXP *rx_sv; /* The SV that is the regexp. */
f8fc2ecf 132 regexp *rx; /* perl core regexp structure */
538e84ed
KW
133 regexp_internal *rxi; /* internal data for regexp object
134 pprivate field */
fac92740 135 char *start; /* Start of input for compile */
830247a4
IZ
136 char *end; /* End of input for compile */
137 char *parse; /* Input-scan pointer. */
285b5ca0
KW
138 char *adjusted_start; /* 'start', adjusted. See code use */
139 STRLEN precomp_adj; /* an offset beyond precomp. See code use */
ea3daa5d 140 SSize_t whilem_seen; /* number of WHILEM in this expr */
fac92740 141 regnode *emit_start; /* Start of emitted-code area */
538e84ed
KW
142 regnode *emit_bound; /* First regnode outside of the
143 allocated space */
f7c7e32a
DM
144 regnode *emit; /* Code-emit pointer; if = &emit_dummy,
145 implies compiling, so don't emit */
9a81a976
KW
146 regnode_ssc emit_dummy; /* placeholder for emit to point to;
147 large enough for the largest
148 non-EXACTish node, so can use it as
149 scratch in pass1 */
830247a4
IZ
150 I32 naughty; /* How bad is this pattern? */
151 I32 sawback; /* Did we see \1, ...? */
152 U32 seen;
ea3daa5d 153 SSize_t size; /* Code size. */
538e84ed
KW
154 I32 npar; /* Capture buffer count, (OPEN) plus
155 one. ("par" 0 is the whole
156 pattern)*/
157 I32 nestroot; /* root parens we are in - used by
158 accept */
830247a4
IZ
159 I32 extralen;
160 I32 seen_zerolen;
40d049e4
YO
161 regnode **open_parens; /* pointers to open parens */
162 regnode **close_parens; /* pointers to close parens */
d5a00e4a 163 regnode *end_op; /* END node in program */
02daf0ab
YO
164 I32 utf8; /* whether the pattern is utf8 or not */
165 I32 orig_utf8; /* whether the pattern was originally in utf8 */
166 /* XXX use this for future optimisation of case
167 * where pattern must be upgraded to utf8. */
e40e74fe
KW
168 I32 uni_semantics; /* If a d charset modifier should use unicode
169 rules, even if the pattern is not in
170 utf8 */
81714fb9 171 HV *paren_names; /* Paren names */
538e84ed 172
40d049e4 173 regnode **recurse; /* Recurse regops */
d5a00e4a 174 I32 recurse_count; /* Number of recurse regops we have generated */
4286711a 175 U8 *study_chunk_recursed; /* bitmap of which subs we have moved
538e84ed 176 through */
09a65838 177 U32 study_chunk_recursed_bytes; /* bytes in bitmap */
b57e4118 178 I32 in_lookbehind;
4624b182 179 I32 contains_locale;
cfafade5 180 I32 contains_i;
bb3f3ed2 181 I32 override_recoding;
b6d67071
KW
182#ifdef EBCDIC
183 I32 recode_x_to_native;
184#endif
9d53c457 185 I32 in_multi_char_class;
3d2bd50a 186 struct reg_code_block *code_blocks; /* positions of literal (?{})
68e2671b 187 within pattern */
b1603ef8
DM
188 int num_code_blocks; /* size of code_blocks[] */
189 int code_index; /* next code_blocks[] slot */
ee273784 190 SSize_t maxlen; /* mininum possible number of chars in string to match */
3f910e62
YO
191 scan_frame *frame_head;
192 scan_frame *frame_last;
193 U32 frame_count;
7eec73eb 194 AV *warn_text;
dc6d7f5c 195#ifdef ADD_TO_REGEXEC
830247a4
IZ
196 char *starttry; /* -Dr: where regtry was called. */
197#define RExC_starttry (pRExC_state->starttry)
198#endif
d24ca0c5 199 SV *runtime_code_qr; /* qr with the runtime code blocks */
3dab1dad 200#ifdef DEBUGGING
be8e71aa 201 const char *lastparse;
3dab1dad 202 I32 lastnum;
1f1031fe 203 AV *paren_name_list; /* idx -> name */
d9a72fcc 204 U32 study_chunk_recursed_count;
c9f0d54c
YO
205 SV *mysv1;
206 SV *mysv2;
3dab1dad
YO
207#define RExC_lastparse (pRExC_state->lastparse)
208#define RExC_lastnum (pRExC_state->lastnum)
1f1031fe 209#define RExC_paren_name_list (pRExC_state->paren_name_list)
d9a72fcc 210#define RExC_study_chunk_recursed_count (pRExC_state->study_chunk_recursed_count)
c9f0d54c
YO
211#define RExC_mysv (pRExC_state->mysv1)
212#define RExC_mysv1 (pRExC_state->mysv1)
213#define RExC_mysv2 (pRExC_state->mysv2)
214
3dab1dad 215#endif
512c0f5a 216 bool seen_unfolded_sharp_s;
911bd04e 217 bool strict;
da7cf1cc 218 bool study_started;
09b2b2e6 219};
830247a4 220
e2509266 221#define RExC_flags (pRExC_state->flags)
514a91f1 222#define RExC_pm_flags (pRExC_state->pm_flags)
830247a4 223#define RExC_precomp (pRExC_state->precomp)
285b5ca0
KW
224#define RExC_precomp_adj (pRExC_state->precomp_adj)
225#define RExC_adjusted_start (pRExC_state->adjusted_start)
711b303b 226#define RExC_precomp_end (pRExC_state->precomp_end)
288b8c02 227#define RExC_rx_sv (pRExC_state->rx_sv)
830247a4 228#define RExC_rx (pRExC_state->rx)
f8fc2ecf 229#define RExC_rxi (pRExC_state->rxi)
fac92740 230#define RExC_start (pRExC_state->start)
830247a4
IZ
231#define RExC_end (pRExC_state->end)
232#define RExC_parse (pRExC_state->parse)
233#define RExC_whilem_seen (pRExC_state->whilem_seen)
512c0f5a
KW
234
235/* Set during the sizing pass when there is a LATIN SMALL LETTER SHARP S in any
236 * EXACTF node, hence was parsed under /di rules. If later in the parse,
237 * something forces the pattern into using /ui rules, the sharp s should be
238 * folded into the sequence 'ss', which takes up more space than previously
239 * calculated. This means that the sizing pass needs to be restarted. (The
240 * node also becomes an EXACTFU_SS.) For all other characters, an EXACTF node
241 * that gets converted to /ui (and EXACTFU) occupies the same amount of space,
242 * so there is no need to resize [perl #125990]. */
243#define RExC_seen_unfolded_sharp_s (pRExC_state->seen_unfolded_sharp_s)
244
7122b237 245#ifdef RE_TRACK_PATTERN_OFFSETS
538e84ed
KW
246#define RExC_offsets (pRExC_state->rxi->u.offsets) /* I am not like the
247 others */
7122b237 248#endif
830247a4 249#define RExC_emit (pRExC_state->emit)
f7c7e32a 250#define RExC_emit_dummy (pRExC_state->emit_dummy)
fac92740 251#define RExC_emit_start (pRExC_state->emit_start)
3b57cd43 252#define RExC_emit_bound (pRExC_state->emit_bound)
830247a4
IZ
253#define RExC_sawback (pRExC_state->sawback)
254#define RExC_seen (pRExC_state->seen)
255#define RExC_size (pRExC_state->size)
ee273784 256#define RExC_maxlen (pRExC_state->maxlen)
830247a4 257#define RExC_npar (pRExC_state->npar)
e2e6a0f1 258#define RExC_nestroot (pRExC_state->nestroot)
830247a4
IZ
259#define RExC_extralen (pRExC_state->extralen)
260#define RExC_seen_zerolen (pRExC_state->seen_zerolen)
1aa99e6b 261#define RExC_utf8 (pRExC_state->utf8)
e40e74fe 262#define RExC_uni_semantics (pRExC_state->uni_semantics)
02daf0ab 263#define RExC_orig_utf8 (pRExC_state->orig_utf8)
40d049e4
YO
264#define RExC_open_parens (pRExC_state->open_parens)
265#define RExC_close_parens (pRExC_state->close_parens)
5bd2d46e 266#define RExC_end_op (pRExC_state->end_op)
81714fb9 267#define RExC_paren_names (pRExC_state->paren_names)
40d049e4
YO
268#define RExC_recurse (pRExC_state->recurse)
269#define RExC_recurse_count (pRExC_state->recurse_count)
09a65838 270#define RExC_study_chunk_recursed (pRExC_state->study_chunk_recursed)
538e84ed
KW
271#define RExC_study_chunk_recursed_bytes \
272 (pRExC_state->study_chunk_recursed_bytes)
b57e4118 273#define RExC_in_lookbehind (pRExC_state->in_lookbehind)
4624b182 274#define RExC_contains_locale (pRExC_state->contains_locale)
cfafade5 275#define RExC_contains_i (pRExC_state->contains_i)
9d53c457 276#define RExC_override_recoding (pRExC_state->override_recoding)
b6d67071
KW
277#ifdef EBCDIC
278# define RExC_recode_x_to_native (pRExC_state->recode_x_to_native)
279#endif
9d53c457 280#define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
3f910e62
YO
281#define RExC_frame_head (pRExC_state->frame_head)
282#define RExC_frame_last (pRExC_state->frame_last)
283#define RExC_frame_count (pRExC_state->frame_count)
67cdf558 284#define RExC_strict (pRExC_state->strict)
da7cf1cc 285#define RExC_study_started (pRExC_state->study_started)
7eec73eb 286#define RExC_warn_text (pRExC_state->warn_text)
830247a4 287
99807a43
HS
288/* Heuristic check on the complexity of the pattern: if TOO_NAUGHTY, we set
289 * a flag to disable back-off on the fixed/floating substrings - if it's
290 * a high complexity pattern we assume the benefit of avoiding a full match
291 * is worth the cost of checking for the substrings even if they rarely help.
292 */
293#define RExC_naughty (pRExC_state->naughty)
294#define TOO_NAUGHTY (10)
295#define MARK_NAUGHTY(add) \
296 if (RExC_naughty < TOO_NAUGHTY) \
297 RExC_naughty += (add)
298#define MARK_NAUGHTY_EXP(exp, add) \
299 if (RExC_naughty < TOO_NAUGHTY) \
300 RExC_naughty += RExC_naughty / (exp) + (add)
cde0cee5 301
a687059c
LW
302#define ISMULT1(c) ((c) == '*' || (c) == '+' || (c) == '?')
303#define ISMULT2(s) ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
412f55bb 304 ((*s) == '{' && regcurly(s)))
a687059c
LW
305
306/*
307 * Flags to be passed up and down.
308 */
a687059c 309#define WORST 0 /* Worst case. */
a3b492c3 310#define HASWIDTH 0x01 /* Known to match non-null strings. */
fda99bee 311
e64f369d 312/* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
2fd92675
KW
313 * character. (There needs to be a case: in the switch statement in regexec.c
314 * for any node marked SIMPLE.) Note that this is not the same thing as
315 * REGNODE_SIMPLE */
fda99bee 316#define SIMPLE 0x02
e64f369d 317#define SPSTART 0x04 /* Starts with * or + */
8d9c2815
NC
318#define POSTPONED 0x08 /* (?1),(?&name), (??{...}) or similar */
319#define TRYAGAIN 0x10 /* Weeded out a declaration. */
b97943f7
KW
320#define RESTART_PASS1 0x20 /* Need to restart sizing pass */
321#define NEED_UTF8 0x40 /* In conjunction with RESTART_PASS1, need to
322 calcuate sizes as UTF-8 */
a687059c 323
3dab1dad
YO
324#define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
325
07be1b83
YO
326/* whether trie related optimizations are enabled */
327#if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
328#define TRIE_STUDY_OPT
786e8c11 329#define FULL_TRIE_STUDY
07be1b83
YO
330#define TRIE_STCLASS
331#endif
1de06328
YO
332
333
40d049e4
YO
334
335#define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
336#define PBITVAL(paren) (1 << ((paren) & 7))
337#define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
338#define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
339#define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
340
82a6ada4 341#define REQUIRE_UTF8(flagp) STMT_START { \
8d9c2815 342 if (!UTF) { \
82a6ada4
KW
343 assert(PASS1); \
344 *flagp = RESTART_PASS1|NEED_UTF8; \
8d9c2815
NC
345 return NULL; \
346 } \
82a6ada4 347 } STMT_END
40d049e4 348
512c0f5a
KW
349/* Change from /d into /u rules, and restart the parse if we've already seen
350 * something whose size would increase as a result, by setting *flagp and
351 * returning 'restart_retval'. RExC_uni_semantics is a flag that indicates
352 * we've change to /u during the parse. */
353#define REQUIRE_UNI_RULES(flagp, restart_retval) \
354 STMT_START { \
355 if (DEPENDS_SEMANTICS) { \
356 assert(PASS1); \
357 set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET); \
358 RExC_uni_semantics = 1; \
359 if (RExC_seen_unfolded_sharp_s) { \
360 *flagp |= RESTART_PASS1; \
361 return restart_retval; \
362 } \
363 } \
364 } STMT_END
365
f19b1a63
KW
366/* This converts the named class defined in regcomp.h to its equivalent class
367 * number defined in handy.h. */
368#define namedclass_to_classnum(class) ((int) ((class) / 2))
369#define classnum_to_namedclass(classnum) ((classnum) * 2)
370
de92f5e6
KW
371#define _invlist_union_complement_2nd(a, b, output) \
372 _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
373#define _invlist_intersection_complement_2nd(a, b, output) \
374 _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
375
1de06328
YO
376/* About scan_data_t.
377
378 During optimisation we recurse through the regexp program performing
379 various inplace (keyhole style) optimisations. In addition study_chunk
380 and scan_commit populate this data structure with information about
538e84ed 381 what strings MUST appear in the pattern. We look for the longest
3b753521 382 string that must appear at a fixed location, and we look for the
1de06328
YO
383 longest string that may appear at a floating location. So for instance
384 in the pattern:
538e84ed 385
1de06328 386 /FOO[xX]A.*B[xX]BAR/
538e84ed 387
1de06328
YO
388 Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
389 strings (because they follow a .* construct). study_chunk will identify
390 both FOO and BAR as being the longest fixed and floating strings respectively.
538e84ed 391
1de06328 392 The strings can be composites, for instance
538e84ed 393
1de06328 394 /(f)(o)(o)/
538e84ed 395
1de06328 396 will result in a composite fixed substring 'foo'.
538e84ed 397
1de06328 398 For each string some basic information is maintained:
538e84ed 399
1de06328
YO
400 - offset or min_offset
401 This is the position the string must appear at, or not before.
402 It also implicitly (when combined with minlenp) tells us how many
3b753521
FN
403 characters must match before the string we are searching for.
404 Likewise when combined with minlenp and the length of the string it
538e84ed 405 tells us how many characters must appear after the string we have
1de06328 406 found.
538e84ed 407
1de06328
YO
408 - max_offset
409 Only used for floating strings. This is the rightmost point that
ea3daa5d 410 the string can appear at. If set to SSize_t_MAX it indicates that the
1de06328 411 string can occur infinitely far to the right.
538e84ed 412
1de06328 413 - minlenp
2d608413
KW
414 A pointer to the minimum number of characters of the pattern that the
415 string was found inside. This is important as in the case of positive
538e84ed 416 lookahead or positive lookbehind we can have multiple patterns
1de06328 417 involved. Consider
538e84ed 418
1de06328 419 /(?=FOO).*F/
538e84ed 420
1de06328
YO
421 The minimum length of the pattern overall is 3, the minimum length
422 of the lookahead part is 3, but the minimum length of the part that
538e84ed 423 will actually match is 1. So 'FOO's minimum length is 3, but the
1de06328 424 minimum length for the F is 1. This is important as the minimum length
538e84ed 425 is used to determine offsets in front of and behind the string being
1de06328 426 looked for. Since strings can be composites this is the length of the
486ec47a 427 pattern at the time it was committed with a scan_commit. Note that
1de06328 428 the length is calculated by study_chunk, so that the minimum lengths
538e84ed 429 are not known until the full pattern has been compiled, thus the
1de06328 430 pointer to the value.
538e84ed 431
1de06328 432 - lookbehind
538e84ed 433
1de06328 434 In the case of lookbehind the string being searched for can be
538e84ed 435 offset past the start point of the final matching string.
1de06328
YO
436 If this value was just blithely removed from the min_offset it would
437 invalidate some of the calculations for how many chars must match
438 before or after (as they are derived from min_offset and minlen and
538e84ed 439 the length of the string being searched for).
1de06328
YO
440 When the final pattern is compiled and the data is moved from the
441 scan_data_t structure into the regexp structure the information
538e84ed
KW
442 about lookbehind is factored in, with the information that would
443 have been lost precalculated in the end_shift field for the
1de06328
YO
444 associated string.
445
446 The fields pos_min and pos_delta are used to store the minimum offset
538e84ed 447 and the delta to the maximum offset at the current point in the pattern.
1de06328
YO
448
449*/
2c2d71f5
JH
450
451typedef struct scan_data_t {
1de06328
YO
452 /*I32 len_min; unused */
453 /*I32 len_delta; unused */
49f55535 454 SSize_t pos_min;
ea3daa5d 455 SSize_t pos_delta;
2c2d71f5 456 SV *last_found;
ea3daa5d 457 SSize_t last_end; /* min value, <0 unless valid. */
49f55535 458 SSize_t last_start_min;
ea3daa5d 459 SSize_t last_start_max;
1de06328
YO
460 SV **longest; /* Either &l_fixed, or &l_float. */
461 SV *longest_fixed; /* longest fixed string found in pattern */
49f55535 462 SSize_t offset_fixed; /* offset where it starts */
ea3daa5d 463 SSize_t *minlen_fixed; /* pointer to the minlen relevant to the string */
1de06328
YO
464 I32 lookbehind_fixed; /* is the position of the string modfied by LB */
465 SV *longest_float; /* longest floating string found in pattern */
49f55535 466 SSize_t offset_float_min; /* earliest point in string it can appear */
ea3daa5d
FC
467 SSize_t offset_float_max; /* latest point in string it can appear */
468 SSize_t *minlen_float; /* pointer to the minlen relevant to the string */
49f55535 469 SSize_t lookbehind_float; /* is the pos of the string modified by LB */
2c2d71f5
JH
470 I32 flags;
471 I32 whilem_c;
49f55535 472 SSize_t *last_closep;
b8f7bb16 473 regnode_ssc *start_class;
2c2d71f5
JH
474} scan_data_t;
475
a687059c 476/*
e50aee73 477 * Forward declarations for pregcomp()'s friends.
a687059c 478 */
a0d0e21e 479
27da23d5 480static const scan_data_t zero_scan_data =
1de06328 481 { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
c277df42
IZ
482
483#define SF_BEFORE_EOL (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
07be1b83
YO
484#define SF_BEFORE_SEOL 0x0001
485#define SF_BEFORE_MEOL 0x0002
c277df42
IZ
486#define SF_FIX_BEFORE_EOL (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
487#define SF_FL_BEFORE_EOL (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
488
44e3dfd2
BF
489#define SF_FIX_SHIFT_EOL (+2)
490#define SF_FL_SHIFT_EOL (+4)
c277df42
IZ
491
492#define SF_FIX_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
493#define SF_FIX_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
494
495#define SF_FL_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
496#define SF_FL_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
07be1b83
YO
497#define SF_IS_INF 0x0040
498#define SF_HAS_PAR 0x0080
499#define SF_IN_PAR 0x0100
500#define SF_HAS_EVAL 0x0200
bc604ad8
KW
501
502
503/* SCF_DO_SUBSTR is the flag that tells the regexp analyzer to track the
504 * longest substring in the pattern. When it is not set the optimiser keeps
505 * track of position, but does not keep track of the actual strings seen,
506 *
507 * So for instance /foo/ will be parsed with SCF_DO_SUBSTR being true, but
508 * /foo/i will not.
509 *
510 * Similarly, /foo.*(blah|erm|huh).*fnorble/ will have "foo" and "fnorble"
511 * parsed with SCF_DO_SUBSTR on, but while processing the (...) it will be
512 * turned off because of the alternation (BRANCH). */
07be1b83 513#define SCF_DO_SUBSTR 0x0400
bc604ad8 514
653099ff
GS
515#define SCF_DO_STCLASS_AND 0x0800
516#define SCF_DO_STCLASS_OR 0x1000
517#define SCF_DO_STCLASS (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
e1901655 518#define SCF_WHILEM_VISITED_POS 0x2000
c277df42 519
786e8c11 520#define SCF_TRIE_RESTUDY 0x4000 /* Do restudy? */
538e84ed 521#define SCF_SEEN_ACCEPT 0x8000
688e0391 522#define SCF_TRIE_DOING_RESTUDY 0x10000
4286711a
YO
523#define SCF_IN_DEFINE 0x20000
524
525
526
07be1b83 527
43fead97 528#define UTF cBOOL(RExC_utf8)
00b27cfc
KW
529
530/* The enums for all these are ordered so things work out correctly */
a62b1201 531#define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
538e84ed
KW
532#define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) \
533 == REGEX_DEPENDS_CHARSET)
00b27cfc 534#define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
538e84ed
KW
535#define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) \
536 >= REGEX_UNICODE_CHARSET)
537#define ASCII_RESTRICTED (get_regex_charset(RExC_flags) \
538 == REGEX_ASCII_RESTRICTED_CHARSET)
539#define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) \
540 >= REGEX_ASCII_RESTRICTED_CHARSET)
541#define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags) \
542 == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
a62b1201 543
43fead97 544#define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
a0ed51b3 545
f2c2a6ab
KW
546/* For programs that want to be strictly Unicode compatible by dying if any
547 * attempt is made to match a non-Unicode code point against a Unicode
548 * property. */
549#define ALWAYS_WARN_SUPER ckDEAD(packWARN(WARN_NON_UNICODE))
550
93733859 551#define OOB_NAMEDCLASS -1
b8c5462f 552
8e661ac5
KW
553/* There is no code point that is out-of-bounds, so this is problematic. But
554 * its only current use is to initialize a variable that is always set before
555 * looked at. */
556#define OOB_UNICODE 0xDEADBEEF
557
a0ed51b3 558#define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
a0ed51b3 559
8615cb43 560
b45f050a
JF
561/* length of regex to show in messages that don't mark a position within */
562#define RegexLengthToShowInErrorMessages 127
563
564/*
565 * If MARKER[12] are adjusted, be sure to adjust the constants at the top
566 * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
567 * op/pragma/warn/regcomp.
568 */
7253e4e3
RK
569#define MARKER1 "<-- HERE" /* marker as it appears in the description */
570#define MARKER2 " <-- HERE " /* marker as it appears within the regex */
b81d288d 571
538e84ed 572#define REPORT_LOCATION " in regex; marked by " MARKER1 \
147e3846 573 " in m/%" UTF8f MARKER2 "%" UTF8f "/"
b45f050a 574
285b5ca0
KW
575/* The code in this file in places uses one level of recursion with parsing
576 * rebased to an alternate string constructed by us in memory. This can take
577 * the form of something that is completely different from the input, or
578 * something that uses the input as part of the alternate. In the first case,
579 * there should be no possibility of an error, as we are in complete control of
580 * the alternate string. But in the second case we don't control the input
581 * portion, so there may be errors in that. Here's an example:
582 * /[abc\x{DF}def]/ui
583 * is handled specially because \x{df} folds to a sequence of more than one
584 * character, 'ss'. What is done is to create and parse an alternate string,
585 * which looks like this:
586 * /(?:\x{DF}|[abc\x{DF}def])/ui
587 * where it uses the input unchanged in the middle of something it constructs,
588 * which is a branch for the DF outside the character class, and clustering
589 * parens around the whole thing. (It knows enough to skip the DF inside the
590 * class while in this substitute parse.) 'abc' and 'def' may have errors that
591 * need to be reported. The general situation looks like this:
592 *
593 * sI tI xI eI
594 * Input: ----------------------------------------------------
595 * Constructed: ---------------------------------------------------
596 * sC tC xC eC EC
597 *
598 * The input string sI..eI is the input pattern. The string sC..EC is the
599 * constructed substitute parse string. The portions sC..tC and eC..EC are
600 * constructed by us. The portion tC..eC is an exact duplicate of the input
601 * pattern tI..eI. In the diagram, these are vertically aligned. Suppose that
602 * while parsing, we find an error at xC. We want to display a message showing
603 * the real input string. Thus we need to find the point xI in it which
604 * corresponds to xC. xC >= tC, since the portion of the string sC..tC has
605 * been constructed by us, and so shouldn't have errors. We get:
606 *
607 * xI = sI + (tI - sI) + (xC - tC)
608 *
609 * and, the offset into sI is:
610 *
611 * (xI - sI) = (tI - sI) + (xC - tC)
612 *
613 * When the substitute is constructed, we save (tI -sI) as RExC_precomp_adj,
614 * and we save tC as RExC_adjusted_start.
903c858a
KW
615 *
616 * During normal processing of the input pattern, everything points to that,
617 * with RExC_precomp_adj set to 0, and RExC_adjusted_start set to sI.
285b5ca0
KW
618 */
619
620#define tI_sI RExC_precomp_adj
621#define tC RExC_adjusted_start
622#define sC RExC_precomp
623#define xI_offset(xC) ((IV) (tI_sI + (xC - tC)))
624#define xI(xC) (sC + xI_offset(xC))
625#define eC RExC_precomp_end
626
627#define REPORT_LOCATION_ARGS(xC) \
628 UTF8fARG(UTF, \
629 (xI(xC) > eC) /* Don't run off end */ \
630 ? eC - sC /* Length before the <--HERE */ \
631 : xI_offset(xC), \
632 sC), /* The input pattern printed up to the <--HERE */ \
633 UTF8fARG(UTF, \
634 (xI(xC) > eC) ? 0 : eC - xI(xC), /* Length after <--HERE */ \
635 (xI(xC) > eC) ? eC : xI(xC)) /* pattern after <--HERE */
c1d900c3 636
8a6d8ec6
HS
637/* Used to point after bad bytes for an error message, but avoid skipping
638 * past a nul byte. */
639#define SKIP_IF_CHAR(s) (!*(s) ? 0 : UTF ? UTF8SKIP(s) : 1)
640
b45f050a
JF
641/*
642 * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
643 * arg. Show regex, up to a maximum length. If it's too long, chop and add
644 * "...".
645 */
58e23c8d 646#define _FAIL(code) STMT_START { \
bfed75c6 647 const char *ellipses = ""; \
711b303b 648 IV len = RExC_precomp_end - RExC_precomp; \
ccb2c380
MP
649 \
650 if (!SIZE_ONLY) \
a5e7bc51 651 SAVEFREESV(RExC_rx_sv); \
ccb2c380
MP
652 if (len > RegexLengthToShowInErrorMessages) { \
653 /* chop 10 shorter than the max, to ensure meaning of "..." */ \
654 len = RegexLengthToShowInErrorMessages - 10; \
655 ellipses = "..."; \
656 } \
58e23c8d 657 code; \
ccb2c380 658} STMT_END
8615cb43 659
58e23c8d 660#define FAIL(msg) _FAIL( \
147e3846 661 Perl_croak(aTHX_ "%s in regex m/%" UTF8f "%s/", \
c1d900c3 662 msg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
58e23c8d
YO
663
664#define FAIL2(msg,arg) _FAIL( \
147e3846 665 Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/", \
c1d900c3 666 arg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
58e23c8d 667
b45f050a 668/*
b45f050a
JF
669 * Simple_vFAIL -- like FAIL, but marks the current location in the scan
670 */
ccb2c380 671#define Simple_vFAIL(m) STMT_START { \
ccb2c380 672 Perl_croak(aTHX_ "%s" REPORT_LOCATION, \
d528642a 673 m, REPORT_LOCATION_ARGS(RExC_parse)); \
ccb2c380 674} STMT_END
b45f050a
JF
675
676/*
677 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
678 */
ccb2c380
MP
679#define vFAIL(m) STMT_START { \
680 if (!SIZE_ONLY) \
a5e7bc51 681 SAVEFREESV(RExC_rx_sv); \
ccb2c380
MP
682 Simple_vFAIL(m); \
683} STMT_END
b45f050a
JF
684
685/*
686 * Like Simple_vFAIL(), but accepts two arguments.
687 */
ccb2c380 688#define Simple_vFAIL2(m,a1) STMT_START { \
d528642a
KW
689 S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, \
690 REPORT_LOCATION_ARGS(RExC_parse)); \
ccb2c380 691} STMT_END
b45f050a
JF
692
693/*
694 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
695 */
ccb2c380
MP
696#define vFAIL2(m,a1) STMT_START { \
697 if (!SIZE_ONLY) \
a5e7bc51 698 SAVEFREESV(RExC_rx_sv); \
ccb2c380
MP
699 Simple_vFAIL2(m, a1); \
700} STMT_END
b45f050a
JF
701
702
703/*
704 * Like Simple_vFAIL(), but accepts three arguments.
705 */
ccb2c380 706#define Simple_vFAIL3(m, a1, a2) STMT_START { \
c1d900c3 707 S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, \
d528642a 708 REPORT_LOCATION_ARGS(RExC_parse)); \
ccb2c380 709} STMT_END
b45f050a
JF
710
711/*
712 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
713 */
ccb2c380
MP
714#define vFAIL3(m,a1,a2) STMT_START { \
715 if (!SIZE_ONLY) \
a5e7bc51 716 SAVEFREESV(RExC_rx_sv); \
ccb2c380
MP
717 Simple_vFAIL3(m, a1, a2); \
718} STMT_END
b45f050a
JF
719
720/*
721 * Like Simple_vFAIL(), but accepts four arguments.
722 */
ccb2c380 723#define Simple_vFAIL4(m, a1, a2, a3) STMT_START { \
d528642a
KW
724 S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, a3, \
725 REPORT_LOCATION_ARGS(RExC_parse)); \
ccb2c380 726} STMT_END
b45f050a 727
95db3ffa
KW
728#define vFAIL4(m,a1,a2,a3) STMT_START { \
729 if (!SIZE_ONLY) \
730 SAVEFREESV(RExC_rx_sv); \
731 Simple_vFAIL4(m, a1, a2, a3); \
732} STMT_END
733
946095af 734/* A specialized version of vFAIL2 that works with UTF8f */
d528642a
KW
735#define vFAIL2utf8f(m, a1) STMT_START { \
736 if (!SIZE_ONLY) \
737 SAVEFREESV(RExC_rx_sv); \
738 S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, \
739 REPORT_LOCATION_ARGS(RExC_parse)); \
946095af
BF
740} STMT_END
741
3ba22297 742#define vFAIL3utf8f(m, a1, a2) STMT_START { \
3ba22297
KW
743 if (!SIZE_ONLY) \
744 SAVEFREESV(RExC_rx_sv); \
745 S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, \
d528642a 746 REPORT_LOCATION_ARGS(RExC_parse)); \
3ba22297
KW
747} STMT_END
748
499333dc
KW
749/* These have asserts in them because of [perl #122671] Many warnings in
750 * regcomp.c can occur twice. If they get output in pass1 and later in that
751 * pass, the pattern has to be converted to UTF-8 and the pass restarted, they
752 * would get output again. So they should be output in pass2, and these
753 * asserts make sure new warnings follow that paradigm. */
946095af 754
5e0a247b
KW
755/* m is not necessarily a "literal string", in this macro */
756#define reg_warn_non_literal_string(loc, m) STMT_START { \
d528642a
KW
757 __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), \
758 "%s" REPORT_LOCATION, \
759 m, REPORT_LOCATION_ARGS(loc)); \
5e0a247b
KW
760} STMT_END
761
668c081a 762#define ckWARNreg(loc,m) STMT_START { \
d528642a
KW
763 __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), \
764 m REPORT_LOCATION, \
765 REPORT_LOCATION_ARGS(loc)); \
ccb2c380
MP
766} STMT_END
767
b927b7e9 768#define vWARN(loc, m) STMT_START { \
d528642a
KW
769 __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), \
770 m REPORT_LOCATION, \
771 REPORT_LOCATION_ARGS(loc)); \
b927b7e9
KW
772} STMT_END
773
0d6106aa 774#define vWARN_dep(loc, m) STMT_START { \
d528642a
KW
775 __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_DEPRECATED), \
776 m REPORT_LOCATION, \
777 REPORT_LOCATION_ARGS(loc)); \
0d6106aa
KW
778} STMT_END
779
147508a2 780#define ckWARNdep(loc,m) STMT_START { \
d528642a
KW
781 __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), \
782 m REPORT_LOCATION, \
783 REPORT_LOCATION_ARGS(loc)); \
147508a2
KW
784} STMT_END
785
d528642a
KW
786#define ckWARNregdep(loc,m) STMT_START { \
787 __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, \
788 WARN_REGEXP), \
789 m REPORT_LOCATION, \
790 REPORT_LOCATION_ARGS(loc)); \
ccb2c380
MP
791} STMT_END
792
d528642a
KW
793#define ckWARN2reg_d(loc,m, a1) STMT_START { \
794 __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP), \
795 m REPORT_LOCATION, \
796 a1, REPORT_LOCATION_ARGS(loc)); \
2335b3d3
KW
797} STMT_END
798
d528642a
KW
799#define ckWARN2reg(loc, m, a1) STMT_START { \
800 __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), \
801 m REPORT_LOCATION, \
802 a1, REPORT_LOCATION_ARGS(loc)); \
ccb2c380
MP
803} STMT_END
804
d528642a
KW
805#define vWARN3(loc, m, a1, a2) STMT_START { \
806 __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), \
807 m REPORT_LOCATION, \
808 a1, a2, REPORT_LOCATION_ARGS(loc)); \
ccb2c380
MP
809} STMT_END
810
d528642a
KW
811#define ckWARN3reg(loc, m, a1, a2) STMT_START { \
812 __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), \
813 m REPORT_LOCATION, \
814 a1, a2, \
815 REPORT_LOCATION_ARGS(loc)); \
668c081a
NC
816} STMT_END
817
ccb2c380 818#define vWARN4(loc, m, a1, a2, a3) STMT_START { \
d528642a
KW
819 __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), \
820 m REPORT_LOCATION, \
821 a1, a2, a3, \
822 REPORT_LOCATION_ARGS(loc)); \
ccb2c380
MP
823} STMT_END
824
668c081a 825#define ckWARN4reg(loc, m, a1, a2, a3) STMT_START { \
d528642a
KW
826 __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), \
827 m REPORT_LOCATION, \
828 a1, a2, a3, \
829 REPORT_LOCATION_ARGS(loc)); \
668c081a
NC
830} STMT_END
831
ccb2c380 832#define vWARN5(loc, m, a1, a2, a3, a4) STMT_START { \
d528642a
KW
833 __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), \
834 m REPORT_LOCATION, \
835 a1, a2, a3, a4, \
836 REPORT_LOCATION_ARGS(loc)); \
ccb2c380 837} STMT_END
9d1d55b5 838
538e84ed 839/* Macros for recording node offsets. 20001227 mjd@plover.com
fac92740
MJD
840 * Nodes are numbered 1, 2, 3, 4. Node #n's position is recorded in
841 * element 2*n-1 of the array. Element #2n holds the byte length node #n.
842 * Element 0 holds the number n.
07be1b83 843 * Position is 1 indexed.
fac92740 844 */
7122b237
YO
845#ifndef RE_TRACK_PATTERN_OFFSETS
846#define Set_Node_Offset_To_R(node,byte)
847#define Set_Node_Offset(node,byte)
848#define Set_Cur_Node_Offset
849#define Set_Node_Length_To_R(node,len)
850#define Set_Node_Length(node,len)
6a86c6ad 851#define Set_Node_Cur_Length(node,start)
538e84ed
KW
852#define Node_Offset(n)
853#define Node_Length(n)
7122b237
YO
854#define Set_Node_Offset_Length(node,offset,len)
855#define ProgLen(ri) ri->u.proglen
856#define SetProgLen(ri,x) ri->u.proglen = x
857#else
858#define ProgLen(ri) ri->u.offsets[0]
859#define SetProgLen(ri,x) ri->u.offsets[0] = x
ccb2c380
MP
860#define Set_Node_Offset_To_R(node,byte) STMT_START { \
861 if (! SIZE_ONLY) { \
862 MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n", \
2a49f0f5 863 __LINE__, (int)(node), (int)(byte))); \
ccb2c380 864 if((node) < 0) { \
538e84ed
KW
865 Perl_croak(aTHX_ "value of node is %d in Offset macro", \
866 (int)(node)); \
ccb2c380
MP
867 } else { \
868 RExC_offsets[2*(node)-1] = (byte); \
869 } \
870 } \
871} STMT_END
872
873#define Set_Node_Offset(node,byte) \
874 Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
875#define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
876
877#define Set_Node_Length_To_R(node,len) STMT_START { \
878 if (! SIZE_ONLY) { \
879 MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n", \
551405c4 880 __LINE__, (int)(node), (int)(len))); \
ccb2c380 881 if((node) < 0) { \
538e84ed
KW
882 Perl_croak(aTHX_ "value of node is %d in Length macro", \
883 (int)(node)); \
ccb2c380
MP
884 } else { \
885 RExC_offsets[2*(node)] = (len); \
886 } \
887 } \
888} STMT_END
889
890#define Set_Node_Length(node,len) \
891 Set_Node_Length_To_R((node)-RExC_emit_start, len)
6a86c6ad
NC
892#define Set_Node_Cur_Length(node, start) \
893 Set_Node_Length(node, RExC_parse - start)
fac92740
MJD
894
895/* Get offsets and lengths */
896#define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
897#define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
898
07be1b83
YO
899#define Set_Node_Offset_Length(node,offset,len) STMT_START { \
900 Set_Node_Offset_To_R((node)-RExC_emit_start, (offset)); \
901 Set_Node_Length_To_R((node)-RExC_emit_start, (len)); \
902} STMT_END
7122b237 903#endif
07be1b83
YO
904
905#if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
906#define EXPERIMENTAL_INPLACESCAN
f427392e 907#endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
07be1b83 908
cb41e5d6
YO
909#ifdef DEBUGGING
910int
6ad9a8ab 911Perl_re_printf(pTHX_ const char *fmt, ...)
cb41e5d6
YO
912{
913 va_list ap;
914 int result;
915 PerlIO *f= Perl_debug_log;
916 PERL_ARGS_ASSERT_RE_PRINTF;
917 va_start(ap, fmt);
918 result = PerlIO_vprintf(f, fmt, ap);
919 va_end(ap);
920 return result;
921}
922
923int
7b031478 924Perl_re_indentf(pTHX_ const char *fmt, U32 depth, ...)
cb41e5d6
YO
925{
926 va_list ap;
927 int result;
928 PerlIO *f= Perl_debug_log;
929 PERL_ARGS_ASSERT_RE_INDENTF;
930 va_start(ap, depth);
daeb874b 931 PerlIO_printf(f, "%*s", ( (int)depth % 20 ) * 2, "");
cb41e5d6
YO
932 result = PerlIO_vprintf(f, fmt, ap);
933 va_end(ap);
934 return result;
935}
936#endif /* DEBUGGING */
937
7b031478 938#define DEBUG_RExC_seen() \
538e84ed 939 DEBUG_OPTIMISE_MORE_r({ \
6ad9a8ab 940 Perl_re_printf( aTHX_ "RExC_seen: "); \
538e84ed 941 \
e384d5c1 942 if (RExC_seen & REG_ZERO_LEN_SEEN) \
6ad9a8ab 943 Perl_re_printf( aTHX_ "REG_ZERO_LEN_SEEN "); \
538e84ed 944 \
e384d5c1 945 if (RExC_seen & REG_LOOKBEHIND_SEEN) \
6ad9a8ab 946 Perl_re_printf( aTHX_ "REG_LOOKBEHIND_SEEN "); \
538e84ed 947 \
e384d5c1 948 if (RExC_seen & REG_GPOS_SEEN) \
6ad9a8ab 949 Perl_re_printf( aTHX_ "REG_GPOS_SEEN "); \
538e84ed 950 \
e384d5c1 951 if (RExC_seen & REG_RECURSE_SEEN) \
6ad9a8ab 952 Perl_re_printf( aTHX_ "REG_RECURSE_SEEN "); \
538e84ed 953 \
7b031478 954 if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN) \
6ad9a8ab 955 Perl_re_printf( aTHX_ "REG_TOP_LEVEL_BRANCHES_SEEN "); \
538e84ed 956 \
e384d5c1 957 if (RExC_seen & REG_VERBARG_SEEN) \
6ad9a8ab 958 Perl_re_printf( aTHX_ "REG_VERBARG_SEEN "); \
538e84ed 959 \
e384d5c1 960 if (RExC_seen & REG_CUTGROUP_SEEN) \
6ad9a8ab 961 Perl_re_printf( aTHX_ "REG_CUTGROUP_SEEN "); \
538e84ed 962 \
e384d5c1 963 if (RExC_seen & REG_RUN_ON_COMMENT_SEEN) \
6ad9a8ab 964 Perl_re_printf( aTHX_ "REG_RUN_ON_COMMENT_SEEN "); \
538e84ed 965 \
e384d5c1 966 if (RExC_seen & REG_UNFOLDED_MULTI_SEEN) \
6ad9a8ab 967 Perl_re_printf( aTHX_ "REG_UNFOLDED_MULTI_SEEN "); \
538e84ed 968 \
7b031478 969 if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN) \
6ad9a8ab 970 Perl_re_printf( aTHX_ "REG_UNBOUNDED_QUANTIFIER_SEEN "); \
ee273784 971 \
6ad9a8ab 972 Perl_re_printf( aTHX_ "\n"); \
9e9ecfdf
YO
973 });
974
fdfb4f21 975#define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
6ad9a8ab 976 if ((flags) & flag) Perl_re_printf( aTHX_ "%s ", #flag)
fdfb4f21
YO
977
978#define DEBUG_SHOW_STUDY_FLAGS(flags,open_str,close_str) \
979 if ( ( flags ) ) { \
6ad9a8ab 980 Perl_re_printf( aTHX_ "%s", open_str); \
fdfb4f21
YO
981 DEBUG_SHOW_STUDY_FLAG(flags,SF_FL_BEFORE_SEOL); \
982 DEBUG_SHOW_STUDY_FLAG(flags,SF_FL_BEFORE_MEOL); \
983 DEBUG_SHOW_STUDY_FLAG(flags,SF_IS_INF); \
984 DEBUG_SHOW_STUDY_FLAG(flags,SF_HAS_PAR); \
985 DEBUG_SHOW_STUDY_FLAG(flags,SF_IN_PAR); \
986 DEBUG_SHOW_STUDY_FLAG(flags,SF_HAS_EVAL); \
987 DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_SUBSTR); \
988 DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS_AND); \
989 DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS_OR); \
990 DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS); \
991 DEBUG_SHOW_STUDY_FLAG(flags,SCF_WHILEM_VISITED_POS); \
992 DEBUG_SHOW_STUDY_FLAG(flags,SCF_TRIE_RESTUDY); \
993 DEBUG_SHOW_STUDY_FLAG(flags,SCF_SEEN_ACCEPT); \
994 DEBUG_SHOW_STUDY_FLAG(flags,SCF_TRIE_DOING_RESTUDY); \
995 DEBUG_SHOW_STUDY_FLAG(flags,SCF_IN_DEFINE); \
6ad9a8ab 996 Perl_re_printf( aTHX_ "%s", close_str); \
fdfb4f21
YO
997 }
998
999
304ee84b
YO
1000#define DEBUG_STUDYDATA(str,data,depth) \
1001DEBUG_OPTIMISE_MORE_r(if(data){ \
147e3846
KW
1002 Perl_re_indentf( aTHX_ "" str "Pos:%" IVdf "/%" IVdf \
1003 " Flags: 0x%" UVXf, \
7b031478 1004 depth, \
1de06328
YO
1005 (IV)((data)->pos_min), \
1006 (IV)((data)->pos_delta), \
fdfb4f21
YO
1007 (UV)((data)->flags) \
1008 ); \
1009 DEBUG_SHOW_STUDY_FLAGS((data)->flags," [ ","]"); \
147e3846
KW
1010 Perl_re_printf( aTHX_ \
1011 " Whilem_c: %" IVdf " Lcp: %" IVdf " %s", \
1de06328 1012 (IV)((data)->whilem_c), \
304ee84b
YO
1013 (IV)((data)->last_closep ? *((data)->last_closep) : -1), \
1014 is_inf ? "INF " : "" \
1de06328
YO
1015 ); \
1016 if ((data)->last_found) \
147e3846
KW
1017 Perl_re_printf( aTHX_ \
1018 "Last:'%s' %" IVdf ":%" IVdf "/%" IVdf \
1019 " %sFixed:'%s' @ %" IVdf \
1020 " %sFloat: '%s' @ %" IVdf "/%" IVdf, \
1de06328
YO
1021 SvPVX_const((data)->last_found), \
1022 (IV)((data)->last_end), \
1023 (IV)((data)->last_start_min), \
1024 (IV)((data)->last_start_max), \
1025 ((data)->longest && \
1026 (data)->longest==&((data)->longest_fixed)) ? "*" : "", \
1027 SvPVX_const((data)->longest_fixed), \
1028 (IV)((data)->offset_fixed), \
1029 ((data)->longest && \
1030 (data)->longest==&((data)->longest_float)) ? "*" : "", \
1031 SvPVX_const((data)->longest_float), \
1032 (IV)((data)->offset_float_min), \
1033 (IV)((data)->offset_float_max) \
1034 ); \
6ad9a8ab 1035 Perl_re_printf( aTHX_ "\n"); \
1de06328
YO
1036});
1037
cb41e5d6 1038
c6871b76
KW
1039/* =========================================================
1040 * BEGIN edit_distance stuff.
1041 *
1042 * This calculates how many single character changes of any type are needed to
1043 * transform a string into another one. It is taken from version 3.1 of
1044 *
1045 * https://metacpan.org/pod/Text::Levenshtein::Damerau::XS
1046 */
1047
1048/* Our unsorted dictionary linked list. */
1049/* Note we use UVs, not chars. */
1050
1051struct dictionary{
1052 UV key;
1053 UV value;
1054 struct dictionary* next;
1055};
1056typedef struct dictionary item;
1057
1058
1059PERL_STATIC_INLINE item*
1060push(UV key,item* curr)
1061{
1062 item* head;
1063 Newxz(head, 1, item);
1064 head->key = key;
1065 head->value = 0;
1066 head->next = curr;
1067 return head;
1068}
1069
1070
1071PERL_STATIC_INLINE item*
1072find(item* head, UV key)
1073{
1074 item* iterator = head;
1075 while (iterator){
1076 if (iterator->key == key){
1077 return iterator;
1078 }
1079 iterator = iterator->next;
1080 }
1081
1082 return NULL;
1083}
1084
1085PERL_STATIC_INLINE item*
1086uniquePush(item* head,UV key)
1087{
1088 item* iterator = head;
1089
1090 while (iterator){
1091 if (iterator->key == key) {
1092 return head;
1093 }
1094 iterator = iterator->next;
1095 }
1096
1097 return push(key,head);
1098}
1099
1100PERL_STATIC_INLINE void
1101dict_free(item* head)
1102{
1103 item* iterator = head;
1104
1105 while (iterator) {
1106 item* temp = iterator;
1107 iterator = iterator->next;
1108 Safefree(temp);
1109 }
1110
1111 head = NULL;
1112}
1113
1114/* End of Dictionary Stuff */
1115
1116/* All calculations/work are done here */
1117STATIC int
1118S_edit_distance(const UV* src,
1119 const UV* tgt,
1120 const STRLEN x, /* length of src[] */
1121 const STRLEN y, /* length of tgt[] */
1122 const SSize_t maxDistance
1123)
1124{
1125 item *head = NULL;
1126 UV swapCount,swapScore,targetCharCount,i,j;
1127 UV *scores;
1128 UV score_ceil = x + y;
1129
1130 PERL_ARGS_ASSERT_EDIT_DISTANCE;
1131
1132 /* intialize matrix start values */
1133 Newxz(scores, ( (x + 2) * (y + 2)), UV);
1134 scores[0] = score_ceil;
1135 scores[1 * (y + 2) + 0] = score_ceil;
1136 scores[0 * (y + 2) + 1] = score_ceil;
1137 scores[1 * (y + 2) + 1] = 0;
1138 head = uniquePush(uniquePush(head,src[0]),tgt[0]);
1139
1140 /* work loops */
1141 /* i = src index */
1142 /* j = tgt index */
1143 for (i=1;i<=x;i++) {
1144 if (i < x)
1145 head = uniquePush(head,src[i]);
1146 scores[(i+1) * (y + 2) + 1] = i;
1147 scores[(i+1) * (y + 2) + 0] = score_ceil;
1148 swapCount = 0;
1149
1150 for (j=1;j<=y;j++) {
1151 if (i == 1) {
1152 if(j < y)
1153 head = uniquePush(head,tgt[j]);
1154 scores[1 * (y + 2) + (j + 1)] = j;
1155 scores[0 * (y + 2) + (j + 1)] = score_ceil;
1156 }
1157
1158 targetCharCount = find(head,tgt[j-1])->value;
1159 swapScore = scores[targetCharCount * (y + 2) + swapCount] + i - targetCharCount - 1 + j - swapCount;
1160
1161 if (src[i-1] != tgt[j-1]){
1162 scores[(i+1) * (y + 2) + (j + 1)] = MIN(swapScore,(MIN(scores[i * (y + 2) + j], MIN(scores[(i+1) * (y + 2) + j], scores[i * (y + 2) + (j + 1)])) + 1));
1163 }
1164 else {
1165 swapCount = j;
1166 scores[(i+1) * (y + 2) + (j + 1)] = MIN(scores[i * (y + 2) + j], swapScore);
1167 }
1168 }
1169
1170 find(head,src[i-1])->value = i;
1171 }
1172
1173 {
1174 IV score = scores[(x+1) * (y + 2) + (y + 1)];
1175 dict_free(head);
1176 Safefree(scores);
1177 return (maxDistance != 0 && maxDistance < score)?(-1):score;
1178 }
1179}
1180
1181/* END of edit_distance() stuff
1182 * ========================================================= */
1183
8e35b056
KW
1184/* is c a control character for which we have a mnemonic? */
1185#define isMNEMONIC_CNTRL(c) _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
1186
549b4e78
KW
1187STATIC const char *
1188S_cntrl_to_mnemonic(const U8 c)
1189{
1190 /* Returns the mnemonic string that represents character 'c', if one
1191 * exists; NULL otherwise. The only ones that exist for the purposes of
1192 * this routine are a few control characters */
1193
1194 switch (c) {
1195 case '\a': return "\\a";
1196 case '\b': return "\\b";
1197 case ESC_NATIVE: return "\\e";
1198 case '\f': return "\\f";
1199 case '\n': return "\\n";
1200 case '\r': return "\\r";
1201 case '\t': return "\\t";
1202 }
1203
1204 return NULL;
1205}
1206
653099ff 1207/* Mark that we cannot extend a found fixed substring at this point.
786e8c11 1208 Update the longest found anchored substring and the longest found
653099ff
GS
1209 floating substrings if needed. */
1210
4327152a 1211STATIC void
ea3daa5d
FC
1212S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
1213 SSize_t *minlenp, int is_inf)
c277df42 1214{
e1ec3a88
AL
1215 const STRLEN l = CHR_SVLEN(data->last_found);
1216 const STRLEN old_l = CHR_SVLEN(*data->longest);
1de06328 1217 GET_RE_DEBUG_FLAGS_DECL;
b81d288d 1218
7918f24d
NC
1219 PERL_ARGS_ASSERT_SCAN_COMMIT;
1220
c277df42 1221 if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
6b43b216 1222 SvSetMagicSV(*data->longest, data->last_found);
c277df42
IZ
1223 if (*data->longest == data->longest_fixed) {
1224 data->offset_fixed = l ? data->last_start_min : data->pos_min;
1225 if (data->flags & SF_BEFORE_EOL)
b81d288d 1226 data->flags
c277df42
IZ
1227 |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
1228 else
1229 data->flags &= ~SF_FIX_BEFORE_EOL;
686b73d4 1230 data->minlen_fixed=minlenp;
1de06328 1231 data->lookbehind_fixed=0;
a0ed51b3 1232 }
304ee84b 1233 else { /* *data->longest == data->longest_float */
c277df42 1234 data->offset_float_min = l ? data->last_start_min : data->pos_min;
b81d288d 1235 data->offset_float_max = (l
646e8787
DM
1236 ? data->last_start_max
1237 : (data->pos_delta > SSize_t_MAX - data->pos_min
ea3daa5d
FC
1238 ? SSize_t_MAX
1239 : data->pos_min + data->pos_delta));
1240 if (is_inf
1241 || (STRLEN)data->offset_float_max > (STRLEN)SSize_t_MAX)
1242 data->offset_float_max = SSize_t_MAX;
c277df42 1243 if (data->flags & SF_BEFORE_EOL)
b81d288d 1244 data->flags
c277df42
IZ
1245 |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
1246 else
1247 data->flags &= ~SF_FL_BEFORE_EOL;
1de06328
YO
1248 data->minlen_float=minlenp;
1249 data->lookbehind_float=0;
c277df42
IZ
1250 }
1251 }
1252 SvCUR_set(data->last_found, 0);
0eda9292 1253 {
a28509cc 1254 SV * const sv = data->last_found;
097eb12c
AL
1255 if (SvUTF8(sv) && SvMAGICAL(sv)) {
1256 MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
1257 if (mg)
1258 mg->mg_len = 0;
1259 }
0eda9292 1260 }
c277df42
IZ
1261 data->last_end = -1;
1262 data->flags &= ~SF_BEFORE_EOL;
bcdf7404 1263 DEBUG_STUDYDATA("commit: ",data,0);
c277df42
IZ
1264}
1265
cdd87c1d
KW
1266/* An SSC is just a regnode_charclass_posix with an extra field: the inversion
1267 * list that describes which code points it matches */
1268
653099ff 1269STATIC void
3420edd7 1270S_ssc_anything(pTHX_ regnode_ssc *ssc)
653099ff 1271{
cdd87c1d
KW
1272 /* Set the SSC 'ssc' to match an empty string or any code point */
1273
557bd3fb 1274 PERL_ARGS_ASSERT_SSC_ANYTHING;
7918f24d 1275
71068078 1276 assert(is_ANYOF_SYNTHETIC(ssc));
3fffb88a 1277
0854ea0b
KW
1278 /* mortalize so won't leak */
1279 ssc->invlist = sv_2mortal(_add_range_to_invlist(NULL, 0, UV_MAX));
93e92956 1280 ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING; /* Plus matches empty */
653099ff
GS
1281}
1282
653099ff 1283STATIC int
dc3bf405 1284S_ssc_is_anything(const regnode_ssc *ssc)
653099ff 1285{
c144baaa
KW
1286 /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1287 * point; FALSE otherwise. Thus, this is used to see if using 'ssc' buys
1288 * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1289 * in any way, so there's no point in using it */
cdd87c1d
KW
1290
1291 UV start, end;
1292 bool ret;
653099ff 1293
557bd3fb 1294 PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
7918f24d 1295
71068078 1296 assert(is_ANYOF_SYNTHETIC(ssc));
cdd87c1d 1297
93e92956 1298 if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
cdd87c1d
KW
1299 return FALSE;
1300 }
1301
1302 /* See if the list consists solely of the range 0 - Infinity */
1303 invlist_iterinit(ssc->invlist);
1304 ret = invlist_iternext(ssc->invlist, &start, &end)
1305 && start == 0
1306 && end == UV_MAX;
1307
1308 invlist_iterfinish(ssc->invlist);
1309
1310 if (ret) {
1311 return TRUE;
1312 }
1313
1314 /* If e.g., both \w and \W are set, matches everything */
e0e1be5f 1315 if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
cdd87c1d
KW
1316 int i;
1317 for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1318 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1319 return TRUE;
1320 }
1321 }
1322 }
1323
1324 return FALSE;
653099ff
GS
1325}
1326
653099ff 1327STATIC void
cdd87c1d 1328S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
653099ff 1329{
cdd87c1d
KW
1330 /* Initializes the SSC 'ssc'. This includes setting it to match an empty
1331 * string, any code point, or any posix class under locale */
1332
557bd3fb 1333 PERL_ARGS_ASSERT_SSC_INIT;
7918f24d 1334
557bd3fb 1335 Zero(ssc, 1, regnode_ssc);
71068078 1336 set_ANYOF_SYNTHETIC(ssc);
93e92956 1337 ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
3420edd7 1338 ssc_anything(ssc);
cdd87c1d 1339
2f306ab9
KW
1340 /* If any portion of the regex is to operate under locale rules that aren't
1341 * fully known at compile time, initialization includes it. The reason
1342 * this isn't done for all regexes is that the optimizer was written under
1343 * the assumption that locale was all-or-nothing. Given the complexity and
1344 * lack of documentation in the optimizer, and that there are inadequate
1345 * test cases for locale, many parts of it may not work properly, it is
1346 * safest to avoid locale unless necessary. */
cdd87c1d
KW
1347 if (RExC_contains_locale) {
1348 ANYOF_POSIXL_SETALL(ssc);
cdd87c1d
KW
1349 }
1350 else {
1351 ANYOF_POSIXL_ZERO(ssc);
1352 }
653099ff
GS
1353}
1354
b423522f 1355STATIC int
dc3bf405
BF
1356S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1357 const regnode_ssc *ssc)
b423522f
KW
1358{
1359 /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1360 * to the list of code points matched, and locale posix classes; hence does
1361 * not check its flags) */
1362
1363 UV start, end;
1364 bool ret;
1365
1366 PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1367
71068078 1368 assert(is_ANYOF_SYNTHETIC(ssc));
b423522f
KW
1369
1370 invlist_iterinit(ssc->invlist);
1371 ret = invlist_iternext(ssc->invlist, &start, &end)
1372 && start == 0
1373 && end == UV_MAX;
1374
1375 invlist_iterfinish(ssc->invlist);
1376
1377 if (! ret) {
1378 return FALSE;
1379 }
1380
e0e1be5f 1381 if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
31f05a37 1382 return FALSE;
b423522f
KW
1383 }
1384
1385 return TRUE;
1386}
1387
1388STATIC SV*
1389S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
5c0f85ef 1390 const regnode_charclass* const node)
b423522f
KW
1391{
1392 /* Returns a mortal inversion list defining which code points are matched
1393 * by 'node', which is of type ANYOF. Handles complementing the result if
1394 * appropriate. If some code points aren't knowable at this time, the
31f05a37
KW
1395 * returned list must, and will, contain every code point that is a
1396 * possibility. */
b423522f 1397
e2506fa7 1398 SV* invlist = NULL;
1ee208c4 1399 SV* only_utf8_locale_invlist = NULL;
b423522f
KW
1400 unsigned int i;
1401 const U32 n = ARG(node);
31f05a37 1402 bool new_node_has_latin1 = FALSE;
b423522f
KW
1403
1404 PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1405
1406 /* Look at the data structure created by S_set_ANYOF_arg() */
93e92956 1407 if (n != ANYOF_ONLY_HAS_BITMAP) {
b423522f
KW
1408 SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1409 AV * const av = MUTABLE_AV(SvRV(rv));
1410 SV **const ary = AvARRAY(av);
1411 assert(RExC_rxi->data->what[n] == 's');
1412
1413 if (ary[1] && ary[1] != &PL_sv_undef) { /* Has compile-time swash */
1414 invlist = sv_2mortal(invlist_clone(_get_swash_invlist(ary[1])));
1415 }
1416 else if (ary[0] && ary[0] != &PL_sv_undef) {
1417
1418 /* Here, no compile-time swash, and there are things that won't be
1419 * known until runtime -- we have to assume it could be anything */
e2506fa7 1420 invlist = sv_2mortal(_new_invlist(1));
b423522f
KW
1421 return _add_range_to_invlist(invlist, 0, UV_MAX);
1422 }
1ee208c4 1423 else if (ary[3] && ary[3] != &PL_sv_undef) {
b423522f
KW
1424
1425 /* Here no compile-time swash, and no run-time only data. Use the
1426 * node's inversion list */
1ee208c4
KW
1427 invlist = sv_2mortal(invlist_clone(ary[3]));
1428 }
1429
1430 /* Get the code points valid only under UTF-8 locales */
037715a6 1431 if ((ANYOF_FLAGS(node) & ANYOFL_FOLD)
1ee208c4
KW
1432 && ary[2] && ary[2] != &PL_sv_undef)
1433 {
1434 only_utf8_locale_invlist = ary[2];
b423522f
KW
1435 }
1436 }
1437
e2506fa7
KW
1438 if (! invlist) {
1439 invlist = sv_2mortal(_new_invlist(0));
1440 }
1441
dcb20b36
KW
1442 /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1443 * code points, and an inversion list for the others, but if there are code
1444 * points that should match only conditionally on the target string being
1445 * UTF-8, those are placed in the inversion list, and not the bitmap.
1446 * Since there are circumstances under which they could match, they are
1447 * included in the SSC. But if the ANYOF node is to be inverted, we have
1448 * to exclude them here, so that when we invert below, the end result
1449 * actually does include them. (Think about "\xe0" =~ /[^\xc0]/di;). We
1450 * have to do this here before we add the unconditionally matched code
1451 * points */
b423522f
KW
1452 if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1453 _invlist_intersection_complement_2nd(invlist,
1454 PL_UpperLatin1,
1455 &invlist);
1456 }
1457
1458 /* Add in the points from the bit map */
dcb20b36 1459 for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
b423522f 1460 if (ANYOF_BITMAP_TEST(node, i)) {
6f8848d5
TC
1461 unsigned int start = i++;
1462
1463 for (; i < NUM_ANYOF_CODE_POINTS && ANYOF_BITMAP_TEST(node, i); ++i) {
1464 /* empty */
1465 }
1466 invlist = _add_range_to_invlist(invlist, start, i-1);
31f05a37 1467 new_node_has_latin1 = TRUE;
b423522f
KW
1468 }
1469 }
1470
1471 /* If this can match all upper Latin1 code points, have to add them
ac33c516
KW
1472 * as well. But don't add them if inverting, as when that gets done below,
1473 * it would exclude all these characters, including the ones it shouldn't
1474 * that were added just above */
1475 if (! (ANYOF_FLAGS(node) & ANYOF_INVERT) && OP(node) == ANYOFD
f240c685
KW
1476 && (ANYOF_FLAGS(node) & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
1477 {
b423522f
KW
1478 _invlist_union(invlist, PL_UpperLatin1, &invlist);
1479 }
1480
1481 /* Similarly for these */
93e92956 1482 if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
e0a1ff7a 1483 _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
b423522f
KW
1484 }
1485
1486 if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1487 _invlist_invert(invlist);
1488 }
037715a6 1489 else if (new_node_has_latin1 && ANYOF_FLAGS(node) & ANYOFL_FOLD) {
31f05a37
KW
1490
1491 /* Under /li, any 0-255 could fold to any other 0-255, depending on the
1492 * locale. We can skip this if there are no 0-255 at all. */
1493 _invlist_union(invlist, PL_Latin1, &invlist);
1494 }
1495
1ee208c4
KW
1496 /* Similarly add the UTF-8 locale possible matches. These have to be
1497 * deferred until after the non-UTF-8 locale ones are taken care of just
1498 * above, or it leads to wrong results under ANYOF_INVERT */
1499 if (only_utf8_locale_invlist) {
31f05a37 1500 _invlist_union_maybe_complement_2nd(invlist,
1ee208c4 1501 only_utf8_locale_invlist,
31f05a37
KW
1502 ANYOF_FLAGS(node) & ANYOF_INVERT,
1503 &invlist);
1504 }
b423522f
KW
1505
1506 return invlist;
1507}
1508
1051e1c4 1509/* These two functions currently do the exact same thing */
557bd3fb 1510#define ssc_init_zero ssc_init
653099ff 1511
cdd87c1d
KW
1512#define ssc_add_cp(ssc, cp) ssc_add_range((ssc), (cp), (cp))
1513#define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1514
557bd3fb 1515/* 'AND' a given class with another one. Can create false positives. 'ssc'
93e92956
KW
1516 * should not be inverted. 'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1517 * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
cdd87c1d 1518
653099ff 1519STATIC void
b423522f 1520S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
7dcac5f6 1521 const regnode_charclass *and_with)
653099ff 1522{
cdd87c1d
KW
1523 /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1524 * another SSC or a regular ANYOF class. Can create false positives. */
40d049e4 1525
a0dd4231
KW
1526 SV* anded_cp_list;
1527 U8 anded_flags;
1e6ade67 1528
cdd87c1d 1529 PERL_ARGS_ASSERT_SSC_AND;
653099ff 1530
71068078 1531 assert(is_ANYOF_SYNTHETIC(ssc));
a0dd4231
KW
1532
1533 /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1534 * the code point inversion list and just the relevant flags */
71068078 1535 if (is_ANYOF_SYNTHETIC(and_with)) {
7dcac5f6 1536 anded_cp_list = ((regnode_ssc *)and_with)->invlist;
a0dd4231 1537 anded_flags = ANYOF_FLAGS(and_with);
e9b08962
KW
1538
1539 /* XXX This is a kludge around what appears to be deficiencies in the
1540 * optimizer. If we make S_ssc_anything() add in the WARN_SUPER flag,
1541 * there are paths through the optimizer where it doesn't get weeded
1542 * out when it should. And if we don't make some extra provision for
1543 * it like the code just below, it doesn't get added when it should.
1544 * This solution is to add it only when AND'ing, which is here, and
1545 * only when what is being AND'ed is the pristine, original node
1546 * matching anything. Thus it is like adding it to ssc_anything() but
1547 * only when the result is to be AND'ed. Probably the same solution
1548 * could be adopted for the same problem we have with /l matching,
1549 * which is solved differently in S_ssc_init(), and that would lead to
1550 * fewer false positives than that solution has. But if this solution
1551 * creates bugs, the consequences are only that a warning isn't raised
1552 * that should be; while the consequences for having /l bugs is
1553 * incorrect matches */
7dcac5f6 1554 if (ssc_is_anything((regnode_ssc *)and_with)) {
f240c685 1555 anded_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
e9b08962 1556 }
a0dd4231
KW
1557 }
1558 else {
5c0f85ef 1559 anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
f240c685
KW
1560 if (OP(and_with) == ANYOFD) {
1561 anded_flags = ANYOF_FLAGS(and_with) & ANYOF_COMMON_FLAGS;
1562 }
1563 else {
1564 anded_flags = ANYOF_FLAGS(and_with)
1565 &( ANYOF_COMMON_FLAGS
108316fb
KW
1566 |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1567 |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
d1c40ef5
KW
1568 if (ANYOFL_UTF8_LOCALE_REQD(ANYOF_FLAGS(and_with))) {
1569 anded_flags &=
1570 ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1571 }
f240c685 1572 }
a0dd4231
KW
1573 }
1574
1575 ANYOF_FLAGS(ssc) &= anded_flags;
cdd87c1d
KW
1576
1577 /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1578 * C2 is the list of code points in 'and-with'; P2, its posix classes.
1579 * 'and_with' may be inverted. When not inverted, we have the situation of
1580 * computing:
1581 * (C1 | P1) & (C2 | P2)
1582 * = (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1583 * = ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1584 * <= ((C1 & C2) | P2)) | ( P1 | (P1 & P2))
1585 * <= ((C1 & C2) | P1 | P2)
1586 * Alternatively, the last few steps could be:
1587 * = ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1588 * <= ((C1 & C2) | C1 ) | ( C2 | (P1 & P2))
1589 * <= (C1 | C2 | (P1 & P2))
1590 * We favor the second approach if either P1 or P2 is non-empty. This is
1591 * because these components are a barrier to doing optimizations, as what
1592 * they match cannot be known until the moment of matching as they are
1593 * dependent on the current locale, 'AND"ing them likely will reduce or
1594 * eliminate them.
1595 * But we can do better if we know that C1,P1 are in their initial state (a
1596 * frequent occurrence), each matching everything:
1597 * (<everything>) & (C2 | P2) = C2 | P2
1598 * Similarly, if C2,P2 are in their initial state (again a frequent
1599 * occurrence), the result is a no-op
1600 * (C1 | P1) & (<everything>) = C1 | P1
1601 *
1602 * Inverted, we have
1603 * (C1 | P1) & ~(C2 | P2) = (C1 | P1) & (~C2 & ~P2)
1604 * = (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1605 * <= (C1 & ~C2) | (P1 & ~P2)
1606 * */
1aa99e6b 1607
a0dd4231 1608 if ((ANYOF_FLAGS(and_with) & ANYOF_INVERT)
71068078 1609 && ! is_ANYOF_SYNTHETIC(and_with))
a0dd4231 1610 {
cdd87c1d 1611 unsigned int i;
8951c461 1612
cdd87c1d
KW
1613 ssc_intersection(ssc,
1614 anded_cp_list,
1615 FALSE /* Has already been inverted */
1616 );
c6b76537 1617
cdd87c1d
KW
1618 /* If either P1 or P2 is empty, the intersection will be also; can skip
1619 * the loop */
93e92956 1620 if (! (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL)) {
cdd87c1d
KW
1621 ANYOF_POSIXL_ZERO(ssc);
1622 }
e0e1be5f 1623 else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
cdd87c1d
KW
1624
1625 /* Note that the Posix class component P from 'and_with' actually
1626 * looks like:
1627 * P = Pa | Pb | ... | Pn
1628 * where each component is one posix class, such as in [\w\s].
1629 * Thus
1630 * ~P = ~(Pa | Pb | ... | Pn)
1631 * = ~Pa & ~Pb & ... & ~Pn
1632 * <= ~Pa | ~Pb | ... | ~Pn
1633 * The last is something we can easily calculate, but unfortunately
1634 * is likely to have many false positives. We could do better
1635 * in some (but certainly not all) instances if two classes in
1636 * P have known relationships. For example
1637 * :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1638 * So
1639 * :lower: & :print: = :lower:
1640 * And similarly for classes that must be disjoint. For example,
1641 * since \s and \w can have no elements in common based on rules in
1642 * the POSIX standard,
1643 * \w & ^\S = nothing
1644 * Unfortunately, some vendor locales do not meet the Posix
1645 * standard, in particular almost everything by Microsoft.
1646 * The loop below just changes e.g., \w into \W and vice versa */
1647
1ee208c4 1648 regnode_charclass_posixl temp;
cdd87c1d
KW
1649 int add = 1; /* To calculate the index of the complement */
1650
1651 ANYOF_POSIXL_ZERO(&temp);
1652 for (i = 0; i < ANYOF_MAX; i++) {
1653 assert(i % 2 != 0
7dcac5f6
KW
1654 || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)
1655 || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i + 1));
cdd87c1d 1656
7dcac5f6 1657 if (ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)) {
cdd87c1d
KW
1658 ANYOF_POSIXL_SET(&temp, i + add);
1659 }
1660 add = 0 - add; /* 1 goes to -1; -1 goes to 1 */
1661 }
1662 ANYOF_POSIXL_AND(&temp, ssc);
c6b76537 1663
cdd87c1d
KW
1664 } /* else ssc already has no posixes */
1665 } /* else: Not inverted. This routine is a no-op if 'and_with' is an SSC
1666 in its initial state */
71068078 1667 else if (! is_ANYOF_SYNTHETIC(and_with)
7dcac5f6 1668 || ! ssc_is_cp_posixl_init(pRExC_state, (regnode_ssc *)and_with))
cdd87c1d
KW
1669 {
1670 /* But if 'ssc' is in its initial state, the result is just 'and_with';
1671 * copy it over 'ssc' */
1672 if (ssc_is_cp_posixl_init(pRExC_state, ssc)) {
71068078 1673 if (is_ANYOF_SYNTHETIC(and_with)) {
cdd87c1d
KW
1674 StructCopy(and_with, ssc, regnode_ssc);
1675 }
1676 else {
1677 ssc->invlist = anded_cp_list;
1678 ANYOF_POSIXL_ZERO(ssc);
93e92956 1679 if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
7dcac5f6 1680 ANYOF_POSIXL_OR((regnode_charclass_posixl*) and_with, ssc);
cdd87c1d
KW
1681 }
1682 }
1683 }
e0e1be5f 1684 else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)
93e92956 1685 || (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL))
cdd87c1d
KW
1686 {
1687 /* One or the other of P1, P2 is non-empty. */
93e92956 1688 if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1ea8b7fe
KW
1689 ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1690 }
cdd87c1d
KW
1691 ssc_union(ssc, anded_cp_list, FALSE);
1692 }
1693 else { /* P1 = P2 = empty */
1694 ssc_intersection(ssc, anded_cp_list, FALSE);
1695 }
137165a6 1696 }
653099ff
GS
1697}
1698
653099ff 1699STATIC void
cdd87c1d 1700S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
7dcac5f6 1701 const regnode_charclass *or_with)
653099ff 1702{
cdd87c1d
KW
1703 /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1704 * another SSC or a regular ANYOF class. Can create false positives if
1705 * 'or_with' is to be inverted. */
7918f24d 1706
a0dd4231
KW
1707 SV* ored_cp_list;
1708 U8 ored_flags;
c6b76537 1709
cdd87c1d 1710 PERL_ARGS_ASSERT_SSC_OR;
c6b76537 1711
71068078 1712 assert(is_ANYOF_SYNTHETIC(ssc));
a0dd4231
KW
1713
1714 /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1715 * the code point inversion list and just the relevant flags */
71068078 1716 if (is_ANYOF_SYNTHETIC(or_with)) {
7dcac5f6 1717 ored_cp_list = ((regnode_ssc*) or_with)->invlist;
a0dd4231
KW
1718 ored_flags = ANYOF_FLAGS(or_with);
1719 }
1720 else {
5c0f85ef 1721 ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, or_with);
eff8b7dc 1722 ored_flags = ANYOF_FLAGS(or_with) & ANYOF_COMMON_FLAGS;
f240c685
KW
1723 if (OP(or_with) != ANYOFD) {
1724 ored_flags
1725 |= ANYOF_FLAGS(or_with)
108316fb
KW
1726 & ( ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1727 |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
d1c40ef5
KW
1728 if (ANYOFL_UTF8_LOCALE_REQD(ANYOF_FLAGS(or_with))) {
1729 ored_flags |=
1730 ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1731 }
f240c685 1732 }
a0dd4231
KW
1733 }
1734
1735 ANYOF_FLAGS(ssc) |= ored_flags;
cdd87c1d
KW
1736
1737 /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1738 * C2 is the list of code points in 'or-with'; P2, its posix classes.
1739 * 'or_with' may be inverted. When not inverted, we have the simple
1740 * situation of computing:
1741 * (C1 | P1) | (C2 | P2) = (C1 | C2) | (P1 | P2)
1742 * If P1|P2 yields a situation with both a class and its complement are
1743 * set, like having both \w and \W, this matches all code points, and we
1744 * can delete these from the P component of the ssc going forward. XXX We
1745 * might be able to delete all the P components, but I (khw) am not certain
1746 * about this, and it is better to be safe.
1747 *
1748 * Inverted, we have
1749 * (C1 | P1) | ~(C2 | P2) = (C1 | P1) | (~C2 & ~P2)
1750 * <= (C1 | P1) | ~C2
1751 * <= (C1 | ~C2) | P1
1752 * (which results in actually simpler code than the non-inverted case)
1753 * */
9826f543 1754
a0dd4231 1755 if ((ANYOF_FLAGS(or_with) & ANYOF_INVERT)
71068078 1756 && ! is_ANYOF_SYNTHETIC(or_with))
a0dd4231 1757 {
cdd87c1d 1758 /* We ignore P2, leaving P1 going forward */
1ea8b7fe 1759 } /* else Not inverted */
93e92956 1760 else if (ANYOF_FLAGS(or_with) & ANYOF_MATCHES_POSIXL) {
7dcac5f6 1761 ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
e0e1be5f 1762 if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
cdd87c1d
KW
1763 unsigned int i;
1764 for (i = 0; i < ANYOF_MAX; i += 2) {
1765 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
1766 {
1767 ssc_match_all_cp(ssc);
1768 ANYOF_POSIXL_CLEAR(ssc, i);
1769 ANYOF_POSIXL_CLEAR(ssc, i+1);
cdd87c1d
KW
1770 }
1771 }
1772 }
1aa99e6b 1773 }
cdd87c1d
KW
1774
1775 ssc_union(ssc,
1776 ored_cp_list,
1777 FALSE /* Already has been inverted */
1778 );
653099ff
GS
1779}
1780
b423522f
KW
1781PERL_STATIC_INLINE void
1782S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
1783{
1784 PERL_ARGS_ASSERT_SSC_UNION;
1785
71068078 1786 assert(is_ANYOF_SYNTHETIC(ssc));
b423522f
KW
1787
1788 _invlist_union_maybe_complement_2nd(ssc->invlist,
1789 invlist,
1790 invert2nd,
1791 &ssc->invlist);
1792}
1793
1794PERL_STATIC_INLINE void
1795S_ssc_intersection(pTHX_ regnode_ssc *ssc,
1796 SV* const invlist,
1797 const bool invert2nd)
1798{
1799 PERL_ARGS_ASSERT_SSC_INTERSECTION;
1800
71068078 1801 assert(is_ANYOF_SYNTHETIC(ssc));
b423522f
KW
1802
1803 _invlist_intersection_maybe_complement_2nd(ssc->invlist,
1804 invlist,
1805 invert2nd,
1806 &ssc->invlist);
1807}
1808
1809PERL_STATIC_INLINE void
1810S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
1811{
1812 PERL_ARGS_ASSERT_SSC_ADD_RANGE;
1813
71068078 1814 assert(is_ANYOF_SYNTHETIC(ssc));
b423522f
KW
1815
1816 ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
1817}
1818
1819PERL_STATIC_INLINE void
1820S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
1821{
1822 /* AND just the single code point 'cp' into the SSC 'ssc' */
1823
1824 SV* cp_list = _new_invlist(2);
1825
1826 PERL_ARGS_ASSERT_SSC_CP_AND;
1827
71068078 1828 assert(is_ANYOF_SYNTHETIC(ssc));
b423522f
KW
1829
1830 cp_list = add_cp_to_invlist(cp_list, cp);
1831 ssc_intersection(ssc, cp_list,
1832 FALSE /* Not inverted */
1833 );
1834 SvREFCNT_dec_NN(cp_list);
1835}
1836
1837PERL_STATIC_INLINE void
dc3bf405 1838S_ssc_clear_locale(regnode_ssc *ssc)
b423522f
KW
1839{
1840 /* Set the SSC 'ssc' to not match any locale things */
b423522f
KW
1841 PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
1842
71068078 1843 assert(is_ANYOF_SYNTHETIC(ssc));
b423522f
KW
1844
1845 ANYOF_POSIXL_ZERO(ssc);
1846 ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
1847}
1848
b35552de
KW
1849#define NON_OTHER_COUNT NON_OTHER_COUNT_FOR_USE_ONLY_BY_REGCOMP_DOT_C
1850
1851STATIC bool
1852S_is_ssc_worth_it(const RExC_state_t * pRExC_state, const regnode_ssc * ssc)
1853{
1854 /* The synthetic start class is used to hopefully quickly winnow down
1855 * places where a pattern could start a match in the target string. If it
1856 * doesn't really narrow things down that much, there isn't much point to
1857 * having the overhead of using it. This function uses some very crude
1858 * heuristics to decide if to use the ssc or not.
1859 *
1860 * It returns TRUE if 'ssc' rules out more than half what it considers to
1861 * be the "likely" possible matches, but of course it doesn't know what the
1862 * actual things being matched are going to be; these are only guesses
1863 *
1864 * For /l matches, it assumes that the only likely matches are going to be
1865 * in the 0-255 range, uniformly distributed, so half of that is 127
1866 * For /a and /d matches, it assumes that the likely matches will be just
1867 * the ASCII range, so half of that is 63
1868 * For /u and there isn't anything matching above the Latin1 range, it
1869 * assumes that that is the only range likely to be matched, and uses
1870 * half that as the cut-off: 127. If anything matches above Latin1,
1871 * it assumes that all of Unicode could match (uniformly), except for
1872 * non-Unicode code points and things in the General Category "Other"
1873 * (unassigned, private use, surrogates, controls and formats). This
1874 * is a much large number. */
1875
b35552de
KW
1876 U32 count = 0; /* Running total of number of code points matched by
1877 'ssc' */
1878 UV start, end; /* Start and end points of current range in inversion
1879 list */
72400949
KW
1880 const U32 max_code_points = (LOC)
1881 ? 256
1882 : (( ! UNI_SEMANTICS
1883 || invlist_highest(ssc->invlist) < 256)
1884 ? 128
1885 : NON_OTHER_COUNT);
1886 const U32 max_match = max_code_points / 2;
b35552de
KW
1887
1888 PERL_ARGS_ASSERT_IS_SSC_WORTH_IT;
1889
1890 invlist_iterinit(ssc->invlist);
1891 while (invlist_iternext(ssc->invlist, &start, &end)) {
72400949
KW
1892 if (start >= max_code_points) {
1893 break;
b35552de 1894 }
72400949 1895 end = MIN(end, max_code_points - 1);
b35552de 1896 count += end - start + 1;
72400949 1897 if (count >= max_match) {
b35552de
KW
1898 invlist_iterfinish(ssc->invlist);
1899 return FALSE;
1900 }
1901 }
1902
1903 return TRUE;
1904}
1905
1906
b423522f
KW
1907STATIC void
1908S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
1909{
1910 /* The inversion list in the SSC is marked mortal; now we need a more
1911 * permanent copy, which is stored the same way that is done in a regular
dcb20b36
KW
1912 * ANYOF node, with the first NUM_ANYOF_CODE_POINTS code points in a bit
1913 * map */
b423522f
KW
1914
1915 SV* invlist = invlist_clone(ssc->invlist);
1916
1917 PERL_ARGS_ASSERT_SSC_FINALIZE;
1918
71068078 1919 assert(is_ANYOF_SYNTHETIC(ssc));
b423522f 1920
a0dd4231 1921 /* The code in this file assumes that all but these flags aren't relevant
93e92956
KW
1922 * to the SSC, except SSC_MATCHES_EMPTY_STRING, which should be cleared
1923 * by the time we reach here */
f240c685
KW
1924 assert(! (ANYOF_FLAGS(ssc)
1925 & ~( ANYOF_COMMON_FLAGS
108316fb
KW
1926 |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1927 |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)));
a0dd4231 1928
b423522f
KW
1929 populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
1930
1ee208c4
KW
1931 set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist,
1932 NULL, NULL, NULL, FALSE);
b423522f 1933
85c8e306
KW
1934 /* Make sure is clone-safe */
1935 ssc->invlist = NULL;
1936
e0e1be5f 1937 if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
93e92956 1938 ANYOF_FLAGS(ssc) |= ANYOF_MATCHES_POSIXL;
e0e1be5f 1939 }
1462525b 1940
b2e90ddf
KW
1941 if (RExC_contains_locale) {
1942 OP(ssc) = ANYOFL;
1943 }
1944
1462525b 1945 assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
b423522f
KW
1946}
1947
a3621e74
YO
1948#define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1949#define TRIE_LIST_CUR(state) ( TRIE_LIST_ITEM( state, 0 ).forid )
1950#define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
538e84ed
KW
1951#define TRIE_LIST_USED(idx) ( trie->states[state].trans.list \
1952 ? (TRIE_LIST_CUR( idx ) - 1) \
1953 : 0 )
a3621e74 1954
3dab1dad
YO
1955
1956#ifdef DEBUGGING
07be1b83 1957/*
2b8b4781
NC
1958 dump_trie(trie,widecharmap,revcharmap)
1959 dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1960 dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
3dab1dad
YO
1961
1962 These routines dump out a trie in a somewhat readable format.
07be1b83
YO
1963 The _interim_ variants are used for debugging the interim
1964 tables that are used to generate the final compressed
1965 representation which is what dump_trie expects.
1966
486ec47a 1967 Part of the reason for their existence is to provide a form
3dab1dad 1968 of documentation as to how the different representations function.
07be1b83
YO
1969
1970*/
3dab1dad
YO
1971
1972/*
3dab1dad
YO
1973 Dumps the final compressed table form of the trie to Perl_debug_log.
1974 Used for debugging make_trie().
1975*/
b9a59e08 1976
3dab1dad 1977STATIC void
2b8b4781
NC
1978S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1979 AV *revcharmap, U32 depth)
3dab1dad
YO
1980{
1981 U32 state;
ab3bbdeb 1982 SV *sv=sv_newmortal();
55eed653 1983 int colwidth= widecharmap ? 6 : 4;
2e64971a 1984 U16 word;
3dab1dad
YO
1985 GET_RE_DEBUG_FLAGS_DECL;
1986
7918f24d 1987 PERL_ARGS_ASSERT_DUMP_TRIE;
ab3bbdeb 1988
6ad9a8ab 1989 Perl_re_indentf( aTHX_ "Char : %-6s%-6s%-4s ",
1e37780e 1990 depth+1, "Match","Base","Ofs" );
3dab1dad
YO
1991
1992 for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
2b8b4781 1993 SV ** const tmp = av_fetch( revcharmap, state, 0);
3dab1dad 1994 if ( tmp ) {
6ad9a8ab 1995 Perl_re_printf( aTHX_ "%*s",
ab3bbdeb 1996 colwidth,
538e84ed 1997 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
ab3bbdeb
YO
1998 PL_colors[0], PL_colors[1],
1999 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
538e84ed
KW
2000 PERL_PV_ESCAPE_FIRSTCHAR
2001 )
ab3bbdeb 2002 );
3dab1dad
YO
2003 }
2004 }
1e37780e
YO
2005 Perl_re_printf( aTHX_ "\n");
2006 Perl_re_indentf( aTHX_ "State|-----------------------", depth+1);
3dab1dad
YO
2007
2008 for( state = 0 ; state < trie->uniquecharcount ; state++ )
6ad9a8ab
YO
2009 Perl_re_printf( aTHX_ "%.*s", colwidth, "--------");
2010 Perl_re_printf( aTHX_ "\n");
3dab1dad 2011
1e2e3d02 2012 for( state = 1 ; state < trie->statecount ; state++ ) {
be8e71aa 2013 const U32 base = trie->states[ state ].trans.base;
3dab1dad 2014
147e3846 2015 Perl_re_indentf( aTHX_ "#%4" UVXf "|", depth+1, (UV)state);
3dab1dad
YO
2016
2017 if ( trie->states[ state ].wordnum ) {
1e37780e 2018 Perl_re_printf( aTHX_ " W%4X", trie->states[ state ].wordnum );
3dab1dad 2019 } else {
6ad9a8ab 2020 Perl_re_printf( aTHX_ "%6s", "" );
3dab1dad
YO
2021 }
2022
147e3846 2023 Perl_re_printf( aTHX_ " @%4" UVXf " ", (UV)base );
3dab1dad
YO
2024
2025 if ( base ) {
2026 U32 ofs = 0;
2027
2028 while( ( base + ofs < trie->uniquecharcount ) ||
2029 ( base + ofs - trie->uniquecharcount < trie->lasttrans
538e84ed
KW
2030 && trie->trans[ base + ofs - trie->uniquecharcount ].check
2031 != state))
3dab1dad
YO
2032 ofs++;
2033
147e3846 2034 Perl_re_printf( aTHX_ "+%2" UVXf "[ ", (UV)ofs);
3dab1dad
YO
2035
2036 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
538e84ed
KW
2037 if ( ( base + ofs >= trie->uniquecharcount )
2038 && ( base + ofs - trie->uniquecharcount
2039 < trie->lasttrans )
2040 && trie->trans[ base + ofs
2041 - trie->uniquecharcount ].check == state )
3dab1dad 2042 {
147e3846 2043 Perl_re_printf( aTHX_ "%*" UVXf, colwidth,
1e37780e
YO
2044 (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next
2045 );
3dab1dad 2046 } else {
6ad9a8ab 2047 Perl_re_printf( aTHX_ "%*s",colwidth," ." );
3dab1dad
YO
2048 }
2049 }
2050
6ad9a8ab 2051 Perl_re_printf( aTHX_ "]");
3dab1dad
YO
2052
2053 }
6ad9a8ab 2054 Perl_re_printf( aTHX_ "\n" );
3dab1dad 2055 }
6ad9a8ab 2056 Perl_re_indentf( aTHX_ "word_info N:(prev,len)=",
cb41e5d6 2057 depth);
2e64971a 2058 for (word=1; word <= trie->wordcount; word++) {
6ad9a8ab 2059 Perl_re_printf( aTHX_ " %d:(%d,%d)",
2e64971a
DM
2060 (int)word, (int)(trie->wordinfo[word].prev),
2061 (int)(trie->wordinfo[word].len));
2062 }
6ad9a8ab 2063 Perl_re_printf( aTHX_ "\n" );
538e84ed 2064}
3dab1dad 2065/*
3dab1dad 2066 Dumps a fully constructed but uncompressed trie in list form.
538e84ed 2067 List tries normally only are used for construction when the number of
3dab1dad
YO
2068 possible chars (trie->uniquecharcount) is very high.
2069 Used for debugging make_trie().
2070*/
2071STATIC void
55eed653 2072S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
2b8b4781
NC
2073 HV *widecharmap, AV *revcharmap, U32 next_alloc,
2074 U32 depth)
3dab1dad
YO
2075{
2076 U32 state;
ab3bbdeb 2077 SV *sv=sv_newmortal();
55eed653 2078 int colwidth= widecharmap ? 6 : 4;
3dab1dad 2079 GET_RE_DEBUG_FLAGS_DECL;
7918f24d
NC
2080
2081 PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
2082
3dab1dad 2083 /* print out the table precompression. */
6ad9a8ab 2084 Perl_re_indentf( aTHX_ "State :Word | Transition Data\n",
cb41e5d6 2085 depth+1 );
6ad9a8ab 2086 Perl_re_indentf( aTHX_ "%s",
cb41e5d6 2087 depth+1, "------:-----+-----------------\n" );
538e84ed 2088
3dab1dad
YO
2089 for( state=1 ; state < next_alloc ; state ++ ) {
2090 U16 charid;
538e84ed 2091
147e3846 2092 Perl_re_indentf( aTHX_ " %4" UVXf " :",
cb41e5d6 2093 depth+1, (UV)state );
3dab1dad 2094 if ( ! trie->states[ state ].wordnum ) {
6ad9a8ab 2095 Perl_re_printf( aTHX_ "%5s| ","");
3dab1dad 2096 } else {
6ad9a8ab 2097 Perl_re_printf( aTHX_ "W%4x| ",
3dab1dad
YO
2098 trie->states[ state ].wordnum
2099 );
2100 }
2101 for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
538e84ed
KW
2102 SV ** const tmp = av_fetch( revcharmap,
2103 TRIE_LIST_ITEM(state,charid).forid, 0);
ab3bbdeb 2104 if ( tmp ) {
147e3846 2105 Perl_re_printf( aTHX_ "%*s:%3X=%4" UVXf " | ",
ab3bbdeb 2106 colwidth,
538e84ed
KW
2107 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
2108 colwidth,
2109 PL_colors[0], PL_colors[1],
2110 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
2111 | PERL_PV_ESCAPE_FIRSTCHAR
ab3bbdeb 2112 ) ,
1e2e3d02
YO
2113 TRIE_LIST_ITEM(state,charid).forid,
2114 (UV)TRIE_LIST_ITEM(state,charid).newstate
2115 );
538e84ed 2116 if (!(charid % 10))
6ad9a8ab 2117 Perl_re_printf( aTHX_ "\n%*s| ",
664e119d 2118 (int)((depth * 2) + 14), "");
1e2e3d02 2119 }
ab3bbdeb 2120 }
6ad9a8ab 2121 Perl_re_printf( aTHX_ "\n");
3dab1dad 2122 }
538e84ed 2123}
3dab1dad
YO
2124
2125/*
3dab1dad 2126 Dumps a fully constructed but uncompressed trie in table form.
538e84ed
KW
2127 This is the normal DFA style state transition table, with a few
2128 twists to facilitate compression later.
3dab1dad
YO
2129 Used for debugging make_trie().
2130*/
2131STATIC void
55eed653 2132S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
2b8b4781
NC
2133 HV *widecharmap, AV *revcharmap, U32 next_alloc,
2134 U32 depth)
3dab1dad
YO
2135{
2136 U32 state;
2137 U16 charid;
ab3bbdeb 2138 SV *sv=sv_newmortal();
55eed653 2139 int colwidth= widecharmap ? 6 : 4;
3dab1dad 2140 GET_RE_DEBUG_FLAGS_DECL;
7918f24d
NC
2141
2142 PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
538e84ed 2143
3dab1dad
YO
2144 /*
2145 print out the table precompression so that we can do a visual check
2146 that they are identical.
2147 */
538e84ed 2148
6ad9a8ab 2149 Perl_re_indentf( aTHX_ "Char : ", depth+1 );
3dab1dad
YO
2150
2151 for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2b8b4781 2152 SV ** const tmp = av_fetch( revcharmap, charid, 0);
3dab1dad 2153 if ( tmp ) {
6ad9a8ab 2154 Perl_re_printf( aTHX_ "%*s",
ab3bbdeb 2155 colwidth,
538e84ed 2156 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
ab3bbdeb
YO
2157 PL_colors[0], PL_colors[1],
2158 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
538e84ed
KW
2159 PERL_PV_ESCAPE_FIRSTCHAR
2160 )
ab3bbdeb 2161 );
3dab1dad
YO
2162 }
2163 }
2164
4aaafc03
YO
2165 Perl_re_printf( aTHX_ "\n");
2166 Perl_re_indentf( aTHX_ "State+-", depth+1 );
3dab1dad
YO
2167
2168 for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
6ad9a8ab 2169 Perl_re_printf( aTHX_ "%.*s", colwidth,"--------");
3dab1dad
YO
2170 }
2171
6ad9a8ab 2172 Perl_re_printf( aTHX_ "\n" );
3dab1dad
YO
2173
2174 for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
2175
147e3846 2176 Perl_re_indentf( aTHX_ "%4" UVXf " : ",
cb41e5d6 2177 depth+1,
3dab1dad
YO
2178 (UV)TRIE_NODENUM( state ) );
2179
2180 for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
ab3bbdeb
YO
2181 UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
2182 if (v)
147e3846 2183 Perl_re_printf( aTHX_ "%*" UVXf, colwidth, v );
ab3bbdeb 2184 else
6ad9a8ab 2185 Perl_re_printf( aTHX_ "%*s", colwidth, "." );
3dab1dad
YO
2186 }
2187 if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
147e3846 2188 Perl_re_printf( aTHX_ " (%4" UVXf ")\n",
538e84ed 2189 (UV)trie->trans[ state ].check );
3dab1dad 2190 } else {
147e3846 2191 Perl_re_printf( aTHX_ " (%4" UVXf ") W%4X\n",
538e84ed 2192 (UV)trie->trans[ state ].check,
3dab1dad
YO
2193 trie->states[ TRIE_NODENUM( state ) ].wordnum );
2194 }
2195 }
07be1b83 2196}
3dab1dad
YO
2197
2198#endif
2199
2e64971a 2200
786e8c11
YO
2201/* make_trie(startbranch,first,last,tail,word_count,flags,depth)
2202 startbranch: the first branch in the whole branch sequence
2203 first : start branch of sequence of branch-exact nodes.
2204 May be the same as startbranch
2205 last : Thing following the last branch.
2206 May be the same as tail.
2207 tail : item following the branch sequence
2208 count : words in the sequence
a4525e78 2209 flags : currently the OP() type we will be building one of /EXACT(|F|FA|FU|FU_SS|L|FLU8)/
786e8c11 2210 depth : indent depth
3dab1dad 2211
786e8c11 2212Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
07be1b83 2213
786e8c11
YO
2214A trie is an N'ary tree where the branches are determined by digital
2215decomposition of the key. IE, at the root node you look up the 1st character and
2216follow that branch repeat until you find the end of the branches. Nodes can be
2217marked as "accepting" meaning they represent a complete word. Eg:
07be1b83 2218
786e8c11 2219 /he|she|his|hers/
72f13be8 2220
786e8c11
YO
2221would convert into the following structure. Numbers represent states, letters
2222following numbers represent valid transitions on the letter from that state, if
2223the number is in square brackets it represents an accepting state, otherwise it
2224will be in parenthesis.
07be1b83 2225
786e8c11
YO
2226 +-h->+-e->[3]-+-r->(8)-+-s->[9]
2227 | |
2228 | (2)
2229 | |
2230 (1) +-i->(6)-+-s->[7]
2231 |
2232 +-s->(3)-+-h->(4)-+-e->[5]
07be1b83 2233
786e8c11
YO
2234 Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
2235
2236This shows that when matching against the string 'hers' we will begin at state 1
2237read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
2238then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
2239is also accepting. Thus we know that we can match both 'he' and 'hers' with a
2240single traverse. We store a mapping from accepting to state to which word was
2241matched, and then when we have multiple possibilities we try to complete the
b8fda935 2242rest of the regex in the order in which they occurred in the alternation.
786e8c11
YO
2243
2244The only prior NFA like behaviour that would be changed by the TRIE support is
2245the silent ignoring of duplicate alternations which are of the form:
2246
2247 / (DUPE|DUPE) X? (?{ ... }) Y /x
2248
4b714af6 2249Thus EVAL blocks following a trie may be called a different number of times with
786e8c11 2250and without the optimisation. With the optimisations dupes will be silently
486ec47a 2251ignored. This inconsistent behaviour of EVAL type nodes is well established as
786e8c11
YO
2252the following demonstrates:
2253
2254 'words'=~/(word|word|word)(?{ print $1 })[xyz]/
2255
2256which prints out 'word' three times, but
2257
2258 'words'=~/(word|word|word)(?{ print $1 })S/
2259
2260which doesnt print it out at all. This is due to other optimisations kicking in.
2261
2262Example of what happens on a structural level:
2263
486ec47a 2264The regexp /(ac|ad|ab)+/ will produce the following debug output:
786e8c11
YO
2265
2266 1: CURLYM[1] {1,32767}(18)
2267 5: BRANCH(8)
2268 6: EXACT <ac>(16)
2269 8: BRANCH(11)
2270 9: EXACT <ad>(16)
2271 11: BRANCH(14)
2272 12: EXACT <ab>(16)
2273 16: SUCCEED(0)
2274 17: NOTHING(18)
2275 18: END(0)
2276
2277This would be optimizable with startbranch=5, first=5, last=16, tail=16
2278and should turn into:
2279
2280 1: CURLYM[1] {1,32767}(18)
2281 5: TRIE(16)
2282 [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
2283 <ac>
2284 <ad>
2285 <ab>
2286 16: SUCCEED(0)
2287 17: NOTHING(18)
2288 18: END(0)
2289
2290Cases where tail != last would be like /(?foo|bar)baz/:
2291
2292 1: BRANCH(4)
2293 2: EXACT <foo>(8)
2294 4: BRANCH(7)
2295 5: EXACT <bar>(8)
2296 7: TAIL(8)
2297 8: EXACT <baz>(10)
2298 10: END(0)
2299
2300which would be optimizable with startbranch=1, first=1, last=7, tail=8
2301and would end up looking like:
2302
2303 1: TRIE(8)
2304 [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
2305 <foo>
2306 <bar>
2307 7: TAIL(8)
2308 8: EXACT <baz>(10)
2309 10: END(0)
2310
c80e42f3 2311 d = uvchr_to_utf8_flags(d, uv, 0);
786e8c11
YO
2312
2313is the recommended Unicode-aware way of saying
2314
2315 *(d++) = uv;
2316*/
2317
fab2782b 2318#define TRIE_STORE_REVCHAR(val) \
786e8c11 2319 STMT_START { \
73031816 2320 if (UTF) { \
668fcfea 2321 SV *zlopp = newSV(UTF8_MAXBYTES); \
88c9ea1e 2322 unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp); \
c80e42f3 2323 unsigned const char *const kapow = uvchr_to_utf8(flrbbbbb, val); \
73031816
NC
2324 SvCUR_set(zlopp, kapow - flrbbbbb); \
2325 SvPOK_on(zlopp); \
2326 SvUTF8_on(zlopp); \
2327 av_push(revcharmap, zlopp); \
2328 } else { \
fab2782b 2329 char ooooff = (char)val; \
73031816
NC
2330 av_push(revcharmap, newSVpvn(&ooooff, 1)); \
2331 } \
2332 } STMT_END
786e8c11 2333
914a25d5
KW
2334/* This gets the next character from the input, folding it if not already
2335 * folded. */
2336#define TRIE_READ_CHAR STMT_START { \
2337 wordlen++; \
2338 if ( UTF ) { \
2339 /* if it is UTF then it is either already folded, or does not need \
2340 * folding */ \
1c1d615a 2341 uvc = valid_utf8_to_uvchr( (const U8*) uc, &len); \
914a25d5
KW
2342 } \
2343 else if (folder == PL_fold_latin1) { \
7d006b13
KW
2344 /* This folder implies Unicode rules, which in the range expressible \
2345 * by not UTF is the lower case, with the two exceptions, one of \
2346 * which should have been taken care of before calling this */ \
2347 assert(*uc != LATIN_SMALL_LETTER_SHARP_S); \
2348 uvc = toLOWER_L1(*uc); \
2349 if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU; \
2350 len = 1; \
914a25d5
KW
2351 } else { \
2352 /* raw data, will be folded later if needed */ \
2353 uvc = (U32)*uc; \
2354 len = 1; \
2355 } \
786e8c11
YO
2356} STMT_END
2357
2358
2359
2360#define TRIE_LIST_PUSH(state,fid,ns) STMT_START { \
2361 if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) { \
f9003953
NC
2362 U32 ging = TRIE_LIST_LEN( state ) *= 2; \
2363 Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
786e8c11
YO
2364 } \
2365 TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid; \
2366 TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns; \
2367 TRIE_LIST_CUR( state )++; \
2368} STMT_END
07be1b83 2369
786e8c11
YO
2370#define TRIE_LIST_NEW(state) STMT_START { \
2371 Newxz( trie->states[ state ].trans.list, \
2372 4, reg_trie_trans_le ); \
2373 TRIE_LIST_CUR( state ) = 1; \
2374 TRIE_LIST_LEN( state ) = 4; \
2375} STMT_END
07be1b83 2376
786e8c11
YO
2377#define TRIE_HANDLE_WORD(state) STMT_START { \
2378 U16 dupe= trie->states[ state ].wordnum; \
2379 regnode * const noper_next = regnext( noper ); \
2380 \
786e8c11
YO
2381 DEBUG_r({ \
2382 /* store the word for dumping */ \
2383 SV* tmp; \
2384 if (OP(noper) != NOTHING) \
740cce10 2385 tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF); \
786e8c11 2386 else \
740cce10 2387 tmp = newSVpvn_utf8( "", 0, UTF ); \
2b8b4781 2388 av_push( trie_words, tmp ); \
786e8c11
YO
2389 }); \
2390 \
2391 curword++; \
2e64971a
DM
2392 trie->wordinfo[curword].prev = 0; \
2393 trie->wordinfo[curword].len = wordlen; \
2394 trie->wordinfo[curword].accept = state; \
786e8c11
YO
2395 \
2396 if ( noper_next < tail ) { \
2397 if (!trie->jump) \
538e84ed
KW
2398 trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
2399 sizeof(U16) ); \
7f69552c 2400 trie->jump[curword] = (U16)(noper_next - convert); \
786e8c11
YO
2401 if (!jumper) \
2402 jumper = noper_next; \
2403 if (!nextbranch) \
2404 nextbranch= regnext(cur); \
2405 } \
2406 \
2407 if ( dupe ) { \
2e64971a
DM
2408 /* It's a dupe. Pre-insert into the wordinfo[].prev */\
2409 /* chain, so that when the bits of chain are later */\
2410 /* linked together, the dups appear in the chain */\
2411 trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
2412 trie->wordinfo[dupe].prev = curword; \
786e8c11
YO
2413 } else { \
2414 /* we haven't inserted this word yet. */ \
2415 trie->states[ state ].wordnum = curword; \
2416 } \
2417} STMT_END
07be1b83 2418
3dab1dad 2419
786e8c11
YO
2420#define TRIE_TRANS_STATE(state,base,ucharcount,charid,special) \
2421 ( ( base + charid >= ucharcount \
2422 && base + charid < ubound \
2423 && state == trie->trans[ base - ucharcount + charid ].check \
2424 && trie->trans[ base - ucharcount + charid ].next ) \
2425 ? trie->trans[ base - ucharcount + charid ].next \
2426 : ( state==1 ? special : 0 ) \
2427 )
3dab1dad 2428
8bcafbf4
YO
2429#define TRIE_BITMAP_SET_FOLDED(trie, uvc, folder) \
2430STMT_START { \
2431 TRIE_BITMAP_SET(trie, uvc); \
2432 /* store the folded codepoint */ \
2433 if ( folder ) \
2434 TRIE_BITMAP_SET(trie, folder[(U8) uvc ]); \
2435 \
2436 if ( !UTF ) { \
2437 /* store first byte of utf8 representation of */ \
2438 /* variant codepoints */ \
2439 if (! UVCHR_IS_INVARIANT(uvc)) { \
2440 TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc)); \
2441 } \
2442 } \
2443} STMT_END
786e8c11
YO
2444#define MADE_TRIE 1
2445#define MADE_JUMP_TRIE 2
2446#define MADE_EXACT_TRIE 4
3dab1dad 2447
a3621e74 2448STATIC I32
538e84ed
KW
2449S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
2450 regnode *first, regnode *last, regnode *tail,
2451 U32 word_count, U32 flags, U32 depth)
a3621e74
YO
2452{
2453 /* first pass, loop through and scan words */
2454 reg_trie_data *trie;
55eed653 2455 HV *widecharmap = NULL;
2b8b4781 2456 AV *revcharmap = newAV();
a3621e74 2457 regnode *cur;
a3621e74
YO
2458 STRLEN len = 0;
2459 UV uvc = 0;
2460 U16 curword = 0;
2461 U32 next_alloc = 0;
786e8c11
YO
2462 regnode *jumper = NULL;
2463 regnode *nextbranch = NULL;
7f69552c 2464 regnode *convert = NULL;
2e64971a 2465 U32 *prev_states; /* temp array mapping each state to previous one */
a3621e74 2466 /* we just use folder as a flag in utf8 */
1e696034 2467 const U8 * folder = NULL;
a3621e74 2468
2b8b4781 2469#ifdef DEBUGGING
cf78de0b 2470 const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuuu"));
2b8b4781
NC
2471 AV *trie_words = NULL;
2472 /* along with revcharmap, this only used during construction but both are
2473 * useful during debugging so we store them in the struct when debugging.
8e11feef 2474 */
2b8b4781 2475#else
cf78de0b 2476 const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
3dab1dad 2477 STRLEN trie_charcount=0;
3dab1dad 2478#endif
2b8b4781 2479 SV *re_trie_maxbuff;
a3621e74 2480 GET_RE_DEBUG_FLAGS_DECL;
7918f24d
NC
2481
2482 PERL_ARGS_ASSERT_MAKE_TRIE;
72f13be8
YO
2483#ifndef DEBUGGING
2484 PERL_UNUSED_ARG(depth);
2485#endif
a3621e74 2486
1e696034 2487 switch (flags) {
a4525e78 2488 case EXACT: case EXACTL: break;
2f7f8cb1 2489 case EXACTFA:
fab2782b 2490 case EXACTFU_SS:
a4525e78
KW
2491 case EXACTFU:
2492 case EXACTFLU8: folder = PL_fold_latin1; break;
1e696034 2493 case EXACTF: folder = PL_fold; break;
fab2782b 2494 default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1e696034
KW
2495 }
2496
c944940b 2497 trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
a3621e74 2498 trie->refcount = 1;
3dab1dad 2499 trie->startstate = 1;
786e8c11 2500 trie->wordcount = word_count;
f8fc2ecf 2501 RExC_rxi->data->data[ data_slot ] = (void*)trie;
c944940b 2502 trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
a4525e78 2503 if (flags == EXACT || flags == EXACTL)
c944940b 2504 trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2e64971a
DM
2505 trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2506 trie->wordcount+1, sizeof(reg_trie_wordinfo));
2507
a3621e74 2508 DEBUG_r({
2b8b4781 2509 trie_words = newAV();
a3621e74 2510 });
a3621e74 2511
0111c4fd 2512 re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
316ebaf2 2513 assert(re_trie_maxbuff);
a3621e74 2514 if (!SvIOK(re_trie_maxbuff)) {
0111c4fd 2515 sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
a3621e74 2516 }
df826430 2517 DEBUG_TRIE_COMPILE_r({
6ad9a8ab 2518 Perl_re_indentf( aTHX_
cb41e5d6
YO
2519 "make_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2520 depth+1,
538e84ed
KW
2521 REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
2522 REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
3dab1dad 2523 });
538e84ed 2524
7f69552c
YO
2525 /* Find the node we are going to overwrite */
2526 if ( first == startbranch && OP( last ) != BRANCH ) {
2527 /* whole branch chain */
2528 convert = first;
2529 } else {
2530 /* branch sub-chain */
2531 convert = NEXTOPER( first );
2532 }
538e84ed 2533
a3621e74
YO
2534 /* -- First loop and Setup --
2535
2536 We first traverse the branches and scan each word to determine if it
2537 contains widechars, and how many unique chars there are, this is
2538 important as we have to build a table with at least as many columns as we
2539 have unique chars.
2540
2541 We use an array of integers to represent the character codes 0..255
538e84ed
KW
2542 (trie->charmap) and we use a an HV* to store Unicode characters. We use
2543 the native representation of the character value as the key and IV's for
2544 the coded index.
a3621e74
YO
2545
2546 *TODO* If we keep track of how many times each character is used we can
2547 remap the columns so that the table compression later on is more
3b753521 2548 efficient in terms of memory by ensuring the most common value is in the
a3621e74
YO
2549 middle and the least common are on the outside. IMO this would be better
2550 than a most to least common mapping as theres a decent chance the most
2551 common letter will share a node with the least common, meaning the node
486ec47a 2552 will not be compressible. With a middle is most common approach the worst
a3621e74
YO
2553 case is when we have the least common nodes twice.
2554
2555 */
2556
a3621e74 2557 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
df826430 2558 regnode *noper = NEXTOPER( cur );
944e05e3
YO
2559 const U8 *uc;
2560 const U8 *e;
bc031a7d 2561 int foldlen = 0;
07be1b83 2562 U32 wordlen = 0; /* required init */
bc031a7d
KW
2563 STRLEN minchars = 0;
2564 STRLEN maxchars = 0;
538e84ed
KW
2565 bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2566 bitmap?*/
a3621e74 2567
3dab1dad 2568 if (OP(noper) == NOTHING) {
20ed8c88
YO
2569 /* skip past a NOTHING at the start of an alternation
2570 * eg, /(?:)a|(?:b)/ should be the same as /a|b/
2571 */
df826430 2572 regnode *noper_next= regnext(noper);
944e05e3
YO
2573 if (noper_next < tail)
2574 noper= noper_next;
2575 }
2576
dca5fc4c
YO
2577 if ( noper < tail &&
2578 (
2579 OP(noper) == flags ||
2580 (
2581 flags == EXACTFU &&
2582 OP(noper) == EXACTFU_SS
2583 )
2584 )
2585 ) {
944e05e3
YO
2586 uc= (U8*)STRING(noper);
2587 e= uc + STR_LEN(noper);
2588 } else {
2589 trie->minlen= 0;
2590 continue;
3dab1dad 2591 }
df826430 2592
944e05e3 2593
fab2782b 2594 if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
02daf0ab
YO
2595 TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2596 regardless of encoding */
fab2782b
YO
2597 if (OP( noper ) == EXACTFU_SS) {
2598 /* false positives are ok, so just set this */
0dc4a61d 2599 TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
fab2782b
YO
2600 }
2601 }
dca5fc4c 2602
bc031a7d
KW
2603 for ( ; uc < e ; uc += len ) { /* Look at each char in the current
2604 branch */
3dab1dad 2605 TRIE_CHARCOUNT(trie)++;
a3621e74 2606 TRIE_READ_CHAR;
645de4ce 2607
bc031a7d
KW
2608 /* TRIE_READ_CHAR returns the current character, or its fold if /i
2609 * is in effect. Under /i, this character can match itself, or
2610 * anything that folds to it. If not under /i, it can match just
2611 * itself. Most folds are 1-1, for example k, K, and KELVIN SIGN
2612 * all fold to k, and all are single characters. But some folds
2613 * expand to more than one character, so for example LATIN SMALL
2614 * LIGATURE FFI folds to the three character sequence 'ffi'. If
2615 * the string beginning at 'uc' is 'ffi', it could be matched by
2616 * three characters, or just by the one ligature character. (It
2617 * could also be matched by two characters: LATIN SMALL LIGATURE FF
2618 * followed by 'i', or by 'f' followed by LATIN SMALL LIGATURE FI).
2619 * (Of course 'I' and/or 'F' instead of 'i' and 'f' can also
2620 * match.) The trie needs to know the minimum and maximum number
2621 * of characters that could match so that it can use size alone to
2622 * quickly reject many match attempts. The max is simple: it is
2623 * the number of folded characters in this branch (since a fold is
2624 * never shorter than what folds to it. */
2625
2626 maxchars++;
2627
2628 /* And the min is equal to the max if not under /i (indicated by
2629 * 'folder' being NULL), or there are no multi-character folds. If
2630 * there is a multi-character fold, the min is incremented just
2631 * once, for the character that folds to the sequence. Each
2632 * character in the sequence needs to be added to the list below of
2633 * characters in the trie, but we count only the first towards the
2634 * min number of characters needed. This is done through the
2635 * variable 'foldlen', which is returned by the macros that look
2636 * for these sequences as the number of bytes the sequence
2637 * occupies. Each time through the loop, we decrement 'foldlen' by
2638 * how many bytes the current char occupies. Only when it reaches
2639 * 0 do we increment 'minchars' or look for another multi-character
2640 * sequence. */
2641 if (folder == NULL) {
2642 minchars++;
2643 }
2644 else if (foldlen > 0) {
2645 foldlen -= (UTF) ? UTF8SKIP(uc) : 1;
645de4ce
KW
2646 }
2647 else {
bc031a7d
KW
2648 minchars++;
2649
2650 /* See if *uc is the beginning of a multi-character fold. If
2651 * so, we decrement the length remaining to look at, to account
2652 * for the current character this iteration. (We can use 'uc'
2653 * instead of the fold returned by TRIE_READ_CHAR because for
2654 * non-UTF, the latin1_safe macro is smart enough to account
2655 * for all the unfolded characters, and because for UTF, the
2656 * string will already have been folded earlier in the
2657 * compilation process */
2658 if (UTF) {
2659 if ((foldlen = is_MULTI_CHAR_FOLD_utf8_safe(uc, e))) {
2660 foldlen -= UTF8SKIP(uc);
645de4ce
KW
2661 }
2662 }
bc031a7d
KW
2663 else if ((foldlen = is_MULTI_CHAR_FOLD_latin1_safe(uc, e))) {
2664 foldlen--;
2665 }
645de4ce 2666 }
bc031a7d
KW
2667
2668 /* The current character (and any potential folds) should be added
2669 * to the possible matching characters for this position in this
2670 * branch */
a3621e74 2671 if ( uvc < 256 ) {
fab2782b
YO
2672 if ( folder ) {
2673 U8 folded= folder[ (U8) uvc ];
2674 if ( !trie->charmap[ folded ] ) {
2675 trie->charmap[ folded ]=( ++trie->uniquecharcount );
2676 TRIE_STORE_REVCHAR( folded );
2677 }
2678 }
a3621e74
YO
2679 if ( !trie->charmap[ uvc ] ) {
2680 trie->charmap[ uvc ]=( ++trie->uniquecharcount );
fab2782b 2681 TRIE_STORE_REVCHAR( uvc );
a3621e74 2682 }
02daf0ab 2683 if ( set_bit ) {
62012aee
KW
2684 /* store the codepoint in the bitmap, and its folded
2685 * equivalent. */
8bcafbf4 2686 TRIE_BITMAP_SET_FOLDED(trie, uvc, folder);
02daf0ab
YO
2687 set_bit = 0; /* We've done our bit :-) */
2688 }
a3621e74 2689 } else {
bc031a7d
KW
2690
2691 /* XXX We could come up with the list of code points that fold
2692 * to this using PL_utf8_foldclosures, except not for
2693 * multi-char folds, as there may be multiple combinations
2694 * there that could work, which needs to wait until runtime to
2695 * resolve (The comment about LIGATURE FFI above is such an
2696 * example */
2697
a3621e74 2698 SV** svpp;
55eed653
NC
2699 if ( !widecharmap )
2700 widecharmap = newHV();
a3621e74 2701
55eed653 2702 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
a3621e74
YO
2703
2704 if ( !svpp )
147e3846 2705 Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%" UVXf, uvc );
a3621e74
YO
2706
2707 if ( !SvTRUE( *svpp ) ) {
2708 sv_setiv( *svpp, ++trie->uniquecharcount );
fab2782b 2709 TRIE_STORE_REVCHAR(uvc);
a3621e74
YO
2710 }
2711 }
bc031a7d
KW
2712 } /* end loop through characters in this branch of the trie */
2713
2714 /* We take the min and max for this branch and combine to find the min
2715 * and max for all branches processed so far */
3dab1dad 2716 if( cur == first ) {
bc031a7d
KW
2717 trie->minlen = minchars;
2718 trie->maxlen = maxchars;
2719 } else if (minchars < trie->minlen) {
2720 trie->minlen = minchars;
2721 } else if (maxchars > trie->maxlen) {
2722 trie->maxlen = maxchars;
fab2782b 2723 }
a3621e74
YO
2724 } /* end first pass */
2725 DEBUG_TRIE_COMPILE_r(
6ad9a8ab 2726 Perl_re_indentf( aTHX_
cb41e5d6
YO
2727 "TRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
2728 depth+1,
55eed653 2729 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
be8e71aa
YO
2730 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
2731 (int)trie->minlen, (int)trie->maxlen )
a3621e74 2732 );
a3621e74
YO
2733
2734 /*
2735 We now know what we are dealing with in terms of unique chars and
2736 string sizes so we can calculate how much memory a naive
0111c4fd
RGS
2737 representation using a flat table will take. If it's over a reasonable
2738 limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
a3621e74
YO
2739 conservative but potentially much slower representation using an array
2740 of lists.
2741
2742 At the end we convert both representations into the same compressed
2743 form that will be used in regexec.c for matching with. The latter
2744 is a form that cannot be used to construct with but has memory
2745 properties similar to the list form and access properties similar
2746 to the table form making it both suitable for fast searches and
2747 small enough that its feasable to store for the duration of a program.
2748
2749 See the comment in the code where the compressed table is produced
2750 inplace from the flat tabe representation for an explanation of how
2751 the compression works.
2752
2753 */
2754
2755
2e64971a
DM
2756 Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
2757 prev_states[1] = 0;
2758
538e84ed
KW
2759 if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
2760 > SvIV(re_trie_maxbuff) )
2761 {
a3621e74
YO
2762 /*
2763 Second Pass -- Array Of Lists Representation
2764
2765 Each state will be represented by a list of charid:state records
2766 (reg_trie_trans_le) the first such element holds the CUR and LEN
2767 points of the allocated array. (See defines above).
2768
2769 We build the initial structure using the lists, and then convert
2770 it into the compressed table form which allows faster lookups
2771 (but cant be modified once converted).
a3621e74
YO
2772 */
2773
a3621e74
YO
2774 STRLEN transcount = 1;
2775
6ad9a8ab 2776 DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_ "Compiling trie using list compiler\n",
cb41e5d6 2777 depth+1));
686b73d4 2778
c944940b
JH
2779 trie->states = (reg_trie_state *)
2780 PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2781 sizeof(reg_trie_state) );
a3621e74
YO
2782 TRIE_LIST_NEW(1);
2783 next_alloc = 2;
2784
2785 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2786
df826430 2787 regnode *noper = NEXTOPER( cur );
c445ea15
AL
2788 U32 state = 1; /* required init */
2789 U16 charid = 0; /* sanity init */
07be1b83 2790 U32 wordlen = 0; /* required init */
c445ea15 2791
df826430
YO
2792 if (OP(noper) == NOTHING) {
2793 regnode *noper_next= regnext(noper);
944e05e3
YO
2794 if (noper_next < tail)
2795 noper= noper_next;
df826430
YO
2796 }
2797
944e05e3
YO
2798 if ( noper < tail && ( OP(noper) == flags || ( flags == EXACTFU && OP(noper) == EXACTFU_SS ) ) ) {
2799 const U8 *uc= (U8*)STRING(noper);
2800 const U8 *e= uc + STR_LEN(noper);
2801
786e8c11 2802 for ( ; uc < e ; uc += len ) {
c445ea15 2803
786e8c11 2804 TRIE_READ_CHAR;
c445ea15 2805
786e8c11
YO
2806 if ( uvc < 256 ) {
2807 charid = trie->charmap[ uvc ];
c445ea15 2808 } else {
538e84ed
KW
2809 SV** const svpp = hv_fetch( widecharmap,
2810 (char*)&uvc,
2811 sizeof( UV ),
2812 0);
786e8c11
YO
2813 if ( !svpp ) {
2814 charid = 0;
2815 } else {
2816 charid=(U16)SvIV( *svpp );
2817 }
c445ea15 2818 }
538e84ed
KW
2819 /* charid is now 0 if we dont know the char read, or
2820 * nonzero if we do */
786e8c11 2821 if ( charid ) {
a3621e74 2822
786e8c11
YO
2823 U16 check;
2824 U32 newstate = 0;
a3621e74 2825
786e8c11
YO
2826 charid--;
2827 if ( !trie->states[ state ].trans.list ) {
2828 TRIE_LIST_NEW( state );
c445ea15 2829 }
538e84ed
KW
2830 for ( check = 1;
2831 check <= TRIE_LIST_USED( state );
2832 check++ )
2833 {
2834 if ( TRIE_LIST_ITEM( state, check ).forid
2835 == charid )
2836 {
786e8c11
YO
2837 newstate = TRIE_LIST_ITEM( state, check ).newstate;
2838 break;
2839 }
2840 }
2841 if ( ! newstate ) {
2842 newstate = next_alloc++;
2e64971a 2843 prev_states[newstate] = state;
786e8c11
YO
2844 TRIE_LIST_PUSH( state, charid, newstate );
2845 transcount++;
2846 }
2847 state = newstate;
2848 } else {
147e3846 2849 Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
c445ea15 2850 }
a28509cc 2851 }
c445ea15 2852 }
3dab1dad 2853 TRIE_HANDLE_WORD(state);
a3621e74
YO
2854
2855 } /* end second pass */
2856
1e2e3d02 2857 /* next alloc is the NEXT state to be allocated */
538e84ed 2858 trie->statecount = next_alloc;
c944940b
JH
2859 trie->states = (reg_trie_state *)
2860 PerlMemShared_realloc( trie->states,
2861 next_alloc
2862 * sizeof(reg_trie_state) );
a3621e74 2863
3dab1dad 2864 /* and now dump it out before we compress it */
2b8b4781
NC
2865 DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
2866 revcharmap, next_alloc,
2867 depth+1)
1e2e3d02 2868 );
a3621e74 2869
c944940b
JH
2870 trie->trans = (reg_trie_trans *)
2871 PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
a3621e74
YO
2872 {
2873 U32 state;
a3621e74
YO
2874 U32 tp = 0;
2875 U32 zp = 0;
2876
2877
2878 for( state=1 ; state < next_alloc ; state ++ ) {
2879 U32 base=0;
2880
2881 /*
2882 DEBUG_TRIE_COMPILE_MORE_r(
6ad9a8ab 2883 Perl_re_printf( aTHX_ "tp: %d zp: %d ",tp,zp)
a3621e74
YO
2884 );
2885 */
2886
2887 if (trie->states[state].trans.list) {
2888 U16 minid=TRIE_LIST_ITEM( state, 1).forid;
2889 U16 maxid=minid;
a28509cc 2890 U16 idx;
a3621e74
YO
2891
2892 for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
c445ea15
AL
2893 const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
2894 if ( forid < minid ) {
2895 minid=forid;
2896 } else if ( forid > maxid ) {
2897 maxid=forid;
2898 }
a3621e74
YO
2899 }
2900 if ( transcount < tp + maxid - minid + 1) {
2901 transcount *= 2;
c944940b
JH
2902 trie->trans = (reg_trie_trans *)
2903 PerlMemShared_realloc( trie->trans,
446bd890
NC
2904 transcount
2905 * sizeof(reg_trie_trans) );
538e84ed
KW
2906 Zero( trie->trans + (transcount / 2),
2907 transcount / 2,
2908 reg_trie_trans );
a3621e74
YO
2909 }
2910 base = trie->uniquecharcount + tp - minid;
2911 if ( maxid == minid ) {
2912 U32 set = 0;
2913 for ( ; zp < tp ; zp++ ) {
2914 if ( ! trie->trans[ zp ].next ) {
2915 base = trie->uniquecharcount + zp - minid;
538e84ed
KW
2916 trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
2917 1).newstate;
a3621e74
YO
2918 trie->trans[ zp ].check = state;
2919 set = 1;
2920 break;
2921 }
2922 }
2923 if ( !set ) {
538e84ed
KW
2924 trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
2925 1).newstate;
a3621e74
YO
2926 trie->trans[ tp ].check = state;
2927 tp++;
2928 zp = tp;
2929 }
2930 } else {
2931 for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
538e84ed
KW
2932 const U32 tid = base
2933 - trie->uniquecharcount
2934 + TRIE_LIST_ITEM( state, idx ).forid;
2935 trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
2936 idx ).newstate;
a3621e74
YO
2937 trie->trans[ tid ].check = state;
2938 }
2939 tp += ( maxid - minid + 1 );
2940 }
2941 Safefree(trie->states[ state ].trans.list);
2942 }
2943 /*
2944 DEBUG_TRIE_COMPILE_MORE_r(
6ad9a8ab 2945 Perl_re_printf( aTHX_ " base: %d\n",base);
a3621e74
YO
2946 );
2947 */
2948 trie->states[ state ].trans.base=base;
2949 }
cc601c31 2950 trie->lasttrans = tp + 1;
a3621e74
YO
2951 }
2952 } else {
2953 /*
2954 Second Pass -- Flat Table Representation.
2955
b423522f
KW
2956 we dont use the 0 slot of either trans[] or states[] so we add 1 to
2957 each. We know that we will need Charcount+1 trans at most to store
2958 the data (one row per char at worst case) So we preallocate both
2959 structures assuming worst case.
a3621e74
YO
2960
2961 We then construct the trie using only the .next slots of the entry
2962 structs.
2963
b423522f
KW
2964 We use the .check field of the first entry of the node temporarily
2965 to make compression both faster and easier by keeping track of how
2966 many non zero fields are in the node.
a3621e74
YO
2967
2968 Since trans are numbered from 1 any 0 pointer in the table is a FAIL
2969 transition.
2970
b423522f
KW
2971 There are two terms at use here: state as a TRIE_NODEIDX() which is
2972 a number representing the first entry of the node, and state as a
2973 TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
2974 and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
2975 if there are 2 entrys per node. eg:
a3621e74
YO
2976
2977 A B A B
2978 1. 2 4 1. 3 7
2979 2. 0 3 3. 0 5
2980 3. 0 0 5. 0 0
2981 4. 0 0 7. 0 0
2982
b423522f
KW
2983 The table is internally in the right hand, idx form. However as we
2984 also have to deal with the states array which is indexed by nodenum
2985 we have to use TRIE_NODENUM() to convert.
a3621e74
YO
2986
2987 */
6ad9a8ab 2988 DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_ "Compiling trie using table compiler\n",
cb41e5d6 2989 depth+1));
3dab1dad 2990
c944940b
JH
2991 trie->trans = (reg_trie_trans *)
2992 PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2993 * trie->uniquecharcount + 1,
2994 sizeof(reg_trie_trans) );
2995 trie->states = (reg_trie_state *)
2996 PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2997 sizeof(reg_trie_state) );
a3621e74
YO
2998 next_alloc = trie->uniquecharcount + 1;
2999
3dab1dad 3000
a3621e74
YO
3001 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
3002
df826430 3003 regnode *noper = NEXTOPER( cur );
a3621e74
YO
3004
3005 U32 state = 1; /* required init */
3006
3007 U16 charid = 0; /* sanity init */
3008 U32 accept_state = 0; /* sanity init */
a3621e74 3009
07be1b83 3010 U32 wordlen = 0; /* required init */
a3621e74 3011
df826430
YO
3012 if (OP(noper) == NOTHING) {
3013 regnode *noper_next= regnext(noper);
944e05e3
YO
3014 if (noper_next < tail)
3015 noper= noper_next;
df826430 3016 }
fab2782b 3017
944e05e3
YO
3018 if ( noper < tail && ( OP(noper) == flags || ( flags == EXACTFU && OP(noper) == EXACTFU_SS ) ) ) {
3019 const U8 *uc= (U8*)STRING(noper);
3020 const U8 *e= uc + STR_LEN(noper);
3021
786e8c11 3022 for ( ; uc < e ; uc += len ) {
a3621e74 3023
786e8c11 3024 TRIE_READ_CHAR;
a3621e74 3025
786e8c11
YO
3026 if ( uvc < 256 ) {
3027 charid = trie->charmap[ uvc ];
3028 } else {
538e84ed
KW
3029 SV* const * const svpp = hv_fetch( widecharmap,
3030 (char*)&uvc,
3031 sizeof( UV ),
3032 0);
786e8c11 3033 charid = svpp ? (U16)SvIV(*svpp) : 0;
a3621e74 3034 }
786e8c11
YO
3035 if ( charid ) {
3036 charid--;
3037 if ( !trie->trans[ state + charid ].next ) {
3038 trie->trans[ state + charid ].next = next_alloc;
3039 trie->trans[ state ].check++;
2e64971a
DM
3040 prev_states[TRIE_NODENUM(next_alloc)]
3041 = TRIE_NODENUM(state);
786e8c11
YO
3042 next_alloc += trie->uniquecharcount;
3043 }
3044 state = trie->trans[ state + charid ].next;
3045 } else {
147e3846 3046 Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
786e8c11 3047 }
538e84ed
KW
3048 /* charid is now 0 if we dont know the char read, or
3049 * nonzero if we do */
a3621e74 3050 }
a3621e74 3051 }
3dab1dad
YO
3052 accept_state = TRIE_NODENUM( state );
3053 TRIE_HANDLE_WORD(accept_state);
a3621e74
YO
3054
3055 } /* end second pass */
3056
3dab1dad 3057 /* and now dump it out before we compress it */
2b8b4781
NC
3058 DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
3059 revcharmap,
3060 next_alloc, depth+1));
a3621e74 3061
a3621e74
YO
3062 {
3063 /*
3064 * Inplace compress the table.*
3065
3066 For sparse data sets the table constructed by the trie algorithm will
3067 be mostly 0/FAIL transitions or to put it another way mostly empty.
3068 (Note that leaf nodes will not contain any transitions.)
3069
3070 This algorithm compresses the tables by eliminating most such
3071 transitions, at the cost of a modest bit of extra work during lookup:
3072
3073 - Each states[] entry contains a .base field which indicates the
3074 index in the state[] array wheres its transition data is stored.
3075
3b753521 3076 - If .base is 0 there are no valid transitions from that node.
a3621e74
YO
3077
3078 - If .base is nonzero then charid is added to it to find an entry in
3079 the trans array.
3080
3081 -If trans[states[state].base+charid].check!=state then the
3082 transition is taken to be a 0/Fail transition. Thus if there are fail
3083 transitions at the front of the node then the .base offset will point
3084 somewhere inside the previous nodes data (or maybe even into a node
3085 even earlier), but the .check field determines if the transition is
3086 valid.
3087
786e8c11 3088 XXX - wrong maybe?
a3621e74 3089 The following process inplace converts the table to the compressed
3b753521 3090 table: We first do not compress the root node 1,and mark all its
a3621e74 3091 .check pointers as 1 and set its .base pointer as 1 as well. This
3b753521
FN
3092 allows us to do a DFA construction from the compressed table later,
3093 and ensures that any .base pointers we calculate later are greater
3094 than 0.
a3621e74
YO
3095
3096 - We set 'pos' to indicate the first entry of the second node.
3097
3098 - We then iterate over the columns of the node, finding the first and
3099 last used entry at l and m. We then copy l..m into pos..(pos+m-l),
3100 and set the .check pointers accordingly, and advance pos
3101 appropriately and repreat for the next node. Note that when we copy
3102 the next pointers we have to convert them from the original
3103 NODEIDX form to NODENUM form as the former is not valid post
3104 compression.
3105
3106 - If a node has no transitions used we mark its base as 0 and do not
3107 advance the pos pointer.
3108
3109 - If a node only has one transition we use a second pointer into the
3110 structure to fill in allocated fail transitions from other states.
3111 This pointer is independent of the main pointer and scans forward
3112 looking for null transitions that are allocated to a state. When it
3113 finds one it writes the single transition into the "hole". If the
786e8c11 3114 pointer doesnt find one the single transition is appended as normal.
a3621e74
YO
3115
3116 - Once compressed we can Renew/realloc the structures to release the
3117 excess space.
3118
3119 See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
3120 specifically Fig 3.47 and the associated pseudocode.
3121
3122 demq
3123 */
a3b680e6 3124 const U32 laststate = TRIE_NODENUM( next_alloc );
a28509cc 3125 U32 state, charid;
a3621e74 3126 U32 pos = 0, zp=0;
1e2e3d02 3127 trie->statecount = laststate;
a3621e74
YO
3128
3129 for ( state = 1 ; state < laststate ; state++ ) {
3130 U8 flag = 0;
a28509cc
AL
3131 const U32 stateidx = TRIE_NODEIDX( state );
3132 const U32 o_used = trie->trans[ stateidx ].check;
3133 U32 used = trie->trans[ stateidx ].check;
a3621e74
YO
3134 trie->trans[ stateidx ].check = 0;
3135
538e84ed
KW
3136 for ( charid = 0;
3137 used && charid < trie->uniquecharcount;
3138 charid++ )
3139 {
a3621e74
YO
3140 if ( flag || trie->trans[ stateidx + charid ].next ) {
3141 if ( trie->trans[ stateidx + charid ].next ) {
3142 if (o_used == 1) {
3143 for ( ; zp < pos ; zp++ ) {
3144 if ( ! trie->trans[ zp ].next ) {
3145 break;
3146 }
3147 }
538e84ed
KW
3148 trie->states[ state ].trans.base
3149 = zp
3150 + trie->uniquecharcount
3151 - charid ;
3152 trie->trans[ zp ].next
3153 = SAFE_TRIE_NODENUM( trie->trans[ stateidx
3154 + charid ].next );
a3621e74
YO
3155 trie->trans[ zp ].check = state;
3156 if ( ++zp > pos ) pos = zp;
3157 break;
3158 }
3159 used--;
3160 }
3161 if ( !flag ) {
3162 flag = 1;
538e84ed
KW
3163 trie->states[ state ].trans.base
3164 = pos + trie->uniquecharcount - charid ;
a3621e74 3165 }
538e84ed
KW
3166 trie->trans[ pos ].next
3167 = SAFE_TRIE_NODENUM(
3168 trie->trans[ stateidx + charid ].next );
a3621e74
YO
3169 trie->trans[ pos ].check = state;
3170 pos++;
3171 }
3172 }
3173 }
cc601c31 3174 trie->lasttrans = pos + 1;
c944940b
JH
3175 trie->states = (reg_trie_state *)
3176 PerlMemShared_realloc( trie->states, laststate
3177 * sizeof(reg_trie_state) );
a3621e74 3178 DEBUG_TRIE_COMPILE_MORE_r(
147e3846 3179 Perl_re_indentf( aTHX_ "Alloc: %d Orig: %" IVdf " elements, Final:%" IVdf ". Savings of %%%5.2f\n",
cb41e5d6 3180 depth+1,
538e84ed
KW
3181 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
3182 + 1 ),
3183 (IV)next_alloc,
3184 (IV)pos,
3185 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
a3621e74
YO
3186 );
3187
3188 } /* end table compress */
3189 }
1e2e3d02 3190 DEBUG_TRIE_COMPILE_MORE_r(
147e3846 3191 Perl_re_indentf( aTHX_ "Statecount:%" UVxf " Lasttrans:%" UVxf "\n",
cb41e5d6 3192 depth+1,
1e2e3d02
YO
3193 (UV)trie->statecount,
3194 (UV)trie->lasttrans)
3195 );
cc601c31 3196 /* resize the trans array to remove unused space */
c944940b
JH
3197 trie->trans = (reg_trie_trans *)
3198 PerlMemShared_realloc( trie->trans, trie->lasttrans
3199 * sizeof(reg_trie_trans) );
a3621e74 3200
538e84ed 3201 { /* Modify the program and insert the new TRIE node */
3dab1dad
YO
3202 U8 nodetype =(U8)(flags & 0xFF);
3203 char *str=NULL;
538e84ed 3204
07be1b83 3205#ifdef DEBUGGING
e62cc96a 3206 regnode *optimize = NULL;
7122b237
YO
3207#ifdef RE_TRACK_PATTERN_OFFSETS
3208
b57a0404
JH
3209 U32 mjd_offset = 0;
3210 U32 mjd_nodelen = 0;
7122b237
YO
3211#endif /* RE_TRACK_PATTERN_OFFSETS */
3212#endif /* DEBUGGING */
a3621e74 3213 /*
3dab1dad
YO
3214 This means we convert either the first branch or the first Exact,
3215 depending on whether the thing following (in 'last') is a branch
3216 or not and whther first is the startbranch (ie is it a sub part of
3217 the alternation or is it the whole thing.)
3b753521 3218 Assuming its a sub part we convert the EXACT otherwise we convert
3dab1dad 3219 the whole branch sequence, including the first.
a3621e74 3220 */
3dab1dad 3221 /* Find the node we are going to overwrite */
7f69552c 3222 if ( first != startbranch || OP( last ) == BRANCH ) {
07be1b83 3223 /* branch sub-chain */
3dab1dad 3224 NEXT_OFF( first ) = (U16)(last - first);
7122b237 3225#ifdef RE_TRACK_PATTERN_OFFSETS
07be1b83
YO
3226 DEBUG_r({
3227 mjd_offset= Node_Offset((convert));
3228 mjd_nodelen= Node_Length((convert));
3229 });
7122b237 3230#endif
7f69552c 3231 /* whole branch chain */
7122b237
YO
3232 }
3233#ifdef RE_TRACK_PATTERN_OFFSETS
3234 else {
7f69552c
YO
3235 DEBUG_r({
3236 const regnode *nop = NEXTOPER( convert );
3237 mjd_offset= Node_Offset((nop));
3238 mjd_nodelen= Node_Length((nop));
3239 });
07be1b83
YO
3240 }
3241 DEBUG_OPTIMISE_r(
147e3846 3242 Perl_re_indentf( aTHX_ "MJD offset:%" UVuf " MJD length:%" UVuf "\n",
cb41e5d6 3243 depth+1,
786e8c11 3244 (UV)mjd_offset, (UV)mjd_nodelen)
07be1b83 3245 );
7122b237 3246#endif
538e84ed 3247 /* But first we check to see if there is a common prefix we can
3dab1dad
YO
3248 split out as an EXACT and put in front of the TRIE node. */
3249 trie->startstate= 1;
55eed653 3250 if ( trie->bitmap && !widecharmap && !trie->jump ) {
5ee57374
YO
3251 /* we want to find the first state that has more than
3252 * one transition, if that state is not the first state
3253 * then we have a common prefix which we can remove.
3254 */
3dab1dad 3255 U32 state;
1e2e3d02 3256 for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
a3621e74 3257 U32 ofs = 0;
ee0dfd0b
YO
3258 I32 first_ofs = -1; /* keeps track of the ofs of the first
3259 transition, -1 means none */
8e11feef
RGS
3260 U32 count = 0;
3261 const U32 base = trie->states[ state ].trans.base;
a3621e74 3262
5ee57374 3263 /* does this state terminate an alternation? */
3dab1dad 3264 if ( trie->states[state].wordnum )
8e11feef 3265 count = 1;
a3621e74 3266
8e11feef 3267 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
cc601c31
YO
3268 if ( ( base + ofs >= trie->uniquecharcount ) &&
3269 ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
a3621e74
YO
3270 trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
3271 {
3dab1dad 3272 if ( ++count > 1 ) {
5ee57374 3273 /* we have more than one transition */
d3d91c7c
YO
3274 SV **tmp;
3275 U8 *ch;
5ee57374
YO
3276 /* if this is the first state there is no common prefix
3277 * to extract, so we can exit */
8e11feef 3278 if ( state == 1 ) break;
d3d91c7c
YO
3279 tmp = av_fetch( revcharmap, ofs, 0);
3280 ch = (U8*)SvPV_nolen_const( *tmp );
3281
5ee57374
YO
3282 /* if we are on count 2 then we need to initialize the
3283 * bitmap, and store the previous char if there was one
3284 * in it*/
3dab1dad 3285 if ( count == 2 ) {
5ee57374 3286 /* clear the bitmap */
3dab1dad
YO
3287 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
3288 DEBUG_OPTIMISE_r(
147e3846 3289 Perl_re_indentf( aTHX_ "New Start State=%" UVuf " Class: [",
cb41e5d6 3290 depth+1,
786e8c11 3291 (UV)state));
ee0dfd0b
YO
3292 if (first_ofs >= 0) {
3293 SV ** const tmp = av_fetch( revcharmap, first_ofs, 0);
be8e71aa 3294 const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
8e11feef 3295
8bcafbf4 3296 TRIE_BITMAP_SET_FOLDED(trie,*ch,folder);
3dab1dad 3297 DEBUG_OPTIMISE_r(
6ad9a8ab 3298 Perl_re_printf( aTHX_ "%s", (char*)ch)
3dab1dad 3299 );
8e11feef
RGS
3300 }
3301 }
8bcafbf4
YO
3302 /* store the current firstchar in the bitmap */
3303 TRIE_BITMAP_SET_FOLDED(trie,*ch,folder);
6ad9a8ab 3304 DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "%s", ch));
8e11feef 3305 }
ee0dfd0b 3306 first_ofs = ofs;
8e11feef 3307 }
3dab1dad
YO
3308 }
3309 if ( count == 1 ) {
5ee57374
YO
3310 /* This state has only one transition, its transition is part
3311 * of a common prefix - we need to concatenate the char it
3312 * represents to what we have so far. */
ee0dfd0b 3313 SV **tmp = av_fetch( revcharmap, first_ofs, 0);
c490c714
YO
3314 STRLEN len;
3315 char *ch = SvPV( *tmp, len );
de734bd5
A
3316 DEBUG_OPTIMISE_r({
3317 SV *sv=sv_newmortal();
147e3846 3318 Perl_re_indentf( aTHX_ "Prefix State: %" UVuf " Ofs:%" UVuf " Char='%s'\n",
cb41e5d6 3319 depth+1,
ee0dfd0b 3320 (UV)state, (UV)first_ofs,
538e84ed 3321 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
de734bd5
A
3322 PL_colors[0], PL_colors[1],
3323 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
538e84ed 3324 PERL_PV_ESCAPE_FIRSTCHAR
de734bd5
A
3325 )
3326 );
3327 });
3dab1dad
YO
3328 if ( state==1 ) {
3329 OP( convert ) = nodetype;
3330 str=STRING(convert);
3331 STR_LEN(convert)=0;
3332 }
c490c714
YO
3333 STR_LEN(convert) += len;
3334 while (len--)
de734bd5 3335 *str++ = *ch++;
8e11feef 3336 } else {
538e84ed 3337#ifdef DEBUGGING
8e11feef 3338 if (state>1)
6ad9a8ab 3339 DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "]\n"));
f9049ba1 3340#endif
8e11feef
RGS
3341 break;
3342 }
3343 }
2e64971a 3344 trie->prefixlen = (state-1);
3dab1dad 3345 if (str) {
8e11feef 3346 regnode *n = convert+NODE_SZ_STR(convert);
07be1b83 3347 NEXT_OFF(convert) = NODE_SZ_STR(convert);
8e11feef 3348 trie->startstate = state;
07be1b83
YO
3349 trie->minlen -= (state - 1);
3350 trie->maxlen -= (state - 1);
33809eae
JH
3351#ifdef DEBUGGING
3352 /* At least the UNICOS C compiler choked on this
3353 * being argument to DEBUG_r(), so let's just have
3354 * it right here. */
3355 if (
3356#ifdef PERL_EXT_RE_BUILD
3357 1
3358#else
3359 DEBUG_r_TEST
3360#endif
3361 ) {
3362 regnode *fix = convert;
3363 U32 word = trie->wordcount;
3364 mjd_nodelen++;
3365 Set_Node_Offset_Length(convert, mjd_offset, state - 1);
3366 while( ++fix < n ) {
3367 Set_Node_Offset_Length(fix, 0, 0);
3368 }
3369 while (word--) {
3370 SV ** const tmp = av_fetch( trie_words, word, 0 );
3371 if (tmp) {
3372 if ( STR_LEN(convert) <= SvCUR(*tmp) )
3373 sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
3374 else
3375 sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
3376 }
3377 }
3378 }
3379#endif
8e11feef
RGS
3380 if (trie->maxlen) {
3381 convert = n;
3382 } else {
3dab1dad 3383 NEXT_OFF(convert) = (U16)(tail - convert);
a5ca303d 3384 DEBUG_r(optimize= n);
3dab1dad
YO
3385 }
3386 }
3387 }
538e84ed
KW
3388 if (!jumper)
3389 jumper = last;
3dab1dad 3390 if ( trie->maxlen ) {
8e11feef
RGS
3391 NEXT_OFF( convert ) = (U16)(tail - convert);
3392 ARG_SET( convert, data_slot );
538e84ed
KW
3393 /* Store the offset to the first unabsorbed branch in
3394 jump[0], which is otherwise unused by the jump logic.
786e8c11 3395 We use this when dumping a trie and during optimisation. */
538e84ed 3396 if (trie->jump)
7f69552c 3397 trie->jump[0] = (U16)(nextbranch - convert);
538e84ed 3398
6c48061a
YO
3399 /* If the start state is not accepting (meaning there is no empty string/NOTHING)
3400 * and there is a bitmap
3401 * and the first "jump target" node we found leaves enough room
3402 * then convert the TRIE node into a TRIEC node, with the bitmap
3403 * embedded inline in the opcode - this is hypothetically faster.
3404 */
3405 if ( !trie->states[trie->startstate].wordnum
3406 && trie->bitmap
3407 && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
786e8c11
YO
3408 {
3409 OP( convert ) = TRIEC;
3410 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
446bd890 3411 PerlMemShared_free(trie->bitmap);
786e8c11 3412 trie->bitmap= NULL;
538e84ed 3413 } else
786e8c11 3414 OP( convert ) = TRIE;
a3621e74 3415
3dab1dad
YO
3416 /* store the type in the flags */
3417 convert->flags = nodetype;
a5ca303d 3418 DEBUG_r({
538e84ed
KW
3419 optimize = convert
3420 + NODE_STEP_REGNODE
a5ca303d
YO
3421 + regarglen[ OP( convert ) ];
3422 });
538e84ed 3423 /* XXX We really should free up the resource in trie now,
a5ca303d 3424 as we won't use them - (which resources?) dmq */
3dab1dad 3425 }
a3621e74 3426 /* needed for dumping*/
e62cc96a 3427 DEBUG_r(if (optimize) {
07be1b83 3428 regnode *opt = convert;
bcdf7404 3429
e62cc96a 3430 while ( ++opt < optimize) {
07be1b83
YO
3431 Set_Node_Offset_Length(opt,0,0);
3432 }
538e84ed
KW
3433 /*
3434 Try to clean up some of the debris left after the
786e8c11 3435 optimisation.
a3621e74 3436 */
786e8c11 3437 while( optimize < jumper ) {
07be1b83 3438 mjd_nodelen += Node_Length((optimize));
a3621e74 3439 OP( optimize ) = OPTIMIZED;
07be1b83 3440 Set_Node_Offset_Length(optimize,0,0);
a3621e74
YO
3441 optimize++;
3442 }
07be1b83 3443 Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
a3621e74
YO
3444 });
3445 } /* end node insert */
2e64971a
DM
3446
3447 /* Finish populating the prev field of the wordinfo array. Walk back
3448 * from each accept state until we find another accept state, and if
3449 * so, point the first word's .prev field at the second word. If the
3450 * second already has a .prev field set, stop now. This will be the
3451 * case either if we've already processed that word's accept state,
3b753521
FN
3452 * or that state had multiple words, and the overspill words were
3453 * already linked up earlier.
2e64971a
DM
3454 */
3455 {
3456 U16 word;
3457 U32 state;
3458 U16 prev;
3459
3460 for (word=1; word <= trie->wordcount; word++) {
3461 prev = 0;
3462 if (trie->wordinfo[word].prev)
3463 continue;
3464 state = trie->wordinfo[word].accept;
3465 while (state) {
3466 state = prev_states[state];
3467 if (!state)
3468 break;
3469 prev = trie->states[state].wordnum;
3470 if (prev)
3471 break;
3472 }
3473 trie->wordinfo[word].prev = prev;
3474 }
3475 Safefree(prev_states);