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