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