This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
s/PERL_COPY_ON_WRITE/PERL_OLD_COPY_ON_WRITE/g
[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. */
cad2e5aa 136#define REXEC_ML 0x20 /* $* was set. */
c277df42 137
155aba94 138#define ReREFCNT_inc(re) ((void)(re && re->refcnt++), re)
cad2e5aa 139#define ReREFCNT_dec(re) CALLREGFREE(aTHX_ re)
cf93c79d
IZ
140
141#define FBMcf_TAIL_DOLLAR 1
cad2e5aa
JH
142#define FBMcf_TAIL_DOLLARM 2
143#define FBMcf_TAIL_Z 4
144#define FBMcf_TAIL_z 8
145#define FBMcf_TAIL (FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)
cf93c79d
IZ
146
147#define FBMrf_MULTILINE 1
cad2e5aa
JH
148
149struct re_scream_pos_data_s;