This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Save the regexp engine state as 1 block on the save stack.
[perl5.git] / regexp.h
CommitLineData
a0d0e21e 1/* regexp.h
d6376244 2 *
4bb101f2
JH
3 * Copyright (C) 1993, 1994, 1996, 1997, 1999, 2000, 2001, 2003,
4 * by Larry Wall and others
d6376244
JH
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 *
a0d0e21e
LW
9 */
10
378cc40b
LW
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
378cc40b 18
c277df42
IZ
19struct regnode {
20 U8 flags;
21 U8 type;
22 U16 next_off;
23};
24
25typedef struct regnode regnode;
26
cad2e5aa 27struct reg_substr_data;
2779dcf1 28
0ee3c8d0
JH
29struct reg_data;
30
378cc40b 31typedef struct regexp {
cf93c79d
IZ
32 I32 *startp;
33 I32 *endp;
c277df42 34 regnode *regstclass;
2779dcf1 35 struct reg_substr_data *substrs;
cf93c79d 36 char *precomp; /* pre-compilation regular expression */
c277df42 37 struct reg_data *data; /* Additional data. */
cf93c79d
IZ
38 char *subbeg; /* saved or original string
39 so \digit works forever. */
f8c7b90f 40#ifdef PERL_OLD_COPY_ON_WRITE
ed252734
NC
41 SV *saved_copy; /* If non-NULL, SV which is COW from original */
42#endif
fac92740 43 U32 *offsets; /* offset annotations 20001228 MJD */
cf93c79d
IZ
44 I32 sublen; /* Length of string pointed by subbeg */
45 I32 refcnt;
46 I32 minlen; /* mininum possible length of $& */
47 I32 prelen; /* length of precomp */
48 U32 nparens; /* number of parentheses */
49 U32 lastparen; /* last paren matched */
a01268b5 50 U32 lastcloseparen; /* last paren matched */
cf93c79d
IZ
51 U32 reganch; /* Internal use only +
52 Tainted information used by regexec? */
c277df42 53 regnode program[1]; /* Unwarranted chumminess with compiler. */
378cc40b
LW
54} regexp;
55
cad2e5aa
JH
56#define ROPT_ANCH (ROPT_ANCH_BOL|ROPT_ANCH_MBOL|ROPT_ANCH_GPOS|ROPT_ANCH_SBOL)
57#define ROPT_ANCH_SINGLE (ROPT_ANCH_SBOL|ROPT_ANCH_GPOS)
a0ed51b3
LW
58#define ROPT_ANCH_BOL 0x00001
59#define ROPT_ANCH_MBOL 0x00002
cad2e5aa
JH
60#define ROPT_ANCH_SBOL 0x00004
61#define ROPT_ANCH_GPOS 0x00008
62#define ROPT_SKIP 0x00010
63#define ROPT_IMPLICIT 0x00020 /* Converted .* to ^.* */
64#define ROPT_NOSCAN 0x00040 /* Check-string always at start. */
65#define ROPT_GPOS_SEEN 0x00080
66#define ROPT_CHECK_ALL 0x00100
67#define ROPT_LOOKBEHIND_SEEN 0x00200
68#define ROPT_EVAL_SEEN 0x00400
cce850e4
JH
69#define ROPT_CANY_SEEN 0x00800
70#define ROPT_SANY_SEEN ROPT_CANY_SEEN /* src bckwrd cmpt */
a0ed51b3 71
8782bef2 72/* 0xf800 of reganch is used by PMf_COMPILETIME */
c277df42 73
a0ed51b3
LW
74#define ROPT_UTF8 0x10000
75#define ROPT_NAUGHTY 0x20000 /* how exponential is this pattern? */
cf93c79d 76#define ROPT_COPY_DONE 0x40000 /* subbeg is a copy of the string */
bc9a0d2c 77#define ROPT_TAINTED_SEEN 0x80000
a30b2f1f 78#define ROPT_MATCH_UTF8 0x10000000 /* subbeg is utf-8 */
a0ed51b3 79
cad2e5aa
JH
80#define RE_USE_INTUIT_NOML 0x0100000 /* Best to intuit before matching */
81#define RE_USE_INTUIT_ML 0x0200000
82#define REINT_AUTORITATIVE_NOML 0x0400000 /* Can trust a positive answer */
83#define REINT_AUTORITATIVE_ML 0x0800000
84#define REINT_ONCE_NOML 0x1000000 /* Intuit can succed once only. */
85#define REINT_ONCE_ML 0x2000000
86#define RE_INTUIT_ONECHAR 0x4000000
87#define RE_INTUIT_TAIL 0x8000000
88
89#define RE_USE_INTUIT (RE_USE_INTUIT_NOML|RE_USE_INTUIT_ML)
90#define REINT_AUTORITATIVE (REINT_AUTORITATIVE_NOML|REINT_AUTORITATIVE_ML)
91#define REINT_ONCE (REINT_ONCE_NOML|REINT_ONCE_ML)
92
c277df42 93#define RX_MATCH_TAINTED(prog) ((prog)->reganch & ROPT_TAINTED_SEEN)
72311751
GS
94#define RX_MATCH_TAINTED_on(prog) ((prog)->reganch |= ROPT_TAINTED_SEEN)
95#define RX_MATCH_TAINTED_off(prog) ((prog)->reganch &= ~ROPT_TAINTED_SEEN)
96#define RX_MATCH_TAINTED_set(prog, t) ((t) \
97 ? RX_MATCH_TAINTED_on(prog) \
98 : RX_MATCH_TAINTED_off(prog))
c277df42 99
cf93c79d
IZ
100#define RX_MATCH_COPIED(prog) ((prog)->reganch & ROPT_COPY_DONE)
101#define RX_MATCH_COPIED_on(prog) ((prog)->reganch |= ROPT_COPY_DONE)
102#define RX_MATCH_COPIED_off(prog) ((prog)->reganch &= ~ROPT_COPY_DONE)
103#define RX_MATCH_COPIED_set(prog,t) ((t) \
104 ? RX_MATCH_COPIED_on(prog) \
105 : RX_MATCH_COPIED_off(prog))
106
f8c7b90f 107#ifdef PERL_OLD_COPY_ON_WRITE
ed252734
NC
108#define RX_MATCH_COPY_FREE(rx) \
109 STMT_START {if (rx->saved_copy) { \
110 SV_CHECK_THINKFIRST_COW_DROP(rx->saved_copy); \
111 } \
112 if (RX_MATCH_COPIED(rx)) { \
113 Safefree(rx->subbeg); \
114 RX_MATCH_COPIED_off(rx); \
115 }} STMT_END
116#else
117#define RX_MATCH_COPY_FREE(rx) \
118 STMT_START {if (RX_MATCH_COPIED(rx)) { \
119 Safefree(rx->subbeg); \
120 RX_MATCH_COPIED_off(rx); \
121 }} STMT_END
122#endif
123
a30b2f1f
RGS
124#define RX_MATCH_UTF8(prog) ((prog)->reganch & ROPT_MATCH_UTF8)
125#define RX_MATCH_UTF8_on(prog) ((prog)->reganch |= ROPT_MATCH_UTF8)
126#define RX_MATCH_UTF8_off(prog) ((prog)->reganch &= ~ROPT_MATCH_UTF8)
127#define RX_MATCH_UTF8_set(prog, t) ((t) \
128 ? (RX_MATCH_UTF8_on(prog), (PL_reg_match_utf8 = 1)) \
129 : (RX_MATCH_UTF8_off(prog), (PL_reg_match_utf8 = 0)))
130
cad2e5aa
JH
131#define REXEC_COPY_STR 0x01 /* Need to copy the string. */
132#define REXEC_CHECKED 0x02 /* check_substr already checked. */
133#define REXEC_SCREAM 0x04 /* use scream table. */
134#define REXEC_IGNOREPOS 0x08 /* \G matches at start. */
cf93c79d 135#define REXEC_NOT_FIRST 0x10 /* This is another iteration of //g. */
c277df42 136
155aba94 137#define ReREFCNT_inc(re) ((void)(re && re->refcnt++), re)
cad2e5aa 138#define ReREFCNT_dec(re) CALLREGFREE(aTHX_ re)
cf93c79d
IZ
139
140#define FBMcf_TAIL_DOLLAR 1
cad2e5aa
JH
141#define FBMcf_TAIL_DOLLARM 2
142#define FBMcf_TAIL_Z 4
143#define FBMcf_TAIL_z 8
144#define FBMcf_TAIL (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)
cf93c79d
IZ
145
146#define FBMrf_MULTILINE 1
cad2e5aa
JH
147
148struct re_scream_pos_data_s;
5d9a96ca
DM
149
150/* an accepting state/position*/
151struct _reg_trie_accepted {
152 U8 *endpos;
153 U16 wordnum;
154};
155typedef struct _reg_trie_accepted reg_trie_accepted;
156
157
158/* structures for holding and saving the state maintained by regmatch() */
159
160typedef I32 CHECKPOINT;
161
5d9a96ca
DM
162typedef struct re_cc_state
163{
164 I32 ss;
165 regnode *node;
166 struct re_cc_state *prev;
a0374537 167 struct regmatch_state *cc; /* state corresponding to the current curly */
5d9a96ca
DM
168 regexp *re;
169} re_cc_state;
170
171
5d9a96ca
DM
172typedef enum {
173 resume_TRIE1,
174 resume_TRIE2,
175 resume_CURLYX,
176 resume_WHILEM1,
177 resume_WHILEM2,
178 resume_WHILEM3,
179 resume_WHILEM4,
180 resume_WHILEM5,
181 resume_WHILEM6,
182 resume_CURLYM1,
183 resume_CURLYM2,
184 resume_CURLYM3,
185 resume_CURLYM4,
186 resume_IFMATCH,
187 resume_PLUS1,
188 resume_PLUS2,
189 resume_PLUS3,
190 resume_PLUS4,
191 resume_END
192} regmatch_resume_states;
193
194
a0374537 195typedef struct regmatch_state {
5d9a96ca
DM
196
197 /* these vars contain state that needs to be maintained
198 * across the main while loop ... */
199
200 regmatch_resume_states resume_state; /* where to jump to on return */
201 regnode *scan; /* Current node. */
202 regnode *next; /* Next node. */
203 bool minmod; /* the next "{n.m}" is a "{n,m}?" */
204 bool sw; /* the condition value in (?(cond)a|b) */
205 int logical;
206 I32 unwind; /* savestack index of current unwind block */
a0374537 207 struct regmatch_state *cc; /* current innermost curly state */
5d9a96ca
DM
208 char *locinput;
209
e822a8b4 210 /* ... while the rest of these are local to an individual branch */
5d9a96ca
DM
211
212 I32 n; /* no or next */
213 I32 ln; /* len or last */
e822a8b4
DM
214
215 union {
216 struct {
217 reg_trie_accepted *accept_buff;
218 U32 accepted; /* how many accepting states we have seen */
219 } trie;
220
221 struct {
222 CHECKPOINT cp; /* remember current savestack indexes */
223 CHECKPOINT lastcp;
224 } eval;
225
226 struct {
227 CHECKPOINT cp; /* remember current savestack indexes */
a0374537
DM
228 struct regmatch_state *outercc; /* outer CURLYX state if any */
229
230 /* these contain the current curly state, and are accessed
231 * by subsequent WHILEMs */
232 int parenfloor;/* how far back to strip paren data */
233 int cur; /* how many instances of scan we've matched */
234 int min; /* the minimal number of scans to match */
235 int max; /* the maximal number of scans to match */
236 regnode * scan; /* the thing to match */
237 char * lastloc;/* where we started matching this scan */
e822a8b4
DM
238 } curlyx;
239
240 struct {
241 CHECKPOINT cp; /* remember current savestack indexes */
242 CHECKPOINT lastcp;
a0374537 243 struct regmatch_state *savecc;
e822a8b4
DM
244 char *lastloc; /* Detection of 0-len. */
245 I32 cache_offset;
246 I32 cache_bit;
247 } whilem;
248
249 struct {
250 I32 paren;
251 I32 c1, c2; /* case fold search */
252 CHECKPOINT lastcp;
253 I32 l;
254 I32 matches;
255 I32 maxwanted;
256 } curlym;
257
258 struct {
259 I32 paren;
260 CHECKPOINT lastcp;
261 I32 c1, c2; /* case fold search */
262 char *e;
263 char *old;
264 int count;
265 } plus; /* and CURLYN/CURLY/STAR */
266
267 struct {
268 CHECKPOINT cp; /* remember current savestack indexes */
269 CHECKPOINT lastcp;
a0374537 270 struct regmatch_state *savecc;
e822a8b4
DM
271 re_cc_state *cur_call_cc;
272 regexp *end_re;
273 } end;
d8319b27 274 } u;
5d9a96ca
DM
275
276 re_cc_state *reg_call_cc; /* saved value of PL_reg_call_cc */
277} regmatch_state;
278
279/* how many regmatch_state structs to allocate as a single slab.
280 * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
281 * pointers, plus 1 for any mythical malloc overhead. */
282
283#define PERL_REGMATCH_SLAB_SLOTS \
284 ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
285
286typedef struct regmatch_slab {
287 regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
288 struct regmatch_slab *prev, *next;
289} regmatch_slab;
1ade1aa1
NC
290
291struct re_save_state {
292 U32 re_state_reg_flags; /* from regexec.c */
293 char *re_state_bostr;
294 char *re_state_reginput; /* String-input pointer. */
295 char *re_state_regbol; /* Beginning of input, for ^ check. */
296 char *re_state_regeol; /* End of input, for $ check. */
297 I32 *re_state_regstartp; /* Pointer to startp array. */
298 I32 *re_state_regendp; /* Ditto for endp. */
299 U32 *re_state_reglastparen; /* Similarly for lastparen. */
300 U32 *re_state_reglastcloseparen; /* Similarly for lastcloseparen. */
301 char *re_state_regtill; /* How far we are required to go. */
302 char **re_state_reg_start_tmp; /* from regexec.c */
303 U32 re_state_reg_start_tmpl; /* from regexec.c */
304 I32 re_state_reg_eval_set; /* from regexec.c */
305 I32 re_state_regnarrate; /* from regexec.c */
306 int re_state_regindent; /* from regexec.c */
307 struct re_cc_state *re_state_reg_call_cc; /* from regexec.c */
308 regexp *re_state_reg_re; /* from regexec.c */
309 char *re_state_reg_ganch; /* from regexec.c */
310 SV *re_state_reg_sv; /* from regexec.c */
311 bool re_state_reg_match_utf8; /* from regexec.c */
312 MAGIC *re_state_reg_magic; /* from regexec.c */
313 I32 re_state_reg_oldpos; /* from regexec.c */
314 PMOP *re_state_reg_oldcurpm; /* from regexec.c */
315 PMOP *re_state_reg_curpm; /* from regexec.c */
316 char *re_state_reg_oldsaved; /* old saved substr during match */
317 STRLEN re_state_reg_oldsavedlen; /* old length of saved substr during match */
318 I32 re_state_reg_maxiter; /* max wait until caching pos */
319 I32 re_state_reg_leftiter; /* wait until caching pos */
320 char *re_state_reg_poscache; /* cache of pos of WHILEM */
321 STRLEN re_state_reg_poscache_size; /* size of pos cache of WHILEM */
322 I32 re_state_regsize; /* from regexec.c */
323 char *re_state_reg_starttry; /* from regexec.c */
324#ifdef PERL_OLD_COPY_ON_WRITE
325 SV *re_state_nrs;
326#endif
327};
328
329#define SAVESTACK_ALLOC_FOR_RE_SAVE_STATE \
330 (1 + ((sizeof(struct re_save_state) - 1) / sizeof(*PL_savestack)))
331/*
332 * Local variables:
333 * c-indentation-style: bsd
334 * c-basic-offset: 4
335 * indent-tabs-mode: t
336 * End:
337 *
338 * ex: set ts=8 sts=4 sw=4 noet:
339 */