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