[perl5.git] / gv.h

/*    gv.h
 *
 *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
 *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

struct gp {
    SV *	gp_sv;		/* scalar value */
    struct io *	gp_io;		/* filehandle value */
    CV *	gp_cv;		/* subroutine value */
    U32		gp_cvgen;	/* generational validity of cached gp_cv */
    U32		gp_refcnt;	/* how many globs point to this? */
    HV *	gp_hv;		/* hash value */
    AV *	gp_av;		/* array value */
    CV *	gp_form;	/* format value */
    GV *	gp_egv;		/* effective gv, if *glob */
    PERL_BITFIELD32 gp_line:31;	/* line first declared at (for -w) */
    PERL_BITFIELD32 gp_flags:1;
    HEK *	gp_file_hek;	/* file first declared in (for -w) */
};

#define GvXPVGV(gv)	((XPVGV*)SvANY(gv))


#if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS) && !defined(__INTEL_COMPILER)
#  define GvGP(gv)							\
	(0+(*({GV *const _gvgp = (GV *) (gv);				\
	    assert(SvTYPE(_gvgp) == SVt_PVGV || SvTYPE(_gvgp) == SVt_PVLV); \
	    assert(isGV_with_GP(_gvgp));				\
	    &((_gvgp)->sv_u.svu_gp);})))
#  define GvGP_set(gv,gp)						\
	{GV *const _gvgp = (GV *) (gv);				\
	    assert(SvTYPE(_gvgp) == SVt_PVGV || SvTYPE(_gvgp) == SVt_PVLV); \
	    assert(isGV_with_GP(_gvgp));				\
	    (_gvgp)->sv_u.svu_gp = (gp); }
#  define GvFLAGS(gv)							\
	(*({GV *const _gvflags = (GV *) (gv);				\
	    assert(SvTYPE(_gvflags) == SVt_PVGV || SvTYPE(_gvflags) == SVt_PVLV); \
	    assert(isGV_with_GP(_gvflags));				\
	    &(GvXPVGV(_gvflags)->xpv_cur);}))
#  define GvSTASH(gv)							\
	(*({ GV * const _gvstash = (GV *) (gv);				\
	    assert(isGV_with_GP(_gvstash));				\
	    assert(SvTYPE(_gvstash) == SVt_PVGV || SvTYPE(_gvstash) >= SVt_PVLV); \
	    &(GvXPVGV(_gvstash)->xnv_u.xgv_stash);			\
	 }))
#  define GvNAME_HEK(gv)						\
    (*({ GV * const _gvname_hek = (GV *) (gv);				\
	   assert(isGV_with_GP(_gvname_hek));				\
	   assert(SvTYPE(_gvname_hek) == SVt_PVGV || SvTYPE(_gvname_hek) >= SVt_PVLV); \
	   &(GvXPVGV(_gvname_hek)->xiv_u.xivu_namehek);			\
	 }))
#  define GvNAME_get(gv)	({ assert(GvNAME_HEK(gv)); (char *)HEK_KEY(GvNAME_HEK(gv)); })
#  define GvNAMELEN_get(gv)	({ assert(GvNAME_HEK(gv)); HEK_LEN(GvNAME_HEK(gv)); })
#  define GvNAMEUTF8(gv)	({ assert(GvNAME_HEK(gv)); HEK_UTF8(GvNAME_HEK(gv)); })
#else
#  define GvGP(gv)	(0+(gv)->sv_u.svu_gp)
#  define GvGP_set(gv,gp)	((gv)->sv_u.svu_gp = (gp))
#  define GvFLAGS(gv)	(GvXPVGV(gv)->xpv_cur)
#  define GvSTASH(gv)	(GvXPVGV(gv)->xnv_u.xgv_stash)
#  define GvNAME_HEK(gv)	(GvXPVGV(gv)->xiv_u.xivu_namehek)
#  define GvNAME_get(gv)	HEK_KEY(GvNAME_HEK(gv))
#  define GvNAMELEN_get(gv)	HEK_LEN(GvNAME_HEK(gv))
#  define GvNAMEUTF8(gv)	HEK_UTF8(GvNAME_HEK(gv))
#endif

