[perl5.git] / gv.h

/*    gv.h
 *
 *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
 *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 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 */
    U32		gp_refcnt;	/* how many globs point to this? */
    struct io *	gp_io;		/* filehandle value */
    CV *	gp_form;	/* format value */
    AV *	gp_av;		/* array value */
    HV *	gp_hv;		/* hash value */
    GV *	gp_egv;		/* effective gv, if *glob */
    CV *	gp_cv;		/* subroutine value */
    U32		gp_cvgen;	/* generational validity of cached gv_cv */
    line_t	gp_line;	/* line first declared at (for -w) */
    char *	gp_file;	/* file first declared in (for -w) */
};

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

/* MSVC++ 6.0 (_MSC_VER == 1200) can't compile pp_hot.c with DEBUGGING enabled
 * if we include the following assert(). Must be a compiler bug because it
 * works fine with MSVC++ 7.0. Borland (5.5.1) has the same problem. */
#if defined(DEBUGGING) && \
    ((!defined(_MSC_VER) || _MSC_VER > 1200) && !defined(__BORLANDC__))
#  define GvGP(gv)	(*(assert(SvTYPE(gv) == SVt_PVGV || \
				  SvTYPE(gv) == SVt_PVLV), \
			   &(GvXPVGV(gv)->xgv_gp)))
#else
#  define GvGP(gv)	(GvXPVGV(gv)->xgv_gp)
#endif

#define GvNAME(gv)	(GvXPVGV(gv)->xgv_name)
#define GvNAMELEN(gv)	(GvXPVGV(gv)->xgv_namelen)
#define GvSTASH(gv)	(GvXPVGV(gv)->xgv_stash)
#define GvFLAGS(gv)	(GvXPVGV(gv)->xgv_flags)

/*
=head1 GV Functions

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

Return the SV 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((SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : 0)
#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)

/* This macro is deprecated.  Do not use! */
#define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv))	/* DO NOT USE */

#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)	(GvGP(gv)->gp_cv)
#define GvCVGEN(gv)	(GvGP(gv)->gp_cvgen)
#define GvCVu(gv)	(GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)

#define GvLINE(gv)	(GvGP(gv)->gp_line)
#define GvFILE(gv)	(GvGP(gv)->gp_file)
#define GvFILEGV(gv)	(gv_fetchfile(GvFILE(gv)))

#define GvEGV(gv)	(GvGP(gv)->gp_egv)
#define GvENAME(gv)	GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
#define GvESTASH(gv)	GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)

#define GVf_INTRO	0x01
#define GVf_MULTI	0x02
#define GVf_ASSUMECV	0x04
#define GVf_IN_PAD	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)

#define GvIN_PAD(gv)		(GvFLAGS(gv) & GVf_IN_PAD)
#define GvIN_PAD_on(gv)		(GvFLAGS(gv) |= GVf_IN_PAD)
#define GvIN_PAD_off(gv)	(GvFLAGS(gv) &= ~GVf_IN_PAD)

#define GvUNIQUE(gv)            0
#define GvUNIQUE_on(gv)
#define GvUNIQUE_off(gv)

#ifdef USE_ITHREADS
#define GV_UNIQUE_CHECK
#else
#undef  GV_UNIQUE_CHECK
#endif

#define Nullgv Null(GV*)

#define DM_UID   0x003
#define DM_RUID   0x001
#define DM_EUID   0x002
#define DM_GID   0x030
#define DM_RGID   0x010
#define DM_EGID   0x020
#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 */
#define GV_ADDMULTI	0x02	/* add, pretending it has been added already */
#define GV_ADDWARN	0x04	/* add, but warn if symbol wasn't already there */
#define GV_ADDINEVAL	0x08	/* add, as though we're doing so within an eval */
#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 ')  */

/*      SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
	as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range.
*/
#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)
Commit	Line	Data
a0d0e21e	1	/* gv.h
79072805	2	*
4bb101f2	3	* Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
acde74e1	4	* 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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 */
	13	U32 gp_refcnt; /* how many globs point to this? */
	14	struct io * gp_io; /* filehandle value */
	15	CV * gp_form; /* format value */
	16	AV * gp_av; /* array value */
