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