#define GvNAME(gv)	GvNAME_get(gv)
#define GvNAMELEN(gv)	GvNAMELEN_get(gv)

/*
=for apidoc_section GV Handling

=for apidoc Am|SV*|GvSV|GV* gv

Return the SV from the GV.

Prior to Perl v5.9.3, this would add a scalar if none existed.  Nowadays, use
C<L</GvSVn>> for that, or compile perl with S<C<-DPERL_CREATE_GVSV>>.  See
L<perl5100delta>.

=for apidoc Am|SV*|GvSVn|GV* gv
Like C<L</GvSV>>, but creates an empty scalar if none already exists.

=for apidoc Am|AV*|GvAV|GV* gv

Return the AV from the GV.

=for apidoc Am|HV*|GvHV|GV* gv

Return the HV from the GV.

=for apidoc Am|CV*|GvCV|GV* gv

Return the CV from the GV.

=cut
*/

#define GvSV(gv)	(GvGP(gv)->gp_sv)
#ifdef PERL_DONT_CREATE_GVSV
#define GvSVn(gv)	(*(GvGP(gv)->gp_sv ? \
			 &(GvGP(gv)->gp_sv) : \
			 &(GvGP(gv_SVadd(gv))->gp_sv)))
#else
#define GvSVn(gv)	GvSV(gv)
#endif

#define GvREFCNT(gv)	(GvGP(gv)->gp_refcnt)
#define GvIO(gv)                         \
 (                                        \
     (gv)                                  \
  && (                                      \
         SvTYPE((const SV*)(gv)) == SVt_PVGV \
      || SvTYPE((const SV*)(gv)) == SVt_PVLV  \
     )                                         \
  && GvGP(gv)                                   \
   ? GvIOp(gv)                                   \
   : NULL                                         \
 )
#define GvIOp(gv)	(GvGP(gv)->gp_io)
#define GvIOn(gv)	(GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))

#define GvFORM(gv)	(GvGP(gv)->gp_form)
#define GvAV(gv)	(GvGP(gv)->gp_av)

#define GvAVn(gv)	(GvGP(gv)->gp_av ? \
			 GvGP(gv)->gp_av : \
			 GvGP(gv_AVadd(gv))->gp_av)
#define GvHV(gv)	((GvGP(gv))->gp_hv)

#define GvHVn(gv)	(GvGP(gv)->gp_hv ? \
			 GvGP(gv)->gp_hv : \
			 GvGP(gv_HVadd(gv))->gp_hv)

#define GvCV(gv)	(0+GvGP(gv)->gp_cv)
#define GvCV_set(gv,cv)	(GvGP(gv)->gp_cv = (cv))
#define GvCVGEN(gv)	(GvGP(gv)->gp_cvgen)
#define GvCVu(gv)	(GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)

#define GvGPFLAGS(gv)	(GvGP(gv)->gp_flags)

#define GvLINE(gv)	(GvGP(gv)->gp_line)
#define GvFILE_HEK(gv)	(GvGP(gv)->gp_file_hek)
#define GvFILEx(gv)	HEK_KEY(GvFILE_HEK(gv))
#define GvFILE(gv)	(GvFILE_HEK(gv) ? GvFILEx(gv) : NULL)
#define GvFILEGV(gv)	(GvFILE_HEK(gv) ? gv_fetchfile(GvFILEx(gv)) : NULL)

#define GvEGV(gv)	(GvGP(gv)->gp_egv)
#define GvEGVx(gv)	(isGV_with_GP(gv) ? GvEGV(gv) : NULL)
#define GvENAME(gv)	GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
#define GvENAMELEN(gv)  GvNAMELEN(GvEGV(gv) ? GvEGV(gv) : gv)
#define GvENAMEUTF8(gv) GvNAMEUTF8(GvEGV(gv) ? GvEGV(gv) : gv)
#define GvENAME_HEK(gv) GvNAME_HEK(GvEGV(gv) ? GvEGV(gv) : gv)
#define GvESTASH(gv)	GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)

