c526cf98e5c808891a58af83598ae45dc41462b3
[p5sagit/p5-mst-13.2.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
35 struct reg_substr_datum {
36     I32 min_offset;
37     I32 max_offset;
38     SV *substr;         /* non-utf8 variant */
39     SV *utf8_substr;    /* utf8 variant */
40     I32 end_shift;
41 };
42 struct reg_substr_data {
43     struct reg_substr_datum data[3];    /* Actual array */
44 };
45
46 #ifdef PERL_OLD_COPY_ON_WRITE
47 #define SV_SAVED_COPY   SV *saved_copy; /* If non-NULL, SV which is COW from original */
48 #else
49 #define SV_SAVED_COPY
50 #endif
51 /* this is ordered such that the most commonly used 
52    fields are at the start of the struct */
53 typedef struct regexp {
54         /* what engine created this regexp? */
55         const struct regexp_engine* engine; 
56         
57         /* Information about the match that the perl core uses to manage things */
58         U32 extflags;           /* Flags used both externally and internally */
59         I32 minlen;             /* mininum possible length of string to match */
60         I32 minlenret;          /* mininum possible length of $& */
61         U32 gofs;               /* chars left of pos that we search from */
62         struct reg_substr_data *substrs; /* substring data about strings that must appear
63                                    in the final match, used for optimisations */
64         U32 nparens;            /* number of capture buffers */
65
66         /* private engine specific data */
67         U32 intflags;           /* Engine Specific Internal flags */
68         void *pprivate;         /* Data private to the regex engine which 
69                                    created this object. */
70         
71         /* Data about the last/current match. These are modified during matching*/
72         U32 lastparen;          /* last open paren matched */
73         U32 lastcloseparen;     /* last close paren matched */
74         I32 *startp;            /* Array of offsets from start of string (@-) */
75         I32 *endp;              /* Array of offsets from start of string (@+) */
76         char *subbeg;           /* saved or original string 
77                                    so \digit works forever. */
78         I32 sublen;             /* Length of string pointed by subbeg */
79         SV_SAVED_COPY           /* If non-NULL, SV which is COW from original */
80         
81         
82         /* Information about the match that isn't often used */
83         char *precomp;          /* pre-compilation regular expression */
84         I32 prelen;             /* length of precomp */
85         char *wrapped;          /* wrapped version of the pattern */
86         I32 wraplen;            /* length of wrapped */
87         I32 seen_evals;         /* number of eval groups in the pattern - for security checks */ 
88         HV *paren_names;        /* Optional hash of paren names */
89         
90         /* Refcount of this regexp */
91         I32 refcnt;             /* Refcount of this regexp */
92 } regexp;
93
94 /* used for high speed searches */
95 typedef struct re_scream_pos_data_s
96 {
97     char **scream_olds;         /* match pos */
98     I32 *scream_pos;            /* Internal iterator of scream. */
99 } re_scream_pos_data;
100
101 /* regexp_engine structure. This is the dispatch table for regexes.
102  * Any regex engine implementation must be able to build one of these.
103  */
104 typedef struct regexp_engine {
105     regexp* (*comp) (pTHX_ char* exp, char* xend, PMOP* pm);
106     I32     (*exec) (pTHX_ regexp* prog, char* stringarg, char* strend,
107                             char* strbeg, I32 minend, SV* screamer,
108                             void* data, U32 flags);
109     char*   (*intuit) (pTHX_ regexp *prog, SV *sv, char *strpos,
110                             char *strend, U32 flags,
111                             struct re_scream_pos_data_s *data);
112     SV*     (*checkstr) (pTHX_ regexp *prog);
113     void    (*free) (pTHX_ struct regexp* r);
114     SV*     (*numbered_buff_get) (pTHX_ const REGEXP * const rx, I32 paren, SV* usesv);
115     SV*     (*named_buff_get)(pTHX_ const REGEXP * const rx, SV* namesv, U32 flags);
116 #ifdef USE_ITHREADS
117     void* (*dupe) (pTHX_ const regexp *r, CLONE_PARAMS *param);
118 #endif    
119 } regexp_engine;
120
121 /* Flags stored in regexp->extflags 
122  * These are used by code external to the regexp engine
123  *
124  * Note that flags starting with RXf_PMf_ have exact equivalents
125  * stored in op_pmflags and which are defined in op.h, they are defined
126  * numerically here only for clarity.
127  */
128
129 /* Anchor and GPOS related stuff */
130 #define RXf_ANCH_BOL            0x00000001
131 #define RXf_ANCH_MBOL           0x00000002
132 #define RXf_ANCH_SBOL           0x00000004
133 #define RXf_ANCH_GPOS           0x00000008
134 #define RXf_GPOS_SEEN           0x00000010
135 #define RXf_GPOS_FLOAT          0x00000020
136 /* two bits here */
137 #define RXf_ANCH                (RXf_ANCH_BOL|RXf_ANCH_MBOL|RXf_ANCH_GPOS|RXf_ANCH_SBOL)
138 #define RXf_GPOS_CHECK          (RXf_GPOS_SEEN|RXf_ANCH_GPOS)
139 #define RXf_ANCH_SINGLE         (RXf_ANCH_SBOL|RXf_ANCH_GPOS)
140
141 /* Flags indicating special patterns */
142 #define RXf_START_ONLY          0x00000200 /* Pattern is /^/ */
143 #define RXf_WHITE               0x00000400 /* Pattern is /\s+/ */
144
145 /* 0x1F800 of extflags is used by (RXf_)PMf_COMPILETIME */
146 #define RXf_PMf_LOCALE          0x00000800 /* use locale */
147 #define RXf_PMf_MULTILINE       0x00001000 /* /m         */
148 #define RXf_PMf_SINGLELINE      0x00002000 /* /s         */
149 #define RXf_PMf_FOLD            0x00004000 /* /i         */
150 #define RXf_PMf_EXTENDED        0x00008000 /* /x         */
151 #define RXf_PMf_KEEPCOPY        0x00010000 /* /k         */
152 /* these flags are transfered from the PMOP->op_pmflags member during compilation */
153 #define RXf_PMf_STD_PMMOD       (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_FOLD|RXf_PMf_EXTENDED)
154 #define RXf_PMf_COMPILETIME     (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_LOCALE|RXf_PMf_FOLD|RXf_PMf_EXTENDED|RXf_PMf_KEEPCOPY)
155
156 #define CASE_STD_PMMOD_FLAGS_PARSE_SET(pmfl)                        \
157     case IGNORE_PAT_MOD:    *(pmfl) |= RXf_PMf_FOLD;       break;   \
158     case MULTILINE_PAT_MOD: *(pmfl) |= RXf_PMf_MULTILINE;  break;   \
159     case SINGLE_PAT_MOD:    *(pmfl) |= RXf_PMf_SINGLELINE; break;   \
160     case XTENDED_PAT_MOD:   *(pmfl) |= RXf_PMf_EXTENDED;   break
161
162 /* chars and strings used as regex pattern modifiers
163  * Singlular is a 'c'har, plural is a "string"
164  *
165  * NOTE, KEEPCOPY was originally 'k', but was changed to 'p' for preserve
166  * for compatibility reasons with Regexp::Common which highjacked (?k:...)
167  * for its own uses. So 'k' is out as well.
168  */
169 #define EXEC_PAT_MOD         'e'
170 #define KEEPCOPY_PAT_MOD     'p'
171 #define ONCE_PAT_MOD         'o'
172 #define GLOBAL_PAT_MOD       'g'
173 #define CONTINUE_PAT_MOD     'c'
174 #define MULTILINE_PAT_MOD    'm'
175 #define SINGLE_PAT_MOD       's'
176 #define IGNORE_PAT_MOD       'i'
177 #define XTENDED_PAT_MOD      'x'
178
179 #define ONCE_PAT_MODS        "o"
180 #define KEEPCOPY_PAT_MODS    "p"
181 #define EXEC_PAT_MODS        "e"
182 #define LOOP_PAT_MODS        "gc"
183
184 #define STD_PAT_MODS        "msix"
185
186 #define INT_PAT_MODS    STD_PAT_MODS    KEEPCOPY_PAT_MODS
187
188 #define EXT_PAT_MODS    ONCE_PAT_MODS   KEEPCOPY_PAT_MODS
189 #define QR_PAT_MODS     STD_PAT_MODS    EXT_PAT_MODS
190 #define M_PAT_MODS      QR_PAT_MODS     LOOP_PAT_MODS
191 #define S_PAT_MODS      M_PAT_MODS      EXEC_PAT_MODS
192
193
194 /* What we have seen */
195 #define RXf_LOOKBEHIND_SEEN     0x00020000
196 #define RXf_EVAL_SEEN           0x00040000
197 #define RXf_CANY_SEEN           0x00080000
198
199 /* Special */
200 #define RXf_NOSCAN              0x00100000
201 #define RXf_CHECK_ALL           0x00200000
202
203 /* UTF8 related */
204 #define RXf_UTF8                0x00400000
205 #define RXf_MATCH_UTF8          0x00800000
206
207 /* Intuit related */
208 #define RXf_USE_INTUIT_NOML     0x01000000
209 #define RXf_USE_INTUIT_ML       0x02000000
210 #define RXf_INTUIT_TAIL         0x04000000
211 /* one bit here */
212 #define RXf_USE_INTUIT          (RXf_USE_INTUIT_NOML|RXf_USE_INTUIT_ML)
213
214 /* Copy and tainted info */
215 #define RXf_COPY_DONE           0x10000000
216 #define RXf_TAINTED_SEEN        0x20000000
217 /* two bits here  */
218
219
220 #define RX_HAS_CUTGROUP(prog) ((prog)->intflags & PREGf_CUTGROUP_SEEN)
221 #define RX_MATCH_TAINTED(prog)  ((prog)->extflags & RXf_TAINTED_SEEN)
222 #define RX_MATCH_TAINTED_on(prog) ((prog)->extflags |= RXf_TAINTED_SEEN)
223 #define RX_MATCH_TAINTED_off(prog) ((prog)->extflags &= ~RXf_TAINTED_SEEN)
224 #define RX_MATCH_TAINTED_set(prog, t) ((t) \
225                                        ? RX_MATCH_TAINTED_on(prog) \
226                                        : RX_MATCH_TAINTED_off(prog))
227
228 #define RX_MATCH_COPIED(prog)           ((prog)->extflags & RXf_COPY_DONE)
229 #define RX_MATCH_COPIED_on(prog)        ((prog)->extflags |= RXf_COPY_DONE)
230 #define RX_MATCH_COPIED_off(prog)       ((prog)->extflags &= ~RXf_COPY_DONE)
231 #define RX_MATCH_COPIED_set(prog,t)     ((t) \
232                                          ? RX_MATCH_COPIED_on(prog) \
233                                          : RX_MATCH_COPIED_off(prog))
234
235 #endif /* PLUGGABLE_RE_EXTENSION */
236
237 /* Stuff that needs to be included in the plugable extension goes below here */
238
239 #ifdef PERL_OLD_COPY_ON_WRITE
240 #define RX_MATCH_COPY_FREE(rx) \
241         STMT_START {if (rx->saved_copy) { \
242             SV_CHECK_THINKFIRST_COW_DROP(rx->saved_copy); \
243         } \
244         if (RX_MATCH_COPIED(rx)) { \
245             Safefree(rx->subbeg); \
246             RX_MATCH_COPIED_off(rx); \
247         }} STMT_END
248 #else
249 #define RX_MATCH_COPY_FREE(rx) \
250         STMT_START {if (RX_MATCH_COPIED(rx)) { \
251             Safefree(rx->subbeg); \
252             RX_MATCH_COPIED_off(rx); \
253         }} STMT_END
254 #endif
255
256 #define RX_MATCH_UTF8(prog)             ((prog)->extflags & RXf_MATCH_UTF8)
257 #define RX_MATCH_UTF8_on(prog)          ((prog)->extflags |= RXf_MATCH_UTF8)
258 #define RX_MATCH_UTF8_off(prog)         ((prog)->extflags &= ~RXf_MATCH_UTF8)
259 #define RX_MATCH_UTF8_set(prog, t)      ((t) \
260                         ? (RX_MATCH_UTF8_on(prog), (PL_reg_match_utf8 = 1)) \
261                         : (RX_MATCH_UTF8_off(prog), (PL_reg_match_utf8 = 0)))
262     
263 #define REXEC_COPY_STR  0x01            /* Need to copy the string. */
264 #define REXEC_CHECKED   0x02            /* check_substr already checked. */
265 #define REXEC_SCREAM    0x04            /* use scream table. */
266 #define REXEC_IGNOREPOS 0x08            /* \G matches at start. */
267 #define REXEC_NOT_FIRST 0x10            /* This is another iteration of //g. */
268
269 #define ReREFCNT_inc(re) ((void)(re && re->refcnt++), re)
270 #define ReREFCNT_dec(re) CALLREGFREE(re)
271
272 #define FBMcf_TAIL_DOLLAR       1
273 #define FBMcf_TAIL_DOLLARM      2
274 #define FBMcf_TAIL_Z            4
275 #define FBMcf_TAIL_z            8
276 #define FBMcf_TAIL              (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)
277
278 #define FBMrf_MULTILINE 1
279
280 /* an accepting state/position*/
281 struct _reg_trie_accepted {
282     U8   *endpos;
283     U16  wordnum;
284 };
285 typedef struct _reg_trie_accepted reg_trie_accepted;
286
287 /* some basic information about the current match that is created by
288  * Perl_regexec_flags and then passed to regtry(), regmatch() etc */
289
290 typedef struct {
291     regexp *prog;
292     char *bol;
293     char *till;
294     SV *sv;
295     char *ganch;
296     char *cutpoint;
297 } regmatch_info;
298  
299
300 /* structures for holding and saving the state maintained by regmatch() */
301
302 #define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 50
303
304 typedef I32 CHECKPOINT;
305
306 typedef struct regmatch_state {
307     int resume_state;           /* where to jump to on return */
308     char *locinput;             /* where to backtrack in string on failure */
309
310     union {
311
312         /* this is a fake union member that matches the first element
313          * of each member that needs to store positive backtrack
314          * information */
315         struct {
316             struct regmatch_state *prev_yes_state;
317         } yes;
318
319         /* branchlike members */
320         /* this is a fake union member that matches the first elements
321          * of each member that needs to behave like a branch */
322         struct {
323             /* this first element must match u.yes */
324             struct regmatch_state *prev_yes_state;
325             U32 lastparen;
326             CHECKPOINT cp;
327             
328         } branchlike;
329                     
330         struct {
331             /* the first elements must match u.branchlike */
332             struct regmatch_state *prev_yes_state;
333             U32 lastparen;
334             CHECKPOINT cp;
335             
336             regnode *next_branch; /* next branch node */
337         } branch;
338
339         struct {
340             /* the first elements must match u.branchlike */
341             struct regmatch_state *prev_yes_state;
342             U32 lastparen;
343             CHECKPOINT cp;
344
345             reg_trie_accepted *accept_buff; /* accepting states we have seen */
346             U32         accepted; /* how many accepting states we have seen */
347             U16         *jump;  /* positive offsets from me */
348             regnode     *B;     /* node following the trie */
349             regnode     *me;    /* Which node am I - needed for jump tries*/
350         } trie;
351
352         /* special types - these members are used to store state for special
353            regops like eval, if/then, lookaround and the markpoint state */
354         struct {
355             /* this first element must match u.yes */
356             struct regmatch_state *prev_yes_state;
357             struct regmatch_state *prev_eval;
358             struct regmatch_state *prev_curlyx;
359             regexp      *prev_rex;
360             U32         toggle_reg_flags; /* what bits in PL_reg_flags to
361                                             flip when transitioning between
362                                             inner and outer rexen */
363             CHECKPOINT  cp;     /* remember current savestack indexes */
364             CHECKPOINT  lastcp;
365             regnode     *B;     /* the node following us  */
366             U32        close_paren; /* which close bracket is our end */
367         } eval;
368
369         struct {
370             /* this first element must match u.yes */
371             struct regmatch_state *prev_yes_state;
372             I32 wanted;
373             I32 logical;        /* saved copy of 'logical' var */
374             regnode  *me; /* the IFMATCH/SUSPEND/UNLESSM node  */
375         } ifmatch; /* and SUSPEND/UNLESSM */
376         
377         struct {
378             /* this first element must match u.yes */
379             struct regmatch_state *prev_yes_state;
380             struct regmatch_state *prev_mark;
381             SV* mark_name;
382             char *mark_loc;
383         } mark;
384         
385         struct {
386             int val;
387         } keeper;
388
389         /* quantifiers - these members are used for storing state for
390            for the regops used to implement quantifiers */
391         struct {
392             /* this first element must match u.yes */
393             struct regmatch_state *prev_yes_state;
394             struct regmatch_state *prev_curlyx; /* previous cur_curlyx */
395             CHECKPOINT  cp;     /* remember current savestack index */
396             bool        minmod;
397             int         parenfloor;/* how far back to strip paren data */
398             int         min;    /* the minimal number of A's to match */
399             int         max;    /* the maximal number of A's to match */
400             regnode     *A, *B; /* the nodes corresponding to /A*B/  */
401
402             /* these two are modified by WHILEM */
403             int         count;  /* how many instances of A we've matched */
404             char        *lastloc;/* where previous A matched (0-len detect) */
405         } curlyx;
406
407         struct {
408             /* this first element must match u.yes */
409             struct regmatch_state *prev_yes_state;
410             struct regmatch_state *save_curlyx;
411             CHECKPOINT  cp;     /* remember current savestack indexes */
412             CHECKPOINT  lastcp;
413             char        *save_lastloc;  /* previous curlyx.lastloc */
414             I32         cache_offset;
415             I32         cache_mask;
416         } whilem;
417
418         struct {
419             /* this first element must match u.yes */
420             struct regmatch_state *prev_yes_state;
421             I32 c1, c2;         /* case fold search */
422             CHECKPOINT cp;
423             I32 alen;           /* length of first-matched A string */
424             I32 count;
425             bool minmod;
426             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
427             regnode *me;        /* the curlym node */
428         } curlym;
429
430         struct {
431             U32 paren;
432             CHECKPOINT cp;
433             I32 c1, c2;         /* case fold search */
434             char *maxpos;       /* highest possible point in string to match */
435             char *oldloc;       /* the previous locinput */
436             int count;
437             int min, max;       /* {m,n} */
438             regnode *A, *B;     /* the nodes corresponding to /A*B/  */
439         } curly; /* and CURLYN/PLUS/STAR */
440
441     } u;
442 } regmatch_state;
443
444 /* how many regmatch_state structs to allocate as a single slab.
445  * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
446  * pointers, plus 1 for any mythical malloc overhead. */
447  
448 #define PERL_REGMATCH_SLAB_SLOTS \
449     ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
450
451 typedef struct regmatch_slab {
452     regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
453     struct regmatch_slab *prev, *next;
454 } regmatch_slab;
455
456 #define PL_reg_flags            PL_reg_state.re_state_reg_flags
457 #define PL_bostr                PL_reg_state.re_state_bostr
458 #define PL_reginput             PL_reg_state.re_state_reginput
459 #define PL_regeol               PL_reg_state.re_state_regeol
460 #define PL_regstartp            PL_reg_state.re_state_regstartp
461 #define PL_regendp              PL_reg_state.re_state_regendp
462 #define PL_reglastparen         PL_reg_state.re_state_reglastparen
463 #define PL_reglastcloseparen    PL_reg_state.re_state_reglastcloseparen
464 #define PL_reg_start_tmp        PL_reg_state.re_state_reg_start_tmp
465 #define PL_reg_start_tmpl       PL_reg_state.re_state_reg_start_tmpl
466 #define PL_reg_eval_set         PL_reg_state.re_state_reg_eval_set
467 #define PL_reg_match_utf8       PL_reg_state.re_state_reg_match_utf8
468 #define PL_reg_magic            PL_reg_state.re_state_reg_magic
469 #define PL_reg_oldpos           PL_reg_state.re_state_reg_oldpos
470 #define PL_reg_oldcurpm         PL_reg_state.re_state_reg_oldcurpm
471 #define PL_reg_curpm            PL_reg_state.re_state_reg_curpm
472 #define PL_reg_oldsaved         PL_reg_state.re_state_reg_oldsaved
473 #define PL_reg_oldsavedlen      PL_reg_state.re_state_reg_oldsavedlen
474 #define PL_reg_maxiter          PL_reg_state.re_state_reg_maxiter
475 #define PL_reg_leftiter         PL_reg_state.re_state_reg_leftiter
476 #define PL_reg_poscache         PL_reg_state.re_state_reg_poscache
477 #define PL_reg_poscache_size    PL_reg_state.re_state_reg_poscache_size
478 #define PL_regsize              PL_reg_state.re_state_regsize
479 #define PL_reg_starttry         PL_reg_state.re_state_reg_starttry
480 #define PL_nrs                  PL_reg_state.re_state_nrs
481
482 struct re_save_state {
483     U32 re_state_reg_flags;             /* from regexec.c */
484     char *re_state_bostr;
485     char *re_state_reginput;            /* String-input pointer. */
486     char *re_state_regeol;              /* End of input, for $ check. */
487     I32 *re_state_regstartp;            /* Pointer to startp array. */
488     I32 *re_state_regendp;              /* Ditto for endp. */
489     U32 *re_state_reglastparen;         /* Similarly for lastparen. */
490     U32 *re_state_reglastcloseparen;    /* Similarly for lastcloseparen. */
491     char **re_state_reg_start_tmp;      /* from regexec.c */
492     U32 re_state_reg_start_tmpl;        /* from regexec.c */
493     I32 re_state_reg_eval_set;          /* from regexec.c */
494     bool re_state_reg_match_utf8;       /* from regexec.c */
495     MAGIC *re_state_reg_magic;          /* from regexec.c */
496     I32 re_state_reg_oldpos;            /* from regexec.c */
497     PMOP *re_state_reg_oldcurpm;        /* from regexec.c */
498     PMOP *re_state_reg_curpm;           /* from regexec.c */
499     char *re_state_reg_oldsaved;        /* old saved substr during match */
500     STRLEN re_state_reg_oldsavedlen;    /* old length of saved substr during match */
501     I32 re_state_reg_maxiter;           /* max wait until caching pos */
502     I32 re_state_reg_leftiter;          /* wait until caching pos */
503     char *re_state_reg_poscache;        /* cache of pos of WHILEM */
504     STRLEN re_state_reg_poscache_size;  /* size of pos cache of WHILEM */
505     U32 re_state_regsize;               /* from regexec.c */
506     char *re_state_reg_starttry;        /* from regexec.c */
507 #ifdef PERL_OLD_COPY_ON_WRITE
508     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 */
509 #endif
510 };
511
512 #define SAVESTACK_ALLOC_FOR_RE_SAVE_STATE \
513         (1 + ((sizeof(struct re_save_state) - 1) / sizeof(*PL_savestack)))
514
515 /*
516  * Local variables:
517  * c-indentation-style: bsd
518  * c-basic-offset: 4
519  * indent-tabs-mode: t
520  * End:
521  *
522  * ex: set ts=8 sts=4 sw=4 noet:
523  */