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