/* GVf_INTRO is one-shot flag which indicates that the next assignment
   of a reference to the glob is to be localised; it distinguishes
   'local *g = $ref' from '*g = $ref'.
*/
#define GVf_INTRO	0x01
#define GVf_MULTI	0x02
#define GVf_ASSUMECV	0x04
/*	UNUSED		0x08 */
#define GVf_IMPORTED	0xF0
#define GVf_IMPORTED_SV	  0x10
#define GVf_IMPORTED_AV	  0x20
#define GVf_IMPORTED_HV	  0x40
#define GVf_IMPORTED_CV	  0x80

#define GvINTRO(gv)		(GvFLAGS(gv) & GVf_INTRO)
#define GvINTRO_on(gv)		(GvFLAGS(gv) |= GVf_INTRO)
#define GvINTRO_off(gv)		(GvFLAGS(gv) &= ~GVf_INTRO)

#define GvMULTI(gv)		(GvFLAGS(gv) & GVf_MULTI)
#define GvMULTI_on(gv)		(GvFLAGS(gv) |= GVf_MULTI)
#define GvMULTI_off(gv)		(GvFLAGS(gv) &= ~GVf_MULTI)

#define GvASSUMECV(gv)		(GvFLAGS(gv) & GVf_ASSUMECV)
#define GvASSUMECV_on(gv)	(GvFLAGS(gv) |= GVf_ASSUMECV)
#define GvASSUMECV_off(gv)	(GvFLAGS(gv) &= ~GVf_ASSUMECV)

#define GvIMPORTED(gv)		(GvFLAGS(gv) & GVf_IMPORTED)
#define GvIMPORTED_on(gv)	(GvFLAGS(gv) |= GVf_IMPORTED)
#define GvIMPORTED_off(gv)	(GvFLAGS(gv) &= ~GVf_IMPORTED)

#define GvIMPORTED_SV(gv)	(GvFLAGS(gv) & GVf_IMPORTED_SV)
#define GvIMPORTED_SV_on(gv)	(GvFLAGS(gv) |= GVf_IMPORTED_SV)
#define GvIMPORTED_SV_off(gv)	(GvFLAGS(gv) &= ~GVf_IMPORTED_SV)

#define GvIMPORTED_AV(gv)	(GvFLAGS(gv) & GVf_IMPORTED_AV)
#define GvIMPORTED_AV_on(gv)	(GvFLAGS(gv) |= GVf_IMPORTED_AV)
#define GvIMPORTED_AV_off(gv)	(GvFLAGS(gv) &= ~GVf_IMPORTED_AV)

#define GvIMPORTED_HV(gv)	(GvFLAGS(gv) & GVf_IMPORTED_HV)
#define GvIMPORTED_HV_on(gv)	(GvFLAGS(gv) |= GVf_IMPORTED_HV)
#define GvIMPORTED_HV_off(gv)	(GvFLAGS(gv) &= ~GVf_IMPORTED_HV)

#define GvIMPORTED_CV(gv)	(GvFLAGS(gv) & GVf_IMPORTED_CV)
#define GvIMPORTED_CV_on(gv)	(GvFLAGS(gv) |= GVf_IMPORTED_CV)
#define GvIMPORTED_CV_off(gv)	(GvFLAGS(gv) &= ~GVf_IMPORTED_CV)

#ifndef PERL_CORE
#  define GvIN_PAD(gv)		0
#  define GvIN_PAD_on(gv)	NOOP
#  define GvIN_PAD_off(gv)	NOOP
#  define Nullgv Null(GV*)
#endif

#define DM_RUID      0x001
#define DM_EUID      0x002
#define DM_UID       (DM_RUID|DM_EUID)
#define DM_ARRAY_ISA 0x004
#define DM_RGID      0x010
#define DM_EGID      0x020
#define DM_GID       (DM_RGID|DM_EGID)
#define DM_DELAY     0x100

/*
 * symbol creation flags, for use in gv_fetchpv() and get_*v()
 */
#define GV_ADD		0x01	/* add, if symbol not already there
				   For gv_name_set, adding a HEK for the first
				   time, so don't try to free what's there.  */
#define GV_ADDMULTI	0x02	/* add, pretending it has been added
				   already; used also by gv_init_* */
#define GV_ADDWARN	0x04	/* add, but warn if symbol wasn't already there */
		/*	0x08	   UNUSED */
