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