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