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