This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
add svt_local slot to magic vtable, and fix local $shared
[perl5.git] / mg.h
CommitLineData
a0d0e21e 1/* mg.h
79072805 2 *
4bb101f2
JH
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999,
4 * 2000, 2002, by Larry Wall and others
79072805
LW
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 *
79072805
LW
9 */
10
0f4eea8f
DL
11#ifdef STRUCT_MGVTBL_DEFINITION
12STRUCT_MGVTBL_DEFINITION;
13#else
79072805 14struct mgvtbl {
cea2e8a9
GS
15 int (CPERLscope(*svt_get)) (pTHX_ SV *sv, MAGIC* mg);
16 int (CPERLscope(*svt_set)) (pTHX_ SV *sv, MAGIC* mg);
17 U32 (CPERLscope(*svt_len)) (pTHX_ SV *sv, MAGIC* mg);
18 int (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg);
19 int (CPERLscope(*svt_free)) (pTHX_ SV *sv, MAGIC* mg);
68795e93
NIS
20 int (CPERLscope(*svt_copy)) (pTHX_ SV *sv, MAGIC* mg,
21 SV *nsv, const char *name, int namlen);
22 int (CPERLscope(*svt_dup)) (pTHX_ MAGIC *mg, CLONE_PARAMS *param);
a5063e7c 23 int (CPERLscope(*svt_local))(pTHX_ SV *nsv, MAGIC *mg);
79072805 24};
0f4eea8f 25#endif
79072805
LW
26
27struct magic {
28 MAGIC* mg_moremagic;
e1ec3a88 29 const MGVTBL* mg_virtual; /* pointer to magic functions */
79072805
LW
30 U16 mg_private;
31 char mg_type;
32 U8 mg_flags;
33 SV* mg_obj;
34 char* mg_ptr;
565764a8 35 I32 mg_len;
79072805 36};
8990e307 37
cb50f42d
YST
38#define MGf_TAINTEDDIR 1 /* PERL_MAGIC_envelem only */
39#define MGf_MINMATCH 1 /* PERL_MAGIC_regex_global only */
85e6fe83 40#define MGf_REFCOUNTED 2
a0d0e21e 41#define MGf_GSKIP 4
a5063e7c
DM
42#define MGf_COPY 8 /* has an svt_copy MGVTBL entry */
43#define MGf_DUP 0x10 /* has an svt_dup MGVTBL entry */
44#define MGf_LOCAL 0x20 /* has an svt_local MGVTBL entry */
748a9306 45
1e422769
PP
46#define MgTAINTEDDIR(mg) (mg->mg_flags & MGf_TAINTEDDIR)
47#define MgTAINTEDDIR_on(mg) (mg->mg_flags |= MGf_TAINTEDDIR)
48#define MgTAINTEDDIR_off(mg) (mg->mg_flags &= ~MGf_TAINTEDDIR)
99069129 49
32da55ab 50#define MgPV(mg,lp) ((((int)(lp = (mg)->mg_len)) == HEf_SVKEY) ? \
5aabfad6
PP
51 SvPV((SV*)((mg)->mg_ptr),lp) : \
52 (mg)->mg_ptr)
01b8bcb7
NC
53#define MgPV_const(mg,lp) ((((int)(lp = (mg)->mg_len)) == HEf_SVKEY) ? \
54 SvPV_const((SV*)((mg)->mg_ptr),lp) : \
55 (const char*)(mg)->mg_ptr)
56#define MgPV_nolen_const(mg) (((((int)(mg)->mg_len)) == HEf_SVKEY) ? \
57 SvPV_nolen_const((SV*)((mg)->mg_ptr)) : \
fa28a6c6 58 (const char*)(mg)->mg_ptr)
33c27489
GS
59
60#define SvTIED_mg(sv,how) \
61 (SvRMAGICAL(sv) ? mg_find((sv),(how)) : Null(MAGIC*))
62#define SvTIED_obj(sv,mg) \
63 ((mg)->mg_obj ? (mg)->mg_obj : sv_2mortal(newRV(sv)))