Socket::my_inet_aton() tweak
[p5sagit/p5-mst-13.2.git] / hv.h
CommitLineData
a0d0e21e 1/* hv.h
79072805 2 *
bc89e66f 3 * Copyright (c) 1991-2001, Larry Wall
79072805 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 8 */
9
5cbe4eec 10/* typedefs to eliminate some typing */
79072805 11typedef struct he HE;
ff68c719 12typedef struct hek HEK;
79072805 13
5cbe4eec 14/* entry in hash value chain */
79072805 15struct he {
5cbe4eec 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};
20
5cbe4eec 21/* hash key -- defined separately for use as shared pointer */
ff68c719 22struct hek {
5cbe4eec 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 26};
27
5cbe4eec 28/* hash structure: */
6ee623d5 29/* This structure must match the beginning of struct xpvmg in sv.h. */
79072805 30struct xpvhv {
463ee0b2 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 36 MAGIC* xmg_magic; /* magic for scalar array */
37 HV* xmg_stash; /* class package */
38
79072805 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 43};
44
5cbe4eec 45/* hash a key */
a6fe520e 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) \
50 STMT_START { \
08105a92 51 register const char *s_PeRlHaSh = str; \
bf6bd887 52 register I32 i_PeRlHaSh = len; \
53 register U32 hash_PeRlHaSh = 0; \
a6fe520e 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
63
954c1994 64/*
65=for apidoc AmU||HEf_SVKEY
66This flag, used in the length slot of hash entries and magic structures,
d1be9408 67specifies the structure contains an C<SV*> pointer where a C<char*> pointer
954c1994 68is to be expected. (For information only--not to be used).
69
70=for apidoc AmU||Nullhv
71Null HV pointer.
72
73=for apidoc Am|char*|HvNAME|HV* stash
74Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
75
76=for apidoc Am|void*|HeKEY|HE* he
77Returns the actual pointer stored in the key slot of the hash entry. The
78pointer may be either C<char*> or C<SV*>, depending on the value of
79C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
80usually preferable for finding the value of a key.
81
82=for apidoc Am|STRLEN|HeKLEN|HE* he
83If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
84holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
85be assigned to. The C<HePV()> macro is usually preferable for finding key
86lengths.
87
88=for apidoc Am|SV*|HeVAL|HE* he
89Returns the value slot (type C<SV*>) stored in the hash entry.
90
91=for apidoc Am|U32|HeHASH|HE* he
92Returns the computed hash stored in the hash entry.
93
94=for apidoc Am|char*|HePV|HE* he|STRLEN len
95Returns the key slot of the hash entry as a C<char*> value, doing any
96necessary dereferencing of possibly C<SV*> keys. The length of the string
97is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
98not care about what the length of the key is, you may use the global
99variable C<PL_na>, though this is rather less efficient than using a local
100variable. Remember though, that hash keys in perl are free to contain
101embedded nulls, so using C<strlen()> or similar is not a good way to find
102the length of hash keys. This is very similar to the C<SvPV()> macro
103described elsewhere in this document.
104
105=for apidoc Am|SV*|HeSVKEY|HE* he
106Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
107contain an C<SV*> key.
108
109=for apidoc Am|SV*|HeSVKEY_force|HE* he
110Returns the key as an C<SV*>. Will create and return a temporary mortal
111C<SV*> if the hash entry contains only a C<char*> key.
112
113=for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
114Sets the key to a given C<SV*>, taking care to set the appropriate flags to
115indicate the presence of an C<SV*> key, and returns the same
116C<SV*>.
117
118=cut
119*/
bf6bd887 120
bf5b86ae 121/* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
d1be9408 122#define HEf_SVKEY -2 /* hent_key is an SV* */
bf6bd887 123
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 128#define HvMAX(hv) ((XPVHV*) SvANY(hv))->xhv_max
129#define HvKEYS(hv) ((XPVHV*) SvANY(hv))->xhv_keys
79072805 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 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 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
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 162#define HeKUTF8(he) HEK_UTF8(HeKEY_hek(he))
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 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