Commit | Line | Data |
---|---|---|
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 |
23 | struct regnode { |
24 | U8 flags; | |
25 | U8 type; | |
26 | U16 next_off; | |
27 | }; | |
28 | ||
29 | typedef struct regnode regnode; | |
30 | ||
cad2e5aa | 31 | struct reg_substr_data; |
2779dcf1 | 32 | |
0ee3c8d0 JH |
33 | struct reg_data; |
34 | ||
f9f4320a | 35 | struct regexp_engine; |
28d8d7f4 | 36 | struct regexp; |
bbe252da | 37 | |
785a26d5 | 38 | struct 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 | }; |
45 | struct 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 | 58 | typedef 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 | ||
81 | struct 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 | ||
90 | struct 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 | 154 | typedef 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 |
162 | typedef 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 | 171 | typedef 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 | 249 | Convenience macro to get the REGEXP from a SV. This is approximately |
f7e71195 AB |
250 | equivalent 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 | 259 | C<NULL> will be returned if a REGEXP* is not found. |
f7e71195 AB |
260 | |
261 | =for apidoc Am|bool|SvRXOK|SV* sv | |
262 | ||
1af910ea DL |
263 | Returns a boolean indicating whether the SV (or the one it references) |
264 | is a REGEXP. | |
f7e71195 AB |
265 | |
266 | If you want to do something with the REGEXP* later use SvRX instead | |
267 | and 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 |
a885a8e0 | 460 | # define RX_ISTAINTED(rx_sv) 0 |
196a02af | 461 | # define RXp_ISTAINTED(prog) 0 |
a885a8e0 DM |
462 | # define RX_TAINT_on(rx_sv) NOOP |
463 | # define RXp_MATCH_TAINTED(prog) 0 | |
464 | # define RX_MATCH_TAINTED(rx_sv) 0 | |
465 | # define RXp_MATCH_TAINTED_on(prog) NOOP | |
466 | # define RX_MATCH_TAINTED_on(rx_sv) NOOP | |
467 | # define RX_MATCH_TAINTED_off(rx_sv) NOOP | |
284167a5 | 468 | #else |
a885a8e0 | 469 | # define RX_ISTAINTED(rx_sv) (RX_EXTFLAGS(rx_sv) & RXf_TAINTED) |
196a02af | 470 | # define RXp_ISTAINTED(prog) (RXp_EXTFLAGS(prog) & RXf_TAINTED) |
a885a8e0 DM |
471 | # define RX_TAINT_on(rx_sv) (RX_EXTFLAGS(rx_sv) |= RXf_TAINTED) |
472 | # define RXp_MATCH_TAINTED(prog) (RXp_EXTFLAGS(prog) & RXf_TAINTED_SEEN) | |
473 | # define RX_MATCH_TAINTED(rx_sv) (RX_EXTFLAGS(rx_sv) & RXf_TAINTED_SEEN) | |
474 | # define RXp_MATCH_TAINTED_on(prog) (RXp_EXTFLAGS(prog) |= RXf_TAINTED_SEEN) | |
475 | # define RX_MATCH_TAINTED_on(rx_sv) (RX_EXTFLAGS(rx_sv) |= RXf_TAINTED_SEEN) | |
196a02af | 476 | # define RXp_MATCH_TAINTED_off(prog) (RXp_EXTFLAGS(prog) &= ~RXf_TAINTED_SEEN) |
a885a8e0 | 477 | # define RX_MATCH_TAINTED_off(rx_sv) (RX_EXTFLAGS(rx_sv) &= ~RXf_TAINTED_SEEN) |
284167a5 S |
478 | #endif |
479 | ||
ea0673ee | 480 | #define RXp_HAS_CUTGROUP(prog) ((prog)->intflags & PREGf_CUTGROUP_SEEN) |
a885a8e0 DM |
481 | |
482 | #define RX_MATCH_TAINTED_set(rx_sv, t) ((t) \ | |
483 | ? RX_MATCH_TAINTED_on(rx_sv) \ | |
484 | : RX_MATCH_TAINTED_off(rx_sv)) | |
485 | ||
486 | #define RXp_MATCH_COPIED(prog) (RXp_EXTFLAGS(prog) & RXf_COPY_DONE) | |
487 | #define RX_MATCH_COPIED(rx_sv) (RX_EXTFLAGS(rx_sv) & RXf_COPY_DONE) | |
488 | #define RXp_MATCH_COPIED_on(prog) (RXp_EXTFLAGS(prog) |= RXf_COPY_DONE) | |
489 | #define RX_MATCH_COPIED_on(rx_sv) (RX_EXTFLAGS(rx_sv) |= RXf_COPY_DONE) | |
490 | #define RXp_MATCH_COPIED_off(prog) (RXp_EXTFLAGS(prog) &= ~RXf_COPY_DONE) | |
491 | #define RX_MATCH_COPIED_off(rx_sv) (RX_EXTFLAGS(rx_sv) &= ~RXf_COPY_DONE) | |
492 | #define RX_MATCH_COPIED_set(rx_sv,t) ((t) \ | |
493 | ? RX_MATCH_COPIED_on(rx_sv) \ | |
494 | : RX_MATCH_COPIED_off(rx_sv)) | |
495 | ||
496 | #define RXp_EXTFLAGS(rx) ((rx)->extflags) | |
497 | #define RXp_COMPFLAGS(rx) ((rx)->compflags) | |
866c78d1 | 498 | |
07bc277f | 499 | /* For source compatibility. We used to store these explicitly. */ |
a885a8e0 DM |
500 | #define RX_PRECOMP(rx_sv) (RX_WRAPPED(rx_sv) \ |
501 | + ReANY(rx_sv)->pre_prefix) | |
502 | #define RX_PRECOMP_const(rx_sv) (RX_WRAPPED_const(rx_sv) \ | |
503 | + ReANY(rx_sv)->pre_prefix) | |
5509d87a NC |
504 | /* FIXME? Are we hardcoding too much here and constraining plugin extension |
505 | writers? Specifically, the value 1 assumes that the wrapped version always | |
506 | has exactly one character at the end, a ')'. Will that always be true? */ | |
a885a8e0 DM |
507 | #define RX_PRELEN(rx_sv) (RX_WRAPLEN(rx_sv) \ |
508 | - ReANY(rx_sv)->pre_prefix - 1) | |
509 | ||
510 | #define RX_WRAPPED(rx_sv) SvPVX(rx_sv) | |
511 | #define RX_WRAPPED_const(rx_sv) SvPVX_const(rx_sv) | |
512 | #define RX_WRAPLEN(rx_sv) SvCUR(rx_sv) | |
513 | #define RX_CHECK_SUBSTR(rx_sv) (ReANY(rx_sv)->check_substr) | |
514 | #define RX_REFCNT(rx_sv) SvREFCNT(rx_sv) | |
515 | #define RX_EXTFLAGS(rx_sv) RXp_EXTFLAGS(ReANY(rx_sv)) | |
516 | #define RX_COMPFLAGS(rx_sv) RXp_COMPFLAGS(ReANY(rx_sv)) | |
196a02af DM |
517 | #define RXp_ENGINE(prog) ((prog)->engine) |
518 | #define RX_ENGINE(rx_sv) (RXp_ENGINE(ReANY(rx_sv))) | |
519 | #define RXp_SUBBEG(prog) (prog->subbeg) | |
520 | #define RX_SUBBEG(rx_sv) (RXp_SUBBEG(ReANY(rx_sv))) | |
521 | #define RXp_SUBOFFSET(prog) (prog->suboffset) | |
522 | #define RX_SUBOFFSET(rx_sv) (RXp_SUBOFFSET(ReANY(rx_sv))) | |
a885a8e0 | 523 | #define RX_SUBCOFFSET(rx_sv) (ReANY(rx_sv)->subcoffset) |
196a02af DM |
524 | #define RXp_OFFS(prog) (prog->offs) |
525 | #define RX_OFFS(rx_sv) (RXp_OFFS(ReANY(rx_sv))) | |
526 | #define RXp_NPARENS(prog) (prog->nparens) | |
527 | #define RX_NPARENS(rx_sv) (RXp_NPARENS(ReANY(rx_sv))) | |
a885a8e0 | 528 | #define RX_SUBLEN(rx_sv) (ReANY(rx_sv)->sublen) |
196a02af DM |
529 | #define RXp_MINLEN(prog) (prog->minlen) |
530 | #define RX_MINLEN(rx_sv) (RXp_MINLEN(ReANY(rx_sv))) | |
531 | #define RXp_MINLENRET(prog) (prog->minlenret) | |
532 | #define RX_MINLENRET(rx_sv) (RXp_MINLENRET(ReANY(rx_sv))) | |
533 | #define RXp_GOFS(prog) (prog->gofs) | |
534 | #define RX_GOFS(rx_sv) (RXp_GOFS(ReANY(rx_sv))) | |
a885a8e0 DM |
535 | #define RX_LASTPAREN(rx_sv) (ReANY(rx_sv)->lastparen) |
536 | #define RX_LASTCLOSEPAREN(rx_sv) (ReANY(rx_sv)->lastcloseparen) | |
196a02af DM |
537 | #define RXp_SAVED_COPY(prog) (prog->saved_copy) |
538 | #define RX_SAVED_COPY(rx_sv) (RXp_SAVED_COPY(ReANY(rx_sv))) | |
03c83e26 | 539 | /* last match was zero-length */ |
196a02af DM |
540 | #define RXp_ZERO_LEN(prog) \ |
541 | (RXp_OFFS(prog)[0].start + (SSize_t)RXp_GOFS(prog) \ | |
542 | == RXp_OFFS(prog)[0].end) | |
543 | #define RX_ZERO_LEN(rx_sv) (RXp_ZERO_LEN(ReANY(rx_sv))) | |
220fc49f | 544 | |
be8e71aa YO |
545 | #endif /* PLUGGABLE_RE_EXTENSION */ |
546 | ||
486ec47a | 547 | /* Stuff that needs to be included in the pluggable extension goes below here */ |
be8e71aa | 548 | |
db2c6cb3 | 549 | #ifdef PERL_ANY_COW |
196a02af DM |
550 | #define RXp_MATCH_COPY_FREE(prog) \ |
551 | STMT_START {if (RXp_SAVED_COPY(prog)) { \ | |
552 | SV_CHECK_THINKFIRST_COW_DROP(RXp_SAVED_COPY(prog)); \ | |
ed252734 | 553 | } \ |
196a02af DM |
554 | if (RXp_MATCH_COPIED(prog)) { \ |
555 | Safefree(RXp_SUBBEG(prog)); \ | |
556 | RXp_MATCH_COPIED_off(prog); \ | |
ed252734 NC |
557 | }} STMT_END |
558 | #else | |
196a02af DM |
559 | #define RXp_MATCH_COPY_FREE(prog) \ |
560 | STMT_START {if (RXp_MATCH_COPIED(prog)) { \ | |
561 | Safefree(RXp_SUBBEG(prog)); \ | |
562 | RXp_MATCH_COPIED_off(prog); \ | |
ed252734 NC |
563 | }} STMT_END |
564 | #endif | |
a8cb1947 | 565 | #define RX_MATCH_COPY_FREE(rx_sv) RXp_MATCH_COPY_FREE(ReANY(rx_sv)) |
ed252734 | 566 | |
a885a8e0 DM |
567 | #define RXp_MATCH_UTF8(prog) (RXp_EXTFLAGS(prog) & RXf_MATCH_UTF8) |
568 | #define RX_MATCH_UTF8(rx_sv) (RX_EXTFLAGS(rx_sv) & RXf_MATCH_UTF8) | |
196a02af | 569 | #define RXp_MATCH_UTF8_on(prog) (RXp_EXTFLAGS(prog) |= RXf_MATCH_UTF8) |
97f6857b | 570 | #define RX_MATCH_UTF8_on(rx_sv) (RXp_MATCH_UTF8_on(ReANY(rx_sv))) |
196a02af DM |
571 | #define RXp_MATCH_UTF8_off(prog) (RXp_EXTFLAGS(prog) &= ~RXf_MATCH_UTF8) |
572 | #define RX_MATCH_UTF8_off(rx_sv) (RXp_MATCH_UTF8_off(ReANY(rx_sv)) | |
573 | #define RXp_MATCH_UTF8_set(prog, t) ((t) \ | |
574 | ? RXp_MATCH_UTF8_on(prog) \ | |
575 | : RXp_MATCH_UTF8_off(prog)) | |
576 | #define RX_MATCH_UTF8_set(rx_sv, t) (RXp_MATCH_UTF8_set(ReANY(rx_sv), t)) | |
efd26800 NC |
577 | |
578 | /* Whether the pattern stored at RX_WRAPPED is in UTF-8 */ | |
a885a8e0 | 579 | #define RX_UTF8(rx_sv) SvUTF8(rx_sv) |
7948fc08 | 580 | |
a340edde DM |
581 | |
582 | /* bits in flags arg of Perl_regexec_flags() */ | |
583 | ||
584 | #define REXEC_COPY_STR 0x01 /* Need to copy the string for captures. */ | |
585 | #define REXEC_CHECKED 0x02 /* re_intuit_start() already called. */ | |
586 | #define REXEC_SCREAM 0x04 /* currently unused. */ | |
587 | #define REXEC_IGNOREPOS 0x08 /* use stringarg, not pos(), for \G match */ | |
588 | #define REXEC_NOT_FIRST 0x10 /* This is another iteration of //g: | |
589 | no need to copy string again */ | |
590 | ||
591 | /* under REXEC_COPY_STR, it's ok for the | |
592 | engine (modulo PL_sawamperand etc) | |
593 | to skip copying: ... */ | |
594 | #define REXEC_COPY_SKIP_PRE 0x20 /* ...the $` part of the string, or */ | |
595 | #define REXEC_COPY_SKIP_POST 0x40 /* ...the $' part of the string */ | |
d5e7783a DM |
596 | #define REXEC_FAIL_ON_UNDERFLOW 0x80 /* fail the match if $& would start before |
597 | the start pos (so s/.\G// would fail | |
598 | on second iteration */ | |
c277df42 | 599 | |
7fe44985 | 600 | #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
288b8c02 NC |
601 | # define ReREFCNT_inc(re) \ |
602 | ({ \ | |
603 | /* This is here to generate a casting warning if incorrect. */ \ | |
7948fc08 RU |
604 | REGEXP *const _rerefcnt_inc = (re); \ |
605 | assert(SvTYPE(_rerefcnt_inc) == SVt_REGEXP); \ | |
606 | SvREFCNT_inc(_rerefcnt_inc); \ | |
607 | _rerefcnt_inc; \ | |
288b8c02 NC |
608 | }) |
609 | # define ReREFCNT_dec(re) \ | |
610 | ({ \ | |
611 | /* This is here to generate a casting warning if incorrect. */ \ | |
7948fc08 RU |
612 | REGEXP *const _rerefcnt_dec = (re); \ |
613 | SvREFCNT_dec(_rerefcnt_dec); \ | |
288b8c02 NC |
614 | }) |
615 | #else | |
616 | # define ReREFCNT_dec(re) SvREFCNT_dec(re) | |
b7e0bd9e | 617 | # define ReREFCNT_inc(re) ((REGEXP *) SvREFCNT_inc(re)) |
288b8c02 | 618 | #endif |
8d919b0a | 619 | #define ReANY(re) S_ReANY((const REGEXP *)(re)) |
288b8c02 NC |
620 | |
621 | /* FIXME for plugins. */ | |
cf93c79d IZ |
622 | |
623 | #define FBMcf_TAIL_DOLLAR 1 | |
cad2e5aa JH |
624 | #define FBMcf_TAIL_DOLLARM 2 |
625 | #define FBMcf_TAIL_Z 4 | |
626 | #define FBMcf_TAIL_z 8 | |
627 | #define FBMcf_TAIL (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z) | |
cf93c79d IZ |
628 | |
629 | #define FBMrf_MULTILINE 1 | |
cad2e5aa | 630 | |
331b2dcc DM |
631 | struct regmatch_state; |
632 | struct regmatch_slab; | |
8adc0f72 | 633 | |
bf2039a9 DM |
634 | /* like regmatch_info_aux, but contains extra fields only needed if the |
635 | * pattern contains (?{}). If used, is snuck into the second slot in the | |
636 | * regmatch_state stack at the start of execution */ | |
8adc0f72 DM |
637 | |
638 | typedef struct { | |
639 | regexp *rex; | |
640 | PMOP *curpm; /* saved PL_curpm */ | |
641 | #ifdef PERL_ANY_COW | |
642 | SV *saved_copy; /* saved saved_copy field from rex */ | |
643 | #endif | |
644 | char *subbeg; /* saved subbeg field from rex */ | |
645 | STRLEN sublen; /* saved sublen field from rex */ | |
646 | STRLEN suboffset; /* saved suboffset field from rex */ | |
647 | STRLEN subcoffset; /* saved subcoffset field from rex */ | |
648 | MAGIC *pos_magic; /* pos() magic attached to $_ */ | |
ea3daa5d | 649 | SSize_t pos; /* the original value of pos() in pos_magic */ |
25fdce4a | 650 | U8 pos_flags; /* flags to be restored; currently only MGf_BYTES*/ |
bf2039a9 DM |
651 | } regmatch_info_aux_eval; |
652 | ||
653 | ||
654 | /* fields that logically live in regmatch_info, but which need cleaning | |
655 | * up on croak(), and so are instead are snuck into the first slot in | |
656 | * the regmatch_state stack at the start of execution */ | |
657 | ||
658 | typedef struct { | |
659 | regmatch_info_aux_eval *info_aux_eval; | |
331b2dcc DM |
660 | struct regmatch_state *old_regmatch_state; /* saved PL_regmatch_state */ |
661 | struct regmatch_slab *old_regmatch_slab; /* saved PL_regmatch_slab */ | |
2ac8ff4b | 662 | char *poscache; /* S-L cache of fail positions of WHILEMs */ |
bf2039a9 DM |
663 | } regmatch_info_aux; |
664 | ||
8adc0f72 | 665 | |
3b0527fe | 666 | /* some basic information about the current match that is created by |
bf2039a9 DM |
667 | * Perl_regexec_flags and then passed to regtry(), regmatch() etc. |
668 | * It is allocated as a local var on the stack, so nothing should be | |
669 | * stored in it that needs preserving or clearing up on croak(). | |
670 | * For that, see the aux_info and aux_info_eval members of the | |
671 | * regmatch_state union. */ | |
3b0527fe DM |
672 | |
673 | typedef struct { | |
28d03b21 | 674 | REGEXP *prog; /* the regex being executed */ |
9d9163fb | 675 | const char * strbeg; /* real start of string */ |
28d03b21 DM |
676 | char *strend; /* one byte beyond last char of match string */ |
677 | char *till; /* matches shorter than this fail (see minlen arg) */ | |
678 | SV *sv; /* the SV string currently being matched */ | |
679 | char *ganch; /* position of \G anchor */ | |
680 | char *cutpoint; /* (*COMMIT) position (if any) */ | |
bf2039a9 DM |
681 | regmatch_info_aux *info_aux; /* extra fields that need cleanup */ |
682 | regmatch_info_aux_eval *info_aux_eval; /* extra saved state for (?{}) */ | |
1cb48e53 DM |
683 | I32 poscache_maxiter; /* how many whilems todo before S-L cache kicks in */ |
684 | I32 poscache_iter; /* current countdown from _maxiter to zero */ | |
2ac8ff4b | 685 | STRLEN poscache_size; /* size of regmatch_info_aux.poscache */ |
02d5137b | 686 | bool intuit; /* re_intuit_start() is the top-level caller */ |
ba44c216 DM |
687 | bool is_utf8_pat; /* regex is utf8 */ |
688 | bool is_utf8_target; /* string being matched is utf8 */ | |
39819bd9 | 689 | bool warned; /* we have issued a recursion warning; no need for more */ |
3b0527fe DM |
690 | } regmatch_info; |
691 | ||
5d9a96ca DM |
692 | |
693 | /* structures for holding and saving the state maintained by regmatch() */ | |
694 | ||
d56b3014 | 695 | #ifndef MAX_RECURSE_EVAL_NOCHANGE_DEPTH |
ba6840fb | 696 | #define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 10 |
d56b3014 | 697 | #endif |
6bda09f9 | 698 | |
5d9a96ca DM |
699 | typedef I32 CHECKPOINT; |
700 | ||
a0374537 | 701 | typedef struct regmatch_state { |
40a82448 | 702 | int resume_state; /* where to jump to on return */ |
24d3c4a9 | 703 | char *locinput; /* where to backtrack in string on failure */ |
e822a8b4 DM |
704 | |
705 | union { | |
77cb431f | 706 | |
bf2039a9 DM |
707 | /* the 'info_aux' and 'info_aux_eval' union members are cuckoos in |
708 | * the nest. They aren't saved backtrack state; rather they | |
709 | * represent one or two extra chunks of data that need allocating | |
710 | * at the start of a match. These fields would logically live in | |
711 | * the regmatch_info struct, except that is allocated on the | |
712 | * C stack, and these fields are all things that require cleanup | |
713 | * after a croak(), when the stack is lost. | |
714 | * As a convenience, we just use the first 1 or 2 regmatch_state | |
715 | * slots to store this info, as we will be allocating a slab of | |
716 | * these anyway. Otherwise we'd have to malloc and then free them, | |
717 | * or allocate them on the save stack (where they will get | |
718 | * realloced if the save stack grows). | |
719 | * info_aux contains the extra fields that are always needed; | |
720 | * info_aux_eval contains extra fields that only needed if | |
721 | * the pattern contains code blocks | |
722 | * We split them into two separate structs to avoid increasing | |
723 | * the size of the union. | |
724 | */ | |
725 | ||
726 | regmatch_info_aux info_aux; | |
727 | ||
728 | regmatch_info_aux_eval info_aux_eval; | |
729 | ||
77cb431f DM |
730 | /* this is a fake union member that matches the first element |
731 | * of each member that needs to store positive backtrack | |
732 | * information */ | |
733 | struct { | |
734 | struct regmatch_state *prev_yes_state; | |
735 | } yes; | |
736 | ||
fae667d5 YO |
737 | /* branchlike members */ |
738 | /* this is a fake union member that matches the first elements | |
739 | * of each member that needs to behave like a branch */ | |
740 | struct { | |
5d458dd8 YO |
741 | /* this first element must match u.yes */ |
742 | struct regmatch_state *prev_yes_state; | |
fae667d5 | 743 | U32 lastparen; |
f6033a9d | 744 | U32 lastcloseparen; |
fae667d5 YO |
745 | CHECKPOINT cp; |
746 | ||
747 | } branchlike; | |
748 | ||
749 | struct { | |
750 | /* the first elements must match u.branchlike */ | |
751 | struct regmatch_state *prev_yes_state; | |
752 | U32 lastparen; | |
f6033a9d | 753 | U32 lastcloseparen; |
fae667d5 YO |
754 | CHECKPOINT cp; |
755 | ||
756 | regnode *next_branch; /* next branch node */ | |
757 | } branch; | |
758 | ||
759 | struct { | |
760 | /* the first elements must match u.branchlike */ | |
761 | struct regmatch_state *prev_yes_state; | |
762 | U32 lastparen; | |
f6033a9d | 763 | U32 lastcloseparen; |
fae667d5 YO |
764 | CHECKPOINT cp; |
765 | ||
2e64971a | 766 | U32 accepted; /* how many accepting states left */ |
6603fe3e | 767 | bool longfold;/* saw a fold with a 1->n char mapping */ |
7f69552c | 768 | U16 *jump; /* positive offsets from me */ |
7f69552c | 769 | regnode *me; /* Which node am I - needed for jump tries*/ |
2e64971a DM |
770 | U8 *firstpos;/* pos in string of first trie match */ |
771 | U32 firstchars;/* len in chars of firstpos from start */ | |
772 | U16 nextword;/* next word to try */ | |
773 | U16 topword; /* longest accepted word */ | |
e822a8b4 DM |
774 | } trie; |
775 | ||
fae667d5 YO |
776 | /* special types - these members are used to store state for special |
777 | regops like eval, if/then, lookaround and the markpoint state */ | |
e822a8b4 | 778 | struct { |
77cb431f DM |
779 | /* this first element must match u.yes */ |
780 | struct regmatch_state *prev_yes_state; | |
faec1544 | 781 | struct regmatch_state *prev_curlyx; |
d1c49ad5 | 782 | struct regmatch_state *prev_eval; |
288b8c02 | 783 | REGEXP *prev_rex; |
aa283a38 DM |
784 | CHECKPOINT cp; /* remember current savestack indexes */ |
785 | CHECKPOINT lastcp; | |
24be3102 | 786 | U32 close_paren; /* which close bracket is our end (+1) */ |
1b5c067c | 787 | regnode *B; /* the node following us */ |
ba6840fb | 788 | char *prev_recurse_locinput; |
e822a8b4 DM |
789 | } eval; |
790 | ||
791 | struct { | |
c476f425 | 792 | /* this first element must match u.yes */ |
262b90c4 | 793 | struct regmatch_state *prev_yes_state; |
fae667d5 YO |
794 | I32 wanted; |
795 | I32 logical; /* saved copy of 'logical' var */ | |
796 | regnode *me; /* the IFMATCH/SUSPEND/UNLESSM node */ | |
797 | } ifmatch; /* and SUSPEND/UNLESSM */ | |
798 | ||
799 | struct { | |
800 | /* this first element must match u.yes */ | |
801 | struct regmatch_state *prev_yes_state; | |
802 | struct regmatch_state *prev_mark; | |
803 | SV* mark_name; | |
804 | char *mark_loc; | |
805 | } mark; | |
806 | ||
807 | struct { | |
808 | int val; | |
809 | } keeper; | |
810 | ||
811 | /* quantifiers - these members are used for storing state for | |
812 | for the regops used to implement quantifiers */ | |
813 | struct { | |
814 | /* this first element must match u.yes */ | |
815 | struct regmatch_state *prev_yes_state; | |
c476f425 | 816 | struct regmatch_state *prev_curlyx; /* previous cur_curlyx */ |
d02d6d97 DM |
817 | regnode *me; /* the CURLYX node */ |
818 | regnode *B; /* the B node in /A*B/ */ | |
c476f425 DM |
819 | CHECKPOINT cp; /* remember current savestack index */ |
820 | bool minmod; | |
a0374537 | 821 | int parenfloor;/* how far back to strip paren data */ |
c476f425 DM |
822 | |
823 | /* these two are modified by WHILEM */ | |
824 | int count; /* how many instances of A we've matched */ | |
825 | char *lastloc;/* where previous A matched (0-len detect) */ | |
e822a8b4 DM |
826 | } curlyx; |
827 | ||
828 | struct { | |
c476f425 | 829 | /* this first element must match u.yes */ |
262b90c4 | 830 | struct regmatch_state *prev_yes_state; |
c476f425 DM |
831 | struct regmatch_state *save_curlyx; |
832 | CHECKPOINT cp; /* remember current savestack indexes */ | |
833 | CHECKPOINT lastcp; | |
834 | char *save_lastloc; /* previous curlyx.lastloc */ | |
835 | I32 cache_offset; | |
836 | I32 cache_mask; | |
e822a8b4 DM |
837 | } whilem; |
838 | ||
839 | struct { | |
5d458dd8 YO |
840 | /* this first element must match u.yes */ |
841 | struct regmatch_state *prev_yes_state; | |
79a2a0e8 | 842 | int c1, c2; /* case fold search */ |
40a82448 | 843 | CHECKPOINT cp; |
f6033a9d DM |
844 | U32 lastparen; |
845 | U32 lastcloseparen; | |
40a82448 DM |
846 | I32 alen; /* length of first-matched A string */ |
847 | I32 count; | |
0cadcf80 | 848 | bool minmod; |
40a82448 DM |
849 | regnode *A, *B; /* the nodes corresponding to /A*B/ */ |
850 | regnode *me; /* the curlym node */ | |
79a2a0e8 KW |
851 | U8 c1_utf8[UTF8_MAXBYTES+1]; /* */ |
852 | U8 c2_utf8[UTF8_MAXBYTES+1]; | |
e822a8b4 DM |
853 | } curlym; |
854 | ||
855 | struct { | |
3b6647e0 | 856 | U32 paren; |
c255a977 | 857 | CHECKPOINT cp; |
f6033a9d DM |
858 | U32 lastparen; |
859 | U32 lastcloseparen; | |
79a2a0e8 | 860 | int c1, c2; /* case fold search */ |
c255a977 DM |
861 | char *maxpos; /* highest possible point in string to match */ |
862 | char *oldloc; /* the previous locinput */ | |
e822a8b4 | 863 | int count; |
c255a977 DM |
864 | int min, max; /* {m,n} */ |
865 | regnode *A, *B; /* the nodes corresponding to /A*B/ */ | |
79a2a0e8 KW |
866 | U8 c1_utf8[UTF8_MAXBYTES+1]; /* */ |
867 | U8 c2_utf8[UTF8_MAXBYTES+1]; | |
c255a977 | 868 | } curly; /* and CURLYN/PLUS/STAR */ |
dad79028 | 869 | |
d8319b27 | 870 | } u; |
5d9a96ca DM |
871 | } regmatch_state; |
872 | ||
ce12e254 | 873 | |
d5a00e4a | 874 | |
5d9a96ca DM |
875 | /* how many regmatch_state structs to allocate as a single slab. |
876 | * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev | |
877 | * pointers, plus 1 for any mythical malloc overhead. */ | |
878 | ||
879 | #define PERL_REGMATCH_SLAB_SLOTS \ | |
880 | ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state)) | |
881 | ||
882 | typedef struct regmatch_slab { | |
883 | regmatch_state states[PERL_REGMATCH_SLAB_SLOTS]; | |
884 | struct regmatch_slab *prev, *next; | |
885 | } regmatch_slab; | |
1ade1aa1 | 886 | |
46ab3289 | 887 | |
cde0cee5 | 888 | |
1ade1aa1 | 889 | /* |
14d04a33 | 890 | * ex: set ts=8 sts=4 sw=4 et: |
1ade1aa1 | 891 | */ |