Added 5.21.5 release to perlhist
[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; /* min pos (in chars) that substr must appear */
40     SSize_t max_offset  /* max pos (in chars) that substr must appear */;
41     SV *substr;         /* non-utf8 variant */
42     SV *utf8_substr;    /* utf8 variant */
43     SSize_t end_shift;  /* how many fixed chars must end the string */
44 };
45 struct reg_substr_data {
46     U8      check_ix;   /* index into data[] of check substr */
47     struct reg_substr_datum data[3];    /* Actual array */
48 };
49
50 #ifdef PERL_ANY_COW
51 #define SV_SAVED_COPY   SV *saved_copy; /* If non-NULL, SV which is COW from original */
52 #else
53 #define SV_SAVED_COPY
54 #endif
55
56 /* offsets within a string of a particular /(.)/ capture */
57
58 typedef struct regexp_paren_pair {
59     SSize_t start;
60     SSize_t end;
61     /* 'start_tmp' records a new opening position before the matching end
62      * has been found, so that the old start and end values are still
63      * valid, e.g.
64      *    "abc" =~ /(.(?{print "[$1]"}))+/
65      *outputs [][a][b]
66      * This field is not part of the API.  */
67     SSize_t start_tmp;
68 } regexp_paren_pair;
69
70 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_UTF8_C)
71 #define _invlist_union(a, b, output) _invlist_union_maybe_complement_2nd(a, b, FALSE, output)
72 #define _invlist_intersection(a, b, output) _invlist_intersection_maybe_complement_2nd(a, b, FALSE, output)
73
74 /* Subtracting b from a leaves in a everything that was there that isn't in b,
75  * that is the intersection of a with b's complement */
76 #define _invlist_subtract(a, b, output) _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
77 #endif
78
79 /* record the position of a (?{...}) within a pattern */
80
81 struct reg_code_block {
82     STRLEN start;
83     STRLEN end;
84     OP     *block;
85     REGEXP *src_regex;
86 };
87
88
89 /*
90   The regexp/REGEXP struct, see L<perlreapi> for further documentation
91   on the individual fields. The struct is ordered so that the most
92   commonly used fields are placed at the start.
93
94   Any patch that adds items to this struct will need to include
95   changes to F<sv.c> (C<Perl_re_dup()>) and F<regcomp.c>
96   (C<pregfree()>). This involves freeing or cloning items in the
97   regexp's data array based on the data item's type.
98 */
99
100 #define _REGEXP_COMMON                                                  \
101         /* what engine created this regexp? */                          \
102         const struct regexp_engine* engine;                             \
103         REGEXP *mother_re; /* what re is this a lightweight copy of? */ \
104         HV *paren_names;   /* Optional hash of paren names */           \
105         /* Information about the match that the perl core uses to */    \
106         /* manage things */                                             \
107         U32 extflags;   /* Flags used both externally and internally */ \
108         SSize_t minlen; /* mininum possible number of chars in string to match */\
109         SSize_t minlenret; /* mininum possible number of chars in $& */         \
110         STRLEN gofs;    /* chars left of pos that we search from */     \
111         /* substring data about strings that must appear in the */      \
112         /* final match, used for optimisations */                       \
113         struct reg_substr_data *substrs;                                \
114         U32 nparens;    /* number of capture buffers */                 \
115         /* private engine specific data */                              \
116         U32 intflags;   /* Engine Specific Internal flags */            \
117         void *pprivate; /* Data private to the regex engine which */    \
118                         /* created this object. */                      \
119         /* Data about the last/current match. These are modified */     \
120         /* during matching */                                           \
121         U32 lastparen;                  /* last open paren matched */   \
122         U32 lastcloseparen;             /* last close paren matched */  \
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         SSize_t sublen; /* Length of string pointed by subbeg */        \
129         SSize_t suboffset; /* byte offset of subbeg from logical start of str */ \
130         SSize_t subcoffset; /* suboffset equiv, but in chars (for @-/@+) */ \
131         /* Information about the match that isn't often used */         \
132         SSize_t maxlen;        /* mininum possible number of chars in string to match */\
133         /* offset from wrapped to the start of precomp */               \
134         PERL_BITFIELD32 pre_prefix:4;                                   \
135         /* original flags used to compile the pattern, may differ */    \
136         /* from extflags in various ways */                             \
137         PERL_BITFIELD32 compflags:9;                                    \
138         CV *qr_anoncv   /* the anon sub wrapped round qr/(?{..})/ */
139
140 typedef struct regexp {
141         _XPV_HEAD;
142         _REGEXP_COMMON;
143 } regexp;
144
145 #define RXp_PAREN_NAMES(rx)     ((rx)->paren_names)
146
147 /* used for high speed searches */
148 typedef struct re_scream_pos_data_s
149 {
150     char **scream_olds;         /* match pos */
151     SSize_t *scream_pos;        /* Internal iterator of scream. */
152 } re_scream_pos_data;
153
154 /* regexp_engine structure. This is the dispatch table for regexes.
155  * Any regex engine implementation must be able to build one of these.
156  */
157 typedef struct regexp_engine {
158     REGEXP* (*comp) (pTHX_ SV * const pattern, U32 flags);
159     I32     (*exec) (pTHX_ REGEXP * const rx, char* stringarg, char* strend,
160                      char* strbeg, SSize_t minend, SV* sv,
161                      void* data, U32 flags);
162     char*   (*intuit) (pTHX_
163                         REGEXP * const rx,
164                         SV *sv,
165                         const char * const strbeg,
166                         char *strpos,
167                         char *strend,
168                         const U32 flags,
169                        re_scream_pos_data *data);
170     SV*     (*checkstr) (pTHX_ REGEXP * const rx);
171     void    (*free) (pTHX_ REGEXP * const rx);
172     void    (*numbered_buff_FETCH) (pTHX_ REGEXP * const rx, const I32 paren,
173                                     SV * const sv);
174     void    (*numbered_buff_STORE) (pTHX_ REGEXP * const rx, const I32 paren,
175                                    SV const * const value);
176     I32     (*numbered_buff_LENGTH) (pTHX_ REGEXP * const rx, const SV * const sv,
177                                     const I32 paren);
178     SV*     (*named_buff) (pTHX_ REGEXP * const rx, SV * const key,
179                            SV * const value, const U32 flags);
180     SV*     (*named_buff_iter) (pTHX_ REGEXP * const rx, const SV * const lastkey,
181                                 const U32 flags);
182     SV*     (*qr_package)(pTHX_ REGEXP * const rx);
183 #ifdef USE_ITHREADS
184     void*   (*dupe) (pTHX_ REGEXP * const rx, CLONE_PARAMS *param);
185 #endif
186     REGEXP* (*op_comp) (pTHX_ SV ** const patternp, int pat_count,
187                     OP *expr, const struct regexp_engine* eng,
188                     REGEXP *old_re,
189                     bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags);
190 } regexp_engine;
191
192 /*
193   These are passed to the numbered capture variable callbacks as the
194   paren name. >= 1 is reserved for actual numbered captures, i.e. $1,
195   $2 etc.
196 */
197 #define RX_BUFF_IDX_CARET_PREMATCH  -5 /* ${^PREMATCH}  */
198 #define RX_BUFF_IDX_CARET_POSTMATCH -4 /* ${^POSTMATCH} */
199 #define RX_BUFF_IDX_CARET_FULLMATCH -3 /* ${^MATCH}     */
200 #define RX_BUFF_IDX_PREMATCH        -2 /* $` */
201 #define RX_BUFF_IDX_POSTMATCH       -1 /* $' */
202 #define RX_BUFF_IDX_FULLMATCH        0 /* $& */
203
204 /*
205   Flags that are passed to the named_buff and named_buff_iter
206   callbacks above. Those routines are called from universal.c via the
207   Tie::Hash::NamedCapture interface for %+ and %- and the re::
208   functions in the same file.
209 */
210
211 /* The Tie::Hash::NamedCapture operation this is part of, if any */
212 #define RXapif_FETCH     0x0001
213 #define RXapif_STORE     0x0002
214 #define RXapif_DELETE    0x0004
215 #define RXapif_CLEAR     0x0008
216 #define RXapif_EXISTS    0x0010
217 #define RXapif_SCALAR    0x0020
218 #define RXapif_FIRSTKEY  0x0040
219 #define RXapif_NEXTKEY   0x0080
220
221 /* Whether %+ or %- is being operated on */
222 #define RXapif_ONE       0x0100 /* %+ */
223 #define RXapif_ALL       0x0200 /* %- */
224
225 /* Whether this is being called from a re:: function */
226 #define RXapif_REGNAME         0x0400
227 #define RXapif_REGNAMES        0x0800
228 #define RXapif_REGNAMES_COUNT  0x1000
229
230 /*
231 =head1 REGEXP Functions
232
233 =for apidoc Am|REGEXP *|SvRX|SV *sv
234
235 Convenience macro to get the REGEXP from a SV.  This is approximately
236 equivalent to the following snippet:
237
238     if (SvMAGICAL(sv))
239         mg_get(sv);
240     if (SvROK(sv))
241         sv = MUTABLE_SV(SvRV(sv));
242     if (SvTYPE(sv) == SVt_REGEXP)
243         return (REGEXP*) sv;
244
245 NULL will be returned if a REGEXP* is not found.
246
247 =for apidoc Am|bool|SvRXOK|SV* sv
248
249 Returns a boolean indicating whether the SV (or the one it references)
250 is a REGEXP.
251
252 If you want to do something with the REGEXP* later use SvRX instead
253 and check for NULL.
254
255 =cut
256 */
257
258 #define SvRX(sv)   (Perl_get_re_arg(aTHX_ sv))
259 #define SvRXOK(sv) (Perl_get_re_arg(aTHX_ sv) ? TRUE : FALSE)
260
261
262 /* Flags stored in regexp->extflags
263  * These are used by code external to the regexp engine
264  *
265  * Note that the flags whose names start with RXf_PMf_ are defined in
266  * op_reg_common.h, being copied from the parallel flags of op_pmflags
267  *
268  * NOTE: if you modify any RXf flags you should run regen.pl or
269  * regen/regcomp.pl so that regnodes.h is updated with the changes.
270  *
271  */
272
273 #include "op_reg_common.h"
274
275 #define RXf_PMf_STD_PMMOD       (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_FOLD|RXf_PMf_EXTENDED)
276
277 #define CASE_STD_PMMOD_FLAGS_PARSE_SET(pmfl, x_count)                       \
278     case IGNORE_PAT_MOD:    *(pmfl) |= RXf_PMf_FOLD;       break;           \
279     case MULTILINE_PAT_MOD: *(pmfl) |= RXf_PMf_MULTILINE;  break;           \
280     case SINGLE_PAT_MOD:    *(pmfl) |= RXf_PMf_SINGLELINE; break;           \
281     case XTENDED_PAT_MOD:   *(pmfl) |= RXf_PMf_EXTENDED; (x_count)++; break;
282
283 #define STD_PMMOD_FLAGS_PARSE_X_WARN(x_count)                                   \
284     if (UNLIKELY((x_count) > 1)) {                                              \
285         Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),         \
286                     "Having more than one /%c regexp modifier is deprecated",   \
287                     XTENDED_PAT_MOD);                                           \
288     }
289
290 /* Note, includes charset ones, assumes 0 is the default for them */
291 #define STD_PMMOD_FLAGS_CLEAR(pmfl)                        \
292     *(pmfl) &= ~(RXf_PMf_FOLD|RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_EXTENDED|RXf_PMf_CHARSET)
293
294 /* chars and strings used as regex pattern modifiers
295  * Singular is a 'c'har, plural is a "string"
296  *
297  * NOTE, KEEPCOPY was originally 'k', but was changed to 'p' for preserve
298  * for compatibility reasons with Regexp::Common which highjacked (?k:...)
299  * for its own uses. So 'k' is out as well.
300  */
301 #define DEFAULT_PAT_MOD      '^'    /* Short for all the default modifiers */
302 #define EXEC_PAT_MOD         'e'
303 #define KEEPCOPY_PAT_MOD     'p'
304 #define ONCE_PAT_MOD         'o'
305 #define GLOBAL_PAT_MOD       'g'
306 #define CONTINUE_PAT_MOD     'c'
307 #define MULTILINE_PAT_MOD    'm'
308 #define SINGLE_PAT_MOD       's'
309 #define IGNORE_PAT_MOD       'i'
310 #define XTENDED_PAT_MOD      'x'
311 #define NONDESTRUCT_PAT_MOD  'r'
312 #define LOCALE_PAT_MOD       'l'
313 #define UNICODE_PAT_MOD      'u'
314 #define DEPENDS_PAT_MOD      'd'
315 #define ASCII_RESTRICT_PAT_MOD 'a'
316
317 #define ONCE_PAT_MODS        "o"
318 #define KEEPCOPY_PAT_MODS    "p"
319 #define EXEC_PAT_MODS        "e"
320 #define LOOP_PAT_MODS        "gc"
321 #define NONDESTRUCT_PAT_MODS "r"
322 #define LOCALE_PAT_MODS      "l"
323 #define UNICODE_PAT_MODS     "u"
324 #define DEPENDS_PAT_MODS     "d"
325 #define ASCII_RESTRICT_PAT_MODS "a"
326 #define ASCII_MORE_RESTRICT_PAT_MODS "aa"
327
328 /* This string is expected by regcomp.c to be ordered so that the first
329  * character is the flag in bit RXf_PMf_STD_PMMOD_SHIFT of extflags; the next
330  * character is bit +1, etc. */
331 #define STD_PAT_MODS        "msixx"
332
333 #define CHARSET_PAT_MODS    ASCII_RESTRICT_PAT_MODS DEPENDS_PAT_MODS LOCALE_PAT_MODS UNICODE_PAT_MODS
334
335 /* This string is expected by XS_re_regexp_pattern() in universal.c to be ordered
336  * so that the first character is the flag in bit RXf_PMf_STD_PMMOD_SHIFT of
337  * extflags; the next character is in bit +1, etc. */
338 #define INT_PAT_MODS    STD_PAT_MODS    KEEPCOPY_PAT_MODS
339
340 #define EXT_PAT_MODS    ONCE_PAT_MODS   KEEPCOPY_PAT_MODS
341 #define QR_PAT_MODS     STD_PAT_MODS    EXT_PAT_MODS       CHARSET_PAT_MODS
342 #define M_PAT_MODS      QR_PAT_MODS     LOOP_PAT_MODS
343 #define S_PAT_MODS      M_PAT_MODS      EXEC_PAT_MODS      NONDESTRUCT_PAT_MODS
344
345 /*
346  * NOTE: if you modify any RXf flags you should run regen.pl or
347  * regen/regcomp.pl so that regnodes.h is updated with the changes.
348  *
349  */
350
351 /*
352   Set in Perl_pmruntime if op_flags & OPf_SPECIAL, i.e. split. Will
353   be used by regex engines to check whether they should set
354   RXf_SKIPWHITE
355 */
356 #define RXf_SPLIT   RXf_PMf_SPLIT
357
358 /* Currently the regex flags occupy a single 32-bit word.  Not all bits are
359  * currently used.  The lower bits are shared with their corresponding PMf flag
360  * bits, up to but not including _RXf_PMf_SHIFT_NEXT.  The unused bits
361  * immediately follow; finally the used RXf-only (unshared) bits, so that the
362  * highest bit in the word is used.  This gathers all the unused bits as a pool
363  * in the middle, like so: 11111111111111110000001111111111
364  * where the '1's represent used bits, and the '0's unused.  This design allows
365  * us to allocate off one end of the pool if we need to add a shared bit, and
366  * off the other end if we need a non-shared bit, without disturbing the other
367  * bits.  This maximizes the likelihood of being able to change things without
368  * breaking binary compatibility.
369  *
370  * To add shared bits, do so in op_reg_common.h.  This should change
371  * _RXf_PMf_SHIFT_NEXT so that things won't compile.  Then come to regexp.h and
372  * op.h and adjust the constant adders in the definitions of RXf_BASE_SHIFT and
373  * Pmf_BASE_SHIFT down by the number of shared bits you added.  That's it.
374  * Things should be binary compatible.  But if either of these gets to having
375  * to subtract rather than add, leave at 0 and instead adjust all the entries
376  * that are in terms of it.  But if the first one of those is already
377  * RXf_BASE_SHIFT+0, there are no bits left, and a redesign is in order.
378  *
379  * To remove unshared bits, just delete its entry.  If you're where breaking
380  * binary compatibility is ok to do, you might want to adjust things to move
381  * the newly opened space so that it gets absorbed into the common pool.
382  *
383  * To add unshared bits, first use up any gaps in the middle.  Otherwise,
384  * allocate off the low end until you get to RXf_BASE_SHIFT+0.  If that isn't
385  * enough, move RXf_BASE_SHIFT down (if possible) and add the new bit at the
386  * other end instead; this preserves binary compatibility.
387  *
388  * For the regexp bits, PL_reg_extflags_name[] in regnodes.h has a comment
389  * giving which bits are used/unused */
390
391 #define RXf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT + 4)
392
393 /* What we have seen */
394 #define RXf_NO_INPLACE_SUBST    (1U<<(RXf_BASE_SHIFT+2))
395 #define RXf_EVAL_SEEN           (1U<<(RXf_BASE_SHIFT+3))
396
397 /* Special */
398 #define RXf_UNBOUNDED_QUANTIFIER_SEEN   (1U<<(RXf_BASE_SHIFT+4))
399 #define RXf_CHECK_ALL           (1U<<(RXf_BASE_SHIFT+5))
400
401 /* UTF8 related */
402 #define RXf_MATCH_UTF8          (1U<<(RXf_BASE_SHIFT+6)) /* $1 etc are utf8 */
403
404 /* Intuit related */
405 #define RXf_USE_INTUIT_NOML     (1U<<(RXf_BASE_SHIFT+7))
406 #define RXf_USE_INTUIT_ML       (1U<<(RXf_BASE_SHIFT+8))
407 #define RXf_INTUIT_TAIL         (1U<<(RXf_BASE_SHIFT+9))
408 #define RXf_USE_INTUIT          (RXf_USE_INTUIT_NOML|RXf_USE_INTUIT_ML)
409
410 /* Do we have some sort of anchor? */
411 #define RXf_IS_ANCHORED         (1U<<(RXf_BASE_SHIFT+10))
412
413 /* Copy and tainted info */
414 #define RXf_COPY_DONE           (1U<<(RXf_BASE_SHIFT+11))
415
416 /* post-execution: $1 et al are tainted */
417 #define RXf_TAINTED_SEEN        (1U<<(RXf_BASE_SHIFT+12))
418 /* this pattern was tainted during compilation */
419 #define RXf_TAINTED             (1U<<(RXf_BASE_SHIFT+13))
420
421 /* Flags indicating special patterns */
422 #define RXf_START_ONLY          (1U<<(RXf_BASE_SHIFT+14)) /* Pattern is /^/ */
423 #define RXf_SKIPWHITE           (1U<<(RXf_BASE_SHIFT+15)) /* Pattern is for a */
424                                                           /* split " " */
425 #define RXf_WHITE               (1U<<(RXf_BASE_SHIFT+16)) /* Pattern is /\s+/ */
426 #define RXf_NULL                (1U<<(RXf_BASE_SHIFT+17)) /* Pattern is // */
427
428 /* See comments at the beginning of these defines about adding bits.  The
429  * highest bit position should be used, so that if RXf_BASE_SHIFT gets
430  * increased, the #error below will be triggered so that you will be reminded
431  * to adjust things at the other end to keep the bit positions unchanged */
432 #if RXf_BASE_SHIFT+17 > 31
433 #   error Too many RXf_PMf bits used.  See comments at beginning of these for what to do
434 #endif
435
436 /*
437  * NOTE: if you modify any RXf flags you should run regen.pl or
438  * regen/regcomp.pl so that regnodes.h is updated with the changes.
439  *
440  */
441
442 #ifdef NO_TAINT_SUPPORT
443 #   define RX_ISTAINTED(prog)    0
444 #   define RX_TAINT_on(prog)     NOOP
445 #   define RXp_MATCH_TAINTED(prog) 0
446 #   define RX_MATCH_TAINTED(prog)  0
447 #   define RXp_MATCH_TAINTED_on(prog) NOOP
448 #   define RX_MATCH_TAINTED_on(prog)  NOOP
449 #   define RX_MATCH_TAINTED_off(prog) NOOP
450 #else
451 #   define RX_ISTAINTED(prog)    (RX_EXTFLAGS(prog) & RXf_TAINTED)
452 #   define RX_TAINT_on(prog)     (RX_EXTFLAGS(prog) |= RXf_TAINTED)
453 #   define RXp_MATCH_TAINTED(prog)    (RXp_EXTFLAGS(prog) & RXf_TAINTED_SEEN)
454 #   define RX_MATCH_TAINTED(prog)     (RX_EXTFLAGS(prog)  & RXf_TAINTED_SEEN)
455 #   define RXp_MATCH_TAINTED_on(prog) (RXp_EXTFLAGS(prog) |= RXf_TAINTED_SEEN)
456 #   define RX_MATCH_TAINTED_on(prog)  (RX_EXTFLAGS(prog)  |= RXf_TAINTED_SEEN)
457 #   define RX_MATCH_TAINTED_off(prog) (RX_EXTFLAGS(prog)  &= ~RXf_TAINTED_SEEN)
458 #endif
459
460 #define RX_HAS_CUTGROUP(prog) ((prog)->intflags & PREGf_CUTGROUP_SEEN)
461 #define RX_MATCH_TAINTED_set(prog, t) ((t) \
462                                        ? RX_MATCH_TAINTED_on(prog) \
463                                        : RX_MATCH_TAINTED_off(prog))
464
465 #define RXp_MATCH_COPIED(prog)          (RXp_EXTFLAGS(prog) & RXf_COPY_DONE)
466 #define RX_MATCH_COPIED(prog)           (RX_EXTFLAGS(prog) & RXf_COPY_DONE)
467 #define RXp_MATCH_COPIED_on(prog)       (RXp_EXTFLAGS(prog) |= RXf_COPY_DONE)
468 #define RX_MATCH_COPIED_on(prog)        (RX_EXTFLAGS(prog) |= RXf_COPY_DONE)
469 #define RXp_MATCH_COPIED_off(prog)      (RXp_EXTFLAGS(prog) &= ~RXf_COPY_DONE)
470 #define RX_MATCH_COPIED_off(prog)       (RX_EXTFLAGS(prog) &= ~RXf_COPY_DONE)
471 #define RX_MATCH_COPIED_set(prog,t)     ((t) \
472                                          ? RX_MATCH_COPIED_on(prog) \
473                                          : RX_MATCH_COPIED_off(prog))
474
475 #define RXp_EXTFLAGS(rx)        ((rx)->extflags)
476 #define RXp_COMPFLAGS(rx)        ((rx)->compflags)
477
478 /* For source compatibility. We used to store these explicitly.  */
479 #define RX_PRECOMP(prog)        (RX_WRAPPED(prog) + ReANY(prog)->pre_prefix)
480 #define RX_PRECOMP_const(prog)  (RX_WRAPPED_const(prog) + ReANY(prog)->pre_prefix)
481 /* FIXME? Are we hardcoding too much here and constraining plugin extension
482    writers? Specifically, the value 1 assumes that the wrapped version always
483    has exactly one character at the end, a ')'. Will that always be true?  */
484 #define RX_PRELEN(prog)         (RX_WRAPLEN(prog) - ReANY(prog)->pre_prefix - 1)
485 #define RX_WRAPPED(prog)        ReANY(prog)->xpv_len_u.xpvlenu_pv
486 #define RX_WRAPPED_const(prog)  ((const char *)RX_WRAPPED(prog))
487 #define RX_WRAPLEN(prog)        SvCUR(prog)
488 #define RX_CHECK_SUBSTR(prog)   (ReANY(prog)->check_substr)
489 #define RX_REFCNT(prog)         SvREFCNT(prog)
490 #define RX_EXTFLAGS(prog)       RXp_EXTFLAGS(ReANY(prog))
491 #define RX_COMPFLAGS(prog)        RXp_COMPFLAGS(ReANY(prog))
492 #define RX_ENGINE(prog)         (ReANY(prog)->engine)
493 #define RX_SUBBEG(prog)         (ReANY(prog)->subbeg)
494 #define RX_SUBOFFSET(prog)      (ReANY(prog)->suboffset)
495 #define RX_SUBCOFFSET(prog)     (ReANY(prog)->subcoffset)
496 #define RX_OFFS(prog)           (ReANY(prog)->offs)
497 #define RX_NPARENS(prog)        (ReANY(prog)->nparens)
498 #define RX_SUBLEN(prog)         (ReANY(prog)->sublen)
499 #define RX_MINLEN(prog)         (ReANY(prog)->minlen)
500 #define RX_MINLENRET(prog)      (ReANY(prog)->minlenret)
501 #define RX_GOFS(prog)           (ReANY(prog)->gofs)
502 #define RX_LASTPAREN(prog)      (ReANY(prog)->lastparen)
503 #define RX_LASTCLOSEPAREN(prog) (ReANY(prog)->lastcloseparen)
504 #define RX_SAVED_COPY(prog)     (ReANY(prog)->saved_copy)
505 /* last match was zero-length */
506 #define RX_ZERO_LEN(prog) \
507         (RX_OFFS(prog)[0].start + (SSize_t)RX_GOFS(prog) \
508           == RX_OFFS(prog)[0].end)
509
510 #endif /* PLUGGABLE_RE_EXTENSION */
511
512 /* Stuff that needs to be included in the pluggable extension goes below here */
513
514 #ifdef PERL_ANY_COW
515 #define RX_MATCH_COPY_FREE(rx) \
516         STMT_START {if (RX_SAVED_COPY(rx)) { \
517             SV_CHECK_THINKFIRST_COW_DROP(RX_SAVED_COPY(rx)); \
518         } \
519         if (RX_MATCH_COPIED(rx)) { \
520             Safefree(RX_SUBBEG(rx)); \
521             RX_MATCH_COPIED_off(rx); \
522         }} STMT_END
523 #else
524 #define RX_MATCH_COPY_FREE(rx) \
525         STMT_START {if (RX_MATCH_COPIED(rx)) { \
526             Safefree(RX_SUBBEG(rx)); \
527             RX_MATCH_COPIED_off(rx); \
528         }} STMT_END
529 #endif
530
531 #define RXp_MATCH_UTF8(prog)            (RXp_EXTFLAGS(prog) & RXf_MATCH_UTF8)
532 #define RX_MATCH_UTF8(prog)             (RX_EXTFLAGS(prog) & RXf_MATCH_UTF8)
533 #define RX_MATCH_UTF8_on(prog)          (RX_EXTFLAGS(prog) |= RXf_MATCH_UTF8)
534 #define RX_MATCH_UTF8_off(prog)         (RX_EXTFLAGS(prog) &= ~RXf_MATCH_UTF8)
535 #define RX_MATCH_UTF8_set(prog, t)      ((t) \
536                         ? RX_MATCH_UTF8_on(prog) \
537                         : RX_MATCH_UTF8_off(prog))
538
539 /* Whether the pattern stored at RX_WRAPPED is in UTF-8  */
540 #define RX_UTF8(prog)                   SvUTF8(prog)
541
542
543 /* bits in flags arg of Perl_regexec_flags() */
544
545 #define REXEC_COPY_STR  0x01    /* Need to copy the string for captures. */
546 #define REXEC_CHECKED   0x02    /* re_intuit_start() already called. */
547 #define REXEC_SCREAM    0x04    /* currently unused. */
548 #define REXEC_IGNOREPOS 0x08    /* use stringarg, not pos(), for \G match */
549 #define REXEC_NOT_FIRST 0x10    /* This is another iteration of //g:
550                                    no need to copy string again */
551
552                                      /* under REXEC_COPY_STR, it's ok for the
553                                         engine (modulo PL_sawamperand etc)
554                                         to skip copying: ... */
555 #define REXEC_COPY_SKIP_PRE  0x20    /* ...the $` part of the string, or */
556 #define REXEC_COPY_SKIP_POST 0x40    /* ...the $' part of the string */
557 #define REXEC_FAIL_ON_UNDERFLOW 0x80 /* fail the match if $& would start before
558                                         the start pos (so s/.\G// would fail
559                                         on second iteration */
560
561 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
562 #  define ReREFCNT_inc(re)                                              \
563     ({                                                                  \
564         /* This is here to generate a casting warning if incorrect.  */ \
565         REGEXP *const _rerefcnt_inc = (re);                             \
566         assert(SvTYPE(_rerefcnt_inc) == SVt_REGEXP);                    \
567         SvREFCNT_inc(_rerefcnt_inc);                                    \
568         _rerefcnt_inc;                                                  \
569     })
570 #  define ReREFCNT_dec(re)                                              \
571     ({                                                                  \
572         /* This is here to generate a casting warning if incorrect.  */ \
573         REGEXP *const _rerefcnt_dec = (re);                             \
574         SvREFCNT_dec(_rerefcnt_dec);                                    \
575     })
576 #else
577 #  define ReREFCNT_dec(re)      SvREFCNT_dec(re)
578 #  define ReREFCNT_inc(re)      ((REGEXP *) SvREFCNT_inc(re))
579 #endif
580 #define ReANY(re)               S_ReANY((const REGEXP *)(re))
581
582 /* FIXME for plugins. */
583
584 #define FBMcf_TAIL_DOLLAR       1
585 #define FBMcf_TAIL_DOLLARM      2
586 #define FBMcf_TAIL_Z            4
587 #define FBMcf_TAIL_z            8
588 #define FBMcf_TAIL              (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)
589
590 #define FBMrf_MULTILINE 1
591
592 struct regmatch_state;
593 struct regmatch_slab;
594
595 /* like regmatch_info_aux, but contains extra fields only needed if the
596  * pattern contains (?{}). If used, is snuck into the second slot in the
597  * regmatch_state stack at the start of execution */
598
599 typedef struct {
600     regexp *rex;
601     PMOP    *curpm;     /* saved PL_curpm */
602 #ifdef PERL_ANY_COW
603     SV      *saved_copy; /* saved saved_copy field from rex */
604 #endif
605     char    *subbeg;    /* saved subbeg     field from rex */
606     STRLEN  sublen;     /* saved sublen     field from rex */
607     STRLEN  suboffset;  /* saved suboffset  field from rex */
608     STRLEN  subcoffset; /* saved subcoffset field from rex */
609     MAGIC   *pos_magic; /* pos() magic attached to $_ */
610     SSize_t pos;        /* the original value of pos() in pos_magic */
611     U8      pos_flags;  /* flags to be restored; currently only MGf_BYTES*/
612 } regmatch_info_aux_eval;
613
614
615 /* fields that logically  live in regmatch_info, but which need cleaning
616  * up on croak(), and so are instead are snuck into the first slot in
617  * the regmatch_state stack at the start of execution */
618
619 typedef struct {
620     regmatch_info_aux_eval *info_aux_eval;
621     struct regmatch_state *old_regmatch_state; /* saved PL_regmatch_state */
622     struct regmatch_slab  *old_regmatch_slab;  /* saved PL_regmatch_slab */
623     char *poscache;     /* S-L cache of fail positions of WHILEMs */
624 } regmatch_info_aux;
625
626
627 /* some basic information about the current match that is created by
628  * Perl_regexec_flags and then passed to regtry(), regmatch() etc.
629  * It is allocated as a local var on the stack, so nothing should be
630  * stored in it that needs preserving or clearing up on croak().
631  * For that, see the aux_info and aux_info_eval members of the
632  * regmatch_state union. */
633
634 typedef struct {
635     REGEXP *prog;        /* the regex being executed */
636     const char * strbeg; /* real start of string */
637     char *strend;        /* one byte beyond last char of match string */
638     char *till;          /* matches shorter than this fail (see minlen arg) */
639     SV *sv;              /* the SV string currently being matched */
640     char *ganch;         /* position of \G anchor */
641     char *cutpoint;      /* (*COMMIT) position (if any) */
642     regmatch_info_aux      *info_aux; /* extra fields that need cleanup */
643     regmatch_info_aux_eval *info_aux_eval; /* extra saved state for (?{}) */
644     I32  poscache_maxiter; /* how many whilems todo before S-L cache kicks in */
645     I32  poscache_iter;    /* current countdown from _maxiter to zero */
646     STRLEN poscache_size;  /* size of regmatch_info_aux.poscache */
647     bool intuit;    /* re_intuit_start() is the top-level caller */
648     bool is_utf8_pat;    /* regex is utf8 */
649     bool is_utf8_target; /* string being matched is utf8 */
650     bool warned; /* we have issued a recursion warning; no need for more */
651 } regmatch_info;
652  
653
654 /* structures for holding and saving the state maintained by regmatch() */
655
656 #ifndef MAX_RECURSE_EVAL_NOCHANGE_DEPTH
657 #define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 1000
658 #endif
659
660 typedef I32 CHECKPOINT;
661
662 typedef struct regmatch_state {
663     int resume_state;           /* where to jump to on return */
664     char *locinput;             /* where to backtrack in string on failure */
665
666     union {
667
668         /* the 'info_aux' and 'info_aux_eval' union members are cuckoos in
669          * the nest. They aren't saved backtrack state; rather they
670          * represent one or two extra chunks of data that need allocating
671          * at the start of a match. These fields would logically live in
672          * the regmatch_info struct, except that is allocated on the
673          * C stack, and these fields are all things that require cleanup
674          * after a croak(), when the stack is lost.
675          * As a convenience, we just use the first 1 or 2 regmatch_state
676          * slots to store this info, as we will be allocating a slab of
677          * these anyway. Otherwise we'd have to malloc and then free them,
678          * or allocate them on the save stack (where they will get
679          * realloced if the save stack grows).
680          * info_aux contains the extra fields that are always needed;
681          * info_aux_eval contains extra fields that only needed if
682          * the pattern contains code blocks
683          * We split them into two separate structs to avoid increasing
684          * the size of the union.
685          */
686
687         regmatch_info_aux info_aux;
688
689         regmatch_info_aux_eval info_aux_eval;
690
691         /* this is a fake union member that matches the first element
692          * of each member that needs to store positive backtrack
693          * information */
694         struct {
695             struct regmatch_state *prev_yes_state;
696         } yes;
697
698         /* branchlike members */
699         /* this is a fake union member that matches the first elements
700          * of each member that needs to behave like a branch */
701         struct {
702             /* this first element must match u.yes */
703             struct regmatch_state *prev_yes_state;
704             U32 lastparen;
705             U32 lastcloseparen;
706             CHECKPOINT cp;
707             
708         } branchlike;
709                     
710         struct {
711             /* the first elements must match u.branchlike */
712             struct regmatch_state *prev_yes_state;
713             U32 lastparen;
714             U32 lastcloseparen;
715             CHECKPOINT cp;
716             
717             regnode *next_branch; /* next branch node */
718         } branch;
719
720         struct {
721             /* the first elements must match u.branchlike */
722             struct regmatch_state *prev_yes_state;
723             U32 lastparen;
724             U32 lastcloseparen;
725             CHECKPOINT cp;
726
727             U32         accepted; /* how many accepting states left */
728             bool        longfold;/* saw a fold with a 1->n char mapping */
729             U16         *jump;  /* positive offsets from me */
730             regnode     *me;    /* Which node am I - needed for jump tries*/
731             U8          *firstpos;/* pos in string of first trie match */
732             U32         firstchars;/* len in chars of firstpos from start */
733             U16         nextword;/* next word to try */
734             U16         topword; /* longest accepted word */
735         } trie;
736
737         /* special types - these members are used to store state for special
738            regops like eval, if/then, lookaround and the markpoint state */
739         struct {
740             /* this first element must match u.yes */
741             struct regmatch_state *prev_yes_state;
742             struct regmatch_state *prev_eval;
743             struct regmatch_state *prev_curlyx;
744             REGEXP      *prev_rex;
745             CHECKPOINT  cp;     /* remember current savestack indexes */
746             CHECKPOINT  lastcp;
747             U32        close_paren; /* which close bracket is our end */
748             regnode     *B;     /* the node following us  */
749         } eval;
750
751         struct {
752             /* this first element must match u.yes */
753             struct regmatch_state *prev_yes_state;
754             I32 wanted;
755             I32 logical;        /* saved copy of 'logical' var */
756             regnode  *me; /* the IFMATCH/SUSPEND/UNLESSM node  */
757         } ifmatch; /* and SUSPEND/UNLESSM */
758         
759         struct {
760             /* this first element must match u.yes */
761             struct regmatch_state *prev_yes_state;
762             struct regmatch_state *prev_mark;
763             SV* mark_name;
764             char *mark_loc;
765         } mark;
766         
767         struct {
768             int val;
769         } keeper;
770
771         /* quantifiers - these members are used for storing state for
772            for the regops used to implement quantifiers */
773         struct {
774             /* this first element must match u.yes */
775             struct regmatch_state *prev_yes_state;
776             struct regmatch_state *prev_curlyx; /* previous cur_curlyx */
777             regnode     *me;    /* the CURLYX node  */
778             regnode     *B;     /* the B node in /A*B/  */
779             CHECKPOINT  cp;     /* remember current savestack index */
780             bool        minmod;
781             int         parenfloor;/* how far back to strip paren data */
782
783             /* these two are modified by WHILEM */
784             int         count;  /* how many instances of A we've matched */
785             char        *lastloc;/* where previous A matched (0-len detect) */
786         } curlyx;
787
788         struct {
789             /* this first element must match u.yes */
790             struct regmatch_state *prev_yes_state;
791             struct regmatch_state *save_curlyx;
792             CHECKPOINT  cp;     /* remember current savestack indexes */
793             CHECKPOINT  lastcp;
794             char        *save_lastloc;  /* previous curlyx.lastloc */
795             I32         cache_offset;
796             I32         cache_mask;
797         } whilem;
798
799         struct {
800             /* this first element must match u.yes */
801             struct regmatch_state *prev_yes_state;
802             int c1, c2;         /* case fold search */
803             CHECKPOINT cp;
804             U32 lastparen;
805             U32 lastcloseparen;
806             I32 alen;           /* length of first-matched A string */
807             I32 count;
808             bool minmod;
809             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
810             regnode *me;        /* the curlym node */
811             U8 c1_utf8[UTF8_MAXBYTES+1];  /* */
812             U8 c2_utf8[UTF8_MAXBYTES+1];
813         } curlym;
814
815         struct {
816             U32 paren;
817             CHECKPOINT cp;
818             U32 lastparen;
819             U32 lastcloseparen;
820             int c1, c2;         /* case fold search */
821             char *maxpos;       /* highest possible point in string to match */
822             char *oldloc;       /* the previous locinput */
823             int count;
824             int min, max;       /* {m,n} */
825             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
826             U8 c1_utf8[UTF8_MAXBYTES+1];  /* */
827             U8 c2_utf8[UTF8_MAXBYTES+1];
828         } curly; /* and CURLYN/PLUS/STAR */
829
830     } u;
831 } regmatch_state;
832
833 /* how many regmatch_state structs to allocate as a single slab.
834  * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
835  * pointers, plus 1 for any mythical malloc overhead. */
836  
837 #define PERL_REGMATCH_SLAB_SLOTS \
838     ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
839
840 typedef struct regmatch_slab {
841     regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
842     struct regmatch_slab *prev, *next;
843 } regmatch_slab;
844
845
846
847 /*
848  * Local variables:
849  * c-indentation-style: bsd
850  * c-basic-offset: 4
851  * indent-tabs-mode: nil
852  * End:
853  *
854  * ex: set ts=8 sts=4 sw=4 et:
855  */