[perl5.git] / hv.h

/*    hv.h
 *
 *    Copyright (c) 1991-2001, 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.
 *
 */

/* typedefs to eliminate some typing */
typedef struct he HE;
typedef struct hek HEK;

/* entry in hash value chain */
struct he {
    HE		*hent_next;	/* next entry in chain */
    HEK		*hent_hek;	/* hash key */
    SV		*hent_val;	/* scalar value that was hashed */
};

/* hash key -- defined separately for use as shared pointer */
struct hek {
    U32		hek_hash;	/* hash of key */
    I32		hek_len;	/* length of hash key */
    char	hek_key[1];	/* variable-length hash key */
};

/* hash structure: */
/* This structure must match the beginning of struct xpvmg in sv.h. */
struct xpvhv {
    char *	xhv_array;	/* pointer to malloced string */
    STRLEN	xhv_fill;	/* how full xhv_array currently is */
    STRLEN	xhv_max;	/* subscript of last element of xhv_array */
    IV		xhv_keys;	/* how many elements in the array */
    NV		xnv_nv;		/* numeric value, if any */
    MAGIC*	xmg_magic;	/* magic for scalar array */
    HV*		xmg_stash;	/* class package */

    I32		xhv_riter;	/* current root of iterator */
    HE		*xhv_eiter;	/* current entry of iterator */
    PMOP	*xhv_pmroot;	/* list of pm's for this package */
    char	*xhv_name;	/* name, if a symbol table */
};