#define GV_NOINIT	0x10	/* add, but don't init symbol, if type != PVGV */
/* This is used by toke.c to avoid turing placeholder constants in the symbol
   table into full PVGVs with attached constant subroutines.  */
#define GV_NOADD_NOINIT	0x20	/* Don't add the symbol if it's not there.
				   Don't init it if it is there but ! PVGV */
#define GV_NOEXPAND	0x40	/* Don't expand SvOK() entries to PVGV */
#define GV_NOTQUAL	0x80	/* A plain symbol name, not qualified with a
				   package (so skip checks for :: and ')  */
#define GV_AUTOLOAD	0x100	/* gv_fetchmethod_flags() should AUTOLOAD  */
#define GV_CROAK	0x200	/* gv_fetchmethod_flags() should croak  */
#define GV_ADDMG	0x400	/* add if magical */
#define GV_NO_SVGMAGIC	0x800	/* Skip get-magic on an SV argument;
				   used only by gv_fetchsv(_nomg) */
#define GV_CACHE_ONLY	0x1000  /* return stash only if found in cache;
				   used only in flags parameter to gv_stash* family */

/* Flags for gv_fetchmeth_pvn and gv_autoload_pvn*/
#define GV_SUPER	0x1000	/* SUPER::method */

/* Flags for gv_autoload_*/
#define GV_AUTOLOAD_ISMETHOD 1	/* autoloading a method? */

/*      SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
	as a flag to various gv_* functions, so ensure it lies
	outside this range.
*/

#define GV_NOADD_MASK \
  (SVf_UTF8|GV_NOADD_NOINIT|GV_NOEXPAND|GV_NOTQUAL|GV_ADDMG|GV_NO_SVGMAGIC)
/* The bit flags that don't cause gv_fetchpv() to add a symbol if not
   found (with the exception GV_ADDMG, which *might* cause the symbol
   to be added) */

#define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
#define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
#define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)
#define gv_fetchsv_nomg(n,f,t) gv_fetchsv(n,(f)|GV_NO_SVGMAGIC,t)
#define gv_init(gv,stash,name,len,multi) \
	gv_init_pvn(gv,stash,name,len,GV_ADDMULTI*!!(multi))
#define gv_fetchmeth(stash,name,len,level) gv_fetchmeth_pvn(stash, name, len, level, 0)
#define gv_fetchmeth_autoload(stash,name,len,level) gv_fetchmeth_pvn_autoload(stash, name, len, level, 0)
#define gv_fetchmethod_flags(stash,name,flags) gv_fetchmethod_pv_flags(stash, name, flags)
#define gv_autoload4(stash, name, len, autoload) \
	gv_autoload_pvn(stash, name, len, !!(autoload))
#define newGVgen(pack)  newGVgen_flags(pack, 0)
#define gv_method_changed(gv)		    \
    (					     \
    	assert_(isGV_with_GP(gv))	      \
	GvREFCNT(gv) > 1		       \
	    ? (void)++PL_sub_generation		\
	    : mro_method_changed_in(GvSTASH(gv)) \
    )

#define gv_AVadd(gv) gv_add_by_type((gv), SVt_PVAV)
#define gv_HVadd(gv) gv_add_by_type((gv), SVt_PVHV)
#define gv_IOadd(gv) gv_add_by_type((gv), SVt_PVIO)
#define gv_SVadd(gv) gv_add_by_type((gv), SVt_NULL)

/*
 * ex: set ts=8 sts=4 sw=4 et:
 */
Commit	Line	Data
a0d0e21e	1	/* gv.h
79072805	2	*
1129b882 NC	3	* Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
1129b882 NC	4	* 2001, 2002, 2003, 2004, 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
	11	struct gp {
	12	SV * gp_sv; /* scalar value */
79072805	13	struct io * gp_io; /* filehandle value */
79072805	14	CV * gp_cv; /* subroutine value */
5d855216	15	U32 gp_cvgen; /* generational validity of cached gp_cv */
9bd87817 NC	16	U32 gp_refcnt; /* how many globs point to this? */
	17	HV * gp_hv; /* hash value */
	18	AV * gp_av; /* array value */
	19	CV * gp_form; /* format value */
	20	GV * gp_egv; /* effective gv, if glob /
e12ab2f2 FC	21	PERL_BITFIELD32 gp_line:31; /* line first declared at (for -w) */
e12ab2f2 FC	22	PERL_BITFIELD32 gp_flags:1;
f4890806	23	HEK * gp_file_hek; /* file first declared in (for -w) */
79072805 LW	24	};
79072805 LW	25
79072805 LW	26	#define GvXPVGV(gv) ((XPVGV*)SvANY(gv))
79072805 LW	27
a5f75d66	28
041c1a23	29	#if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS) && !defined(__INTEL_COMPILER)
dedf8e73	30	# define GvGP(gv) \
c43ae56f	31	(0+(({GV const _gvgp = (GV *) (gv); \
603aa20d RU	32	assert(SvTYPE(_gvgp) == SVt_PVGV \|\| SvTYPE(_gvgp) == SVt_PVLV); \
603aa20d RU	33	assert(isGV_with_GP(_gvgp)); \
c43ae56f DM	34	&((_gvgp)->sv_u.svu_gp);})))
	35	# define GvGP_set(gv,gp) \
	36	{GV const _gvgp = (GV ) (gv); \
	37	assert(SvTYPE(_gvgp) == SVt_PVGV \|\| SvTYPE(_gvgp) == SVt_PVLV); \
	38	assert(isGV_with_GP(_gvgp)); \
	39	(_gvgp)->sv_u.svu_gp = (gp); }
