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