/* hash a key */
/* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins */
/* from requirements by Colin Plumb. */
/* (http://burtleburtle.net/bob/hash/doobs.html) */
#define PERL_HASH(hash,str,len) \
     STMT_START	{ \
	register const char *s_PeRlHaSh = str; \
	register I32 i_PeRlHaSh = len; \
	register U32 hash_PeRlHaSh = 0; \
	while (i_PeRlHaSh--) { \
	    hash_PeRlHaSh += *s_PeRlHaSh++; \
	    hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
	    hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
	} \
	hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
	hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
	(hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
    } STMT_END

/*
=for apidoc AmU||HEf_SVKEY
This flag, used in the length slot of hash entries and magic structures,
specifies the structure contains a C<SV*> pointer where a C<char*> pointer
is to be expected. (For information only--not to be used).

=for apidoc AmU||Nullhv
Null HV pointer.

=for apidoc Am|char*|HvNAME|HV* stash
Returns the package name of a stash.  See C<SvSTASH>, C<CvSTASH>.

=for apidoc Am|void*|HeKEY|HE* he
Returns the actual pointer stored in the key slot of the hash entry. The
pointer may be either C<char*> or C<SV*>, depending on the value of
C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
usually preferable for finding the value of a key.

=for apidoc Am|STRLEN|HeKLEN|HE* he
If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
be assigned to. The C<HePV()> macro is usually preferable for finding key
lengths.

=for apidoc Am|SV*|HeVAL|HE* he
Returns the value slot (type C<SV*>) stored in the hash entry.

=for apidoc Am|U32|HeHASH|HE* he
Returns the computed hash stored in the hash entry.

=for apidoc Am|char*|HePV|HE* he|STRLEN len
Returns the key slot of the hash entry as a C<char*> value, doing any
necessary dereferencing of possibly C<SV*> keys.  The length of the string
is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
not care about what the length of the key is, you may use the global
variable C<PL_na>, though this is rather less efficient than using a local
variable.  Remember though, that hash keys in perl are free to contain
embedded nulls, so using C<strlen()> or similar is not a good way to find
the length of hash keys. This is very similar to the C<SvPV()> macro
described elsewhere in this document.

=for apidoc Am|SV*|HeSVKEY|HE* he
Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
contain an C<SV*> key.

=for apidoc Am|SV*|HeSVKEY_force|HE* he
Returns the key as an C<SV*>.  Will create and return a temporary mortal
C<SV*> if the hash entry contains only a C<char*> key.

=for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
Sets the key to a given C<SV*>, taking care to set the appropriate flags to
indicate the presence of an C<SV*> key, and returns the same
C<SV*>.

=cut
*/

/* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
#define HEf_SVKEY	-2	/* hent_key is a SV* */


#define Nullhv Null(HV*)
#define HvARRAY(hv)	(*(HE***)&((XPVHV*)  SvANY(hv))->xhv_array)
#define HvFILL(hv)	((XPVHV*)  SvANY(hv))->xhv_fill
#define HvMAX(hv)	((XPVHV*)  SvANY(hv))->xhv_max
#define HvKEYS(hv)	((XPVHV*)  SvANY(hv))->xhv_keys
#define HvRITER(hv)	((XPVHV*)  SvANY(hv))->xhv_riter
#define HvEITER(hv)	((XPVHV*)  SvANY(hv))->xhv_eiter
#define HvPMROOT(hv)	((XPVHV*)  SvANY(hv))->xhv_pmroot
#define HvNAME(hv)	((XPVHV*)  SvANY(hv))->xhv_name

#define HvSHAREKEYS(hv)		(SvFLAGS(hv) & SVphv_SHAREKEYS)
#define HvSHAREKEYS_on(hv)	(SvFLAGS(hv) |= SVphv_SHAREKEYS)
#define HvSHAREKEYS_off(hv)	(SvFLAGS(hv) &= ~SVphv_SHAREKEYS)

#define HvLAZYDEL(hv)		(SvFLAGS(hv) & SVphv_LAZYDEL)
#define HvLAZYDEL_on(hv)	(SvFLAGS(hv) |= SVphv_LAZYDEL)
#define HvLAZYDEL_off(hv)	(SvFLAGS(hv) &= ~SVphv_LAZYDEL)

/* Maybe amagical: */
/* #define HV_AMAGICmb(hv)      (SvFLAGS(hv) & (SVpgv_badAM | SVpgv_AM)) */

#define HV_AMAGIC(hv)        (SvFLAGS(hv) &   SVpgv_AM)
#define HV_AMAGIC_on(hv)     (SvFLAGS(hv) |=  SVpgv_AM)
#define HV_AMAGIC_off(hv)    (SvFLAGS(hv) &= ~SVpgv_AM)

/*
#define HV_AMAGICbad(hv)     (SvFLAGS(hv) & SVpgv_badAM)
#define HV_badAMAGIC_on(hv)  (SvFLAGS(hv) |= SVpgv_badAM)
#define HV_badAMAGIC_off(hv) (SvFLAGS(hv) &= ~SVpgv_badAM)
*/

#define Nullhe Null(HE*)
#define HeNEXT(he)		(he)->hent_next
#define HeKEY_hek(he)		(he)->hent_hek
#define HeKEY(he)		HEK_KEY(HeKEY_hek(he))
#define HeKEY_sv(he)		(*(SV**)HeKEY(he))
#define HeKLEN(he)		HEK_LEN(HeKEY_hek(he))
#define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
#define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
#define HeVAL(he)		(he)->hent_val
#define HeHASH(he)		HEK_HASH(HeKEY_hek(he))
#define HePV(he,lp)		((HeKLEN(he) == HEf_SVKEY) ?		\
				 SvPV(HeKEY_sv(he),lp) :		\
				 (((lp = HeKLEN(he)) >= 0) ?		\
				  HeKEY(he) : Nullch))

#define HeSVKEY(he)		((HeKEY(he) && 				\
				  HeKLEN(he) == HEf_SVKEY) ?		\
				 HeKEY_sv(he) : Nullsv)

#define HeSVKEY_force(he)	(HeKEY(he) ?				\
				 ((HeKLEN(he) == HEf_SVKEY) ?		\
				  HeKEY_sv(he) :			\
				  sv_2mortal(newSVpvn(HeKEY(he),	\
						     HeKLEN(he)))) :	\
				 &PL_sv_undef)
