[perl5.git] / gv.h

/*    gv.h
 *
 *    Copyright (c) 1991-2002, Larry Wall
 *
 *    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)

/*
=head1 GV Functions

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

Return the SV from the GV.

=cut
*/

#define GvSV(gv)	(GvGP(gv)->gp_sv)
#define GvREFCNT(gv)	(GvGP(gv)->gp_refcnt)
#define GvIO(gv)	((gv) && SvTYPE((SV*)gv) == SVt_PVGV ? 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 */
#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 */
Commit	Line	Data
a0d0e21e	1	/* gv.h
79072805	2	*
be3c0a43	3	* Copyright (c) 1991-2002, Larry Wall
79072805 LW	4	*
	5	* You may distribute under the terms of either the GNU General Public
	6	* License or the Artistic License, as specified in the README file.
	7	*
79072805 LW	8	*/
	9
	10	struct gp {
	11	SV * gp_sv; /* scalar value */
	12	U32 gp_refcnt; /* how many globs point to this? */
	13	struct io * gp_io; /* filehandle value */
	14	CV * gp_form; /* format value */
	15	AV * gp_av; /* array value */
aa689395	16	HV * gp_hv; /* hash value */
79072805 LW	17	GV * gp_egv; /* effective gv, if glob /
79072805 LW	18	CV * gp_cv; /* subroutine value */
463ee0b2	19	U32 gp_cvgen; /* generational validity of cached gv_cv */
f4c556ac	20	U32 gp_flags; /* XXX unused */
79072805	21	line_t gp_line; /* line first declared at (for -w) */
b195d487	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
a5f75d66 AD	27	#define GvGP(gv) (GvXPVGV(gv)->xgv_gp)
	28	#define GvNAME(gv) (GvXPVGV(gv)->xgv_name)
	29	#define GvNAMELEN(gv) (GvXPVGV(gv)->xgv_namelen)
	30	#define GvSTASH(gv) (GvXPVGV(gv)->xgv_stash)
	31	#define GvFLAGS(gv) (GvXPVGV(gv)->xgv_flags)
	32
954c1994	33	/*
ccfc67b7 JH	34	=head1 GV Functions
ccfc67b7 JH	35
954c1994 GS	36	=for apidoc Am\|SV\|GvSV\|GV gv
	37
	38	Return the SV from the GV.
	39
	40	=cut
	41	*/
	42
79072805 LW	43	#define GvSV(gv) (GvGP(gv)->gp_sv)
79072805 LW	44	#define GvREFCNT(gv) (GvGP(gv)->gp_refcnt)
a0d0e21e LW	45	#define GvIO(gv) ((gv) && SvTYPE((SV*)gv) == SVt_PVGV ? GvIOp(gv) : 0)
	46	#define GvIOp(gv) (GvGP(gv)->gp_io)
	47	#define GvIOn(gv) (GvIO(gv) ? GvIOp(gv) : GvIOp(gv_IOadd(gv)))
79072805 LW	48
	49	#define GvFORM(gv) (GvGP(gv)->gp_form)
	50	#define GvAV(gv) (GvGP(gv)->gp_av)
44a8e56a	51
	52	/* This macro is deprecated. Do not use! */
	53	#define GvREFCNT_inc(gv) ((GV)SvREFCNT_inc(gv)) / DO NOT USE */
79072805	54
79072805 LW	55	#define GvAVn(gv) (GvGP(gv)->gp_av ? \
	56	GvGP(gv)->gp_av : \
	57	GvGP(gv_AVadd(gv))->gp_av)
79072805 LW	58	#define GvHV(gv) ((GvGP(gv))->gp_hv)
79072805 LW	59
79072805 LW	60	#define GvHVn(gv) (GvGP(gv)->gp_hv ? \
	61	GvGP(gv)->gp_hv : \
	62	GvGP(gv_HVadd(gv))->gp_hv)
79072805 LW	63
79072805 LW	64	#define GvCV(gv) (GvGP(gv)->gp_cv)
463ee0b2	65	#define GvCVGEN(gv) (GvGP(gv)->gp_cvgen)
8ebc5c01	66	#define GvCVu(gv) (GvGP(gv)->gp_cvgen ? Nullcv : GvGP(gv)->gp_cv)
79072805	67
f4c556ac	68	#define GvGPFLAGS(gv) (GvGP(gv)->gp_flags)
79072805 LW	69
79072805 LW	70	#define GvLINE(gv) (GvGP(gv)->gp_line)
b195d487	71	#define GvFILE(gv) (GvGP(gv)->gp_file)
57843af0	72	#define GvFILEGV(gv) (gv_fetchfile(GvFILE(gv)))
79072805	73
79072805	74	#define GvEGV(gv) (GvGP(gv)->gp_egv)
748a9306	75	#define GvENAME(gv) GvNAME(GvEGV(gv) ? GvEGV(gv) : gv)
748a9306	76	#define GvESTASH(gv) GvSTASH(GvEGV(gv) ? GvEGV(gv) : gv)
79072805	77
a5f75d66 AD	78	#define GVf_INTRO 0x01
	79	#define GVf_MULTI 0x02
	80	#define GVf_ASSUMECV 0x04
