This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Remove some _get variants of *NAMEUTF8 macros in [gh]v.h
[perl5.git] / hv.h
CommitLineData
a0d0e21e 1/* hv.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999,
62a1a1ef 4 * 2000, 2001, 2002, 2003, 2005, 2006, 2007, 2008, 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
5cbe4eec 11/* entry in hash value chain */
79072805 12struct he {
6f51351d
NC
13 /* Keep hent_next first in this structure, because sv_free_arenas take
14 advantage of this to share code between the he arenas and the SV
15 body arenas */
5cbe4eec
MF
16 HE *hent_next; /* next entry in chain */
17 HEK *hent_hek; /* hash key */
de616631
NC
18 union {
19 SV *hent_val; /* scalar value that was hashed */
20 Size_t hent_refcount; /* references for this shared hash key */
21 } he_valu;
bbce6d69
PP
22};
23
5cbe4eec 24/* hash key -- defined separately for use as shared pointer */
ff68c719 25struct hek {
5cbe4eec
MF
26 U32 hek_hash; /* hash of key */
27 I32 hek_len; /* length of hash key */
28 char hek_key[1]; /* variable-length hash key */
e05949c7 29 /* the hash-key is \0-terminated */
1e54db1a
JH
30 /* after the \0 there is a byte for flags, such as whether the key
31 is UTF-8 */
79072805
LW
32};
33
cbae3960
NC
34struct shared_he {
35 struct he shared_he_he;
36 struct hek shared_he_hek;
37};
bfcb3514
NC
38
39/* Subject to change.
40 Don't access this directly.
e1a479c5 41 Use the funcs in mro.c
bfcb3514 42*/
e1a479c5 43
b2685f0c
NC
44struct mro_alg {
45 AV *(*resolve)(pTHX_ HV* stash, U32 level);
46 const char *name;
47 U16 length;
48 U16 kflags; /* For the hash API - set HVhek_UTF8 if name is UTF-8 */
49 U32 hash; /* or 0 */
50};
e1a479c5
BB
51
52struct mro_meta {
9953ff72
NC
53 /* a hash holding the different MROs private data. */
54 HV *mro_linear_all;
3a6fa573
NC
55 /* a pointer directly to the current MROs private data. If mro_linear_all
56 is NULL, this owns the SV reference, else it is just a pointer to a
57 value stored in and owned by mro_linear_all. */
58 SV *mro_linear_current;
dd69841b
BB
59 HV *mro_nextmethod; /* next::method caching */
60 U32 cache_gen; /* Bumping this invalidates our method cache */
70cd14a1 61 U32 pkg_gen; /* Bumps when local methods/@ISA change */
3d76853f 62 const struct mro_alg *mro_which; /* which mro alg is in use? */
a49ba3fc 63 HV *isa; /* Everything this class @ISA */
e1a479c5
BB
64};
65
123892d9
NC
66#define MRO_GET_PRIVATE_DATA(smeta, which) \
67 (((smeta)->mro_which && (which) == (smeta)->mro_which) \
3a6fa573 68 ? (smeta)->mro_linear_current \
123892d9
NC
69 : Perl_mro_get_private_data(aTHX_ (smeta), (which)))
70
e1a479c5
BB
71/* Subject to change.
72 Don't access this directly.
73*/
74
15d9236d
NC
75union _xhvnameu {
76 HEK *xhvnameu_name; /* When xhv_name_count is 0 */
77 HEK **xhvnameu_names; /* When xhv_name_count is non-0 */
78};
79
bfcb3514 80struct xpvhv_aux {
15d9236d 81 union _xhvnameu xhv_name_u; /* name, if a symbol table */
86f55936 82 AV *xhv_backreferences; /* back references for weak references */
bfcb3514
NC
83 HE *xhv_eiter; /* current entry of iterator */
84 I32 xhv_riter; /* current root of iterator */
15d9236d 85/* Concerning xhv_name_count: When non-zero, xhv_name_u contains a pointer
78b79c77
FC
86 * to an array of HEK pointers, this being the length. The first element is
87 * the name of the stash, which may be NULL. If xhv_name_count is positive,
88 * then *xhv_name is one of the effective names. If xhv_name_count is nega-
15d9236d 89 * tive, then xhv_name_u.xhvnameu_names[1] is the first effective name.
78b79c77
FC
90 */
91 I32 xhv_name_count;
bc85b3a1 92 struct mro_meta *xhv_mro_meta;
78b79c77 93};
bfcb3514 94
5cbe4eec 95/* hash structure: */
6ee623d5 96/* This structure must match the beginning of struct xpvmg in sv.h. */
79072805 97struct xpvhv {
6e128786
NC
98 HV* xmg_stash; /* class package */
99 union _xmgu xmg_u;
359164a0 100 STRLEN xhv_keys; /* total keys, including placeholders */
c8e503bf 101 STRLEN xhv_max; /* subscript of last element of xhv_array */
79072805
LW
102};
103
5cbe4eec 104/* hash a key */
5afd6d42
JH
105/* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
106 * from requirements by Colin Plumb.
107 * (http://burtleburtle.net/bob/hash/doobs.html) */
108/* The use of a temporary pointer and the casting games
109 * is needed to serve the dual purposes of
110 * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
df805c3e 111 * a "char" can be either signed or unsigned, depending on the compiler)
5afd6d42 112 * (b) catering for old code that uses a "char"
830b38bd 113 *
504f80c1
JH
114 * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
115 * to avoid "algorithmic complexity attacks".
830b38bd
JH
116 *
117 * If USE_HASH_SEED is defined, hash randomisation is done by default
118 * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
119 * only if the environment variable PERL_HASH_SEED is set.
120 * For maximal control, one can define PERL_HASH_SEED.
90ce55a1 121 * (see also perl.c:perl_parse()).
5afd6d42 122 */
830b38bd
JH
123#ifndef PERL_HASH_SEED
124# if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
125# define PERL_HASH_SEED PL_hash_seed
126# else
127# define PERL_HASH_SEED 0
128# endif
504f80c1 129#endif
f8d50d94
DM
130
131#define PERL_HASH(hash,str,len) PERL_HASH_INTERNAL_(hash,str,len,0)
bf6bd887 132
3d78eb94
NC
133/* Only hv.c and mod_perl should be doing this. */
134#ifdef PERL_HASH_INTERNAL_ACCESS
f8d50d94
DM
135#define PERL_HASH_INTERNAL(hash,str,len) PERL_HASH_INTERNAL_(hash,str,len,1)
136#endif
137
138/* Common base for PERL_HASH and PERL_HASH_INTERNAL that parameterises
139 * the source of the seed. Not for direct use outside of hv.c. */
140
141#define PERL_HASH_INTERNAL_(hash,str,len,internal) \
4b5190b5 142 STMT_START { \
0bd48802 143 register const char * const s_PeRlHaSh_tmp = str; \
4b5190b5
NC
144 register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
145 register I32 i_PeRlHaSh = len; \
f8d50d94 146 register U32 hash_PeRlHaSh = (internal ? PL_rehash_seed : PERL_HASH_SEED); \
4b5190b5
NC
147 while (i_PeRlHaSh--) { \
148 hash_PeRlHaSh += *s_PeRlHaSh++; \
149 hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
150 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
151 } \
152 hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
153 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
154 (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
155 } STMT_END
4b5190b5 156
954c1994 157/*
ccfc67b7
JH
158=head1 Hash Manipulation Functions
159
954c1994
GS
160=for apidoc AmU||HEf_SVKEY
161This flag, used in the length slot of hash entries and magic structures,
d1be9408 162specifies the structure contains an C<SV*> pointer where a C<char*> pointer
954c1994
GS
163is to be expected. (For information only--not to be used).
164
ccfc67b7
JH
165=head1 Handy Values
166
954c1994
GS
167=for apidoc AmU||Nullhv
168Null HV pointer.
169
3ae1b226
NC
170(deprecated - use C<(HV *)NULL> instead)
171
ccfc67b7
JH
172=head1 Hash Manipulation Functions
173
954c1994 174=for apidoc Am|char*|HvNAME|HV* stash
9282b5fd
SH
175Returns the package name of a stash, or NULL if C<stash> isn't a stash.
176See C<SvSTASH>, C<CvSTASH>.
954c1994 177
bc56db2a
FC
178=for apidoc Am|char*|HvENAME|HV* stash
179Returns the effective name of a stash, or NULL if there is none. The
180effective name represents a location in the symbol table where this stash
181resides. It is updated automatically when packages are aliased or deleted.
182A stash that is no longer in the symbol table has no effective name. This
183name is preferable to C<HvNAME> for use in MRO linearisations and isa
184caches.
185
954c1994
GS
186=for apidoc Am|void*|HeKEY|HE* he
187Returns the actual pointer stored in the key slot of the hash entry. The
188pointer may be either C<char*> or C<SV*>, depending on the value of
189C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
190usually preferable for finding the value of a key.
191
192=for apidoc Am|STRLEN|HeKLEN|HE* he
193If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
194holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
195be assigned to. The C<HePV()> macro is usually preferable for finding key
196lengths.
197
198=for apidoc Am|SV*|HeVAL|HE* he
199Returns the value slot (type C<SV*>) stored in the hash entry.
200
201=for apidoc Am|U32|HeHASH|HE* he
202Returns the computed hash stored in the hash entry.
203
204=for apidoc Am|char*|HePV|HE* he|STRLEN len
205Returns the key slot of the hash entry as a C<char*> value, doing any
206necessary dereferencing of possibly C<SV*> keys. The length of the string
207is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
208not care about what the length of the key is, you may use the global
209variable C<PL_na>, though this is rather less efficient than using a local
210variable. Remember though, that hash keys in perl are free to contain
211embedded nulls, so using C<strlen()> or similar is not a good way to find
212the length of hash keys. This is very similar to the C<SvPV()> macro
289d3c6a
NC
213described elsewhere in this document. See also C<HeUTF8>.
214
215If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
216new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
217efficient.
218
cca4e9fa 219=for apidoc Am|char*|HeUTF8|HE* he
289d3c6a
NC
220Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
221doing any necessary dereferencing of possibly C<SV*> keys. The value returned
62a1a1ef 222will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
289d3c6a
NC
223so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
224typedef for C<char>.
954c1994
GS
225
226=for apidoc Am|SV*|HeSVKEY|HE* he
a0714e2c 227Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
954c1994
GS
228contain an C<SV*> key.
229
230=for apidoc Am|SV*|HeSVKEY_force|HE* he
231Returns the key as an C<SV*>. Will create and return a temporary mortal
232C<SV*> if the hash entry contains only a C<char*> key.
233
234=for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
235Sets the key to a given C<SV*>, taking care to set the appropriate flags to
236indicate the presence of an C<SV*> key, and returns the same
237C<SV*>.
238
239=cut
240*/
bf6bd887 241
bf5b86ae 242/* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
d1be9408 243#define HEf_SVKEY -2 /* hent_key is an SV* */
bf6bd887 244
3ae1b226
NC
245#ifndef PERL_CORE
246# define Nullhv Null(HV*)
247#endif
43e6e717 248#define HvARRAY(hv) ((hv)->sv_u.svu_hash)
4d0fbddd 249#define HvFILL(hv) Perl_hv_fill(aTHX_ (const HV *)(hv))
463ee0b2 250#define HvMAX(hv) ((XPVHV*) SvANY(hv))->xhv_max
b79f7545
NC
251/* This quite intentionally does no flag checking first. That's your
252 responsibility. */
253#define HvAUX(hv) ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
dbebbdb4
NC
254#define HvRITER(hv) (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv)))
255#define HvEITER(hv) (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv)))
256#define HvRITER_set(hv,r) Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r)
257#define HvEITER_set(hv,e) Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e)
b79f7545 258#define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
cef6ea9d 259#define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
7423f6db 260#define HvNAME(hv) HvNAME_get(hv)
f2462604 261#define HvNAMELEN(hv) HvNAMELEN_get(hv)
bc56db2a 262#define HvENAME(hv) HvENAME_get(hv)
f2462604 263#define HvENAMELEN(hv) HvENAMELEN_get(hv)
2c7f4b87
BB
264
265/* Checking that hv is a valid package stash is the
266 caller's responsibility */
267#define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
268 ? HvAUX(hv)->xhv_mro_meta \
c60bad7b 269 : Perl_mro_meta_init(aTHX_ hv))
2c7f4b87 270
bfcb3514
NC
271/* FIXME - all of these should use a UTF8 aware API, which should also involve
272 getting the length. */
15d9236d
NC
273#define HvNAME_HEK_NN(hv) \
274 ( \
275 HvAUX(hv)->xhv_name_count \
276 ? *HvAUX(hv)->xhv_name_u.xhvnameu_names \
277 : HvAUX(hv)->xhv_name_u.xhvnameu_name \
b7247a80 278 )
9b9d0b15 279/* This macro may go away without notice. */
b7247a80 280#define HvNAME_HEK(hv) \
15d9236d 281 (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvNAME_HEK_NN(hv) : NULL)
78b79c77 282#define HvNAME_get(hv) \
15d9236d 283 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
b7247a80 284 ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL)
78b79c77 285#define HvNAMELEN_get(hv) \
15d9236d 286 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
b7247a80 287 ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0)
b2c03ebd 288#define HvNAMEUTF8(hv) \
f2462604
BF
289 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
290 ? HEK_UTF8(HvNAME_HEK_NN(hv)) : 0)
c4842d1d 291#define HvENAME_HEK_NN(hv) \
78b79c77 292 ( \
15d9236d
NC
293 HvAUX(hv)->xhv_name_count > 0 ? HvAUX(hv)->xhv_name_u.xhvnameu_names[0] : \
294 HvAUX(hv)->xhv_name_count < -1 ? HvAUX(hv)->xhv_name_u.xhvnameu_names[1] : \
78b79c77 295 HvAUX(hv)->xhv_name_count == -1 ? NULL : \
15d9236d 296 HvAUX(hv)->xhv_name_u.xhvnameu_name \
78b79c77 297 )
c4842d1d 298#define HvENAME_HEK(hv) \
15d9236d 299 (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvENAME_HEK_NN(hv) : NULL)
c4842d1d 300#define HvENAME_get(hv) \
15d9236d 301 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvENAME_HEK_NN(hv)) \
78b79c77 302 ? HEK_KEY(HvENAME_HEK_NN(hv)) : NULL)
c4842d1d 303#define HvENAMELEN_get(hv) \
15d9236d 304 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvENAME_HEK_NN(hv)) \
78b79c77 305 ? HEK_LEN(HvENAME_HEK_NN(hv)) : 0)
b2c03ebd 306#define HvENAMEUTF8(hv) \
f2462604
BF
307 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvENAME_HEK_NN(hv)) \
308 ? HEK_UTF8(HvENAME_HEK_NN(hv)) : 0)
a0d0e21e 309
486ec47a 310/* the number of keys (including any placeholders) */
8aacddc1
NIS
311#define XHvTOTALKEYS(xhv) ((xhv)->xhv_keys)
312
8aacddc1
NIS
313/*
314 * HvKEYS gets the number of keys that actually exist(), and is provided
315 * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
486ec47a 316 * (keys, excluding placeholders) and HvTOTALKEYS (including placeholders)
8aacddc1 317 */
ca732855
NC
318#define HvKEYS(hv) HvUSEDKEYS(hv)
319#define HvUSEDKEYS(hv) (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
8aacddc1 320#define HvTOTALKEYS(hv) XHvTOTALKEYS((XPVHV*) SvANY(hv))
dbebbdb4
NC
321#define HvPLACEHOLDERS(hv) (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv)))
322#define HvPLACEHOLDERS_get(hv) (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0)
323#define HvPLACEHOLDERS_set(hv,p) Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p)
8aacddc1 324
bf6bd887
PP
325#define HvSHAREKEYS(hv) (SvFLAGS(hv) & SVphv_SHAREKEYS)
326#define HvSHAREKEYS_on(hv) (SvFLAGS(hv) |= SVphv_SHAREKEYS)
327#define HvSHAREKEYS_off(hv) (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
328
19692e8d
NC
329/* This is an optimisation flag. It won't be set if all hash keys have a 0
330 * flag. Currently the only flags relate to utf8.
331 * Hence it won't be set if all keys are 8 bit only. It will be set if any key
332 * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
333 * when retrieved during iteration. It may still be set when there are no longer
334 * any utf8 keys.
fdcd69b6 335 * See HVhek_ENABLEHVKFLAGS for the trigger.
19692e8d
NC
336 */
337#define HvHASKFLAGS(hv) (SvFLAGS(hv) & SVphv_HASKFLAGS)
338#define HvHASKFLAGS_on(hv) (SvFLAGS(hv) |= SVphv_HASKFLAGS)
339#define HvHASKFLAGS_off(hv) (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
574c8022 340
bf5b86ae
GS
341#define HvLAZYDEL(hv) (SvFLAGS(hv) & SVphv_LAZYDEL)
342#define HvLAZYDEL_on(hv) (SvFLAGS(hv) |= SVphv_LAZYDEL)
343#define HvLAZYDEL_off(hv) (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
344
4b5190b5
NC
345#define HvREHASH(hv) (SvFLAGS(hv) & SVphv_REHASH)
346#define HvREHASH_on(hv) (SvFLAGS(hv) |= SVphv_REHASH)
347#define HvREHASH_off(hv) (SvFLAGS(hv) &= ~SVphv_REHASH)
348
3ae1b226
NC
349#ifndef PERL_CORE
350# define Nullhe Null(HE*)
351#endif
bf6bd887 352#define HeNEXT(he) (he)->hent_next
ff68c719
PP
353#define HeKEY_hek(he) (he)->hent_hek
354#define HeKEY(he) HEK_KEY(HeKEY_hek(he))
bbce6d69 355#define HeKEY_sv(he) (*(SV**)HeKEY(he))
ff68c719 356#define HeKLEN(he) HEK_LEN(HeKEY_hek(he))
da58a35d 357#define HeKUTF8(he) HEK_UTF8(HeKEY_hek(he))
19692e8d 358#define HeKWASUTF8(he) HEK_WASUTF8(HeKEY_hek(he))
4b5190b5 359#define HeKREHASH(he) HEK_REHASH(HeKEY_hek(he))
da58a35d 360#define HeKLEN_UTF8(he) (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
19692e8d 361#define HeKFLAGS(he) HEK_FLAGS(HeKEY_hek(he))
de616631 362#define HeVAL(he) (he)->he_valu.hent_val
ff68c719 363#define HeHASH(he) HEK_HASH(HeKEY_hek(he))
1e422769
PP
364#define HePV(he,lp) ((HeKLEN(he) == HEf_SVKEY) ? \
365 SvPV(HeKEY_sv(he),lp) : \
402f0539 366 ((lp = HeKLEN(he)), HeKEY(he)))
289d3c6a
NC
367#define HeUTF8(he) ((HeKLEN(he) == HEf_SVKEY) ? \
368 SvUTF8(HeKEY_sv(he)) : \
369 (U32)HeKUTF8(he))
1e422769 370
bbce6d69
PP
371#define HeSVKEY(he) ((HeKEY(he) && \
372 HeKLEN(he) == HEf_SVKEY) ? \
a0714e2c 373 HeKEY_sv(he) : NULL)
bbce6d69
PP
374
375#define HeSVKEY_force(he) (HeKEY(he) ? \
376 ((HeKLEN(he) == HEf_SVKEY) ? \
377 HeKEY_sv(he) : \
ad25789c
NC
378 newSVpvn_flags(HeKEY(he), \
379 HeKLEN(he), SVs_TEMP)) : \
3280af22 380 &PL_sv_undef)
1e422769 381#define HeSVKEY_set(he,sv) ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
bbce6d69 382
3ae1b226
NC
383#ifndef PERL_CORE
384# define Nullhek Null(HEK*)
385#endif
71be2cbc 386#define HEK_BASESIZE STRUCT_OFFSET(HEK, hek_key[0])
ff68c719
PP
387#define HEK_HASH(hek) (hek)->hek_hash
388#define HEK_LEN(hek) (hek)->hek_len
389#define HEK_KEY(hek) (hek)->hek_key
19692e8d
NC
390#define HEK_FLAGS(hek) (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
391
392#define HVhek_UTF8 0x01 /* Key is utf8 encoded. */
393#define HVhek_WASUTF8 0x02 /* Key is bytes here, but was supplied as utf8. */
4b5190b5 394#define HVhek_REHASH 0x04 /* This key is in an hv using a custom HASH . */
45e34800 395#define HVhek_UNSHARED 0x08 /* This key isn't a shared hash key. */
19692e8d 396#define HVhek_FREEKEY 0x100 /* Internal flag to say key is malloc()ed. */
e16e2ff8
NC
397#define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
398 * (may change, but Storable is a core module) */
44b87b50
NC
399#define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form.
400 If the string is UTF-8, it cannot be
401 converted to bytes. */
19692e8d
NC
402#define HVhek_MASK 0xFF
403
fdcd69b6
NC
404/* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
405 HVhek_REHASH is only needed because the rehash flag has to be duplicated
406 into all keys as hv_iternext has no access to the hash flags. At this
407 point Storable's tests get upset, because sometimes hashes are "keyed"
408 and sometimes not, depending on the order of data insertion, and whether
45e34800
NC
409 it triggered rehashing. So currently HVhek_REHASH is exempt.
410 Similarly UNSHARED
fdcd69b6
NC
411*/
412
45e34800 413#define HVhek_ENABLEHVKFLAGS (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
fdcd69b6 414
19692e8d
NC
415#define HEK_UTF8(hek) (HEK_FLAGS(hek) & HVhek_UTF8)
416#define HEK_UTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_UTF8)
417#define HEK_UTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_UTF8)
418#define HEK_WASUTF8(hek) (HEK_FLAGS(hek) & HVhek_WASUTF8)
419#define HEK_WASUTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_WASUTF8)
420#define HEK_WASUTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
4b5190b5
NC
421#define HEK_REHASH(hek) (HEK_FLAGS(hek) & HVhek_REHASH)
422#define HEK_REHASH_on(hek) (HEK_FLAGS(hek) |= HVhek_REHASH)
d18c6117 423
5cbe4eec 424/* calculate HV array allocation */
36768cf4
NC
425#ifndef PERL_USE_LARGE_HV_ALLOC
426/* Default to allocating the correct size - default to assuming that malloc()
427 is not broken and is efficient at allocating blocks sized at powers-of-two.
428*/
d18c6117
GS
429# define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
430#else
431# define MALLOC_OVERHEAD 16
432# define PERL_HV_ARRAY_ALLOC_BYTES(size) \
433 (((size) < 64) \
434 ? (size) * sizeof(HE*) \
435 : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
436#endif
37d85e3a 437
e16e2ff8
NC
438/* Flags for hv_iternext_flags. */
439#define HV_ITERNEXT_WANTPLACEHOLDERS 0x01 /* Don't skip placeholders. */
440
7a7b9979 441#define hv_iternext(hv) hv_iternext_flags(hv, 0)
b1bc3f34 442#define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0)
8581adba 443#define hv_undef(hv) Perl_hv_undef_flags(aTHX_ hv, 0)
7a7b9979 444
37d85e3a
JH
445/* available as a function in hv.c */
446#define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
447#define sharepvn(sv, len, hash) Perl_sharepvn(sv, len, hash)
bfcb3514 448
d1db91c6
NC
449#define share_hek_hek(hek) \
450 (++(((struct shared_he *)(((char *)hek) \
451 - STRUCT_OFFSET(struct shared_he, \
452 shared_he_hek))) \
de616631 453 ->shared_he_he.he_valu.hent_refcount), \
d1db91c6
NC
454 hek)
455
99978bb4
NC
456#define hv_store_ent(hv, keysv, val, hash) \
457 ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE, \
458 (val), (hash)))
4c2df08c 459
99978bb4
NC
460#define hv_exists_ent(hv, keysv, hash) \
461 (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \
4c2df08c 462 ? TRUE : FALSE)
99978bb4
NC
463#define hv_fetch_ent(hv, keysv, lval, hash) \
464 ((HE *) hv_common((hv), (keysv), NULL, 0, 0, \
465 ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash)))
466#define hv_delete_ent(hv, key, flags, hash) \
b1bc3f34
NC
467 (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \
468 NULL, (hash))))
99978bb4
NC
469
470#define hv_store_flags(hv, key, klen, val, hash, flags) \
471 ((SV**) hv_common((hv), NULL, (key), (klen), (flags), \
472 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), \
473 (hash)))
474
475#define hv_store(hv, key, klen, val, hash) \
476 ((SV**) hv_common_key_len((hv), (key), (klen), \
a038e571 477 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), \
99978bb4 478 (val), (hash)))
a038e571 479
99978bb4
NC
480#define hv_exists(hv, key, klen) \
481 (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \
a038e571
NC
482 ? TRUE : FALSE)
483
99978bb4
NC
484#define hv_fetch(hv, key, klen, lval) \
485 ((SV**) hv_common_key_len((hv), (key), (klen), (lval) \
a038e571
NC
486 ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \
487 : HV_FETCH_JUST_SV, NULL, 0))
488
99978bb4 489#define hv_delete(hv, key, klen, flags) \
b1bc3f34
NC
490 (MUTABLE_SV(hv_common_key_len((hv), (key), (klen), \
491 (flags) | HV_DELETE, NULL, 0)))
a038e571 492
71ad1b0c
NC
493/* This refcounted he structure is used for storing the hints used for lexical
494 pragmas. Without threads, it's basically struct he + refcount.
495 With threads, life gets more complex as the structure needs to be shared
496 between threads (because it hangs from OPs, which are shared), hence the
497 alternate definition and mutex. */
498
44ebaf21
NC
499struct refcounted_he;
500
20439bc7
Z
501/* flags for the refcounted_he API */
502#define REFCOUNTED_HE_KEY_UTF8 0x00000001
503
71ad1b0c
NC
504#ifdef PERL_CORE
505
b6bbf3fa 506/* Gosh. This really isn't a good name any longer. */
71ad1b0c
NC
507struct refcounted_he {
508 struct refcounted_he *refcounted_he_next; /* next entry in chain */
cbb1fbea 509#ifdef USE_ITHREADS
b6bbf3fa
NC
510 U32 refcounted_he_hash;
511 U32 refcounted_he_keylen;
cbb1fbea 512#else
71ad1b0c 513 HEK *refcounted_he_hek; /* hint key */
cbb1fbea 514#endif
b6bbf3fa
NC
515 union {
516 IV refcounted_he_u_iv;
517 UV refcounted_he_u_uv;
518 STRLEN refcounted_he_u_len;
44ebaf21 519 void *refcounted_he_u_ptr; /* Might be useful in future */
b6bbf3fa 520 } refcounted_he_val;
9bd87817 521 U32 refcounted_he_refcnt; /* reference count */
b6bbf3fa
NC
522 /* First byte is flags. Then NUL-terminated value. Then for ithreads,
523 non-NUL terminated key. */
524 char refcounted_he_data[1];
71ad1b0c
NC
525};
526
20439bc7
Z
527/*
528=for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|const char *key|U32 flags
529
530Like L</refcounted_he_fetch_pvn>, but takes a literal string instead of
531a string/length pair, and no precomputed hash.
532
533=cut
534*/
535
536#define refcounted_he_fetch_pvs(chain, key, flags) \
537 Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags)
538
539/*
540=for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|const char *key|SV *value|U32 flags
541
542Like L</refcounted_he_new_pvn>, but takes a literal string instead of
543a string/length pair, and no precomputed hash.
544
545=cut
546*/
547
548#define refcounted_he_new_pvs(parent, key, value, flags) \
549 Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags)
550
b6bbf3fa
NC
551/* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
552#define HVrhek_undef 0x00 /* Value is undef. */
44ebaf21
NC
553#define HVrhek_delete 0x10 /* Value is placeholder - signifies delete. */
554#define HVrhek_IV 0x20 /* Value is IV. */
555#define HVrhek_UV 0x30 /* Value is UV. */
556#define HVrhek_PV 0x40 /* Value is a (byte) string. */
557#define HVrhek_PV_UTF8 0x50 /* Value is a (utf8) string. */
558/* Two spare. As these have to live in the optree, you can't store anything
559 interpreter specific, such as SVs. :-( */
560#define HVrhek_typemask 0x70
561
562#ifdef USE_ITHREADS
563/* A big expression to find the key offset */
564#define REF_HE_KEY(chain) \
565 ((((chain->refcounted_he_data[0] & 0x60) == 0x40) \
566 ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0) \
567 + 1 + chain->refcounted_he_data)
568#endif
b6bbf3fa 569
71ad1b0c
NC
570# ifdef USE_ITHREADS
571# define HINTS_REFCNT_LOCK MUTEX_LOCK(&PL_hints_mutex)
572# define HINTS_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_hints_mutex)
573# else
574# define HINTS_REFCNT_LOCK NOOP
575# define HINTS_REFCNT_UNLOCK NOOP
576# endif
577#endif
578
579#ifdef USE_ITHREADS
580# define HINTS_REFCNT_INIT MUTEX_INIT(&PL_hints_mutex)
581# define HINTS_REFCNT_TERM MUTEX_DESTROY(&PL_hints_mutex)
582#else
583# define HINTS_REFCNT_INIT NOOP
584# define HINTS_REFCNT_TERM NOOP
585#endif
586
324a0d18
JH
587/* Hash actions
588 * Passed in PERL_MAGIC_uvar calls
589 */
b54b4831
NC
590#define HV_DISABLE_UVAR_XKEY 0x01
591/* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
592 is documented as being passed to hv_delete(). */
593#define HV_FETCH_ISSTORE 0x04
594#define HV_FETCH_ISEXISTS 0x08
595#define HV_FETCH_LVALUE 0x10
596#define HV_FETCH_JUST_SV 0x20
9dbc5603 597#define HV_DELETE 0x40
df5f182b 598#define HV_FETCH_EMPTY_HE 0x80 /* Leave HeVAL null. */
324a0d18 599
745edda6
FC
600/* Must not conflict with HVhek_UTF8 */
601#define HV_NAME_SETALL 0x02
602
bfcb3514 603/*
78ac7dd9
NC
604=for apidoc newHV
605
606Creates a new HV. The reference count is set to 1.
607
608=cut
609*/
610
dbebbdb4 611#define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
78ac7dd9
NC
612
613/*
bfcb3514
NC
614 * Local variables:
615 * c-indentation-style: bsd
616 * c-basic-offset: 4
617 * indent-tabs-mode: t
618 * End:
619 *
620 * ex: set ts=8 sts=4 sw=4 noet:
621 */