aa689395	17	HV * gp_hv; /* hash value */
79072805 LW	18	GV * gp_egv; /* effective gv, if glob /
79072805 LW	19	CV * gp_cv; /* subroutine value */
463ee0b2	20	U32 gp_cvgen; /* generational validity of cached gv_cv */
79072805	21	line_t gp_line; /* line first declared at (for -w) */
1cb0ed9b	22	char * gp_file; /* file first declared in (for -w) */
79072805 LW	23	};
79072805 LW	24
79072805 LW	25	#define GvXPVGV(gv) ((XPVGV*)SvANY(gv))
79072805 LW	26
834268b8 SH	27	/* MSVC++ 6.0 (_MSC_VER == 1200) can't compile pp_hot.c with DEBUGGING enabled
834268b8 SH	28	* if we include the following assert(). Must be a compiler bug because it
1b94edb6	29	* works fine with MSVC++ 7.0. Borland (5.5.1) has the same problem. */
834268b8	30	#if defined(DEBUGGING) && \
1b94edb6	31	((!defined(_MSC_VER) \|\| _MSC_VER > 1200) && !defined(__BORLANDC__))
f4b190e6 NC	32	# define GvGP(gv) (*(assert(SvTYPE(gv) == SVt_PVGV \|\| \
	33	SvTYPE(gv) == SVt_PVLV), \
	34	&(GvXPVGV(gv)->xgv_gp)))
	35	#else
	36	# define GvGP(gv) (GvXPVGV(gv)->xgv_gp)
	37	#endif
	38
a5f75d66 AD	39	#define GvNAME(gv) (GvXPVGV(gv)->xgv_name)
	40	#define GvNAMELEN(gv) (GvXPVGV(gv)->xgv_namelen)
	41	#define GvSTASH(gv) (GvXPVGV(gv)->xgv_stash)
	42	#define GvFLAGS(gv) (GvXPVGV(gv)->xgv_flags)
	43
954c1994	44	/*
ccfc67b7 JH	45	=head1 GV Functions
ccfc67b7 JH	46
954c1994 GS	47	=for apidoc Am\|SV\|GvSV\|GV gv
	48
	49	Return the SV from the GV.
	50
	51	=cut
	52	*/
	53
79072805	54	#define GvSV(gv) (GvGP(gv)->gp_sv)
c69033f2	55	#ifdef PERL_DONT_CREATE_GVSV
547f15c3 NC	56	#define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \
	57	&(GvGP(gv)->gp_sv) : \
	58	&(GvGP(gv_SVadd(gv))->gp_sv)))
c69033f2 NC	59	#else
	60	#define GvSVn(gv) GvSV(gv)
	61	#endif
	62
79072805	63	#define GvREFCNT(gv) (GvGP(gv)->gp_refcnt)
2035c5e8	64	#define GvIO(gv) ((gv) && SvTYPE((SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : 0)
a0d0e21e LW	65	#define GvIOp(gv) (GvGP(gv)->gp_io)
a0d0e21e LW	66	#define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
79072805 LW	67
	68	#define GvFORM(gv) (GvGP(gv)->gp_form)
	69	#define GvAV(gv) (GvGP(gv)->gp_av)
44a8e56a	70
	71	/* This macro is deprecated. Do not use! */
	72	#define GvREFCNT_inc(gv) ((GV)SvREFCNT_inc(gv)) / DO NOT USE */
79072805	73
79072805 LW	74	#define GvAVn(gv) (GvGP(gv)->gp_av ? \
	75	GvGP(gv)->gp_av : \
	76	GvGP(gv_AVadd(gv))->gp_av)
79072805 LW	77	#define GvHV(gv) ((GvGP(gv))->gp_hv)
79072805 LW	78
79072805 LW	79	#define GvHVn(gv) (GvGP(gv)->gp_hv ? \
	80	GvGP(gv)->gp_hv : \
	81	GvGP(gv_HVadd(gv))->gp_hv)
