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