This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pp_hot.c:pp_subst: add comment
[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
c277df42
IZ
21struct regnode {
22 U8 flags;
23 U8 type;
24 U16 next_off;
25};
26
27typedef struct regnode regnode;
28
cad2e5aa 29struct reg_substr_data;
2779dcf1 30
0ee3c8d0
JH
31struct reg_data;
32
f9f4320a 33struct regexp_engine;
28d8d7f4 34struct regexp;
bbe252da 35
785a26d5
YO
36struct reg_substr_datum {
37 I32 min_offset;
38 I32 max_offset;
39 SV *substr; /* non-utf8 variant */
40 SV *utf8_substr; /* utf8 variant */
41 I32 end_shift;
42};
43struct reg_substr_data {
44 struct reg_substr_datum data[3]; /* Actual array */
45};
f9f4320a 46
f8c7b90f 47#ifdef PERL_OLD_COPY_ON_WRITE
bbe252da
YO
48#define SV_SAVED_COPY SV *saved_copy; /* If non-NULL, SV which is COW from original */
49#else
50#define SV_SAVED_COPY
ed252734 51#endif
28d8d7f4 52
b3fd53f3
DM
53/* offsets within a string of a particular /(.)/ capture */
54
f0ab9afb
NC
55typedef struct regexp_paren_pair {
56 I32 start;
57 I32 end;
b3fd53f3
DM
58 /* 'start_tmp' records a new opening position before the matching end
59 * has been found, so that the old start and end values are still
60 * valid, e.g.
61 * "abc" =~ /(.(?{print "[$1]"}))+/
62 *outputs [][a][b]
63 * This field is not part of the API. */
1ca2007e 64 I32 start_tmp;
f0ab9afb 65} regexp_paren_pair;
28d8d7f4 66
52ae8f7e 67#if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_UTF8_C)
164173a2 68#define _invlist_union(a, b, output) _invlist_union_maybe_complement_2nd(a, b, FALSE, output)
52ae8f7e 69#define _invlist_intersection(a, b, output) _invlist_intersection_maybe_complement_2nd(a, b, FALSE, output)
3f80b571
KW
70
71/* Subtracting b from a leaves in a everything that was there that isn't in b,
72 * that is the intersection of a with b's complement */
73#define _invlist_subtract(a, b, output) _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
52ae8f7e
KW
74#endif
75
3d2bd50a
DM
76/* record the position of a (?{...}) within a pattern */
77
78struct reg_code_block {
79 STRLEN start;
80 STRLEN end;
81 OP *block;
b30fcab9 82 REGEXP *src_regex;
3d2bd50a
DM
83};
84
85
882227b7
AB
86/*
87 The regexp/REGEXP struct, see L<perlreapi> for further documentation
88 on the individual fields. The struct is ordered so that the most
89 commonly used fields are placed at the start.
90
91 Any patch that adds items to this struct will need to include
92 changes to F<sv.c> (C<Perl_re_dup()>) and F<regcomp.c>
93 (C<pregfree()>). This involves freeing or cloning items in the
94 regexp's data array based on the data item's type.
95*/
96
08e44740
NC
97#define _REGEXP_COMMON \
98 /* what engine created this regexp? */ \
99 const struct regexp_engine* engine; \
100 REGEXP *mother_re; /* what re is this a lightweight copy of? */ \
89f6f287 101 HV *paren_names; /* Optional hash of paren names */ \
08e44740
NC
102 /* Information about the match that the perl core uses to */ \
103 /* manage things */ \
104 U32 extflags; /* Flags used both externally and internally */ \
105 I32 minlen; /* mininum possible length of string to match */\
106 I32 minlenret; /* mininum possible length of $& */ \
107 U32 gofs; /* chars left of pos that we search from */ \
108 /* substring data about strings that must appear in the */ \
109 /* final match, used for optimisations */ \
110 struct reg_substr_data *substrs; \
111 U32 nparens; /* number of capture buffers */ \
112 /* private engine specific data */ \
113 U32 intflags; /* Engine Specific Internal flags */ \
114 void *pprivate; /* Data private to the regex engine which */ \
115 /* created this object. */ \
116 /* Data about the last/current match. These are modified */ \
117 /* during matching */ \
118 U32 lastparen; /* last open paren matched */ \
119 U32 lastcloseparen; /* last close paren matched */ \
e9105d30 120 regexp_paren_pair *swap; /* Unused: 5.10.1 and later */ \
08e44740
NC
121 /* Array of offsets for (@-) and (@+) */ \
122 regexp_paren_pair *offs; \
123 /* saved or original string so \digit works forever. */ \
124 char *subbeg; \
125 SV_SAVED_COPY /* If non-NULL, SV which is COW from original */\
126 I32 sublen; /* Length of string pointed by subbeg */ \
6502e081
DM
127 I32 suboffset; /* byte offset of subbeg from logical start of str */ \
128 I32 subcoffset; /* suboffset equiv, but in chars (for @-/@+) */ \
08e44740
NC
129 /* Information about the match that isn't often used */ \
130 /* offset from wrapped to the start of precomp */ \
654eccd5 131 PERL_BITFIELD32 pre_prefix:4; \
b82ad30c 132 CV *qr_anoncv /* the anon sub wrapped round qr/(?{..})/ */
08e44740 133
bbe252da 134typedef struct regexp {
288b8c02 135 _XPV_HEAD;
08e44740 136 _REGEXP_COMMON;
f8fc2ecf
YO
137} regexp;
138
89f6f287 139#define RXp_PAREN_NAMES(rx) ((rx)->paren_names)
5daac39c 140
785a26d5 141/* used for high speed searches */
f9f4320a
YO
142typedef struct re_scream_pos_data_s
143{
144 char **scream_olds; /* match pos */
145 I32 *scream_pos; /* Internal iterator of scream. */
146} re_scream_pos_data;
147
785a26d5
YO
148/* regexp_engine structure. This is the dispatch table for regexes.
149 * Any regex engine implementation must be able to build one of these.
150 */
f9f4320a 151typedef struct regexp_engine {
1593ad57 152 REGEXP* (*comp) (pTHX_ SV * const pattern, U32 flags);
49d7dfbc
AB
153 I32 (*exec) (pTHX_ REGEXP * const rx, char* stringarg, char* strend,
154 char* strbeg, I32 minend, SV* screamer,
155 void* data, U32 flags);
156 char* (*intuit) (pTHX_ REGEXP * const rx, SV *sv, char *strpos,
9f61653a
YO
157 char *strend, const U32 flags,
158 re_scream_pos_data *data);
49d7dfbc
AB
159 SV* (*checkstr) (pTHX_ REGEXP * const rx);
160 void (*free) (pTHX_ REGEXP * const rx);
2fdbfb4d 161 void (*numbered_buff_FETCH) (pTHX_ REGEXP * const rx, const I32 paren,
192b9cd1 162 SV * const sv);
2fdbfb4d
AB
163 void (*numbered_buff_STORE) (pTHX_ REGEXP * const rx, const I32 paren,
164 SV const * const value);
165 I32 (*numbered_buff_LENGTH) (pTHX_ REGEXP * const rx, const SV * const sv,
166 const I32 paren);
192b9cd1
AB
167 SV* (*named_buff) (pTHX_ REGEXP * const rx, SV * const key,
168 SV * const value, const U32 flags);
169 SV* (*named_buff_iter) (pTHX_ REGEXP * const rx, const SV * const lastkey,
170 const U32 flags);
49d7dfbc 171 SV* (*qr_package)(pTHX_ REGEXP * const rx);
f2f78491 172#ifdef USE_ITHREADS
49d7dfbc 173 void* (*dupe) (pTHX_ REGEXP * const rx, CLONE_PARAMS *param);
2fdbfb4d 174#endif
3c13cae6
DM
175 REGEXP* (*op_comp) (pTHX_ SV ** const patternp, int pat_count,
176 OP *expr, const struct regexp_engine* eng,
177 REGEXP *VOL old_re,
76ac488f 178 bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags);
f9f4320a
YO
179} regexp_engine;
180
192b9cd1
AB
181/*
182 These are passed to the numbered capture variable callbacks as the
183 paren name. >= 1 is reserved for actual numbered captures, i.e. $1,
184 $2 etc.
185*/
2c7b5d76
DM
186#define RX_BUFF_IDX_CARET_PREMATCH -5 /* ${^PREMATCH} */
187#define RX_BUFF_IDX_CARET_POSTMATCH -4 /* ${^POSTMATCH} */
188#define RX_BUFF_IDX_CARET_FULLMATCH -3 /* ${^MATCH} */
189#define RX_BUFF_IDX_PREMATCH -2 /* $` */
190#define RX_BUFF_IDX_POSTMATCH -1 /* $' */
191#define RX_BUFF_IDX_FULLMATCH 0 /* $& */
192b9cd1
AB
192
193/*
194 Flags that are passed to the named_buff and named_buff_iter
195 callbacks above. Those routines are called from universal.c via the
196 Tie::Hash::NamedCapture interface for %+ and %- and the re::
197 functions in the same file.
198*/
199
200/* The Tie::Hash::NamedCapture operation this is part of, if any */
f1b875a0
YO
201#define RXapif_FETCH 0x0001
202#define RXapif_STORE 0x0002
203#define RXapif_DELETE 0x0004
204#define RXapif_CLEAR 0x0008
205#define RXapif_EXISTS 0x0010
206#define RXapif_SCALAR 0x0020
207#define RXapif_FIRSTKEY 0x0040
208#define RXapif_NEXTKEY 0x0080
192b9cd1
AB
209
210/* Whether %+ or %- is being operated on */
f1b875a0
YO
211#define RXapif_ONE 0x0100 /* %+ */
212#define RXapif_ALL 0x0200 /* %- */
192b9cd1
AB
213
214/* Whether this is being called from a re:: function */
f1b875a0
YO
215#define RXapif_REGNAME 0x0400
216#define RXapif_REGNAMES 0x0800
7948fc08 217#define RXapif_REGNAMES_COUNT 0x1000
192b9cd1 218
f7e71195
AB
219/*
220=head1 REGEXP Functions
221
222=for apidoc Am|REGEXP *|SvRX|SV *sv
223
224Convenience macro to get the REGEXP from a SV. This is approximately
225equivalent to the following snippet:
226
227 if (SvMAGICAL(sv))
228 mg_get(sv);
1af910ea
DL
229 if (SvROK(sv))
230 sv = MUTABLE_SV(SvRV(sv));
231 if (SvTYPE(sv) == SVt_REGEXP)
232 return (REGEXP*) sv;
f7e71195
AB
233
234NULL will be returned if a REGEXP* is not found.
235
236=for apidoc Am|bool|SvRXOK|SV* sv
237
1af910ea
DL
238Returns a boolean indicating whether the SV (or the one it references)
239is a REGEXP.
f7e71195
AB
240
241If you want to do something with the REGEXP* later use SvRX instead
242and check for NULL.
243
244=cut
245*/
246
247#define SvRX(sv) (Perl_get_re_arg(aTHX_ sv))
248#define SvRXOK(sv) (Perl_get_re_arg(aTHX_ sv) ? TRUE : FALSE)
249
250
7948fc08 251/* Flags stored in regexp->extflags
bbe252da 252 * These are used by code external to the regexp engine
e357fc67 253 *
5b126c84
KW
254 * Note that the flags whose names start with RXf_PMf_ are defined in
255 * op_reg_common.h, being copied from the parallel flags of op_pmflags
cb5027f2 256 *
eb2624c9
FC
257 * NOTE: if you modify any RXf flags you should run regen.pl or
258 * regen/regcomp.pl so that regnodes.h is updated with the changes.
cb5027f2 259 *
bbe252da
YO
260 */
261
5b126c84
KW
262#include "op_reg_common.h"
263
cde0cee5 264#define RXf_PMf_STD_PMMOD (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_FOLD|RXf_PMf_EXTENDED)
cde0cee5 265
a20207d7
YO
266#define CASE_STD_PMMOD_FLAGS_PARSE_SET(pmfl) \
267 case IGNORE_PAT_MOD: *(pmfl) |= RXf_PMf_FOLD; break; \
268 case MULTILINE_PAT_MOD: *(pmfl) |= RXf_PMf_MULTILINE; break; \
269 case SINGLE_PAT_MOD: *(pmfl) |= RXf_PMf_SINGLELINE; break; \
270 case XTENDED_PAT_MOD: *(pmfl) |= RXf_PMf_EXTENDED; break
bbe252da 271
94b03d7d 272/* Note, includes charset ones, assumes 0 is the default for them */
fb85c044 273#define STD_PMMOD_FLAGS_CLEAR(pmfl) \
a62b1201 274 *(pmfl) &= ~(RXf_PMf_FOLD|RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_EXTENDED|RXf_PMf_CHARSET)
fb85c044 275
bcdf7404 276/* chars and strings used as regex pattern modifiers
486ec47a 277 * Singular is a 'c'har, plural is a "string"
87e95b7f
YO
278 *
279 * NOTE, KEEPCOPY was originally 'k', but was changed to 'p' for preserve
280 * for compatibility reasons with Regexp::Common which highjacked (?k:...)
281 * for its own uses. So 'k' is out as well.
bcdf7404 282 */
85508812 283#define DEFAULT_PAT_MOD '^' /* Short for all the default modifiers */
bcdf7404 284#define EXEC_PAT_MOD 'e'
87e95b7f 285#define KEEPCOPY_PAT_MOD 'p'
bcdf7404
YO
286#define ONCE_PAT_MOD 'o'
287#define GLOBAL_PAT_MOD 'g'
288#define CONTINUE_PAT_MOD 'c'
289#define MULTILINE_PAT_MOD 'm'
290#define SINGLE_PAT_MOD 's'
291#define IGNORE_PAT_MOD 'i'
292#define XTENDED_PAT_MOD 'x'
4f4d7508 293#define NONDESTRUCT_PAT_MOD 'r'
9de15fec
KW
294#define LOCALE_PAT_MOD 'l'
295#define UNICODE_PAT_MOD 'u'
50e91148 296#define DEPENDS_PAT_MOD 'd'
cfaf538b 297#define ASCII_RESTRICT_PAT_MOD 'a'
bcdf7404
YO
298
299#define ONCE_PAT_MODS "o"
87e95b7f 300#define KEEPCOPY_PAT_MODS "p"
bcdf7404
YO
301#define EXEC_PAT_MODS "e"
302#define LOOP_PAT_MODS "gc"
4f4d7508 303#define NONDESTRUCT_PAT_MODS "r"
9de15fec
KW
304#define LOCALE_PAT_MODS "l"
305#define UNICODE_PAT_MODS "u"
50e91148 306#define DEPENDS_PAT_MODS "d"
cfaf538b 307#define ASCII_RESTRICT_PAT_MODS "a"
df7a8460 308#define ASCII_MORE_RESTRICT_PAT_MODS "aa"
bcdf7404 309
78fecfc8 310/* This string is expected by regcomp.c to be ordered so that the first
c18d5d15
KW
311 * character is the flag in bit RXf_PMf_STD_PMMOD_SHIFT of extflags; the next
312 * character is bit +1, etc. */
bcdf7404
YO
313#define STD_PAT_MODS "msix"
314
94b03d7d
KW
315#define CHARSET_PAT_MODS ASCII_RESTRICT_PAT_MODS DEPENDS_PAT_MODS LOCALE_PAT_MODS UNICODE_PAT_MODS
316
78fecfc8 317/* This string is expected by XS_re_regexp_pattern() in universal.c to be ordered
c18d5d15
KW
318 * so that the first character is the flag in bit RXf_PMf_STD_PMMOD_SHIFT of
319 * extflags; the next character is in bit +1, etc. */
bcdf7404
YO
320#define INT_PAT_MODS STD_PAT_MODS KEEPCOPY_PAT_MODS
321
322#define EXT_PAT_MODS ONCE_PAT_MODS KEEPCOPY_PAT_MODS
94b03d7d 323#define QR_PAT_MODS STD_PAT_MODS EXT_PAT_MODS CHARSET_PAT_MODS
bcdf7404 324#define M_PAT_MODS QR_PAT_MODS LOOP_PAT_MODS
4f4d7508 325#define S_PAT_MODS M_PAT_MODS EXEC_PAT_MODS NONDESTRUCT_PAT_MODS
bcdf7404 326
cb5027f2 327/*
eb2624c9
FC
328 * NOTE: if you modify any RXf flags you should run regen.pl or
329 * regen/regcomp.pl so that regnodes.h is updated with the changes.
cb5027f2
YO
330 *
331 */
bcdf7404 332
e795e964
KW
333/* Leave some space, so future bit allocations can go either in the shared or
334 * unshared area without affecting binary compatibility */
df7a8460 335#define RXf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+1)
f4a4cecb 336
bf28aba1
KW
337/* Manually decorate this function with gcc-style attributes just to
338 * avoid having to restructure the header files and their called order,
339 * as proto.h would have to be included before this file, and isn't */
340
a62b1201
KW
341PERL_STATIC_INLINE const char *
342get_regex_charset_name(const U32 flags, STRLEN* const lenp)
343 __attribute__warn_unused_result__;
344
df7a8460 345#define MAX_CHARSET_NAME_LENGTH 2
a62b1201
KW
346
347PERL_STATIC_INLINE const char *
348get_regex_charset_name(const U32 flags, STRLEN* const lenp)
349{
350 /* Returns a string that corresponds to the name of the regex character set
351 * given by 'flags', and *lenp is set the length of that string, which
352 * cannot exceed MAX_CHARSET_NAME_LENGTH characters */
353
354 *lenp = 1;
355 switch (get_regex_charset(flags)) {
50e91148 356 case REGEX_DEPENDS_CHARSET: return DEPENDS_PAT_MODS;
a62b1201
KW
357 case REGEX_LOCALE_CHARSET: return LOCALE_PAT_MODS;
358 case REGEX_UNICODE_CHARSET: return UNICODE_PAT_MODS;
cfaf538b 359 case REGEX_ASCII_RESTRICTED_CHARSET: return ASCII_RESTRICT_PAT_MODS;
df7a8460 360 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
07075d19
KW
361 *lenp = 2;
362 return ASCII_MORE_RESTRICT_PAT_MODS;
0984e55e
JC
363 default:
364 return "?"; /* Unknown */
a62b1201 365 }
a62b1201
KW
366}
367
52d81aa8 368/* Anchor and GPOS related stuff */
1ad4ec54
KW
369#define RXf_ANCH_BOL (1<<(RXf_BASE_SHIFT+0))
370#define RXf_ANCH_MBOL (1<<(RXf_BASE_SHIFT+1))
371#define RXf_ANCH_SBOL (1<<(RXf_BASE_SHIFT+2))
372#define RXf_ANCH_GPOS (1<<(RXf_BASE_SHIFT+3))
373#define RXf_GPOS_SEEN (1<<(RXf_BASE_SHIFT+4))
374#define RXf_GPOS_FLOAT (1<<(RXf_BASE_SHIFT+5))
52d81aa8
NC
375/* two bits here */
376#define RXf_ANCH (RXf_ANCH_BOL|RXf_ANCH_MBOL|RXf_ANCH_GPOS|RXf_ANCH_SBOL)
377#define RXf_GPOS_CHECK (RXf_GPOS_SEEN|RXf_ANCH_GPOS)
378#define RXf_ANCH_SINGLE (RXf_ANCH_SBOL|RXf_ANCH_GPOS)
379
bbe252da 380/* What we have seen */
1ad4ec54
KW
381#define RXf_LOOKBEHIND_SEEN (1<<(RXf_BASE_SHIFT+6))
382#define RXf_EVAL_SEEN (1<<(RXf_BASE_SHIFT+7))
383#define RXf_CANY_SEEN (1<<(RXf_BASE_SHIFT+8))
bbe252da
YO
384
385/* Special */
1ad4ec54
KW
386#define RXf_NOSCAN (1<<(RXf_BASE_SHIFT+9))
387#define RXf_CHECK_ALL (1<<(RXf_BASE_SHIFT+10))
bbe252da
YO
388
389/* UTF8 related */
e795e964 390#define RXf_MATCH_UTF8 (1<<(RXf_BASE_SHIFT+11))
bbe252da
YO
391
392/* Intuit related */
e795e964
KW
393#define RXf_USE_INTUIT_NOML (1<<(RXf_BASE_SHIFT+12))
394#define RXf_USE_INTUIT_ML (1<<(RXf_BASE_SHIFT+13))
395#define RXf_INTUIT_TAIL (1<<(RXf_BASE_SHIFT+14))
0ac6acae
AB
396
397/*
5255171e
FC
398 This used to be set in Perl_pmruntime if op_flags & OPf_SPECIAL, i.e.
399 split. It was used by the regex engine to check whether it should set
400 RXf_SKIPWHITE. Regexp plugins on CPAN also have done the same thing
401 historically, so we leave this flag defined, even though it is never set.
0ac6acae 402*/
5255171e
FC
403#if !defined(PERL_CORE) || defined(PERL_IN_DUMP_C)
404# define RXf_SPLIT (1<<(RXf_BASE_SHIFT+15))
405#endif
0ac6acae 406
bbe252da
YO
407#define RXf_USE_INTUIT (RXf_USE_INTUIT_NOML|RXf_USE_INTUIT_ML)
408
409/* Copy and tainted info */
e795e964 410#define RXf_COPY_DONE (1<<(RXf_BASE_SHIFT+16))
ef07e810
DM
411
412/* during execution: pattern temporarily tainted by executing locale ops;
413 * post-execution: $1 et al are tainted */
e795e964 414#define RXf_TAINTED_SEEN (1<<(RXf_BASE_SHIFT+17))
ef07e810
DM
415/* this pattern was tainted during compilation */
416#define RXf_TAINTED (1<<(RXf_BASE_SHIFT+18))
52d81aa8
NC
417
418/* Flags indicating special patterns */
e795e964 419#define RXf_START_ONLY (1<<(RXf_BASE_SHIFT+19)) /* Pattern is /^/ */
5255171e
FC
420/* No longer used, but CPAN modules still mention it. */
421#if !defined(PERL_CORE) || defined(PERL_IN_DUMP_C)
422# define RXf_SKIPWHITE (1<<(RXf_BASE_SHIFT+20)) /* Pattern is for a split " " */
423#endif
e795e964 424#define RXf_WHITE (1<<(RXf_BASE_SHIFT+21)) /* Pattern is /\s+/ */
ca835a20 425#define RXf_NULL (1U<<(RXf_BASE_SHIFT+22)) /* Pattern is // */
e795e964 426#if RXf_BASE_SHIFT+22 > 31
1850c8f9
KW
427# error Too many RXf_PMf bits used. See regnodes.h for any spare in middle
428#endif
c737faaf 429
cb5027f2 430/*
eb2624c9
FC
431 * NOTE: if you modify any RXf flags you should run regen.pl or
432 * regen/regcomp.pl so that regnodes.h is updated with the changes.
cb5027f2
YO
433 *
434 */
bbe252da 435
bbe252da 436#define RX_HAS_CUTGROUP(prog) ((prog)->intflags & PREGf_CUTGROUP_SEEN)
07bc277f
NC
437#define RXp_MATCH_TAINTED(prog) (RXp_EXTFLAGS(prog) & RXf_TAINTED_SEEN)
438#define RX_MATCH_TAINTED(prog) (RX_EXTFLAGS(prog) & RXf_TAINTED_SEEN)
439#define RX_MATCH_TAINTED_on(prog) (RX_EXTFLAGS(prog) |= RXf_TAINTED_SEEN)
440#define RX_MATCH_TAINTED_off(prog) (RX_EXTFLAGS(prog) &= ~RXf_TAINTED_SEEN)
72311751
GS
441#define RX_MATCH_TAINTED_set(prog, t) ((t) \
442 ? RX_MATCH_TAINTED_on(prog) \
443 : RX_MATCH_TAINTED_off(prog))
c277df42 444
07bc277f
NC
445#define RXp_MATCH_COPIED(prog) (RXp_EXTFLAGS(prog) & RXf_COPY_DONE)
446#define RX_MATCH_COPIED(prog) (RX_EXTFLAGS(prog) & RXf_COPY_DONE)
447#define RXp_MATCH_COPIED_on(prog) (RXp_EXTFLAGS(prog) |= RXf_COPY_DONE)
448#define RX_MATCH_COPIED_on(prog) (RX_EXTFLAGS(prog) |= RXf_COPY_DONE)
449#define RXp_MATCH_COPIED_off(prog) (RXp_EXTFLAGS(prog) &= ~RXf_COPY_DONE)
450#define RX_MATCH_COPIED_off(prog) (RX_EXTFLAGS(prog) &= ~RXf_COPY_DONE)
cf93c79d
IZ
451#define RX_MATCH_COPIED_set(prog,t) ((t) \
452 ? RX_MATCH_COPIED_on(prog) \
453 : RX_MATCH_COPIED_off(prog))
f9f4320a 454
07bc277f 455#define RXp_EXTFLAGS(rx) ((rx)->extflags)
866c78d1 456
07bc277f 457/* For source compatibility. We used to store these explicitly. */
f7c278bf 458#define RX_PRECOMP(prog) (RX_WRAPPED(prog) + ((struct regexp *)SvANY(prog))->pre_prefix)
d2c6dc5e 459#define RX_PRECOMP_const(prog) (RX_WRAPPED_const(prog) + ((struct regexp *)SvANY(prog))->pre_prefix)
5509d87a
NC
460/* FIXME? Are we hardcoding too much here and constraining plugin extension
461 writers? Specifically, the value 1 assumes that the wrapped version always
462 has exactly one character at the end, a ')'. Will that always be true? */
463#define RX_PRELEN(prog) (RX_WRAPLEN(prog) - ((struct regexp *)SvANY(prog))->pre_prefix - 1)
f7c278bf 464#define RX_WRAPPED(prog) SvPVX(prog)
d2c6dc5e 465#define RX_WRAPPED_const(prog) SvPVX_const(prog)
9d17798d 466#define RX_WRAPLEN(prog) SvCUR(prog)
288b8c02 467#define RX_CHECK_SUBSTR(prog) (((struct regexp *)SvANY(prog))->check_substr)
288b8c02 468#define RX_REFCNT(prog) SvREFCNT(prog)
7fe44985 469#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
4450b630
NC
470# define RX_EXTFLAGS(prog) \
471 (*({ \
7948fc08
RU
472 const REGEXP *const _rx_extflags = (prog); \
473 assert(SvTYPE(_rx_extflags) == SVt_REGEXP); \
474 &RXp_EXTFLAGS(SvANY(_rx_extflags)); \
4450b630
NC
475 }))
476# define RX_ENGINE(prog) \
477 (*({ \
7948fc08
RU
478 const REGEXP *const _rx_engine = (prog); \
479 assert(SvTYPE(_rx_engine) == SVt_REGEXP); \
480 &SvANY(_rx_engine)->engine; \
4450b630
NC
481 }))
482# define RX_SUBBEG(prog) \
483 (*({ \
7948fc08
RU
484 const REGEXP *const _rx_subbeg = (prog); \
485 assert(SvTYPE(_rx_subbeg) == SVt_REGEXP); \
486 &SvANY(_rx_subbeg)->subbeg; \
4450b630 487 }))
6502e081
DM
488# define RX_SUBOFFSET(prog) \
489 (*({ \
490 const REGEXP *const _rx_suboffset = (prog); \
491 assert(SvTYPE(_rx_suboffset) == SVt_REGEXP); \
492 &SvANY(_rx_suboffset)->suboffset; \
493 }))
494# define RX_SUBCOFFSET(prog) \
495 (*({ \
496 const REGEXP *const _rx_subcoffset = (prog); \
497 assert(SvTYPE(_rx_subcoffset) == SVt_REGEXP); \
498 &SvANY(_rx_subcoffset)->subcoffset; \
499 }))
200ff815 500# define RX_OFFS(prog) \
4450b630 501 (*({ \
7948fc08
RU
502 const REGEXP *const _rx_offs = (prog); \
503 assert(SvTYPE(_rx_offs) == SVt_REGEXP); \
504 &SvANY(_rx_offs)->offs; \
4450b630
NC
505 }))
506# define RX_NPARENS(prog) \
507 (*({ \
7948fc08
RU
508 const REGEXP *const _rx_nparens = (prog); \
509 assert(SvTYPE(_rx_nparens) == SVt_REGEXP); \
510 &SvANY(_rx_nparens)->nparens; \
4450b630
NC
511 }))
512#else
513# define RX_EXTFLAGS(prog) RXp_EXTFLAGS((struct regexp *)SvANY(prog))
514# define RX_ENGINE(prog) (((struct regexp *)SvANY(prog))->engine)
515# define RX_SUBBEG(prog) (((struct regexp *)SvANY(prog))->subbeg)
6502e081
DM
516# define RX_SUBOFFSET(prog) (((struct regexp *)SvANY(prog))->suboffset)
517# define RX_SUBCOFFSET(prog) (((struct regexp *)SvANY(prog))->subcoffset)
4450b630
NC
518# define RX_OFFS(prog) (((struct regexp *)SvANY(prog))->offs)
519# define RX_NPARENS(prog) (((struct regexp *)SvANY(prog))->nparens)
520#endif
288b8c02 521#define RX_SUBLEN(prog) (((struct regexp *)SvANY(prog))->sublen)
288b8c02
NC
522#define RX_MINLEN(prog) (((struct regexp *)SvANY(prog))->minlen)
523#define RX_MINLENRET(prog) (((struct regexp *)SvANY(prog))->minlenret)
524#define RX_GOFS(prog) (((struct regexp *)SvANY(prog))->gofs)
525#define RX_LASTPAREN(prog) (((struct regexp *)SvANY(prog))->lastparen)
526#define RX_LASTCLOSEPAREN(prog) (((struct regexp *)SvANY(prog))->lastcloseparen)
bdd9a1b1 527#define RX_SAVED_COPY(prog) (((struct regexp *)SvANY(prog))->saved_copy)
220fc49f 528
be8e71aa
YO
529#endif /* PLUGGABLE_RE_EXTENSION */
530
486ec47a 531/* Stuff that needs to be included in the pluggable extension goes below here */
be8e71aa 532
f8c7b90f 533#ifdef PERL_OLD_COPY_ON_WRITE
ed252734 534#define RX_MATCH_COPY_FREE(rx) \
bdd9a1b1
NC
535 STMT_START {if (RX_SAVED_COPY(rx)) { \
536 SV_CHECK_THINKFIRST_COW_DROP(RX_SAVED_COPY(rx)); \
ed252734
NC
537 } \
538 if (RX_MATCH_COPIED(rx)) { \
07bc277f 539 Safefree(RX_SUBBEG(rx)); \
ed252734
NC
540 RX_MATCH_COPIED_off(rx); \
541 }} STMT_END
542#else
543#define RX_MATCH_COPY_FREE(rx) \
544 STMT_START {if (RX_MATCH_COPIED(rx)) { \
07bc277f 545 Safefree(RX_SUBBEG(rx)); \
ed252734
NC
546 RX_MATCH_COPIED_off(rx); \
547 }} STMT_END
548#endif
549
07bc277f
NC
550#define RXp_MATCH_UTF8(prog) (RXp_EXTFLAGS(prog) & RXf_MATCH_UTF8)
551#define RX_MATCH_UTF8(prog) (RX_EXTFLAGS(prog) & RXf_MATCH_UTF8)
552#define RX_MATCH_UTF8_on(prog) (RX_EXTFLAGS(prog) |= RXf_MATCH_UTF8)
553#define RX_MATCH_UTF8_off(prog) (RX_EXTFLAGS(prog) &= ~RXf_MATCH_UTF8)
a30b2f1f
RGS
554#define RX_MATCH_UTF8_set(prog, t) ((t) \
555 ? (RX_MATCH_UTF8_on(prog), (PL_reg_match_utf8 = 1)) \
556 : (RX_MATCH_UTF8_off(prog), (PL_reg_match_utf8 = 0)))
efd26800
NC
557
558/* Whether the pattern stored at RX_WRAPPED is in UTF-8 */
8f6ae13c 559#define RX_UTF8(prog) SvUTF8(prog)
7948fc08 560
cad2e5aa
JH
561#define REXEC_COPY_STR 0x01 /* Need to copy the string. */
562#define REXEC_CHECKED 0x02 /* check_substr already checked. */
563#define REXEC_SCREAM 0x04 /* use scream table. */
564#define REXEC_IGNOREPOS 0x08 /* \G matches at start. */
cf93c79d 565#define REXEC_NOT_FIRST 0x10 /* This is another iteration of //g. */
6502e081
DM
566 /* under REXEC_COPY_STR, it's ok for the
567 * engine (modulo PL_sawamperand etc)
568 * to skip copying ... */
569#define REXEC_COPY_SKIP_PRE 0x20 /* ...the $` part of the string, or */
570#define REXEC_COPY_SKIP_POST 0x40 /* ...the $' part of the string */
c277df42 571
7fe44985 572#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
288b8c02
NC
573# define ReREFCNT_inc(re) \
574 ({ \
575 /* This is here to generate a casting warning if incorrect. */ \
7948fc08
RU
576 REGEXP *const _rerefcnt_inc = (re); \
577 assert(SvTYPE(_rerefcnt_inc) == SVt_REGEXP); \
578 SvREFCNT_inc(_rerefcnt_inc); \
579 _rerefcnt_inc; \
288b8c02
NC
580 })
581# define ReREFCNT_dec(re) \
582 ({ \
583 /* This is here to generate a casting warning if incorrect. */ \
7948fc08
RU
584 REGEXP *const _rerefcnt_dec = (re); \
585 SvREFCNT_dec(_rerefcnt_dec); \
288b8c02
NC
586 })
587#else
588# define ReREFCNT_dec(re) SvREFCNT_dec(re)
b7e0bd9e 589# define ReREFCNT_inc(re) ((REGEXP *) SvREFCNT_inc(re))
288b8c02
NC
590#endif
591
592/* FIXME for plugins. */
cf93c79d
IZ
593
594#define FBMcf_TAIL_DOLLAR 1
cad2e5aa
JH
595#define FBMcf_TAIL_DOLLARM 2
596#define FBMcf_TAIL_Z 4
597#define FBMcf_TAIL_z 8
598#define FBMcf_TAIL (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)
cf93c79d
IZ
599
600#define FBMrf_MULTILINE 1
cad2e5aa 601
3b0527fe
DM
602/* some basic information about the current match that is created by
603 * Perl_regexec_flags and then passed to regtry(), regmatch() etc */
604
605typedef struct {
288b8c02 606 REGEXP *prog;
3b0527fe
DM
607 char *bol;
608 char *till;
609 SV *sv;
610 char *ganch;
24b23f37 611 char *cutpoint;
3b0527fe
DM
612} regmatch_info;
613
5d9a96ca
DM
614
615/* structures for holding and saving the state maintained by regmatch() */
616
d56b3014 617#ifndef MAX_RECURSE_EVAL_NOCHANGE_DEPTH
4b196cd4 618#define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 1000
d56b3014 619#endif
6bda09f9 620
5d9a96ca
DM
621typedef I32 CHECKPOINT;
622
a0374537 623typedef struct regmatch_state {
40a82448 624 int resume_state; /* where to jump to on return */
24d3c4a9 625 char *locinput; /* where to backtrack in string on failure */
e822a8b4
DM
626
627 union {
77cb431f
DM
628
629 /* this is a fake union member that matches the first element
630 * of each member that needs to store positive backtrack
631 * information */
632 struct {
633 struct regmatch_state *prev_yes_state;
634 } yes;
635
fae667d5
YO
636 /* branchlike members */
637 /* this is a fake union member that matches the first elements
638 * of each member that needs to behave like a branch */
639 struct {
5d458dd8
YO
640 /* this first element must match u.yes */
641 struct regmatch_state *prev_yes_state;
fae667d5 642 U32 lastparen;
f6033a9d 643 U32 lastcloseparen;
fae667d5
YO
644 CHECKPOINT cp;
645
646 } branchlike;
647
648 struct {
649 /* the first elements must match u.branchlike */
650 struct regmatch_state *prev_yes_state;
651 U32 lastparen;
f6033a9d 652 U32 lastcloseparen;
fae667d5
YO
653 CHECKPOINT cp;
654
655 regnode *next_branch; /* next branch node */
656 } branch;
657
658 struct {
659 /* the first elements must match u.branchlike */
660 struct regmatch_state *prev_yes_state;
661 U32 lastparen;
f6033a9d 662 U32 lastcloseparen;
fae667d5
YO
663 CHECKPOINT cp;
664
2e64971a 665 U32 accepted; /* how many accepting states left */
6603fe3e 666 bool longfold;/* saw a fold with a 1->n char mapping */
7f69552c 667 U16 *jump; /* positive offsets from me */
7f69552c 668 regnode *me; /* Which node am I - needed for jump tries*/
2e64971a
DM
669 U8 *firstpos;/* pos in string of first trie match */
670 U32 firstchars;/* len in chars of firstpos from start */
671 U16 nextword;/* next word to try */
672 U16 topword; /* longest accepted word */
e822a8b4
DM
673 } trie;
674
fae667d5
YO
675 /* special types - these members are used to store state for special
676 regops like eval, if/then, lookaround and the markpoint state */
e822a8b4 677 struct {
77cb431f
DM
678 /* this first element must match u.yes */
679 struct regmatch_state *prev_yes_state;
faec1544
DM
680 struct regmatch_state *prev_eval;
681 struct regmatch_state *prev_curlyx;
288b8c02 682 REGEXP *prev_rex;
faec1544
DM
683 U32 toggle_reg_flags; /* what bits in PL_reg_flags to
684 flip when transitioning between
685 inner and outer rexen */
aa283a38
DM
686 CHECKPOINT cp; /* remember current savestack indexes */
687 CHECKPOINT lastcp;
6bda09f9 688 U32 close_paren; /* which close bracket is our end */
1b5c067c 689 regnode *B; /* the node following us */
e822a8b4
DM
690 } eval;
691
692 struct {
c476f425 693 /* this first element must match u.yes */
262b90c4 694 struct regmatch_state *prev_yes_state;
fae667d5
YO
695 I32 wanted;
696 I32 logical; /* saved copy of 'logical' var */
697 regnode *me; /* the IFMATCH/SUSPEND/UNLESSM node */
698 } ifmatch; /* and SUSPEND/UNLESSM */
699
700 struct {
701 /* this first element must match u.yes */
702 struct regmatch_state *prev_yes_state;
703 struct regmatch_state *prev_mark;
704 SV* mark_name;
705 char *mark_loc;
706 } mark;
707
708 struct {
709 int val;
710 } keeper;
711
712 /* quantifiers - these members are used for storing state for
713 for the regops used to implement quantifiers */
714 struct {
715 /* this first element must match u.yes */
716 struct regmatch_state *prev_yes_state;
c476f425 717 struct regmatch_state *prev_curlyx; /* previous cur_curlyx */
d02d6d97
DM
718 regnode *me; /* the CURLYX node */
719 regnode *B; /* the B node in /A*B/ */
c476f425
DM
720 CHECKPOINT cp; /* remember current savestack index */
721 bool minmod;
a0374537 722 int parenfloor;/* how far back to strip paren data */
c476f425
DM
723
724 /* these two are modified by WHILEM */
725 int count; /* how many instances of A we've matched */
726 char *lastloc;/* where previous A matched (0-len detect) */
e822a8b4
DM
727 } curlyx;
728
729 struct {
c476f425 730 /* this first element must match u.yes */
262b90c4 731 struct regmatch_state *prev_yes_state;
c476f425
DM
732 struct regmatch_state *save_curlyx;
733 CHECKPOINT cp; /* remember current savestack indexes */
734 CHECKPOINT lastcp;
735 char *save_lastloc; /* previous curlyx.lastloc */
736 I32 cache_offset;
737 I32 cache_mask;
e822a8b4
DM
738 } whilem;
739
740 struct {
5d458dd8
YO
741 /* this first element must match u.yes */
742 struct regmatch_state *prev_yes_state;
e822a8b4 743 I32 c1, c2; /* case fold search */
40a82448 744 CHECKPOINT cp;
f6033a9d
DM
745 U32 lastparen;
746 U32 lastcloseparen;
40a82448
DM
747 I32 alen; /* length of first-matched A string */
748 I32 count;
0cadcf80 749 bool minmod;
40a82448
DM
750 regnode *A, *B; /* the nodes corresponding to /A*B/ */
751 regnode *me; /* the curlym node */
e822a8b4
DM
752 } curlym;
753
754 struct {
3b6647e0 755 U32 paren;
c255a977 756 CHECKPOINT cp;
f6033a9d
DM
757 U32 lastparen;
758 U32 lastcloseparen;
e822a8b4 759 I32 c1, c2; /* case fold search */
c255a977
DM
760 char *maxpos; /* highest possible point in string to match */
761 char *oldloc; /* the previous locinput */
e822a8b4 762 int count;
c255a977
DM
763 int min, max; /* {m,n} */
764 regnode *A, *B; /* the nodes corresponding to /A*B/ */
765 } curly; /* and CURLYN/PLUS/STAR */
dad79028 766
d8319b27 767 } u;
5d9a96ca
DM
768} regmatch_state;
769
770/* how many regmatch_state structs to allocate as a single slab.
771 * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
772 * pointers, plus 1 for any mythical malloc overhead. */
773
774#define PERL_REGMATCH_SLAB_SLOTS \
775 ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
776
777typedef struct regmatch_slab {
778 regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
779 struct regmatch_slab *prev, *next;
780} regmatch_slab;
1ade1aa1 781
46ab3289
NC
782#define PL_reg_flags PL_reg_state.re_state_reg_flags
783#define PL_bostr PL_reg_state.re_state_bostr
46ab3289 784#define PL_regeol PL_reg_state.re_state_regeol
46ab3289
NC
785#define PL_reg_match_utf8 PL_reg_state.re_state_reg_match_utf8
786#define PL_reg_magic PL_reg_state.re_state_reg_magic
787#define PL_reg_oldpos PL_reg_state.re_state_reg_oldpos
788#define PL_reg_oldcurpm PL_reg_state.re_state_reg_oldcurpm
789#define PL_reg_curpm PL_reg_state.re_state_reg_curpm
790#define PL_reg_oldsaved PL_reg_state.re_state_reg_oldsaved
791#define PL_reg_oldsavedlen PL_reg_state.re_state_reg_oldsavedlen
6502e081
DM
792#define PL_reg_oldsavedoffset PL_reg_state.re_state_reg_oldsavedoffset
793#define PL_reg_oldsavedcoffset PL_reg_state.re_state_reg_oldsavedcoffset
46ab3289
NC
794#define PL_reg_maxiter PL_reg_state.re_state_reg_maxiter
795#define PL_reg_leftiter PL_reg_state.re_state_reg_leftiter
796#define PL_reg_poscache PL_reg_state.re_state_reg_poscache
797#define PL_reg_poscache_size PL_reg_state.re_state_reg_poscache_size
798#define PL_regsize PL_reg_state.re_state_regsize
799#define PL_reg_starttry PL_reg_state.re_state_reg_starttry
800#define PL_nrs PL_reg_state.re_state_nrs
801
1ade1aa1
NC
802struct re_save_state {
803 U32 re_state_reg_flags; /* from regexec.c */
ed301438 804 bool re_state_eval_setup_done; /* from regexec.c */
1b5c067c 805 bool re_state_reg_match_utf8; /* from regexec.c */
d24ca0c5 806 bool re_reparsing; /* runtime (?{}) fed back into parser */
1ade1aa1 807 char *re_state_bostr;
1ade1aa1 808 char *re_state_regeol; /* End of input, for $ check. */
1ade1aa1 809 MAGIC *re_state_reg_magic; /* from regexec.c */
1ade1aa1
NC
810 PMOP *re_state_reg_oldcurpm; /* from regexec.c */
811 PMOP *re_state_reg_curpm; /* from regexec.c */
812 char *re_state_reg_oldsaved; /* old saved substr during match */
813 STRLEN re_state_reg_oldsavedlen; /* old length of saved substr during match */
6502e081
DM
814 STRLEN re_state_reg_oldsavedoffset; /* old offset of saved substr during match */
815 STRLEN re_state_reg_oldsavedcoffset;/* old coffset of saved substr during match */
1b5c067c
NC
816 STRLEN re_state_reg_poscache_size; /* size of pos cache of WHILEM */
817 I32 re_state_reg_oldpos; /* from regexec.c */
1ade1aa1
NC
818 I32 re_state_reg_maxiter; /* max wait until caching pos */
819 I32 re_state_reg_leftiter; /* wait until caching pos */
3b6647e0 820 U32 re_state_regsize; /* from regexec.c */
1b5c067c 821 char *re_state_reg_poscache; /* cache of pos of WHILEM */
1ade1aa1
NC
822 char *re_state_reg_starttry; /* from regexec.c */
823#ifdef PERL_OLD_COPY_ON_WRITE
46ab3289 824 SV *re_state_nrs; /* was placeholder: unused since 5.8.0 (5.7.2 patch #12027 for bug ID 20010815.012). Used to save rx->saved_copy */
1ade1aa1
NC
825#endif
826};
827
828#define SAVESTACK_ALLOC_FOR_RE_SAVE_STATE \
829 (1 + ((sizeof(struct re_save_state) - 1) / sizeof(*PL_savestack)))
cde0cee5 830
1ade1aa1
NC
831/*
832 * Local variables:
833 * c-indentation-style: bsd
834 * c-basic-offset: 4
14d04a33 835 * indent-tabs-mode: nil
1ade1aa1
NC
836 * End:
837 *
14d04a33 838 * ex: set ts=8 sts=4 sw=4 et:
1ade1aa1 839 */