dedf8e73	40	# define GvFLAGS(gv) \
603aa20d RU	41	(({GV const _gvflags = (GV *) (gv); \
	42	assert(SvTYPE(_gvflags) == SVt_PVGV \|\| SvTYPE(_gvflags) == SVt_PVLV); \
	43	assert(isGV_with_GP(_gvflags)); \
	44	&(GvXPVGV(_gvflags)->xpv_cur);}))
c72c5e99	45	# define GvSTASH(gv) \
603aa20d RU	46	(({ GV const _gvstash = (GV *) (gv); \
	47	assert(isGV_with_GP(_gvstash)); \
	48	assert(SvTYPE(_gvstash) == SVt_PVGV \|\| SvTYPE(_gvstash) >= SVt_PVLV); \
	49	&(GvXPVGV(_gvstash)->xnv_u.xgv_stash); \
c72c5e99	50	}))
acda4c6a	51	# define GvNAME_HEK(gv) \
603aa20d RU	52	(({ GV const _gvname_hek = (GV *) (gv); \
	53	assert(isGV_with_GP(_gvname_hek)); \
	54	assert(SvTYPE(_gvname_hek) == SVt_PVGV \|\| SvTYPE(_gvname_hek) >= SVt_PVLV); \
603aa20d	55	&(GvXPVGV(_gvname_hek)->xiv_u.xivu_namehek); \
acda4c6a	56	}))
1404b487	57	# define GvNAME_get(gv) ({ assert(GvNAME_HEK(gv)); (char *)HEK_KEY(GvNAME_HEK(gv)); })
9f616d01	58	# define GvNAMELEN_get(gv) ({ assert(GvNAME_HEK(gv)); HEK_LEN(GvNAME_HEK(gv)); })
b2c03ebd	59	# define GvNAMEUTF8(gv) ({ assert(GvNAME_HEK(gv)); HEK_UTF8(GvNAME_HEK(gv)); })
c72c5e99	60	#else
c43ae56f DM	61	# define GvGP(gv) (0+(gv)->sv_u.svu_gp)
c43ae56f DM	62	# define GvGP_set(gv,gp) ((gv)->sv_u.svu_gp = (gp))
5526b5b3	63	# define GvFLAGS(gv) (GvXPVGV(gv)->xpv_cur)
58430790	64	# define GvSTASH(gv) (GvXPVGV(gv)->xnv_u.xgv_stash)
274ac62a	65	# define GvNAME_HEK(gv) (GvXPVGV(gv)->xiv_u.xivu_namehek)
9f616d01 MHM	66	# define GvNAME_get(gv) HEK_KEY(GvNAME_HEK(gv))
9f616d01 MHM	67	# define GvNAMELEN_get(gv) HEK_LEN(GvNAME_HEK(gv))
b2c03ebd	68	# define GvNAMEUTF8(gv) HEK_UTF8(GvNAME_HEK(gv))
c72c5e99	69	#endif
dedf8e73	70
f5c1e807 NC	71	#define GvNAME(gv) GvNAME_get(gv)
	72	#define GvNAMELEN(gv) GvNAMELEN_get(gv)
	73
