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