79072805 LW	82
79072805 LW	83	#define GvCV(gv) (GvGP(gv)->gp_cv)
463ee0b2	84	#define GvCVGEN(gv) (GvGP(gv)->gp_cvgen)
601f1833	85	#define GvCVu(gv) (GvGP(gv)->gp_cvgen ? NULL : GvGP(gv)->gp_cv)
79072805	86
79072805	87	#define GvLINE(gv) (GvGP(gv)->gp_line)
b195d487	88	#define GvFILE(gv) (GvGP(gv)->gp_file)
57843af0	89	#define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv)))
79072805	90
79072805	91	#define GvEGV(gv) (GvGP(gv)->gp_egv)
748a9306	92	#define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
748a9306	93	#define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
79072805	94
a5f75d66 AD	95	#define GVf_INTRO 0x01
	96	#define GVf_MULTI 0x02
	97	#define GVf_ASSUMECV 0x04
743e66e6	98	#define GVf_IN_PAD 0x08
a5f75d66 AD	99	#define GVf_IMPORTED 0xF0
	100	#define GVf_IMPORTED_SV 0x10
	101	#define GVf_IMPORTED_AV 0x20
	102	#define GVf_IMPORTED_HV 0x40
	103	#define GVf_IMPORTED_CV 0x80
	104
	105	#define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO)
	106	#define GvINTRO_on(gv) (GvFLAGS(gv) \|= GVf_INTRO)
	107	#define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO)
	108
	109	#define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI)
	110	#define GvMULTI_on(gv) (GvFLAGS(gv) \|= GVf_MULTI)
	111	#define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI)
	112
	113	#define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV)
	114	#define GvASSUMECV_on(gv) (GvFLAGS(gv) \|= GVf_ASSUMECV)
	115	#define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV)
	116
	117	#define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED)
	118	#define GvIMPORTED_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED)
	119	#define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED)
	120
	121	#define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV)
	122	#define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_SV)
	123	#define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
	124
	125	#define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV)
	126	#define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_AV)
	127	#define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
	128
	129	#define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV)
	130	#define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_HV)
	131	#define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
	132
	133	#define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV)
	134	#define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_CV)
	135	#define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
	136
743e66e6 GS	137	#define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD)
	138	#define GvIN_PAD_on(gv) (GvFLAGS(gv) \|= GVf_IN_PAD)
	139	#define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD)
	140
49c0300d	141	#define GvUNIQUE(gv) 0
40e48b40 DM	142	#define GvUNIQUE_on(gv)
40e48b40 DM	143	#define GvUNIQUE_off(gv)
5bd07a3d DM	144
5bd07a3d DM	145	#ifdef USE_ITHREADS
7fb37951	146	#define GV_UNIQUE_CHECK
5bd07a3d	147	#else
7fb37951	148	#undef GV_UNIQUE_CHECK
5bd07a3d DM	149	#endif
5bd07a3d DM	150
79072805 LW	151	#define Nullgv Null(GV*)
	152
	153	#define DM_UID 0x003
	154	#define DM_RUID 0x001
	155	#define DM_EUID 0x002
	156	#define DM_GID 0x030
	157	#define DM_RGID 0x010
	158	#define DM_EGID 0x020
	159	#define DM_DELAY 0x100
	160
0f303493	161	/*
864dbfa3	162	* symbol creation flags, for use in gv_fetchpv() and get_*v()
0f303493 GS	163	*/
	164	#define GV_ADD 0x01 /* add, if symbol not already there */
	165	#define GV_ADDMULTI 0x02 /* add, pretending it has been added already */
	166	#define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */
	167	#define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */
	168	#define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */
add2581e NC	169	/* This is used by toke.c to avoid turing placeholder constants in the symbol
	170	table into full PVGVs with attached constant subroutines. */
	171	#define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there.
	172	Don't init it if it is there but ! PVGV */
e26df76a	173	#define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */
fafc274c NC	174	#define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a
fafc274c NC	175	package (so skip checks for :: and ') */
add2581e	176
7a5fd60d NC	177	/* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
	178	as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range.
	179	*/
d9a22066 NC	180	#define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
d9a22066 NC	181	#define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
887986eb	182	#define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)