954c1994	74	/*
51b56f5c	75	=for apidoc_section GV Handling
ccfc67b7	76
954c1994 GS	77	=for apidoc Am\|SV\|GvSV\|GV gv
	78
	79	Return the SV from the GV.
	80
0f1c8062 KW	81	Prior to Perl v5.9.3, this would add a scalar if none existed. Nowadays, use
	82	C<L</GvSVn>> for that, or compile perl with S<C<-DPERL_CREATE_GVSV>>. See
	83	L<perl5100delta>.
	84
	85	=for apidoc Am\|SV\|GvSVn\|GV gv
	86	Like C<L</GvSV>>, but creates an empty scalar if none already exists.
	87
b019ef6e JL	88	=for apidoc Am\|AV\|GvAV\|GV gv
	89
	90	Return the AV from the GV.
	91
	92	=for apidoc Am\|HV\|GvHV\|GV gv
	93
	94	Return the HV from the GV.
	95
	96	=for apidoc Am\|CV\|GvCV\|GV gv
	97
	98	Return the CV from the GV.
	99
954c1994 GS	100	=cut
	101	*/
	102
79072805	103	#define GvSV(gv) (GvGP(gv)->gp_sv)
c69033f2	104	#ifdef PERL_DONT_CREATE_GVSV
13c59d41 MH	105	#define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \
	106	&(GvGP(gv)->gp_sv) : \
	107	&(GvGP(gv_SVadd(gv))->gp_sv)))
c69033f2 NC	108	#else
	109	#define GvSVn(gv) GvSV(gv)
	110	#endif
	111
79072805	112	#define GvREFCNT(gv) (GvGP(gv)->gp_refcnt)
13be902c FC	113	#define GvIO(gv) \
	114	( \
	115	(gv) \
	116	&& ( \
	117	SvTYPE((const SV*)(gv)) == SVt_PVGV \
	118	\|\| SvTYPE((const SV*)(gv)) == SVt_PVLV \
	119	) \
	120	&& GvGP(gv) \
	121	? GvIOp(gv) \
	122	: NULL \
	123	)
a0d0e21e	124	#define GvIOp(gv) (GvGP(gv)->gp_io)
13c59d41	125	#define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
79072805 LW	126
	127	#define GvFORM(gv) (GvGP(gv)->gp_form)
	128	#define GvAV(gv) (GvGP(gv)->gp_av)
44a8e56a	129
79072805 LW	130	#define GvAVn(gv) (GvGP(gv)->gp_av ? \
79072805 LW	131	GvGP(gv)->gp_av : \
13c59d41	132	GvGP(gv_AVadd(gv))->gp_av)
79072805 LW	133	#define GvHV(gv) ((GvGP(gv))->gp_hv)
79072805 LW	134
79072805 LW	135	#define GvHVn(gv) (GvGP(gv)->gp_hv ? \
79072805 LW	136	GvGP(gv)->gp_hv : \
13c59d41	137	GvGP(gv_HVadd(gv))->gp_hv)
79072805	138
c43ae56f DM	139	#define GvCV(gv) (0+GvGP(gv)->gp_cv)
c43ae56f DM	140	#define GvCV_set(gv,cv) (GvGP(gv)->gp_cv = (cv))
463ee0b2	141	#define GvCVGEN(gv) (GvGP(gv)->gp_cvgen)
601f1833	142	#define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)
79072805	143
4a8cd1ba FC	144	#define GvGPFLAGS(gv) (GvGP(gv)->gp_flags)
4a8cd1ba FC	145
79072805	146	#define GvLINE(gv) (GvGP(gv)->gp_line)
f4890806	147	#define GvFILE_HEK(gv) (GvGP(gv)->gp_file_hek)
c835650e DM	148	#define GvFILEx(gv) HEK_KEY(GvFILE_HEK(gv))
	149	#define GvFILE(gv) (GvFILE_HEK(gv) ? GvFILEx(gv) : NULL)
	150	#define GvFILEGV(gv) (GvFILE_HEK(gv) ? gv_fetchfile(GvFILEx(gv)) : NULL)
