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