743e66e6	81	#define GVf_IN_PAD 0x08
a5f75d66 AD	82	#define GVf_IMPORTED 0xF0
	83	#define GVf_IMPORTED_SV 0x10
	84	#define GVf_IMPORTED_AV 0x20
	85	#define GVf_IMPORTED_HV 0x40
	86	#define GVf_IMPORTED_CV 0x80
	87
	88	#define GvINTRO(gv) (GvFLAGS(gv) & GVf_INTRO)
	89	#define GvINTRO_on(gv) (GvFLAGS(gv) \|= GVf_INTRO)
	90	#define GvINTRO_off(gv) (GvFLAGS(gv) &= ~GVf_INTRO)
	91
	92	#define GvMULTI(gv) (GvFLAGS(gv) & GVf_MULTI)
	93	#define GvMULTI_on(gv) (GvFLAGS(gv) \|= GVf_MULTI)
	94	#define GvMULTI_off(gv) (GvFLAGS(gv) &= ~GVf_MULTI)
	95
	96	#define GvASSUMECV(gv) (GvFLAGS(gv) & GVf_ASSUMECV)
	97	#define GvASSUMECV_on(gv) (GvFLAGS(gv) \|= GVf_ASSUMECV)
	98	#define GvASSUMECV_off(gv) (GvFLAGS(gv) &= ~GVf_ASSUMECV)
	99
	100	#define GvIMPORTED(gv) (GvFLAGS(gv) & GVf_IMPORTED)
	101	#define GvIMPORTED_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED)
	102	#define GvIMPORTED_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED)
	103
	104	#define GvIMPORTED_SV(gv) (GvFLAGS(gv) & GVf_IMPORTED_SV)
	105	#define GvIMPORTED_SV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_SV)
	106	#define GvIMPORTED_SV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_SV)
	107
	108	#define GvIMPORTED_AV(gv) (GvFLAGS(gv) & GVf_IMPORTED_AV)
	109	#define GvIMPORTED_AV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_AV)
	110	#define GvIMPORTED_AV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_AV)
	111
	112	#define GvIMPORTED_HV(gv) (GvFLAGS(gv) & GVf_IMPORTED_HV)
	113	#define GvIMPORTED_HV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_HV)
	114	#define GvIMPORTED_HV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_HV)
	115
	116	#define GvIMPORTED_CV(gv) (GvFLAGS(gv) & GVf_IMPORTED_CV)
	117	#define GvIMPORTED_CV_on(gv) (GvFLAGS(gv) \|= GVf_IMPORTED_CV)
	118	#define GvIMPORTED_CV_off(gv) (GvFLAGS(gv) &= ~GVf_IMPORTED_CV)
	119
743e66e6 GS	120	#define GvIN_PAD(gv) (GvFLAGS(gv) & GVf_IN_PAD)
	121	#define GvIN_PAD_on(gv) (GvFLAGS(gv) \|= GVf_IN_PAD)
	122	#define GvIN_PAD_off(gv) (GvFLAGS(gv) &= ~GVf_IN_PAD)
	123
5bd07a3d DM	124	/* XXX: all GvFLAGS options are used, borrowing GvGPFLAGS for the moment */
5bd07a3d DM	125
7fb37951 AMS	126	#define GVf_UNIQUE 0x0001
	127	#define GvUNIQUE(gv) (GvGP(gv) && (GvGPFLAGS(gv) & GVf_UNIQUE))
	128	#define GvUNIQUE_on(gv) (GvGPFLAGS(gv) \|= GVf_UNIQUE)
	129	#define GvUNIQUE_off(gv) (GvGPFLAGS(gv) &= ~GVf_UNIQUE)
5bd07a3d DM	130
5bd07a3d DM	131	#ifdef USE_ITHREADS
7fb37951	132	#define GV_UNIQUE_CHECK
5bd07a3d	133	#else
7fb37951	134	#undef GV_UNIQUE_CHECK
5bd07a3d DM	135	#endif
5bd07a3d DM	136
79072805 LW	137	#define Nullgv Null(GV*)
	138
	139	#define DM_UID 0x003
	140	#define DM_RUID 0x001
	141	#define DM_EUID 0x002
	142	#define DM_GID 0x030
	143	#define DM_RGID 0x010
	144	#define DM_EGID 0x020
	145	#define DM_DELAY 0x100
	146
0f303493	147	/*
864dbfa3	148	* symbol creation flags, for use in gv_fetchpv() and get_*v()
0f303493 GS	149	*/
	150	#define GV_ADD 0x01 /* add, if symbol not already there */
	151	#define GV_ADDMULTI 0x02 /* add, pretending it has been added already */
	152	#define GV_ADDWARN 0x04 /* add, but warn if symbol wasn't already there */
	153	#define GV_ADDINEVAL 0x08 /* add, as though we're doing so within an eval */
	154	#define GV_NOINIT 0x10 /* add, but don't init symbol, if type != PVGV */