Update perldelta_template.pod to include an "Errata From Previous Releases" section
[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     SSize_t min_offset;
40     SSize_t max_offset;
41     SV *substr;         /* non-utf8 variant */
42     SV *utf8_substr;    /* utf8 variant */
43     SSize_t 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     SSize_t start;
59     SSize_t 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     SSize_t 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         SSize_t minlen; /* mininum possible number of chars in string to match */\
108         SSize_t minlenret; /* mininum possible number of chars in $& */         \
109         STRLEN 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         SSize_t sublen; /* Length of string pointed by subbeg */        \
128         SSize_t suboffset; /* byte offset of subbeg from logical start of str */ \
129         SSize_t 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         /* original flags used to compile the pattern, may differ */    \
134         /* from extflags in various ways */                             \
135         PERL_BITFIELD32 compflags:9;                                    \
136         CV *qr_anoncv   /* the anon sub wrapped round qr/(?{..})/ */
137
138 typedef struct regexp {
139         _XPV_HEAD;
140         _REGEXP_COMMON;
141 } regexp;
142
143 #define RXp_PAREN_NAMES(rx)     ((rx)->paren_names)
144
145 /* used for high speed searches */
146 typedef struct re_scream_pos_data_s
147 {
148     char **scream_olds;         /* match pos */
149     SSize_t *scream_pos;        /* Internal iterator of scream. */
150 } re_scream_pos_data;
151
152 /* regexp_engine structure. This is the dispatch table for regexes.
153  * Any regex engine implementation must be able to build one of these.
154  */
155 typedef struct regexp_engine {
156     REGEXP* (*comp) (pTHX_ SV * const pattern, U32 flags);
157     I32     (*exec) (pTHX_ REGEXP * const rx, char* stringarg, char* strend,
158                      char* strbeg, SSize_t minend, SV* sv,
159                      void* data, U32 flags);
160     char*   (*intuit) (pTHX_
161                         REGEXP * const rx,
162                         SV *sv,
163                         const char * const strbeg,
164                         char *strpos,
165                         char *strend,
166                         const U32 flags,
167                        re_scream_pos_data *data);
168     SV*     (*checkstr) (pTHX_ REGEXP * const rx);
169     void    (*free) (pTHX_ REGEXP * const rx);
170     void    (*numbered_buff_FETCH) (pTHX_ REGEXP * const rx, const I32 paren,
171                                     SV * const sv);
172     void    (*numbered_buff_STORE) (pTHX_ REGEXP * const rx, const I32 paren,
173                                    SV const * const value);
174     I32     (*numbered_buff_LENGTH) (pTHX_ REGEXP * const rx, const SV * const sv,
175                                     const I32 paren);
176     SV*     (*named_buff) (pTHX_ REGEXP * const rx, SV * const key,
177                            SV * const value, const U32 flags);
178     SV*     (*named_buff_iter) (pTHX_ REGEXP * const rx, const SV * const lastkey,
179                                 const U32 flags);
180     SV*     (*qr_package)(pTHX_ REGEXP * const rx);
181 #ifdef USE_ITHREADS
182     void*   (*dupe) (pTHX_ REGEXP * const rx, CLONE_PARAMS *param);
183 #endif
184     REGEXP* (*op_comp) (pTHX_ SV ** const patternp, int pat_count,
185                     OP *expr, const struct regexp_engine* eng,
186                     REGEXP *VOL old_re,
187                     bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags);
188 } regexp_engine;
189
190 /*
191   These are passed to the numbered capture variable callbacks as the
192   paren name. >= 1 is reserved for actual numbered captures, i.e. $1,
193   $2 etc.
194 */
195 #define RX_BUFF_IDX_CARET_PREMATCH  -5 /* ${^PREMATCH}  */
196 #define RX_BUFF_IDX_CARET_POSTMATCH -4 /* ${^POSTMATCH} */
197 #define RX_BUFF_IDX_CARET_FULLMATCH -3 /* ${^MATCH}     */
198 #define RX_BUFF_IDX_PREMATCH        -2 /* $` */
199 #define RX_BUFF_IDX_POSTMATCH       -1 /* $' */
200 #define RX_BUFF_IDX_FULLMATCH        0 /* $& */
201
202 /*
203   Flags that are passed to the named_buff and named_buff_iter
204   callbacks above. Those routines are called from universal.c via the
205   Tie::Hash::NamedCapture interface for %+ and %- and the re::
206   functions in the same file.
207 */
208
209 /* The Tie::Hash::NamedCapture operation this is part of, if any */
210 #define RXapif_FETCH     0x0001
211 #define RXapif_STORE     0x0002
212 #define RXapif_DELETE    0x0004
213 #define RXapif_CLEAR     0x0008
214 #define RXapif_EXISTS    0x0010
215 #define RXapif_SCALAR    0x0020
216 #define RXapif_FIRSTKEY  0x0040
217 #define RXapif_NEXTKEY   0x0080
218
219 /* Whether %+ or %- is being operated on */
220 #define RXapif_ONE       0x0100 /* %+ */
221 #define RXapif_ALL       0x0200 /* %- */
222
223 /* Whether this is being called from a re:: function */
224 #define RXapif_REGNAME         0x0400
225 #define RXapif_REGNAMES        0x0800
226 #define RXapif_REGNAMES_COUNT  0x1000
227
228 /*
229 =head1 REGEXP Functions
230
231 =for apidoc Am|REGEXP *|SvRX|SV *sv
232
233 Convenience macro to get the REGEXP from a SV.  This is approximately
234 equivalent to the following snippet:
235
236     if (SvMAGICAL(sv))
237         mg_get(sv);
238     if (SvROK(sv))
239         sv = MUTABLE_SV(SvRV(sv));
240     if (SvTYPE(sv) == SVt_REGEXP)
241         return (REGEXP*) sv;
242
243 NULL will be returned if a REGEXP* is not found.
244
245 =for apidoc Am|bool|SvRXOK|SV* sv
246
247 Returns a boolean indicating whether the SV (or the one it references)
248 is a REGEXP.
249
250 If you want to do something with the REGEXP* later use SvRX instead
251 and check for NULL.
252
253 =cut
254 */
255
256 #define SvRX(sv)   (Perl_get_re_arg(aTHX_ sv))
257 #define SvRXOK(sv) (Perl_get_re_arg(aTHX_ sv) ? TRUE : FALSE)
258
259
260 /* Flags stored in regexp->extflags
261  * These are used by code external to the regexp engine
262  *
263  * Note that the flags whose names start with RXf_PMf_ are defined in
264  * op_reg_common.h, being copied from the parallel flags of op_pmflags
265  *
266  * NOTE: if you modify any RXf flags you should run regen.pl or
267  * regen/regcomp.pl so that regnodes.h is updated with the changes.
268  *
269  */
270
271 #include "op_reg_common.h"
272
273 #define RXf_PMf_STD_PMMOD       (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_FOLD|RXf_PMf_EXTENDED)
274
275 #define CASE_STD_PMMOD_FLAGS_PARSE_SET(pmfl)                        \
276     case IGNORE_PAT_MOD:    *(pmfl) |= RXf_PMf_FOLD;       break;   \
277     case MULTILINE_PAT_MOD: *(pmfl) |= RXf_PMf_MULTILINE;  break;   \
278     case SINGLE_PAT_MOD:    *(pmfl) |= RXf_PMf_SINGLELINE; break;   \
279     case XTENDED_PAT_MOD:   *(pmfl) |= RXf_PMf_EXTENDED;   break
280
281 /* Note, includes charset ones, assumes 0 is the default for them */
282 #define STD_PMMOD_FLAGS_CLEAR(pmfl)                        \
283     *(pmfl) &= ~(RXf_PMf_FOLD|RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_EXTENDED|RXf_PMf_CHARSET)
284
285 /* chars and strings used as regex pattern modifiers
286  * Singular is a 'c'har, plural is a "string"
287  *
288  * NOTE, KEEPCOPY was originally 'k', but was changed to 'p' for preserve
289  * for compatibility reasons with Regexp::Common which highjacked (?k:...)
290  * for its own uses. So 'k' is out as well.
291  */
292 #define DEFAULT_PAT_MOD      '^'    /* Short for all the default modifiers */
293 #define EXEC_PAT_MOD         'e'
294 #define KEEPCOPY_PAT_MOD     'p'
295 #define ONCE_PAT_MOD         'o'
296 #define GLOBAL_PAT_MOD       'g'
297 #define CONTINUE_PAT_MOD     'c'
298 #define MULTILINE_PAT_MOD    'm'
299 #define SINGLE_PAT_MOD       's'
300 #define IGNORE_PAT_MOD       'i'
301 #define XTENDED_PAT_MOD      'x'
302 #define NONDESTRUCT_PAT_MOD  'r'
303 #define LOCALE_PAT_MOD       'l'
304 #define UNICODE_PAT_MOD      'u'
305 #define DEPENDS_PAT_MOD      'd'
306 #define ASCII_RESTRICT_PAT_MOD 'a'
307
308 #define ONCE_PAT_MODS        "o"
309 #define KEEPCOPY_PAT_MODS    "p"
310 #define EXEC_PAT_MODS        "e"
311 #define LOOP_PAT_MODS        "gc"
312 #define NONDESTRUCT_PAT_MODS "r"
313 #define LOCALE_PAT_MODS      "l"
314 #define UNICODE_PAT_MODS     "u"
315 #define DEPENDS_PAT_MODS     "d"
316 #define ASCII_RESTRICT_PAT_MODS "a"
317 #define ASCII_MORE_RESTRICT_PAT_MODS "aa"
318
319 /* This string is expected by regcomp.c to be ordered so that the first
320  * character is the flag in bit RXf_PMf_STD_PMMOD_SHIFT of extflags; the next
321  * character is bit +1, etc. */
322 #define STD_PAT_MODS        "msix"
323
324 #define CHARSET_PAT_MODS    ASCII_RESTRICT_PAT_MODS DEPENDS_PAT_MODS LOCALE_PAT_MODS UNICODE_PAT_MODS
325
326 /* This string is expected by XS_re_regexp_pattern() in universal.c to be ordered
327  * so that the first character is the flag in bit RXf_PMf_STD_PMMOD_SHIFT of
328  * extflags; the next character is in bit +1, etc. */
329 #define INT_PAT_MODS    STD_PAT_MODS    KEEPCOPY_PAT_MODS
330
331 #define EXT_PAT_MODS    ONCE_PAT_MODS   KEEPCOPY_PAT_MODS
332 #define QR_PAT_MODS     STD_PAT_MODS    EXT_PAT_MODS       CHARSET_PAT_MODS
333 #define M_PAT_MODS      QR_PAT_MODS     LOOP_PAT_MODS
334 #define S_PAT_MODS      M_PAT_MODS      EXEC_PAT_MODS      NONDESTRUCT_PAT_MODS
335
336 /*
337  * NOTE: if you modify any RXf flags you should run regen.pl or
338  * regen/regcomp.pl so that regnodes.h is updated with the changes.
339  *
340  */
341
342 /* Leave some space, so future bit allocations can go either in the shared or
343  * unshared area without affecting binary compatibility */
344 #define RXf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT)
345
346 /*
347   Set in Perl_pmruntime if op_flags & OPf_SPECIAL, i.e. split. Will
348   be used by regex engines to check whether they should set
349   RXf_SKIPWHITE
350 */
351 #define RXf_SPLIT                (1<<(RXf_BASE_SHIFT-1))
352 #if RXf_SPLIT != RXf_PMf_SPLIT
353 #   error "RXf_SPLIT does not match RXf_PMf_SPLIT"
354 #endif
355
356 /* Manually decorate this function with gcc-style attributes just to
357  * avoid having to restructure the header files and their called order,
358  * as proto.h would have to be included before this file, and isn't */
359
360 PERL_STATIC_INLINE const char *
361 get_regex_charset_name(const U32 flags, STRLEN* const lenp)
362     __attribute__warn_unused_result__;
363
364 #define MAX_CHARSET_NAME_LENGTH 2
365
366 PERL_STATIC_INLINE const char *
367 get_regex_charset_name(const U32 flags, STRLEN* const lenp)
368 {
369     /* Returns a string that corresponds to the name of the regex character set
370      * given by 'flags', and *lenp is set the length of that string, which
371      * cannot exceed MAX_CHARSET_NAME_LENGTH characters */
372
373     *lenp = 1;
374     switch (get_regex_charset(flags)) {
375         case REGEX_DEPENDS_CHARSET: return DEPENDS_PAT_MODS;
376         case REGEX_LOCALE_CHARSET:  return LOCALE_PAT_MODS;
377         case REGEX_UNICODE_CHARSET: return UNICODE_PAT_MODS;
378         case REGEX_ASCII_RESTRICTED_CHARSET: return ASCII_RESTRICT_PAT_MODS;
379         case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
380             *lenp = 2;
381             return ASCII_MORE_RESTRICT_PAT_MODS;
382         default:
383             return "?";     /* Unknown */
384     }
385 }
386
387 /* Do we have some sort of anchor? */
388 #define RXf_IS_ANCHORED         (1<<(RXf_BASE_SHIFT+0))
389 #define RXf_UNUSED1             (1<<(RXf_BASE_SHIFT+1))
390 #define RXf_UNUSED2             (1<<(RXf_BASE_SHIFT+2))
391 #define RXf_UNUSED3             (1<<(RXf_BASE_SHIFT+3))
392 #define RXf_UNUSED4             (1<<(RXf_BASE_SHIFT+4))
393 #define RXf_UNUSED5             (1<<(RXf_BASE_SHIFT+5))
394
395 /* What we have seen */
396 #define RXf_NO_INPLACE_SUBST    (1<<(RXf_BASE_SHIFT+6))
397 #define RXf_EVAL_SEEN           (1<<(RXf_BASE_SHIFT+7))
398 #define RXf_UNUSED8             (1<<(RXf_BASE_SHIFT+8))
399
400 /* Special */
401 #define RXf_UNUSED9             (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)) /* $1 etc are utf8 */
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 /* Copy and tainted info */
414 #define RXf_COPY_DONE           (1<<(RXf_BASE_SHIFT+16))
415
416 /* during execution: pattern temporarily tainted by executing locale ops;
417  * post-execution: $1 et al are tainted */
418 #define RXf_TAINTED_SEEN        (1<<(RXf_BASE_SHIFT+17))
419 /* this pattern was tainted during compilation */
420 #define RXf_TAINTED             (1<<(RXf_BASE_SHIFT+18))
421
422 /* Flags indicating special patterns */
423 #define RXf_START_ONLY          (1<<(RXf_BASE_SHIFT+19)) /* Pattern is /^/ */
424 #define RXf_SKIPWHITE                (1<<(RXf_BASE_SHIFT+20)) /* Pattern is for a split " " */
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 #define RXp_COMPFLAGS(rx)        ((rx)->compflags)
472
473 /* For source compatibility. We used to store these explicitly.  */
474 #define RX_PRECOMP(prog)        (RX_WRAPPED(prog) + ReANY(prog)->pre_prefix)
475 #define RX_PRECOMP_const(prog)  (RX_WRAPPED_const(prog) + ReANY(prog)->pre_prefix)
476 /* FIXME? Are we hardcoding too much here and constraining plugin extension
477    writers? Specifically, the value 1 assumes that the wrapped version always
478    has exactly one character at the end, a ')'. Will that always be true?  */
479 #define RX_PRELEN(prog)         (RX_WRAPLEN(prog) - ReANY(prog)->pre_prefix - 1)
480 #define RX_WRAPPED(prog)        ReANY(prog)->xpv_len_u.xpvlenu_pv
481 #define RX_WRAPPED_const(prog)  ((const char *)RX_WRAPPED(prog))
482 #define RX_WRAPLEN(prog)        SvCUR(prog)
483 #define RX_CHECK_SUBSTR(prog)   (ReANY(prog)->check_substr)
484 #define RX_REFCNT(prog)         SvREFCNT(prog)
485 #define RX_EXTFLAGS(prog)       RXp_EXTFLAGS(ReANY(prog))
486 #define RX_COMPFLAGS(prog)        RXp_COMPFLAGS(ReANY(prog))
487 #define RX_ENGINE(prog)         (ReANY(prog)->engine)
488 #define RX_SUBBEG(prog)         (ReANY(prog)->subbeg)
489 #define RX_SUBOFFSET(prog)      (ReANY(prog)->suboffset)
490 #define RX_SUBCOFFSET(prog)     (ReANY(prog)->subcoffset)
491 #define RX_OFFS(prog)           (ReANY(prog)->offs)
492 #define RX_NPARENS(prog)        (ReANY(prog)->nparens)
493 #define RX_SUBLEN(prog)         (ReANY(prog)->sublen)
494 #define RX_MINLEN(prog)         (ReANY(prog)->minlen)
495 #define RX_MINLENRET(prog)      (ReANY(prog)->minlenret)
496 #define RX_GOFS(prog)           (ReANY(prog)->gofs)
497 #define RX_LASTPAREN(prog)      (ReANY(prog)->lastparen)
498 #define RX_LASTCLOSEPAREN(prog) (ReANY(prog)->lastcloseparen)
499 #define RX_SAVED_COPY(prog)     (ReANY(prog)->saved_copy)
500 /* last match was zero-length */
501 #define RX_ZERO_LEN(prog) \
502         (RX_OFFS(prog)[0].start + (SSize_t)RX_GOFS(prog) \
503           == RX_OFFS(prog)[0].end)
504
505 #endif /* PLUGGABLE_RE_EXTENSION */
506
507 /* Stuff that needs to be included in the pluggable extension goes below here */
508
509 #ifdef PERL_ANY_COW
510 #define RX_MATCH_COPY_FREE(rx) \
511         STMT_START {if (RX_SAVED_COPY(rx)) { \
512             SV_CHECK_THINKFIRST_COW_DROP(RX_SAVED_COPY(rx)); \
513         } \
514         if (RX_MATCH_COPIED(rx)) { \
515             Safefree(RX_SUBBEG(rx)); \
516             RX_MATCH_COPIED_off(rx); \
517         }} STMT_END
518 #else
519 #define RX_MATCH_COPY_FREE(rx) \
520         STMT_START {if (RX_MATCH_COPIED(rx)) { \
521             Safefree(RX_SUBBEG(rx)); \
522             RX_MATCH_COPIED_off(rx); \
523         }} STMT_END
524 #endif
525
526 #define RXp_MATCH_UTF8(prog)            (RXp_EXTFLAGS(prog) & RXf_MATCH_UTF8)
527 #define RX_MATCH_UTF8(prog)             (RX_EXTFLAGS(prog) & RXf_MATCH_UTF8)
528 #define RX_MATCH_UTF8_on(prog)          (RX_EXTFLAGS(prog) |= RXf_MATCH_UTF8)
529 #define RX_MATCH_UTF8_off(prog)         (RX_EXTFLAGS(prog) &= ~RXf_MATCH_UTF8)
530 #define RX_MATCH_UTF8_set(prog, t)      ((t) \
531                         ? RX_MATCH_UTF8_on(prog) \
532                         : RX_MATCH_UTF8_off(prog))
533
534 /* Whether the pattern stored at RX_WRAPPED is in UTF-8  */
535 #define RX_UTF8(prog)                   SvUTF8(prog)
536
537
538 /* bits in flags arg of Perl_regexec_flags() */
539
540 #define REXEC_COPY_STR  0x01    /* Need to copy the string for captures. */
541 #define REXEC_CHECKED   0x02    /* re_intuit_start() already called. */
542 #define REXEC_SCREAM    0x04    /* currently unused. */
543 #define REXEC_IGNOREPOS 0x08    /* use stringarg, not pos(), for \G match */
544 #define REXEC_NOT_FIRST 0x10    /* This is another iteration of //g:
545                                    no need to copy string again */
546
547                                      /* under REXEC_COPY_STR, it's ok for the
548                                         engine (modulo PL_sawamperand etc)
549                                         to skip copying: ... */
550 #define REXEC_COPY_SKIP_PRE  0x20    /* ...the $` part of the string, or */
551 #define REXEC_COPY_SKIP_POST 0x40    /* ...the $' part of the string */
552 #define REXEC_FAIL_ON_UNDERFLOW 0x80 /* fail the match if $& would start before
553                                         the start pos (so s/.\G// would fail
554                                         on second iteration */
555
556 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
557 #  define ReREFCNT_inc(re)                                              \
558     ({                                                                  \
559         /* This is here to generate a casting warning if incorrect.  */ \
560         REGEXP *const _rerefcnt_inc = (re);                             \
561         assert(SvTYPE(_rerefcnt_inc) == SVt_REGEXP);                    \
562         SvREFCNT_inc(_rerefcnt_inc);                                    \
563         _rerefcnt_inc;                                                  \
564     })
565 #  define ReREFCNT_dec(re)                                              \
566     ({                                                                  \
567         /* This is here to generate a casting warning if incorrect.  */ \
568         REGEXP *const _rerefcnt_dec = (re);                             \
569         SvREFCNT_dec(_rerefcnt_dec);                                    \
570     })
571 #else
572 #  define ReREFCNT_dec(re)      SvREFCNT_dec(re)
573 #  define ReREFCNT_inc(re)      ((REGEXP *) SvREFCNT_inc(re))
574 #endif
575 #define ReANY(re)               S_ReANY((const REGEXP *)(re))
576
577 /* FIXME for plugins. */
578
579 #define FBMcf_TAIL_DOLLAR       1
580 #define FBMcf_TAIL_DOLLARM      2
581 #define FBMcf_TAIL_Z            4
582 #define FBMcf_TAIL_z            8
583 #define FBMcf_TAIL              (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)
584
585 #define FBMrf_MULTILINE 1
586
587 struct regmatch_state;
588 struct regmatch_slab;
589
590 /* like regmatch_info_aux, but contains extra fields only needed if the
591  * pattern contains (?{}). If used, is snuck into the second slot in the
592  * regmatch_state stack at the start of execution */
593
594 typedef struct {
595     regexp *rex;
596     PMOP    *curpm;     /* saved PL_curpm */
597 #ifdef PERL_ANY_COW
598     SV      *saved_copy; /* saved saved_copy field from rex */
599 #endif
600     char    *subbeg;    /* saved subbeg     field from rex */
601     STRLEN  sublen;     /* saved sublen     field from rex */
602     STRLEN  suboffset;  /* saved suboffset  field from rex */
603     STRLEN  subcoffset; /* saved subcoffset field from rex */
604     MAGIC   *pos_magic; /* pos() magic attached to $_ */
605     SSize_t pos;        /* the original value of pos() in pos_magic */
606     U8      pos_flags;  /* flags to be restored; currently only MGf_BYTES*/
607 } regmatch_info_aux_eval;
608
609
610 /* fields that logically  live in regmatch_info, but which need cleaning
611  * up on croak(), and so are instead are snuck into the first slot in
612  * the regmatch_state stack at the start of execution */
613
614 typedef struct {
615     regmatch_info_aux_eval *info_aux_eval;
616     struct regmatch_state *old_regmatch_state; /* saved PL_regmatch_state */
617     struct regmatch_slab  *old_regmatch_slab;  /* saved PL_regmatch_slab */
618     char *poscache;     /* S-L cache of fail positions of WHILEMs */
619 } regmatch_info_aux;
620
621
622 /* some basic information about the current match that is created by
623  * Perl_regexec_flags and then passed to regtry(), regmatch() etc.
624  * It is allocated as a local var on the stack, so nothing should be
625  * stored in it that needs preserving or clearing up on croak().
626  * For that, see the aux_info and aux_info_eval members of the
627  * regmatch_state union. */
628
629 typedef struct {
630     REGEXP *prog;        /* the regex being executed */
631     const char * strbeg; /* real start of string */
632     char *strend;        /* one byte beyond last char of match string */
633     char *till;          /* matches shorter than this fail (see minlen arg) */
634     SV *sv;              /* the SV string currently being matched */
635     char *ganch;         /* position of \G anchor */
636     char *cutpoint;      /* (*COMMIT) position (if any) */
637     regmatch_info_aux      *info_aux; /* extra fields that need cleanup */
638     regmatch_info_aux_eval *info_aux_eval; /* extra saved state for (?{}) */
639     I32  poscache_maxiter; /* how many whilems todo before S-L cache kicks in */
640     I32  poscache_iter;    /* current countdown from _maxiter to zero */
641     STRLEN poscache_size;  /* size of regmatch_info_aux.poscache */
642     bool intuit;    /* re_intuit_start() is the top-level caller */
643     bool is_utf8_pat;    /* regex is utf8 */
644     bool is_utf8_target; /* string being matched is utf8 */
645     bool warned; /* we have issued a recursion warning; no need for more */
646 } regmatch_info;
647  
648
649 /* structures for holding and saving the state maintained by regmatch() */
650
651 #ifndef MAX_RECURSE_EVAL_NOCHANGE_DEPTH
652 #define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 1000
653 #endif
654
655 typedef I32 CHECKPOINT;
656
657 typedef struct regmatch_state {
658     int resume_state;           /* where to jump to on return */
659     char *locinput;             /* where to backtrack in string on failure */
660
661     union {
662
663         /* the 'info_aux' and 'info_aux_eval' union members are cuckoos in
664          * the nest. They aren't saved backtrack state; rather they
665          * represent one or two extra chunks of data that need allocating
666          * at the start of a match. These fields would logically live in
667          * the regmatch_info struct, except that is allocated on the
668          * C stack, and these fields are all things that require cleanup
669          * after a croak(), when the stack is lost.
670          * As a convenience, we just use the first 1 or 2 regmatch_state
671          * slots to store this info, as we will be allocating a slab of
672          * these anyway. Otherwise we'd have to malloc and then free them,
673          * or allocate them on the save stack (where they will get
674          * realloced if the save stack grows).
675          * info_aux contains the extra fields that are always needed;
676          * info_aux_eval contains extra fields that only needed if
677          * the pattern contains code blocks
678          * We split them into two separate structs to avoid increasing
679          * the size of the union.
680          */
681
682         regmatch_info_aux info_aux;
683
684         regmatch_info_aux_eval info_aux_eval;
685
686         /* this is a fake union member that matches the first element
687          * of each member that needs to store positive backtrack
688          * information */
689         struct {
690             struct regmatch_state *prev_yes_state;
691         } yes;
692
693         /* branchlike members */
694         /* this is a fake union member that matches the first elements
695          * of each member that needs to behave like a branch */
696         struct {
697             /* this first element must match u.yes */
698             struct regmatch_state *prev_yes_state;
699             U32 lastparen;
700             U32 lastcloseparen;
701             CHECKPOINT cp;
702             
703         } branchlike;
704                     
705         struct {
706             /* the first elements must match u.branchlike */
707             struct regmatch_state *prev_yes_state;
708             U32 lastparen;
709             U32 lastcloseparen;
710             CHECKPOINT cp;
711             
712             regnode *next_branch; /* next branch node */
713         } branch;
714
715         struct {
716             /* the first elements must match u.branchlike */
717             struct regmatch_state *prev_yes_state;
718             U32 lastparen;
719             U32 lastcloseparen;
720             CHECKPOINT cp;
721
722             U32         accepted; /* how many accepting states left */
723             bool        longfold;/* saw a fold with a 1->n char mapping */
724             U16         *jump;  /* positive offsets from me */
725             regnode     *me;    /* Which node am I - needed for jump tries*/
726             U8          *firstpos;/* pos in string of first trie match */
727             U32         firstchars;/* len in chars of firstpos from start */
728             U16         nextword;/* next word to try */
729             U16         topword; /* longest accepted word */
730         } trie;
731
732         /* special types - these members are used to store state for special
733            regops like eval, if/then, lookaround and the markpoint state */
734         struct {
735             /* this first element must match u.yes */
736             struct regmatch_state *prev_yes_state;
737             struct regmatch_state *prev_eval;
738             struct regmatch_state *prev_curlyx;
739             REGEXP      *prev_rex;
740             CHECKPOINT  cp;     /* remember current savestack indexes */
741             CHECKPOINT  lastcp;
742             U32        close_paren; /* which close bracket is our end */
743             regnode     *B;     /* the node following us  */
744         } eval;
745
746         struct {
747             /* this first element must match u.yes */
748             struct regmatch_state *prev_yes_state;
749             I32 wanted;
750             I32 logical;        /* saved copy of 'logical' var */
751             regnode  *me; /* the IFMATCH/SUSPEND/UNLESSM node  */
752         } ifmatch; /* and SUSPEND/UNLESSM */
753         
754         struct {
755             /* this first element must match u.yes */
756             struct regmatch_state *prev_yes_state;
757             struct regmatch_state *prev_mark;
758             SV* mark_name;
759             char *mark_loc;
760         } mark;
761         
762         struct {
763             int val;
764         } keeper;
765
766         /* quantifiers - these members are used for storing state for
767            for the regops used to implement quantifiers */
768         struct {
769             /* this first element must match u.yes */
770             struct regmatch_state *prev_yes_state;
771             struct regmatch_state *prev_curlyx; /* previous cur_curlyx */
772             regnode     *me;    /* the CURLYX node  */
773             regnode     *B;     /* the B node in /A*B/  */
774             CHECKPOINT  cp;     /* remember current savestack index */
775             bool        minmod;
776             int         parenfloor;/* how far back to strip paren data */
777
778             /* these two are modified by WHILEM */
779             int         count;  /* how many instances of A we've matched */
780             char        *lastloc;/* where previous A matched (0-len detect) */
781         } curlyx;
782
783         struct {
784             /* this first element must match u.yes */
785             struct regmatch_state *prev_yes_state;
786             struct regmatch_state *save_curlyx;
787             CHECKPOINT  cp;     /* remember current savestack indexes */
788             CHECKPOINT  lastcp;
789             char        *save_lastloc;  /* previous curlyx.lastloc */
790             I32         cache_offset;
791             I32         cache_mask;
792         } whilem;
793
794         struct {
795             /* this first element must match u.yes */
796             struct regmatch_state *prev_yes_state;
797             int c1, c2;         /* case fold search */
798             CHECKPOINT cp;
799             U32 lastparen;
800             U32 lastcloseparen;
801             I32 alen;           /* length of first-matched A string */
802             I32 count;
803             bool minmod;
804             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
805             regnode *me;        /* the curlym node */
806             U8 c1_utf8[UTF8_MAXBYTES+1];  /* */
807             U8 c2_utf8[UTF8_MAXBYTES+1];
808         } curlym;
809
810         struct {
811             U32 paren;
812             CHECKPOINT cp;
813             U32 lastparen;
814             U32 lastcloseparen;
815             int c1, c2;         /* case fold search */
816             char *maxpos;       /* highest possible point in string to match */
817             char *oldloc;       /* the previous locinput */
818             int count;
819             int min, max;       /* {m,n} */
820             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
821             U8 c1_utf8[UTF8_MAXBYTES+1];  /* */
822             U8 c2_utf8[UTF8_MAXBYTES+1];
823         } curly; /* and CURLYN/PLUS/STAR */
824
825     } u;
826 } regmatch_state;
827
828 /* how many regmatch_state structs to allocate as a single slab.
829  * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
830  * pointers, plus 1 for any mythical malloc overhead. */
831  
832 #define PERL_REGMATCH_SLAB_SLOTS \
833     ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
834
835 typedef struct regmatch_slab {
836     regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
837     struct regmatch_slab *prev, *next;
838 } regmatch_slab;
839
840
841
842 /*
843  * Local variables:
844  * c-indentation-style: bsd
845  * c-basic-offset: 4
846  * indent-tabs-mode: nil
847  * End:
848  *
849  * ex: set ts=8 sts=4 sw=4 et:
850  */