This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
rename RExC_opend RExC_end_op for clarity
[perl5.git] / regexp.h
CommitLineData
a0d0e21e 1/* regexp.h
d6376244 2 *
4bb101f2 3 * Copyright (C) 1993, 1994, 1996, 1997, 1999, 2000, 2001, 2003,
1129b882 4 * 2005, 2006, 2007, 2008 by Larry Wall and others
d6376244
JH
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 *
a0d0e21e
LW
9 */
10
378cc40b
LW
11/*
12 * Definitions etc. for regexp(3) routines.
13 *
14 * Caveat: this is V8 regexp(3) [actually, a reimplementation thereof],
15 * not the System V one.
16 */
be8e71aa 17#ifndef PLUGGABLE_RE_EXTENSION
785a26d5
YO
18/* we don't want to include this stuff if we are inside of
19 an external regex engine based on the core one - like re 'debug'*/
378cc40b 20
79a2a0e8
KW
21#include "utf8.h"
22
c277df42
IZ
23struct regnode {
24 U8 flags;
25 U8 type;
26 U16 next_off;
27};
28
29typedef struct regnode regnode;
30
cad2e5aa 31struct reg_substr_data;
2779dcf1 32
0ee3c8d0
JH
33struct reg_data;
34
f9f4320a 35struct regexp_engine;
28d8d7f4 36struct regexp;
bbe252da 37
785a26d5 38struct reg_substr_datum {
c4828ca0
DM
39 SSize_t min_offset; /* min pos (in chars) that substr must appear */
40 SSize_t max_offset /* max pos (in chars) that substr must appear */;
785a26d5
YO
41 SV *substr; /* non-utf8 variant */
42 SV *utf8_substr; /* utf8 variant */
c4828ca0 43 SSize_t end_shift; /* how many fixed chars must end the string */
785a26d5
YO
44};
45struct reg_substr_data {
6480a6c4 46 U8 check_ix; /* index into data[] of check substr */
785a26d5
YO
47 struct reg_substr_datum data[3]; /* Actual array */
48};
f9f4320a 49
db2c6cb3 50#ifdef PERL_ANY_COW
bbe252da
YO
51#define SV_SAVED_COPY SV *saved_copy; /* If non-NULL, SV which is COW from original */
52#else
53#define SV_SAVED_COPY
ed252734 54#endif
28d8d7f4 55
b3fd53f3
DM
56/* offsets within a string of a particular /(.)/ capture */
57
f0ab9afb 58typedef struct regexp_paren_pair {
99a90e59
FC
59 SSize_t start;
60 SSize_t end;
b3fd53f3
DM
61 /* 'start_tmp' records a new opening position before the matching end
62 * has been found, so that the old start and end values are still
63 * valid, e.g.
64 * "abc" =~ /(.(?{print "[$1]"}))+/
65 *outputs [][a][b]
66 * This field is not part of the API. */
ea3daa5d 67 SSize_t start_tmp;
f0ab9afb 68} regexp_paren_pair;
28d8d7f4 69
52ae8f7e 70#if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_UTF8_C)
164173a2 71#define _invlist_union(a, b, output) _invlist_union_maybe_complement_2nd(a, b, FALSE, output)
52ae8f7e 72#define _invlist_intersection(a, b, output) _invlist_intersection_maybe_complement_2nd(a, b, FALSE, output)
3f80b571
KW
73
74/* Subtracting b from a leaves in a everything that was there that isn't in b,
75 * that is the intersection of a with b's complement */
76#define _invlist_subtract(a, b, output) _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
52ae8f7e
KW
77#endif
78
3d2bd50a
DM
79/* record the position of a (?{...}) within a pattern */
80
81struct reg_code_block {
82 STRLEN start;
83 STRLEN end;
84 OP *block;
b30fcab9 85 REGEXP *src_regex;
3d2bd50a
DM
86};
87
88
882227b7
AB
89/*
90 The regexp/REGEXP struct, see L<perlreapi> for further documentation
91 on the individual fields. The struct is ordered so that the most
92 commonly used fields are placed at the start.
93
94 Any patch that adds items to this struct will need to include
95 changes to F<sv.c> (C<Perl_re_dup()>) and F<regcomp.c>
96 (C<pregfree()>). This involves freeing or cloning items in the
97 regexp's data array based on the data item's type.
98*/
99
08e44740
NC
100#define _REGEXP_COMMON \
101 /* what engine created this regexp? */ \
102 const struct regexp_engine* engine; \
103 REGEXP *mother_re; /* what re is this a lightweight copy of? */ \
89f6f287 104 HV *paren_names; /* Optional hash of paren names */ \
08e44740
NC
105 /* Information about the match that the perl core uses to */ \
106 /* manage things */ \
107 U32 extflags; /* Flags used both externally and internally */ \
ea3daa5d
FC
108 SSize_t minlen; /* mininum possible number of chars in string to match */\
109 SSize_t minlenret; /* mininum possible number of chars in $& */ \
110 STRLEN gofs; /* chars left of pos that we search from */ \
08e44740
NC
111 /* substring data about strings that must appear in the */ \
112 /* final match, used for optimisations */ \
113 struct reg_substr_data *substrs; \
114 U32 nparens; /* number of capture buffers */ \
115 /* private engine specific data */ \
116 U32 intflags; /* Engine Specific Internal flags */ \
117 void *pprivate; /* Data private to the regex engine which */ \
118 /* created this object. */ \
119 /* Data about the last/current match. These are modified */ \
120 /* during matching */ \
121 U32 lastparen; /* last open paren matched */ \
122 U32 lastcloseparen; /* last close paren matched */ \
08e44740
NC
123 /* Array of offsets for (@-) and (@+) */ \
124 regexp_paren_pair *offs; \
125 /* saved or original string so \digit works forever. */ \
126 char *subbeg; \
127 SV_SAVED_COPY /* If non-NULL, SV which is COW from original */\
19394178 128 SSize_t sublen; /* Length of string pointed by subbeg */ \
ea3daa5d
FC
129 SSize_t suboffset; /* byte offset of subbeg from logical start of str */ \
130 SSize_t subcoffset; /* suboffset equiv, but in chars (for @-/@+) */ \
08e44740 131 /* Information about the match that isn't often used */ \
ee273784 132 SSize_t maxlen; /* mininum possible number of chars in string to match */\
08e44740 133 /* offset from wrapped to the start of precomp */ \
654eccd5 134 PERL_BITFIELD32 pre_prefix:4; \
dbc200c5
YO
135 /* original flags used to compile the pattern, may differ */ \
136 /* from extflags in various ways */ \
137 PERL_BITFIELD32 compflags:9; \
b82ad30c 138 CV *qr_anoncv /* the anon sub wrapped round qr/(?{..})/ */
08e44740 139
bbe252da 140typedef struct regexp {
288b8c02 141 _XPV_HEAD;
08e44740 142 _REGEXP_COMMON;
f8fc2ecf
YO
143} regexp;
144
89f6f287 145#define RXp_PAREN_NAMES(rx) ((rx)->paren_names)
5daac39c 146
785a26d5 147/* used for high speed searches */
f9f4320a
YO
148typedef struct re_scream_pos_data_s
149{
150 char **scream_olds; /* match pos */
ea3daa5d 151 SSize_t *scream_pos; /* Internal iterator of scream. */
f9f4320a
YO
152} re_scream_pos_data;
153
785a26d5
YO
154/* regexp_engine structure. This is the dispatch table for regexes.
155 * Any regex engine implementation must be able to build one of these.
156 */
f9f4320a 157typedef struct regexp_engine {
1593ad57 158 REGEXP* (*comp) (pTHX_ SV * const pattern, U32 flags);
49d7dfbc 159 I32 (*exec) (pTHX_ REGEXP * const rx, char* stringarg, char* strend,
ea3daa5d 160 char* strbeg, SSize_t minend, SV* sv,
49d7dfbc 161 void* data, U32 flags);
52a21eb3
DM
162 char* (*intuit) (pTHX_
163 REGEXP * const rx,
164 SV *sv,
165 const char * const strbeg,
166 char *strpos,
167 char *strend,
168 const U32 flags,
9f61653a 169 re_scream_pos_data *data);
49d7dfbc 170 SV* (*checkstr) (pTHX_ REGEXP * const rx);
fc6bde6f 171 void (*rxfree) (pTHX_ REGEXP * const rx);
2fdbfb4d 172 void (*numbered_buff_FETCH) (pTHX_ REGEXP * const rx, const I32 paren,
192b9cd1 173 SV * const sv);
2fdbfb4d
AB
174 void (*numbered_buff_STORE) (pTHX_ REGEXP * const rx, const I32 paren,
175 SV const * const value);
176 I32 (*numbered_buff_LENGTH) (pTHX_ REGEXP * const rx, const SV * const sv,
177 const I32 paren);
192b9cd1
AB
178 SV* (*named_buff) (pTHX_ REGEXP * const rx, SV * const key,
179 SV * const value, const U32 flags);
180 SV* (*named_buff_iter) (pTHX_ REGEXP * const rx, const SV * const lastkey,
181 const U32 flags);
49d7dfbc 182 SV* (*qr_package)(pTHX_ REGEXP * const rx);
f2f78491 183#ifdef USE_ITHREADS
49d7dfbc 184 void* (*dupe) (pTHX_ REGEXP * const rx, CLONE_PARAMS *param);
2fdbfb4d 185#endif
3c13cae6
DM
186 REGEXP* (*op_comp) (pTHX_ SV ** const patternp, int pat_count,
187 OP *expr, const struct regexp_engine* eng,
7984ae89 188 REGEXP *old_re,
76ac488f 189 bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags);
f9f4320a
YO
190} regexp_engine;
191
192b9cd1
AB
192/*
193 These are passed to the numbered capture variable callbacks as the
194 paren name. >= 1 is reserved for actual numbered captures, i.e. $1,
195 $2 etc.
196*/
2c7b5d76
DM
197#define RX_BUFF_IDX_CARET_PREMATCH -5 /* ${^PREMATCH} */
198#define RX_BUFF_IDX_CARET_POSTMATCH -4 /* ${^POSTMATCH} */
199#define RX_BUFF_IDX_CARET_FULLMATCH -3 /* ${^MATCH} */
200#define RX_BUFF_IDX_PREMATCH -2 /* $` */
201#define RX_BUFF_IDX_POSTMATCH -1 /* $' */
202#define RX_BUFF_IDX_FULLMATCH 0 /* $& */
192b9cd1
AB
203
204/*
205 Flags that are passed to the named_buff and named_buff_iter
206 callbacks above. Those routines are called from universal.c via the
207 Tie::Hash::NamedCapture interface for %+ and %- and the re::
208 functions in the same file.
209*/
210
211/* The Tie::Hash::NamedCapture operation this is part of, if any */
f1b875a0
YO
212#define RXapif_FETCH 0x0001
213#define RXapif_STORE 0x0002
214#define RXapif_DELETE 0x0004
215#define RXapif_CLEAR 0x0008
216#define RXapif_EXISTS 0x0010
217#define RXapif_SCALAR 0x0020
218#define RXapif_FIRSTKEY 0x0040
219#define RXapif_NEXTKEY 0x0080
192b9cd1
AB
220
221/* Whether %+ or %- is being operated on */
f1b875a0
YO
222#define RXapif_ONE 0x0100 /* %+ */
223#define RXapif_ALL 0x0200 /* %- */
192b9cd1
AB
224
225/* Whether this is being called from a re:: function */
f1b875a0
YO
226#define RXapif_REGNAME 0x0400
227#define RXapif_REGNAMES 0x0800
7948fc08 228#define RXapif_REGNAMES_COUNT 0x1000
192b9cd1 229
f7e71195
AB
230/*
231=head1 REGEXP Functions
232
233=for apidoc Am|REGEXP *|SvRX|SV *sv
234
72d33970 235Convenience macro to get the REGEXP from a SV. This is approximately
f7e71195
AB
236equivalent to the following snippet:
237
238 if (SvMAGICAL(sv))
239 mg_get(sv);
1af910ea
DL
240 if (SvROK(sv))
241 sv = MUTABLE_SV(SvRV(sv));
242 if (SvTYPE(sv) == SVt_REGEXP)
243 return (REGEXP*) sv;
f7e71195 244
796b6530 245C<NULL> will be returned if a REGEXP* is not found.
f7e71195
AB
246
247=for apidoc Am|bool|SvRXOK|SV* sv
248
1af910ea
DL
249Returns a boolean indicating whether the SV (or the one it references)
250is a REGEXP.
f7e71195
AB
251
252If you want to do something with the REGEXP* later use SvRX instead
253and check for NULL.
254
255=cut
256*/
257
258#define SvRX(sv) (Perl_get_re_arg(aTHX_ sv))
259#define SvRXOK(sv) (Perl_get_re_arg(aTHX_ sv) ? TRUE : FALSE)
260
261
7948fc08 262/* Flags stored in regexp->extflags
bbe252da 263 * These are used by code external to the regexp engine
e357fc67 264 *
5b126c84
KW
265 * Note that the flags whose names start with RXf_PMf_ are defined in
266 * op_reg_common.h, being copied from the parallel flags of op_pmflags
cb5027f2 267 *
eb2624c9
FC
268 * NOTE: if you modify any RXf flags you should run regen.pl or
269 * regen/regcomp.pl so that regnodes.h is updated with the changes.
cb5027f2 270 *
bbe252da
YO
271 */
272
5b126c84
KW
273#include "op_reg_common.h"
274
41d7c59e 275#define RXf_PMf_STD_PMMOD (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_FOLD|RXf_PMf_EXTENDED|RXf_PMf_NOCAPTURE)
cde0cee5 276
cc4d09e1
KW
277#define CASE_STD_PMMOD_FLAGS_PARSE_SET(pmfl, x_count) \
278 case IGNORE_PAT_MOD: *(pmfl) |= RXf_PMf_FOLD; break; \
279 case MULTILINE_PAT_MOD: *(pmfl) |= RXf_PMf_MULTILINE; break; \
280 case SINGLE_PAT_MOD: *(pmfl) |= RXf_PMf_SINGLELINE; break; \
41d7c59e
MH
281 case XTENDED_PAT_MOD: *(pmfl) |= RXf_PMf_EXTENDED; (x_count)++; break;\
282 case NOCAPTURE_PAT_MOD: *(pmfl) |= RXf_PMf_NOCAPTURE; break;
cc4d09e1
KW
283
284#define STD_PMMOD_FLAGS_PARSE_X_WARN(x_count) \
285 if (UNLIKELY((x_count) > 1)) { \
286 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP), \
287 "Having more than one /%c regexp modifier is deprecated", \
288 XTENDED_PAT_MOD); \
289 }
bbe252da 290
94b03d7d 291/* Note, includes charset ones, assumes 0 is the default for them */
fb85c044 292#define STD_PMMOD_FLAGS_CLEAR(pmfl) \
41d7c59e 293 *(pmfl) &= ~(RXf_PMf_FOLD|RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_EXTENDED|RXf_PMf_CHARSET|RXf_PMf_NOCAPTURE)
fb85c044 294
bcdf7404 295/* chars and strings used as regex pattern modifiers
486ec47a 296 * Singular is a 'c'har, plural is a "string"
87e95b7f
YO
297 *
298 * NOTE, KEEPCOPY was originally 'k', but was changed to 'p' for preserve
299 * for compatibility reasons with Regexp::Common which highjacked (?k:...)
300 * for its own uses. So 'k' is out as well.
bcdf7404 301 */
85508812 302#define DEFAULT_PAT_MOD '^' /* Short for all the default modifiers */
bcdf7404 303#define EXEC_PAT_MOD 'e'
87e95b7f 304#define KEEPCOPY_PAT_MOD 'p'
41d7c59e 305#define NOCAPTURE_PAT_MOD 'n'
bcdf7404
YO
306#define ONCE_PAT_MOD 'o'
307#define GLOBAL_PAT_MOD 'g'
308#define CONTINUE_PAT_MOD 'c'
309#define MULTILINE_PAT_MOD 'm'
310#define SINGLE_PAT_MOD 's'
311#define IGNORE_PAT_MOD 'i'
312#define XTENDED_PAT_MOD 'x'
4f4d7508 313#define NONDESTRUCT_PAT_MOD 'r'
9de15fec
KW
314#define LOCALE_PAT_MOD 'l'
315#define UNICODE_PAT_MOD 'u'
50e91148 316#define DEPENDS_PAT_MOD 'd'
cfaf538b 317#define ASCII_RESTRICT_PAT_MOD 'a'
bcdf7404
YO
318
319#define ONCE_PAT_MODS "o"
87e95b7f 320#define KEEPCOPY_PAT_MODS "p"
41d7c59e 321#define NOCAPTURE_PAT_MODS "n"
bcdf7404
YO
322#define EXEC_PAT_MODS "e"
323#define LOOP_PAT_MODS "gc"
4f4d7508 324#define NONDESTRUCT_PAT_MODS "r"
9de15fec
KW
325#define LOCALE_PAT_MODS "l"
326#define UNICODE_PAT_MODS "u"
50e91148 327#define DEPENDS_PAT_MODS "d"
cfaf538b 328#define ASCII_RESTRICT_PAT_MODS "a"
df7a8460 329#define ASCII_MORE_RESTRICT_PAT_MODS "aa"
bcdf7404 330
78fecfc8 331/* This string is expected by regcomp.c to be ordered so that the first
c18d5d15
KW
332 * character is the flag in bit RXf_PMf_STD_PMMOD_SHIFT of extflags; the next
333 * character is bit +1, etc. */
41d7c59e 334#define STD_PAT_MODS "msixxn"
bcdf7404 335
94b03d7d
KW
336#define CHARSET_PAT_MODS ASCII_RESTRICT_PAT_MODS DEPENDS_PAT_MODS LOCALE_PAT_MODS UNICODE_PAT_MODS
337
78fecfc8 338/* This string is expected by XS_re_regexp_pattern() in universal.c to be ordered
c18d5d15
KW
339 * so that the first character is the flag in bit RXf_PMf_STD_PMMOD_SHIFT of
340 * extflags; the next character is in bit +1, etc. */
bcdf7404
YO
341#define INT_PAT_MODS STD_PAT_MODS KEEPCOPY_PAT_MODS
342
41d7c59e 343#define EXT_PAT_MODS ONCE_PAT_MODS KEEPCOPY_PAT_MODS NOCAPTURE_PAT_MODS
94b03d7d 344#define QR_PAT_MODS STD_PAT_MODS EXT_PAT_MODS CHARSET_PAT_MODS
bcdf7404 345#define M_PAT_MODS QR_PAT_MODS LOOP_PAT_MODS
4f4d7508 346#define S_PAT_MODS M_PAT_MODS EXEC_PAT_MODS NONDESTRUCT_PAT_MODS
bcdf7404 347
cb5027f2 348/*
eb2624c9
FC
349 * NOTE: if you modify any RXf flags you should run regen.pl or
350 * regen/regcomp.pl so that regnodes.h is updated with the changes.
cb5027f2
YO
351 *
352 */
bcdf7404 353
dbc200c5
YO
354/*
355 Set in Perl_pmruntime if op_flags & OPf_SPECIAL, i.e. split. Will
356 be used by regex engines to check whether they should set
357 RXf_SKIPWHITE
358*/
32f62247
KW
359#define RXf_SPLIT RXf_PMf_SPLIT
360
0bd51918
KW
361/* Currently the regex flags occupy a single 32-bit word. Not all bits are
362 * currently used. The lower bits are shared with their corresponding PMf flag
363 * bits, up to but not including _RXf_PMf_SHIFT_NEXT. The unused bits
364 * immediately follow; finally the used RXf-only (unshared) bits, so that the
365 * highest bit in the word is used. This gathers all the unused bits as a pool
366 * in the middle, like so: 11111111111111110000001111111111
367 * where the '1's represent used bits, and the '0's unused. This design allows
368 * us to allocate off one end of the pool if we need to add a shared bit, and
369 * off the other end if we need a non-shared bit, without disturbing the other
370 * bits. This maximizes the likelihood of being able to change things without
371 * breaking binary compatibility.
372 *
373 * To add shared bits, do so in op_reg_common.h. This should change
374 * _RXf_PMf_SHIFT_NEXT so that things won't compile. Then come to regexp.h and
375 * op.h and adjust the constant adders in the definitions of RXf_BASE_SHIFT and
376 * Pmf_BASE_SHIFT down by the number of shared bits you added. That's it.
377 * Things should be binary compatible. But if either of these gets to having
378 * to subtract rather than add, leave at 0 and instead adjust all the entries
379 * that are in terms of it. But if the first one of those is already
380 * RXf_BASE_SHIFT+0, there are no bits left, and a redesign is in order.
381 *
382 * To remove unshared bits, just delete its entry. If you're where breaking
383 * binary compatibility is ok to do, you might want to adjust things to move
384 * the newly opened space so that it gets absorbed into the common pool.
385 *
386 * To add unshared bits, first use up any gaps in the middle. Otherwise,
387 * allocate off the low end until you get to RXf_BASE_SHIFT+0. If that isn't
388 * enough, move RXf_BASE_SHIFT down (if possible) and add the new bit at the
389 * other end instead; this preserves binary compatibility.
390 *
391 * For the regexp bits, PL_reg_extflags_name[] in regnodes.h has a comment
392 * giving which bits are used/unused */
393
d262c0c7 394#define RXf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT + 2)
52d81aa8 395
bbe252da 396/* What we have seen */
9cba692b
KW
397#define RXf_NO_INPLACE_SUBST (1U<<(RXf_BASE_SHIFT+2))
398#define RXf_EVAL_SEEN (1U<<(RXf_BASE_SHIFT+3))
bbe252da
YO
399
400/* Special */
9cba692b
KW
401#define RXf_UNBOUNDED_QUANTIFIER_SEEN (1U<<(RXf_BASE_SHIFT+4))
402#define RXf_CHECK_ALL (1U<<(RXf_BASE_SHIFT+5))
bbe252da
YO
403
404/* UTF8 related */
9cba692b 405#define RXf_MATCH_UTF8 (1U<<(RXf_BASE_SHIFT+6)) /* $1 etc are utf8 */
bbe252da
YO
406
407/* Intuit related */
9cba692b
KW
408#define RXf_USE_INTUIT_NOML (1U<<(RXf_BASE_SHIFT+7))
409#define RXf_USE_INTUIT_ML (1U<<(RXf_BASE_SHIFT+8))
410#define RXf_INTUIT_TAIL (1U<<(RXf_BASE_SHIFT+9))
bbe252da
YO
411#define RXf_USE_INTUIT (RXf_USE_INTUIT_NOML|RXf_USE_INTUIT_ML)
412
a3b51d37 413/* Do we have some sort of anchor? */
9cba692b 414#define RXf_IS_ANCHORED (1U<<(RXf_BASE_SHIFT+10))
a3b51d37 415
bbe252da 416/* Copy and tainted info */
9cba692b 417#define RXf_COPY_DONE (1U<<(RXf_BASE_SHIFT+11))
ef07e810 418
1738e041 419/* post-execution: $1 et al are tainted */
9cba692b 420#define RXf_TAINTED_SEEN (1U<<(RXf_BASE_SHIFT+12))
ef07e810 421/* this pattern was tainted during compilation */
9cba692b 422#define RXf_TAINTED (1U<<(RXf_BASE_SHIFT+13))
52d81aa8
NC
423
424/* Flags indicating special patterns */
9cba692b
KW
425#define RXf_START_ONLY (1U<<(RXf_BASE_SHIFT+14)) /* Pattern is /^/ */
426#define RXf_SKIPWHITE (1U<<(RXf_BASE_SHIFT+15)) /* Pattern is for a */
427 /* split " " */
428#define RXf_WHITE (1U<<(RXf_BASE_SHIFT+16)) /* Pattern is /\s+/ */
3f6e6b29 429#define RXf_NULL (1U<<(RXf_BASE_SHIFT+17)) /* Pattern is // */
0bd51918
KW
430
431/* See comments at the beginning of these defines about adding bits. The
432 * highest bit position should be used, so that if RXf_BASE_SHIFT gets
433 * increased, the #error below will be triggered so that you will be reminded
434 * to adjust things at the other end to keep the bit positions unchanged */
3f6e6b29 435#if RXf_BASE_SHIFT+17 > 31
0bd51918 436# error Too many RXf_PMf bits used. See comments at beginning of these for what to do
1850c8f9 437#endif
c737faaf 438
cb5027f2 439/*
eb2624c9
FC
440 * NOTE: if you modify any RXf flags you should run regen.pl or
441 * regen/regcomp.pl so that regnodes.h is updated with the changes.
cb5027f2
YO
442 *
443 */
bbe252da 444
dc6d7f5c 445#ifdef NO_TAINT_SUPPORT
284167a5
SM
446# define RX_ISTAINTED(prog) 0
447# define RX_TAINT_on(prog) NOOP
272d35c9
DM
448# define RXp_MATCH_TAINTED(prog) 0
449# define RX_MATCH_TAINTED(prog) 0
450# define RXp_MATCH_TAINTED_on(prog) NOOP
451# define RX_MATCH_TAINTED_on(prog) NOOP
452# define RX_MATCH_TAINTED_off(prog) NOOP
284167a5
SM
453#else
454# define RX_ISTAINTED(prog) (RX_EXTFLAGS(prog) & RXf_TAINTED)
455# define RX_TAINT_on(prog) (RX_EXTFLAGS(prog) |= RXf_TAINTED)
272d35c9
DM
456# define RXp_MATCH_TAINTED(prog) (RXp_EXTFLAGS(prog) & RXf_TAINTED_SEEN)
457# define RX_MATCH_TAINTED(prog) (RX_EXTFLAGS(prog) & RXf_TAINTED_SEEN)
458# define RXp_MATCH_TAINTED_on(prog) (RXp_EXTFLAGS(prog) |= RXf_TAINTED_SEEN)
459# define RX_MATCH_TAINTED_on(prog) (RX_EXTFLAGS(prog) |= RXf_TAINTED_SEEN)
460# define RX_MATCH_TAINTED_off(prog) (RX_EXTFLAGS(prog) &= ~RXf_TAINTED_SEEN)
284167a5
SM
461#endif
462
bbe252da 463#define RX_HAS_CUTGROUP(prog) ((prog)->intflags & PREGf_CUTGROUP_SEEN)
72311751
GS
464#define RX_MATCH_TAINTED_set(prog, t) ((t) \
465 ? RX_MATCH_TAINTED_on(prog) \
466 : RX_MATCH_TAINTED_off(prog))
c277df42 467
07bc277f
NC
468#define RXp_MATCH_COPIED(prog) (RXp_EXTFLAGS(prog) & RXf_COPY_DONE)
469#define RX_MATCH_COPIED(prog) (RX_EXTFLAGS(prog) & RXf_COPY_DONE)
470#define RXp_MATCH_COPIED_on(prog) (RXp_EXTFLAGS(prog) |= RXf_COPY_DONE)
471#define RX_MATCH_COPIED_on(prog) (RX_EXTFLAGS(prog) |= RXf_COPY_DONE)
472#define RXp_MATCH_COPIED_off(prog) (RXp_EXTFLAGS(prog) &= ~RXf_COPY_DONE)
473#define RX_MATCH_COPIED_off(prog) (RX_EXTFLAGS(prog) &= ~RXf_COPY_DONE)
cf93c79d
IZ
474#define RX_MATCH_COPIED_set(prog,t) ((t) \
475 ? RX_MATCH_COPIED_on(prog) \
476 : RX_MATCH_COPIED_off(prog))
f9f4320a 477
07bc277f 478#define RXp_EXTFLAGS(rx) ((rx)->extflags)
dbc200c5 479#define RXp_COMPFLAGS(rx) ((rx)->compflags)
866c78d1 480
07bc277f 481/* For source compatibility. We used to store these explicitly. */
8d919b0a
FC
482#define RX_PRECOMP(prog) (RX_WRAPPED(prog) + ReANY(prog)->pre_prefix)
483#define RX_PRECOMP_const(prog) (RX_WRAPPED_const(prog) + ReANY(prog)->pre_prefix)
5509d87a
NC
484/* FIXME? Are we hardcoding too much here and constraining plugin extension
485 writers? Specifically, the value 1 assumes that the wrapped version always
486 has exactly one character at the end, a ')'. Will that always be true? */
8d919b0a
FC
487#define RX_PRELEN(prog) (RX_WRAPLEN(prog) - ReANY(prog)->pre_prefix - 1)
488#define RX_WRAPPED(prog) ReANY(prog)->xpv_len_u.xpvlenu_pv
489#define RX_WRAPPED_const(prog) ((const char *)RX_WRAPPED(prog))
9d17798d 490#define RX_WRAPLEN(prog) SvCUR(prog)
8d919b0a 491#define RX_CHECK_SUBSTR(prog) (ReANY(prog)->check_substr)
288b8c02 492#define RX_REFCNT(prog) SvREFCNT(prog)
8d919b0a 493#define RX_EXTFLAGS(prog) RXp_EXTFLAGS(ReANY(prog))
dbc200c5 494#define RX_COMPFLAGS(prog) RXp_COMPFLAGS(ReANY(prog))
8d919b0a
FC
495#define RX_ENGINE(prog) (ReANY(prog)->engine)
496#define RX_SUBBEG(prog) (ReANY(prog)->subbeg)
497#define RX_SUBOFFSET(prog) (ReANY(prog)->suboffset)
498#define RX_SUBCOFFSET(prog) (ReANY(prog)->subcoffset)
499#define RX_OFFS(prog) (ReANY(prog)->offs)
500#define RX_NPARENS(prog) (ReANY(prog)->nparens)
501#define RX_SUBLEN(prog) (ReANY(prog)->sublen)
502#define RX_MINLEN(prog) (ReANY(prog)->minlen)
503#define RX_MINLENRET(prog) (ReANY(prog)->minlenret)
504#define RX_GOFS(prog) (ReANY(prog)->gofs)
505#define RX_LASTPAREN(prog) (ReANY(prog)->lastparen)
506#define RX_LASTCLOSEPAREN(prog) (ReANY(prog)->lastcloseparen)
507#define RX_SAVED_COPY(prog) (ReANY(prog)->saved_copy)
03c83e26
DM
508/* last match was zero-length */
509#define RX_ZERO_LEN(prog) \
99a90e59
FC
510 (RX_OFFS(prog)[0].start + (SSize_t)RX_GOFS(prog) \
511 == RX_OFFS(prog)[0].end)
220fc49f 512
be8e71aa
YO
513#endif /* PLUGGABLE_RE_EXTENSION */
514
486ec47a 515/* Stuff that needs to be included in the pluggable extension goes below here */
be8e71aa 516
db2c6cb3 517#ifdef PERL_ANY_COW
ed252734 518#define RX_MATCH_COPY_FREE(rx) \
bdd9a1b1
NC
519 STMT_START {if (RX_SAVED_COPY(rx)) { \
520 SV_CHECK_THINKFIRST_COW_DROP(RX_SAVED_COPY(rx)); \
ed252734
NC
521 } \
522 if (RX_MATCH_COPIED(rx)) { \
07bc277f 523 Safefree(RX_SUBBEG(rx)); \
ed252734
NC
524 RX_MATCH_COPIED_off(rx); \
525 }} STMT_END
526#else
527#define RX_MATCH_COPY_FREE(rx) \
528 STMT_START {if (RX_MATCH_COPIED(rx)) { \
07bc277f 529 Safefree(RX_SUBBEG(rx)); \
ed252734
NC
530 RX_MATCH_COPIED_off(rx); \
531 }} STMT_END
532#endif
533
07bc277f
NC
534#define RXp_MATCH_UTF8(prog) (RXp_EXTFLAGS(prog) & RXf_MATCH_UTF8)
535#define RX_MATCH_UTF8(prog) (RX_EXTFLAGS(prog) & RXf_MATCH_UTF8)
536#define RX_MATCH_UTF8_on(prog) (RX_EXTFLAGS(prog) |= RXf_MATCH_UTF8)
537#define RX_MATCH_UTF8_off(prog) (RX_EXTFLAGS(prog) &= ~RXf_MATCH_UTF8)
a30b2f1f 538#define RX_MATCH_UTF8_set(prog, t) ((t) \
0603fe5c
DM
539 ? RX_MATCH_UTF8_on(prog) \
540 : RX_MATCH_UTF8_off(prog))
efd26800
NC
541
542/* Whether the pattern stored at RX_WRAPPED is in UTF-8 */
8f6ae13c 543#define RX_UTF8(prog) SvUTF8(prog)
7948fc08 544
a340edde
DM
545
546/* bits in flags arg of Perl_regexec_flags() */
547
548#define REXEC_COPY_STR 0x01 /* Need to copy the string for captures. */
549#define REXEC_CHECKED 0x02 /* re_intuit_start() already called. */
550#define REXEC_SCREAM 0x04 /* currently unused. */
551#define REXEC_IGNOREPOS 0x08 /* use stringarg, not pos(), for \G match */
552#define REXEC_NOT_FIRST 0x10 /* This is another iteration of //g:
553 no need to copy string again */
554
555 /* under REXEC_COPY_STR, it's ok for the
556 engine (modulo PL_sawamperand etc)
557 to skip copying: ... */
558#define REXEC_COPY_SKIP_PRE 0x20 /* ...the $` part of the string, or */
559#define REXEC_COPY_SKIP_POST 0x40 /* ...the $' part of the string */
d5e7783a
DM
560#define REXEC_FAIL_ON_UNDERFLOW 0x80 /* fail the match if $& would start before
561 the start pos (so s/.\G// would fail
562 on second iteration */
c277df42 563
7fe44985 564#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
288b8c02
NC
565# define ReREFCNT_inc(re) \
566 ({ \
567 /* This is here to generate a casting warning if incorrect. */ \
7948fc08
RU
568 REGEXP *const _rerefcnt_inc = (re); \
569 assert(SvTYPE(_rerefcnt_inc) == SVt_REGEXP); \
570 SvREFCNT_inc(_rerefcnt_inc); \
571 _rerefcnt_inc; \
288b8c02
NC
572 })
573# define ReREFCNT_dec(re) \
574 ({ \
575 /* This is here to generate a casting warning if incorrect. */ \
7948fc08
RU
576 REGEXP *const _rerefcnt_dec = (re); \
577 SvREFCNT_dec(_rerefcnt_dec); \
288b8c02
NC
578 })
579#else
580# define ReREFCNT_dec(re) SvREFCNT_dec(re)
b7e0bd9e 581# define ReREFCNT_inc(re) ((REGEXP *) SvREFCNT_inc(re))
288b8c02 582#endif
8d919b0a 583#define ReANY(re) S_ReANY((const REGEXP *)(re))
288b8c02
NC
584
585/* FIXME for plugins. */
cf93c79d
IZ
586
587#define FBMcf_TAIL_DOLLAR 1
cad2e5aa
JH
588#define FBMcf_TAIL_DOLLARM 2
589#define FBMcf_TAIL_Z 4
590#define FBMcf_TAIL_z 8
591#define FBMcf_TAIL (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)
cf93c79d
IZ
592
593#define FBMrf_MULTILINE 1
cad2e5aa 594
331b2dcc
DM
595struct regmatch_state;
596struct regmatch_slab;
8adc0f72 597
bf2039a9
DM
598/* like regmatch_info_aux, but contains extra fields only needed if the
599 * pattern contains (?{}). If used, is snuck into the second slot in the
600 * regmatch_state stack at the start of execution */
8adc0f72
DM
601
602typedef struct {
603 regexp *rex;
604 PMOP *curpm; /* saved PL_curpm */
605#ifdef PERL_ANY_COW
606 SV *saved_copy; /* saved saved_copy field from rex */
607#endif
608 char *subbeg; /* saved subbeg field from rex */
609 STRLEN sublen; /* saved sublen field from rex */
610 STRLEN suboffset; /* saved suboffset field from rex */
611 STRLEN subcoffset; /* saved subcoffset field from rex */
612 MAGIC *pos_magic; /* pos() magic attached to $_ */
ea3daa5d 613 SSize_t pos; /* the original value of pos() in pos_magic */
25fdce4a 614 U8 pos_flags; /* flags to be restored; currently only MGf_BYTES*/
bf2039a9
DM
615} regmatch_info_aux_eval;
616
617
618/* fields that logically live in regmatch_info, but which need cleaning
619 * up on croak(), and so are instead are snuck into the first slot in
620 * the regmatch_state stack at the start of execution */
621
622typedef struct {
623 regmatch_info_aux_eval *info_aux_eval;
331b2dcc
DM
624 struct regmatch_state *old_regmatch_state; /* saved PL_regmatch_state */
625 struct regmatch_slab *old_regmatch_slab; /* saved PL_regmatch_slab */
2ac8ff4b 626 char *poscache; /* S-L cache of fail positions of WHILEMs */
bf2039a9
DM
627} regmatch_info_aux;
628
8adc0f72 629
3b0527fe 630/* some basic information about the current match that is created by
bf2039a9
DM
631 * Perl_regexec_flags and then passed to regtry(), regmatch() etc.
632 * It is allocated as a local var on the stack, so nothing should be
633 * stored in it that needs preserving or clearing up on croak().
634 * For that, see the aux_info and aux_info_eval members of the
635 * regmatch_state union. */
3b0527fe
DM
636
637typedef struct {
28d03b21 638 REGEXP *prog; /* the regex being executed */
9d9163fb 639 const char * strbeg; /* real start of string */
28d03b21
DM
640 char *strend; /* one byte beyond last char of match string */
641 char *till; /* matches shorter than this fail (see minlen arg) */
642 SV *sv; /* the SV string currently being matched */
643 char *ganch; /* position of \G anchor */
644 char *cutpoint; /* (*COMMIT) position (if any) */
bf2039a9
DM
645 regmatch_info_aux *info_aux; /* extra fields that need cleanup */
646 regmatch_info_aux_eval *info_aux_eval; /* extra saved state for (?{}) */
1cb48e53
DM
647 I32 poscache_maxiter; /* how many whilems todo before S-L cache kicks in */
648 I32 poscache_iter; /* current countdown from _maxiter to zero */
2ac8ff4b 649 STRLEN poscache_size; /* size of regmatch_info_aux.poscache */
02d5137b 650 bool intuit; /* re_intuit_start() is the top-level caller */
ba44c216
DM
651 bool is_utf8_pat; /* regex is utf8 */
652 bool is_utf8_target; /* string being matched is utf8 */
39819bd9 653 bool warned; /* we have issued a recursion warning; no need for more */
3b0527fe
DM
654} regmatch_info;
655
5d9a96ca
DM
656
657/* structures for holding and saving the state maintained by regmatch() */
658
d56b3014 659#ifndef MAX_RECURSE_EVAL_NOCHANGE_DEPTH
4b196cd4 660#define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 1000
d56b3014 661#endif
6bda09f9 662
5d9a96ca
DM
663typedef I32 CHECKPOINT;
664
a0374537 665typedef struct regmatch_state {
40a82448 666 int resume_state; /* where to jump to on return */
24d3c4a9 667 char *locinput; /* where to backtrack in string on failure */
e822a8b4
DM
668
669 union {
77cb431f 670
bf2039a9
DM
671 /* the 'info_aux' and 'info_aux_eval' union members are cuckoos in
672 * the nest. They aren't saved backtrack state; rather they
673 * represent one or two extra chunks of data that need allocating
674 * at the start of a match. These fields would logically live in
675 * the regmatch_info struct, except that is allocated on the
676 * C stack, and these fields are all things that require cleanup
677 * after a croak(), when the stack is lost.
678 * As a convenience, we just use the first 1 or 2 regmatch_state
679 * slots to store this info, as we will be allocating a slab of
680 * these anyway. Otherwise we'd have to malloc and then free them,
681 * or allocate them on the save stack (where they will get
682 * realloced if the save stack grows).
683 * info_aux contains the extra fields that are always needed;
684 * info_aux_eval contains extra fields that only needed if
685 * the pattern contains code blocks
686 * We split them into two separate structs to avoid increasing
687 * the size of the union.
688 */
689
690 regmatch_info_aux info_aux;
691
692 regmatch_info_aux_eval info_aux_eval;
693
77cb431f
DM
694 /* this is a fake union member that matches the first element
695 * of each member that needs to store positive backtrack
696 * information */
697 struct {
698 struct regmatch_state *prev_yes_state;
699 } yes;
700
fae667d5
YO
701 /* branchlike members */
702 /* this is a fake union member that matches the first elements
703 * of each member that needs to behave like a branch */
704 struct {
5d458dd8
YO
705 /* this first element must match u.yes */
706 struct regmatch_state *prev_yes_state;
fae667d5 707 U32 lastparen;
f6033a9d 708 U32 lastcloseparen;
fae667d5
YO
709 CHECKPOINT cp;
710
711 } branchlike;
712
713 struct {
714 /* the first elements must match u.branchlike */
715 struct regmatch_state *prev_yes_state;
716 U32 lastparen;
f6033a9d 717 U32 lastcloseparen;
fae667d5
YO
718 CHECKPOINT cp;
719
720 regnode *next_branch; /* next branch node */
721 } branch;
722
723 struct {
724 /* the first elements must match u.branchlike */
725 struct regmatch_state *prev_yes_state;
726 U32 lastparen;
f6033a9d 727 U32 lastcloseparen;
fae667d5
YO
728 CHECKPOINT cp;
729
2e64971a 730 U32 accepted; /* how many accepting states left */
6603fe3e 731 bool longfold;/* saw a fold with a 1->n char mapping */
7f69552c 732 U16 *jump; /* positive offsets from me */
7f69552c 733 regnode *me; /* Which node am I - needed for jump tries*/
2e64971a
DM
734 U8 *firstpos;/* pos in string of first trie match */
735 U32 firstchars;/* len in chars of firstpos from start */
736 U16 nextword;/* next word to try */
737 U16 topword; /* longest accepted word */
e822a8b4
DM
738 } trie;
739
fae667d5
YO
740 /* special types - these members are used to store state for special
741 regops like eval, if/then, lookaround and the markpoint state */
e822a8b4 742 struct {
77cb431f
DM
743 /* this first element must match u.yes */
744 struct regmatch_state *prev_yes_state;
faec1544
DM
745 struct regmatch_state *prev_eval;
746 struct regmatch_state *prev_curlyx;
288b8c02 747 REGEXP *prev_rex;
aa283a38
DM
748 CHECKPOINT cp; /* remember current savestack indexes */
749 CHECKPOINT lastcp;
24be3102 750 U32 close_paren; /* which close bracket is our end (+1) */
1b5c067c 751 regnode *B; /* the node following us */
e822a8b4
DM
752 } eval;
753
754 struct {
c476f425 755 /* this first element must match u.yes */
262b90c4 756 struct regmatch_state *prev_yes_state;
fae667d5
YO
757 I32 wanted;
758 I32 logical; /* saved copy of 'logical' var */
759 regnode *me; /* the IFMATCH/SUSPEND/UNLESSM node */
760 } ifmatch; /* and SUSPEND/UNLESSM */
761
762 struct {
763 /* this first element must match u.yes */
764 struct regmatch_state *prev_yes_state;
765 struct regmatch_state *prev_mark;
766 SV* mark_name;
767 char *mark_loc;
768 } mark;
769
770 struct {
771 int val;
772 } keeper;
773
774 /* quantifiers - these members are used for storing state for
775 for the regops used to implement quantifiers */
776 struct {
777 /* this first element must match u.yes */
778 struct regmatch_state *prev_yes_state;
c476f425 779 struct regmatch_state *prev_curlyx; /* previous cur_curlyx */
d02d6d97
DM
780 regnode *me; /* the CURLYX node */
781 regnode *B; /* the B node in /A*B/ */
c476f425
DM
782 CHECKPOINT cp; /* remember current savestack index */
783 bool minmod;
a0374537 784 int parenfloor;/* how far back to strip paren data */
c476f425
DM
785
786 /* these two are modified by WHILEM */
787 int count; /* how many instances of A we've matched */
788 char *lastloc;/* where previous A matched (0-len detect) */
e822a8b4
DM
789 } curlyx;
790
791 struct {
c476f425 792 /* this first element must match u.yes */
262b90c4 793 struct regmatch_state *prev_yes_state;
c476f425
DM
794 struct regmatch_state *save_curlyx;
795 CHECKPOINT cp; /* remember current savestack indexes */
796 CHECKPOINT lastcp;
797 char *save_lastloc; /* previous curlyx.lastloc */
798 I32 cache_offset;
799 I32 cache_mask;
e822a8b4
DM
800 } whilem;
801
802 struct {
5d458dd8
YO
803 /* this first element must match u.yes */
804 struct regmatch_state *prev_yes_state;
79a2a0e8 805 int c1, c2; /* case fold search */
40a82448 806 CHECKPOINT cp;
f6033a9d
DM
807 U32 lastparen;
808 U32 lastcloseparen;
40a82448
DM
809 I32 alen; /* length of first-matched A string */
810 I32 count;
0cadcf80 811 bool minmod;
40a82448
DM
812 regnode *A, *B; /* the nodes corresponding to /A*B/ */
813 regnode *me; /* the curlym node */
79a2a0e8
KW
814 U8 c1_utf8[UTF8_MAXBYTES+1]; /* */
815 U8 c2_utf8[UTF8_MAXBYTES+1];
e822a8b4
DM
816 } curlym;
817
818 struct {
3b6647e0 819 U32 paren;
c255a977 820 CHECKPOINT cp;
f6033a9d
DM
821 U32 lastparen;
822 U32 lastcloseparen;
79a2a0e8 823 int c1, c2; /* case fold search */
c255a977
DM
824 char *maxpos; /* highest possible point in string to match */
825 char *oldloc; /* the previous locinput */
e822a8b4 826 int count;
c255a977
DM
827 int min, max; /* {m,n} */
828 regnode *A, *B; /* the nodes corresponding to /A*B/ */
79a2a0e8
KW
829 U8 c1_utf8[UTF8_MAXBYTES+1]; /* */
830 U8 c2_utf8[UTF8_MAXBYTES+1];
c255a977 831 } curly; /* and CURLYN/PLUS/STAR */
dad79028 832
d8319b27 833 } u;
5d9a96ca
DM
834} regmatch_state;
835
24be3102
YO
836#define EVAL_CLOSE_PAREN_IS(cur_eval,expr) \
837(\
838 ( ( cur_eval ) ) && \
839 ( ( cur_eval )->u.eval.close_paren ) && \
840 ( ( ( cur_eval )->u.eval.close_paren - 1 ) == ( expr ) ) \
841)
842
5d9a96ca
DM
843/* how many regmatch_state structs to allocate as a single slab.
844 * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
845 * pointers, plus 1 for any mythical malloc overhead. */
846
847#define PERL_REGMATCH_SLAB_SLOTS \
848 ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
849
850typedef struct regmatch_slab {
851 regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
852 struct regmatch_slab *prev, *next;
853} regmatch_slab;
1ade1aa1 854
46ab3289 855
cde0cee5 856
1ade1aa1 857/*
14d04a33 858 * ex: set ts=8 sts=4 sw=4 et:
1ade1aa1 859 */