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