[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 */
    U32		gp_flags;	/* XXX unused */
    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))

#define GvGP(gv)	(GvXPVGV(gv)->xgv_gp)
#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)

#define GvNAME_get(gv)		(0 + GvXPVGV(gv)->xgv_name)
#define GvNAMELEN_get(gv)	(0 + GvXPVGV(gv)->xgv_namelen)
#define	GvASSIGN_GENERATION(gv)		(0 + ((XPV*) SvANY(gv))->xpv_cur)
#define	GvASSIGN_GENERATION_set(gv,val)			\
	STMT_START { assert(SvTYPE(gv) == SVt_PVGV);	\
		(((XPV*) SvANY(gv))->xpv_cur = (val)); } STMT_END

/*
=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 ? Nullcv : GvGP(gv)->gp_cv)

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

#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)

/* XXX: all GvFLAGS options are used, borrowing GvGPFLAGS for the moment */

#define GVf_UNIQUE           0x0001
#define GvUNIQUE(gv)         (GvGP(gv) && (GvGPFLAGS(gv) & GVf_UNIQUE))
#define GvUNIQUE_on(gv)      (GvGPFLAGS(gv) |= GVf_UNIQUE)
#define GvUNIQUE_off(gv)     (GvGPFLAGS(gv) &= ~GVf_UNIQUE)

#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
				   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 */
#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	*
e6906430	3	* Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2c351e65	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 */
f4c556ac	21	U32 gp_flags; /* XXX unused */
79072805	22	line_t gp_line; /* line first declared at (for -w) */
ec6f298e	23	char * gp_file; /* 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 AD	28	#define GvGP(gv) (GvXPVGV(gv)->xgv_gp)
	29	#define GvNAME(gv) (GvXPVGV(gv)->xgv_name)
	30	#define GvNAMELEN(gv) (GvXPVGV(gv)->xgv_namelen)
	31	#define GvSTASH(gv) (GvXPVGV(gv)->xgv_stash)
	32	#define GvFLAGS(gv) (GvXPVGV(gv)->xgv_flags)
	33
23d47fdc NC	34	#define GvNAME_get(gv) (0 + GvXPVGV(gv)->xgv_name)
23d47fdc NC	35	#define GvNAMELEN_get(gv) (0 + GvXPVGV(gv)->xgv_namelen)
2ebc12fe NC	36	#define GvASSIGN_GENERATION(gv) (0 + ((XPV*) SvANY(gv))->xpv_cur)
	37	#define GvASSIGN_GENERATION_set(gv,val) \
	38	STMT_START { assert(SvTYPE(gv) == SVt_PVGV); \
	39	(((XPV*) SvANY(gv))->xpv_cur = (val)); } STMT_END
	40
954c1994	41	/*
ccfc67b7 JH	42	=head1 GV Functions
ccfc67b7 JH	43
954c1994 GS	44	=for apidoc Am\|SV\|GvSV\|GV gv
	45
	46	Return the SV from the GV.
	47
	48	=cut
	49	*/
	50
79072805	51	#define GvSV(gv) (GvGP(gv)->gp_sv)
83fd6193 NC	52	#ifdef PERL_DONT_CREATE_GVSV
	53	#define GvSVn(gv) (*(GvGP(gv)->gp_sv ? \
	54	&(GvGP(gv)->gp_sv) : \
	55	&(GvGP(gv_SVadd(gv))->gp_sv)))
	56	#else
	57	#define GvSVn(gv) GvSV(gv)
	58	#endif
	59
79072805	60	#define GvREFCNT(gv) (GvGP(gv)->gp_refcnt)
2035c5e8	61	#define GvIO(gv) ((gv) && SvTYPE((SV*)gv) == SVt_PVGV && GvGP(gv) ? GvIOp(gv) : 0)
a0d0e21e LW	62	#define GvIOp(gv) (GvGP(gv)->gp_io)
a0d0e21e LW	63	#define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
79072805 LW	64
	65	#define GvFORM(gv) (GvGP(gv)->gp_form)
	66	#define GvAV(gv) (GvGP(gv)->gp_av)
44a8e56a	67
	68	/* This macro is deprecated. Do not use! */
	69	#define GvREFCNT_inc(gv) ((GV)SvREFCNT_inc(gv)) / DO NOT USE */
79072805	70
79072805 LW	71	#define GvAVn(gv) (GvGP(gv)->gp_av ? \
	72	GvGP(gv)->gp_av : \
	73	GvGP(gv_AVadd(gv))->gp_av)
79072805 LW	74	#define GvHV(gv) ((GvGP(gv))->gp_hv)
79072805 LW	75
79072805 LW	76	#define GvHVn(gv) (GvGP(gv)->gp_hv ? \
	77	GvGP(gv)->gp_hv : \
	78	GvGP(gv_HVadd(gv))->gp_hv)
