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