79072805	151
79072805	152	#define GvEGV(gv) (GvGP(gv)->gp_egv)
099be4f1	153	#define GvEGVx(gv) (isGV_with_GP(gv) ? GvEGV(gv) : NULL)
748a9306	154	#define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
f2462604 BF	155	#define GvENAMELEN(gv) GvNAMELEN(GvEGV(gv) ? GvEGV(gv) : gv)
	156	#define GvENAMEUTF8(gv) GvNAMEUTF8(GvEGV(gv) ? GvEGV(gv) : gv)
	157	#define GvENAME_HEK(gv) GvNAME_HEK(GvEGV(gv) ? GvEGV(gv) : gv)
748a9306	158	#define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
79072805	159
364bbfa4 TC	160	/* GVf_INTRO is one-shot flag which indicates that the next assignment
	161	of a reference to the glob is to be localised; it distinguishes
	162	'local g = $ref' from 'g = $ref'.
	163	*/
a5f75d66 AD	164	#define GVf_INTRO 0x01
	165	#define GVf_MULTI 0x02
	166	#define GVf_ASSUMECV 0x04
a5bc03e9	167	/* UNUSED 0x08 */
a5f75d66 AD	168	#define GVf_IMPORTED 0xF0
	169	#define GVf_IMPORTED_SV 0x10
	170	#define GVf_IMPORTED_AV 0x20
	171	#define GVf_IMPORTED_HV 0x40
	172	#define GVf_IMPORTED_CV 0x80
	173
	174	#define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO)
	175	#define GvINTRO_on(gv) (GvFLAGS(gv) \|= GVf_INTRO)
	176	#define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO)
	177
	178	#define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI)
	179	#define GvMULTI_on(gv) (GvFLAGS(gv) \|= GVf_MULTI)
	180	#define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI)
	181
	182	#define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV)
	183	#define GvASSUMECV_on(gv) (GvFLAGS(gv) \|= GVf_ASSUMECV)
	184	#define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV)
	185
	186	#define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED)
	187	#define GvIMPORTED_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED)
	188	#define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED)
	189
	190	#define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV)
	191	#define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_SV)
	192	#define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
	193
	194	#define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV)
	195	#define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_AV)
	196	#define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
	197
	198	#define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV)
	199	#define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_HV)
	200	#define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
	201
	202	#define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV)
	203	#define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_CV)
	204	#define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
	205
3ae1b226	206	#ifndef PERL_CORE
a5bc03e9 FC	207	# define GvIN_PAD(gv) 0
	208	# define GvIN_PAD_on(gv) NOOP
	209	# define GvIN_PAD_off(gv) NOOP
3ae1b226 NC	210	# define Nullgv Null(GV*)
3ae1b226 NC	211	#endif
79072805	212
613a9ec2 DM	213	#define DM_RUID 0x001
613a9ec2 DM	214	#define DM_EUID 0x002
6ca8229d	215	#define DM_UID (DM_RUID\|DM_EUID)
354b0578	216	#define DM_ARRAY_ISA 0x004
613a9ec2 DM	217	#define DM_RGID 0x010
613a9ec2 DM	218	#define DM_EGID 0x020
6ca8229d	219	#define DM_GID (DM_RGID\|DM_EGID)
613a9ec2	220	#define DM_DELAY 0x100
79072805	221
0f303493	222	/*
864dbfa3	223	* symbol creation flags, for use in gv_fetchpv() and get_*v()
0f303493	224	*/
ae8cc45f NC	225	#define GV_ADD 0x01 /* add, if symbol not already there
	226	For gv_name_set, adding a HEK for the first
	227	time, so don't try to free what's there. */
04ec7e59 FC	228	#define GV_ADDMULTI 0x02 /* add, pretending it has been added
04ec7e59 FC	229	already; used also by gv_init_* */
0f303493	230	#define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */
4bff32c5	231	/* 0x08 UNUSED */
0f303493	232	#define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */
add2581e NC	233	/* This is used by toke.c to avoid turing placeholder constants in the symbol
	234	table into full PVGVs with attached constant subroutines. */
	235	#define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there.
	236	Don't init it if it is there but ! PVGV */
