This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Remove per-thread section; move to real scns
[perl5.git] / mg.h
CommitLineData
a0d0e21e 1/* mg.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999,
1129b882 4 * 2000, 2002, 2005, 2006, 2007, 2008 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
11struct mgvtbl {
16c91539
BM
12 int (*svt_get) (pTHX_ SV *sv, MAGIC* mg);
13 int (*svt_set) (pTHX_ SV *sv, MAGIC* mg);
14 U32 (*svt_len) (pTHX_ SV *sv, MAGIC* mg);
6a84ef7c 15 int (*svt_clear) (pTHX_ SV *sv, MAGIC* mg);
16c91539
BM
16 int (*svt_free) (pTHX_ SV *sv, MAGIC* mg);
17 int (*svt_copy) (pTHX_ SV *sv, MAGIC* mg,
3468c7ea 18 SV *nsv, const char *name, I32 namlen);
16c91539
BM
19 int (*svt_dup) (pTHX_ MAGIC *mg, CLONE_PARAMS *param);
20 int (*svt_local)(pTHX_ SV *nsv, MAGIC *mg);
79072805
LW
21};
22
23struct magic {
24 MAGIC* mg_moremagic;
92e67595 25 MGVTBL* mg_virtual; /* pointer to magic functions */
79072805
LW
26 U16 mg_private;
27 char mg_type;
28 U8 mg_flags;
6174b39a 29 SSize_t mg_len;
79072805
LW
30 SV* mg_obj;
31 char* mg_ptr;
79072805 32};
8990e307 33
cb50f42d
YST
34#define MGf_TAINTEDDIR 1 /* PERL_MAGIC_envelem only */
35#define MGf_MINMATCH 1 /* PERL_MAGIC_regex_global only */
aa38f4b1 36#define MGf_REQUIRE_GV 1 /* PERL_MAGIC_checkcall only */
85e6fe83 37#define MGf_REFCOUNTED 2
fd69380d 38#define MGf_GSKIP 4 /* skip further GETs until after next SET */
a5063e7c
DM
39#define MGf_COPY 8 /* has an svt_copy MGVTBL entry */
40#define MGf_DUP 0x10 /* has an svt_dup MGVTBL entry */
41#define MGf_LOCAL 0x20 /* has an svt_local MGVTBL entry */
25fdce4a 42#define MGf_BYTES 0x40 /* PERL_MAGIC_regex_global only */
d39c26a6 43#define MGf_PERSIST 0x80 /* PERL_MAGIC_lvref only */
748a9306 44
1e422769
PP
45#define MgTAINTEDDIR(mg) (mg->mg_flags & MGf_TAINTEDDIR)
46#define MgTAINTEDDIR_on(mg) (mg->mg_flags |= MGf_TAINTEDDIR)
47#define MgTAINTEDDIR_off(mg) (mg->mg_flags &= ~MGf_TAINTEDDIR)
99069129 48
32da55ab 49#define MgPV(mg,lp) ((((int)(lp = (mg)->mg_len)) == HEf_SVKEY) ? \
b1bc3f34 50 SvPV(MUTABLE_SV((mg)->mg_ptr),lp) : \
5aabfad6 51 (mg)->mg_ptr)
01b8bcb7 52#define MgPV_const(mg,lp) ((((int)(lp = (mg)->mg_len)) == HEf_SVKEY) ? \
b1bc3f34 53 SvPV_const(MUTABLE_SV((mg)->mg_ptr),lp) : \
01b8bcb7 54 (const char*)(mg)->mg_ptr)
b1bc3f34
NC
55#define MgPV_nolen_const(mg) (((((int)(mg)->mg_len)) == HEf_SVKEY) ? \
56 SvPV_nolen_const(MUTABLE_SV((mg)->mg_ptr)) : \
fa28a6c6 57 (const char*)(mg)->mg_ptr)
33c27489 58
4608196e 59#define SvTIED_mg(sv,how) (SvRMAGICAL(sv) ? mg_find((sv),(how)) : NULL)
33c27489
GS
60#define SvTIED_obj(sv,mg) \
61 ((mg)->mg_obj ? (mg)->mg_obj : sv_2mortal(newRV(sv)))
e9a8c099 62
25fdce4a
FC
63#if defined(PERL_CORE) || defined(PERL_EXT)
64# define MgBYTEPOS(mg,sv,pv,len) S_MgBYTEPOS(aTHX_ mg,sv,pv,len)
65/* assumes get-magic and stringification have already occurred */
66# define MgBYTEPOS_set(mg,sv,pv,off) ( \
67 assert_((mg)->mg_type == PERL_MAGIC_regex_global) \
ed382232 68 SvPOK(sv) && (!SvGMAGICAL(sv) || sv_only_taint_gmagic(sv)) \
25fdce4a
FC
69 ? (mg)->mg_len = (off), (mg)->mg_flags |= MGf_BYTES \
70 : ((mg)->mg_len = DO_UTF8(sv) \
4df947ee
FC
71 ? (SSize_t)utf8_length((U8 *)(pv), (U8 *)(pv)+(off)) \
72 : (SSize_t)(off), \
25fdce4a
FC
73 (mg)->mg_flags &= ~MGf_BYTES))
74#endif
75
84c7b88c
BF
76#define whichsig(pv) whichsig_pv(pv)
77
e9a8c099 78/*
14d04a33 79 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 80 */