79072805 LW	79
79072805 LW	80	#define GvCV(gv) (GvGP(gv)->gp_cv)
463ee0b2	81	#define GvCVGEN(gv) (GvGP(gv)->gp_cvgen)
8ebc5c01	82	#define GvCVu(gv) (GvGP(gv)->gp_cvgen ? Nullcv : GvGP(gv)->gp_cv)
79072805	83
f4c556ac	84	#define GvGPFLAGS(gv) (GvGP(gv)->gp_flags)
79072805 LW	85
79072805 LW	86	#define GvLINE(gv) (GvGP(gv)->gp_line)
b195d487	87	#define GvFILE(gv) (GvGP(gv)->gp_file)
57843af0	88	#define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv)))
79072805	89
79072805	90	#define GvEGV(gv) (GvGP(gv)->gp_egv)
748a9306	91	#define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
748a9306	92	#define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
79072805	93
a5f75d66 AD	94	#define GVf_INTRO 0x01
	95	#define GVf_MULTI 0x02
	96	#define GVf_ASSUMECV 0x04
743e66e6	97	#define GVf_IN_PAD 0x08
a5f75d66 AD	98	#define GVf_IMPORTED 0xF0
	99	#define GVf_IMPORTED_SV 0x10
	100	#define GVf_IMPORTED_AV 0x20
	101	#define GVf_IMPORTED_HV 0x40
	102	#define GVf_IMPORTED_CV 0x80
	103
	104	#define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO)
	105	#define GvINTRO_on(gv) (GvFLAGS(gv) \|= GVf_INTRO)
	106	#define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO)
	107
	108	#define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI)
	109	#define GvMULTI_on(gv) (GvFLAGS(gv) \|= GVf_MULTI)
	110	#define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI)
	111
	112	#define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV)
	113	#define GvASSUMECV_on(gv) (GvFLAGS(gv) \|= GVf_ASSUMECV)
	114	#define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV)
	115
	116	#define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED)
	117	#define GvIMPORTED_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED)
	118	#define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED)
	119
	120	#define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV)
	121	#define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_SV)
	122	#define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
	123
	124	#define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV)
	125	#define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_AV)
	126	#define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
	127
	128	#define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV)
	129	#define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_HV)
	130	#define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
	131
	132	#define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV)
	133	#define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_CV)
	134	#define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
	135
743e66e6 GS	136	#define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD)
	137	#define GvIN_PAD_on(gv) (GvFLAGS(gv) \|= GVf_IN_PAD)
	138	#define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD)
	139
5bd07a3d DM	140	/* XXX: all GvFLAGS options are used, borrowing GvGPFLAGS for the moment */
5bd07a3d DM	141
7fb37951 AMS	142	#define GVf_UNIQUE 0x0001
	143	#define GvUNIQUE(gv) (GvGP(gv) && (GvGPFLAGS(gv) & GVf_UNIQUE))
	144	#define GvUNIQUE_on(gv) (GvGPFLAGS(gv) \|= GVf_UNIQUE)
	145	#define GvUNIQUE_off(gv) (GvGPFLAGS(gv) &= ~GVf_UNIQUE)
5bd07a3d DM	146
5bd07a3d DM	147	#ifdef USE_ITHREADS
7fb37951	148	#define GV_UNIQUE_CHECK
5bd07a3d	149	#else
7fb37951	150	#undef GV_UNIQUE_CHECK
5bd07a3d DM	151	#endif
5bd07a3d DM	152
79072805 LW	153	#define Nullgv Null(GV*)
	154
	155	#define DM_UID 0x003
	156	#define DM_RUID 0x001
	157	#define DM_EUID 0x002
	158	#define DM_GID 0x030
	159	#define DM_RGID 0x010
	160	#define DM_EGID 0x020
	161	#define DM_DELAY 0x100
	162
0f303493	163	/*
864dbfa3	164	* symbol creation flags, for use in gv_fetchpv() and get_*v()
0f303493	165	*/
23d47fdc NC	166	#define GV_ADD 0x01 /* add, if symbol not already there
	167	For gv_name_set, adding a HEK for the first
	168	time, so don't try to free what's there. */
0f303493 GS	169	#define GV_ADDMULTI 0x02 /* add, pretending it has been added already */
	170	#define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */
	171	#define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */
	172	#define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */
a92f283d NC	173	/* This is used by toke.c to avoid turing placeholder constants in the symbol
	174	table into full PVGVs with attached constant subroutines. */
	175	#define GV_NOADD_NOINIT 0x20 /* Don't add the symbol if it's not there.
	176	Don't init it if it is there but ! PVGV */
6aa01a30	177	#define GV_NOEXPAND 0x40 /* Don't expand SvOK() entries to PVGV */
b977d03a NC	178	#define GV_NOTQUAL 0x80 /* A plain symbol name, not qualified with a
b977d03a NC	179	package (so skip checks for :: and ') */
a92f283d	180
057b822e NC	181	/* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid
	182	as a flag to gv_fetch_pvn_flags, so ensure it lies outside this range.
	183	*/
3c71ae1e NC	184	#define gv_fullname3(sv,gv,prefix) gv_fullname4(sv,gv,prefix,TRUE)
3c71ae1e NC	185	#define gv_efullname3(sv,gv,prefix) gv_efullname4(sv,gv,prefix,TRUE)
5082993f	186	#define gv_fetchmethod(stash, name) gv_fetchmethod_autoload(stash, name, TRUE)