e26df76a	237	#define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */
fafc274c NC	238	#define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a
fafc274c NC	239	package (so skip checks for :: and ') */
256d1bb2 NC	240	#define GV_AUTOLOAD 0x100 /* gv_fetchmethod_flags() should AUTOLOAD */
256d1bb2 NC	241	#define GV_CROAK 0x200 /* gv_fetchmethod_flags() should croak */
23496c6e	242	#define GV_ADDMG 0x400 /* add if magical */
77cb3b01 FC	243	#define GV_NO_SVGMAGIC 0x800 /* Skip get-magic on an SV argument;
77cb3b01 FC	244	used only by gv_fetchsv(_nomg) */
d283e876	245	#define GV_CACHE_ONLY 0x1000 /* return stash only if found in cache;
d283e876	246	used only in flags parameter to gv_stash* family */
add2581e	247
aae43805 FC	248	/* Flags for gv_fetchmeth_pvn and gv_autoload_pvn*/
	249	#define GV_SUPER 0x1000 /* SUPER::method */
	250
0eeb01b9 FC	251	/* Flags for gv_autoload_*/
	252	#define GV_AUTOLOAD_ISMETHOD 1 /* autoloading a method? */
	253
7a5fd60d	254	/* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
04ec7e59	255	as a flag to various gv_* functions, so ensure it lies
0eeb01b9	256	outside this range.
7a5fd60d	257	*/
780a5241	258
23496c6e	259	#define GV_NOADD_MASK \
77cb3b01	260	(SVf_UTF8\|GV_NOADD_NOINIT\|GV_NOEXPAND\|GV_NOTQUAL\|GV_ADDMG\|GV_NO_SVGMAGIC)
23496c6e FC	261	/* The bit flags that don't cause gv_fetchpv() to add a symbol if not
	262	found (with the exception GV_ADDMG, which might cause the symbol
	263	to be added) */
780a5241	264
d9a22066 NC	265	#define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
d9a22066 NC	266	#define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
887986eb	267	#define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)
77cb3b01	268	#define gv_fetchsv_nomg(n,f,t) gv_fetchsv(n,(f)\|GV_NO_SVGMAGIC,t)
04ec7e59 FC	269	#define gv_init(gv,stash,name,len,multi) \
04ec7e59 FC	270	gv_init_pvn(gv,stash,name,len,GV_ADDMULTI*!!(multi))
d21989ed BF	271	#define gv_fetchmeth(stash,name,len,level) gv_fetchmeth_pvn(stash, name, len, level, 0)
d21989ed BF	272	#define gv_fetchmeth_autoload(stash,name,len,level) gv_fetchmeth_pvn_autoload(stash, name, len, level, 0)
44130a26	273	#define gv_fetchmethod_flags(stash,name,flags) gv_fetchmethod_pv_flags(stash, name, flags)
030d06e7 KW	274	#define gv_autoload4(stash, name, len, autoload) \
030d06e7 KW	275	gv_autoload_pvn(stash, name, len, !!(autoload))
9cc50d5b	276	#define newGVgen(pack) newGVgen_flags(pack, 0)
978a498e FC	277	#define gv_method_changed(gv) \
	278	( \
	279	assert_(isGV_with_GP(gv)) \
	280	GvREFCNT(gv) > 1 \
	281	? (void)++PL_sub_generation \
	282	: mro_method_changed_in(GvSTASH(gv)) \
	283	)
f4890806	284
13c59d41 MH	285	#define gv_AVadd(gv) gv_add_by_type((gv), SVt_PVAV)
	286	#define gv_HVadd(gv) gv_add_by_type((gv), SVt_PVHV)
	287	#define gv_IOadd(gv) gv_add_by_type((gv), SVt_PVIO)
	288	#define gv_SVadd(gv) gv_add_by_type((gv), SVt_NULL)
d5713896	289
f4890806	290	/*
14d04a33	291	* ex: set ts=8 sts=4 sw=4 et:
f4890806	292	*/