#define HeSVKEY_set(he,sv)	((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))

#define Nullhek Null(HEK*)
#define HEK_BASESIZE		STRUCT_OFFSET(HEK, hek_key[0])
#define HEK_HASH(hek)		(hek)->hek_hash
#define HEK_LEN(hek)		(hek)->hek_len
#define HEK_KEY(hek)		(hek)->hek_key
#define HEK_UTF8(hek)  (*(HEK_KEY(hek)+HEK_LEN(hek)))

/* calculate HV array allocation */
#if defined(STRANGE_MALLOC) || defined(MYMALLOC)
#  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
#else
#  define MALLOC_OVERHEAD 16
#  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
			(((size) < 64)					\
			 ? (size) * sizeof(HE*)				\
			 : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
#endif
Commit	Line	Data
a0d0e21e	1	/* hv.h
79072805	2	*
bc89e66f	3	* Copyright (c) 1991-2001, 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	*/
79072805 LW	9
5cbe4eec	10	/* typedefs to eliminate some typing */
79072805	11	typedef struct he HE;
ff68c719	12	typedef struct hek HEK;
79072805	13
5cbe4eec	14	/* entry in hash value chain */
79072805	15	struct he {
5cbe4eec MLF	16	HE hent_next; / next entry in chain */
	17	HEK hent_hek; / hash key */
	18	SV hent_val; / scalar value that was hashed */
bbce6d69	19	};
bbce6d69	20
5cbe4eec	21	/* hash key -- defined separately for use as shared pointer */
ff68c719	22	struct hek {
5cbe4eec MLF	23	U32 hek_hash; /* hash of key */
	24	I32 hek_len; /* length of hash key */
	25	char hek_key[1]; /* variable-length hash key */
79072805 LW	26	};
79072805 LW	27
5cbe4eec	28	/* hash structure: */
6ee623d5	29	/* This structure must match the beginning of struct xpvmg in sv.h. */
79072805	30	struct xpvhv {
463ee0b2 LW	31	char * xhv_array; /* pointer to malloced string */
	32	STRLEN xhv_fill; /* how full xhv_array currently is */
	33	STRLEN xhv_max; /* subscript of last element of xhv_array */
6ee623d5	34	IV xhv_keys; /* how many elements in the array */
65202027	35	NV xnv_nv; /* numeric value, if any */
79072805 LW	36	MAGIC* xmg_magic; /* magic for scalar array */
	37	HV* xmg_stash; /* class package */
	38
79072805 LW	39	I32 xhv_riter; /* current root of iterator */
	40	HE xhv_eiter; / current entry of iterator */
	41	PMOP xhv_pmroot; / list of pm's for this package */
	42	char xhv_name; / name, if a symbol table */
79072805 LW	43	};
79072805 LW	44
5cbe4eec	45	/* hash a key */
a6fe520e MLF	46	/* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins */
	47	/* from requirements by Colin Plumb. */
	48	/* (http://burtleburtle.net/bob/hash/doobs.html) */
bf6bd887	49	#define PERL_HASH(hash,str,len) \
bf6bd887	50	STMT_START { \
08105a92	51	register const char *s_PeRlHaSh = str; \
bf6bd887	52	register I32 i_PeRlHaSh = len; \
bf6bd887	53	register U32 hash_PeRlHaSh = 0; \
a6fe520e MLF	54	while (i_PeRlHaSh--) { \
	55	hash_PeRlHaSh += *s_PeRlHaSh++; \
	56	hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
	57	hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
	58	} \
	59	hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
	60	hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
4fee5c71	61	(hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
bf6bd887	62	} STMT_END
bf6bd887	63
954c1994 GS	64	/*
	65	=for apidoc AmU\|\|HEf_SVKEY
	66	This flag, used in the length slot of hash entries and magic structures,
	67	specifies the structure contains a C<SV> pointer where a C<char> pointer
	68	is to be expected. (For information only--not to be used).
	69
	70	=for apidoc AmU\|\|Nullhv
	71	Null HV pointer.
	72
	73	=for apidoc Am\|char\|HvNAME\|HV stash
	74	Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
	75
	76	=for apidoc Am\|void\|HeKEY\|HE he
	77	Returns the actual pointer stored in the key slot of the hash entry. The
	78	pointer may be either C<char> or C<SV>, depending on the value of
	79	C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
	80	usually preferable for finding the value of a key.
	81
	82	=for apidoc Am\|STRLEN\|HeKLEN\|HE* he
	83	If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
	84	holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
	85	be assigned to. The C<HePV()> macro is usually preferable for finding key
	86	lengths.
	87
	88	=for apidoc Am\|SV\|HeVAL\|HE he
	89	Returns the value slot (type C<SV*>) stored in the hash entry.
	90
	91	=for apidoc Am\|U32\|HeHASH\|HE* he
	92	Returns the computed hash stored in the hash entry.
	93
	94	=for apidoc Am\|char\|HePV\|HE he\|STRLEN len
	95	Returns the key slot of the hash entry as a C<char*> value, doing any
	96	necessary dereferencing of possibly C<SV*> keys. The length of the string
	97	is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
	98	not care about what the length of the key is, you may use the global
	99	variable C<PL_na>, though this is rather less efficient than using a local
	100	variable. Remember though, that hash keys in perl are free to contain
	101	embedded nulls, so using C<strlen()> or similar is not a good way to find
	102	the length of hash keys. This is very similar to the C<SvPV()> macro
	103	described elsewhere in this document.
	104
	105	=for apidoc Am\|SV\|HeSVKEY\|HE he
	106	Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
	107	contain an C<SV*> key.
	108
	109	=for apidoc Am\|SV\|HeSVKEY_force\|HE he
	110	Returns the key as an C<SV*>. Will create and return a temporary mortal
	111	C<SV> if the hash entry contains only a C<char> key.
	112
	113	=for apidoc Am\|SV\|HeSVKEY_set\|HE he\|SV* sv
	114	Sets the key to a given C<SV*>, taking care to set the appropriate flags to
	115	indicate the presence of an C<SV*> key, and returns the same
	116	C<SV*>.
	117
	118	=cut
	119	*/
bf6bd887	120
bf5b86ae GS	121	/* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
bf5b86ae GS	122	#define HEf_SVKEY -2 /* hent_key is a SV* */
bf6bd887	123
bf6bd887	124
79072805	125	#define Nullhv Null(HV*)
4efcf9a2	126	#define HvARRAY(hv) ((HE*)&((XPVHV) SvANY(hv))->xhv_array)
79072805	127	#define HvFILL(hv) ((XPVHV*) SvANY(hv))->xhv_fill
463ee0b2 LW	128	#define HvMAX(hv) ((XPVHV*) SvANY(hv))->xhv_max
463ee0b2 LW	129	#define HvKEYS(hv) ((XPVHV*) SvANY(hv))->xhv_keys
79072805 LW	130	#define HvRITER(hv) ((XPVHV*) SvANY(hv))->xhv_riter
	131	#define HvEITER(hv) ((XPVHV*) SvANY(hv))->xhv_eiter
	132	#define HvPMROOT(hv) ((XPVHV*) SvANY(hv))->xhv_pmroot
	133	#define HvNAME(hv) ((XPVHV*) SvANY(hv))->xhv_name
a0d0e21e	134
bf6bd887	135	#define HvSHAREKEYS(hv) (SvFLAGS(hv) & SVphv_SHAREKEYS)
	136	#define HvSHAREKEYS_on(hv) (SvFLAGS(hv) \|= SVphv_SHAREKEYS)
	137	#define HvSHAREKEYS_off(hv) (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
	138
bf5b86ae GS	139	#define HvLAZYDEL(hv) (SvFLAGS(hv) & SVphv_LAZYDEL)
	140	#define HvLAZYDEL_on(hv) (SvFLAGS(hv) \|= SVphv_LAZYDEL)
	141	#define HvLAZYDEL_off(hv) (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
	142
a0d0e21e LW	143	/* Maybe amagical: */
	144	/* #define HV_AMAGICmb(hv) (SvFLAGS(hv) & (SVpgv_badAM \| SVpgv_AM)) */
	145
	146	#define HV_AMAGIC(hv) (SvFLAGS(hv) & SVpgv_AM)
	147	#define HV_AMAGIC_on(hv) (SvFLAGS(hv) \|= SVpgv_AM)
	148	#define HV_AMAGIC_off(hv) (SvFLAGS(hv) &= ~SVpgv_AM)
	149
	150	/*
	151	#define HV_AMAGICbad(hv) (SvFLAGS(hv) & SVpgv_badAM)
	152	#define HV_badAMAGIC_on(hv) (SvFLAGS(hv) \|= SVpgv_badAM)
	153	#define HV_badAMAGIC_off(hv) (SvFLAGS(hv) &= ~SVpgv_badAM)
	154	*/
bf6bd887	155
	156	#define Nullhe Null(HE*)
	157	#define HeNEXT(he) (he)->hent_next
ff68c719	158	#define HeKEY_hek(he) (he)->hent_hek
ff68c719	159	#define HeKEY(he) HEK_KEY(HeKEY_hek(he))
bbce6d69	160	#define HeKEY_sv(he) ((SV*)HeKEY(he))
ff68c719	161	#define HeKLEN(he) HEK_LEN(HeKEY_hek(he))
da58a35d JH	162	#define HeKUTF8(he) HEK_UTF8(HeKEY_hek(he))
da58a35d JH	163	#define HeKLEN_UTF8(he) (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
bf6bd887	164	#define HeVAL(he) (he)->hent_val
ff68c719	165	#define HeHASH(he) HEK_HASH(HeKEY_hek(he))
1e422769	166	#define HePV(he,lp) ((HeKLEN(he) == HEf_SVKEY) ? \
	167	SvPV(HeKEY_sv(he),lp) : \
	168	(((lp = HeKLEN(he)) >= 0) ? \
	169	HeKEY(he) : Nullch))
	170
bbce6d69	171	#define HeSVKEY(he) ((HeKEY(he) && \
	172	HeKLEN(he) == HEf_SVKEY) ? \
	173	HeKEY_sv(he) : Nullsv)
	174
	175	#define HeSVKEY_force(he) (HeKEY(he) ? \
	176	((HeKLEN(he) == HEf_SVKEY) ? \
	177	HeKEY_sv(he) : \
79cb57f6	178	sv_2mortal(newSVpvn(HeKEY(he), \
bbce6d69	179	HeKLEN(he)))) : \
3280af22	180	&PL_sv_undef)
1e422769	181	#define HeSVKEY_set(he,sv) ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
bbce6d69	182
ff68c719	183	#define Nullhek Null(HEK*)
71be2cbc	184	#define HEK_BASESIZE STRUCT_OFFSET(HEK, hek_key[0])
ff68c719	185	#define HEK_HASH(hek) (hek)->hek_hash
	186	#define HEK_LEN(hek) (hek)->hek_len
	187	#define HEK_KEY(hek) (hek)->hek_key
da58a35d	188	#define HEK_UTF8(hek) (*(HEK_KEY(hek)+HEK_LEN(hek)))
d18c6117	189
5cbe4eec	190	/* calculate HV array allocation */
d18c6117 GS	191	#if defined(STRANGE_MALLOC) \|\| defined(MYMALLOC)
	192	# define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
	193	#else
	194	# define MALLOC_OVERHEAD 16
	195	# define PERL_HV_ARRAY_ALLOC_BYTES(size) \
	196	(((size) < 64) \
	197	? (size) * sizeof(HE*) \
	198	: (size) * sizeof(HE) 2 - MALLOC_OVERHEAD)
	199	#endif