pp_match(): skip passing gpos arg to regexec()
[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 /* These control hash traversal randomization and the environment variable PERL_PERTURB_KEYS.
12  * Currently disabling this functionality will break a few tests, but should otherwise work fine.
13  * See perlrun for more details. */
14
15 #if defined(PERL_PERTURB_KEYS_DISABLED)
16 #   define PL_HASH_RAND_BITS_ENABLED        0
17 #   define PERL_HASH_ITER_BUCKET(iter)      ((iter)->xhv_riter)
18 #else
19 #   define PERL_HASH_RANDOMIZE_KEYS         1
20 #   if defined(PERL_PERTURB_KEYS_RANDOM)
21 #       define PL_HASH_RAND_BITS_ENABLED    1
22 #   elif defined(PERL_PERTURB_KEYS_DETERMINISTIC)
23 #       define PL_HASH_RAND_BITS_ENABLED    2
24 #   else
25 #       define USE_PERL_PERTURB_KEYS        1
26 #       define PL_HASH_RAND_BITS_ENABLED    PL_hash_rand_bits_enabled
27 #   endif
28 #   define PERL_HASH_ITER_BUCKET(iter)      (((iter)->xhv_riter) ^ ((iter)->xhv_rand))
29 #endif
30
31 /* entry in hash value chain */
32 struct he {
33     /* Keep hent_next first in this structure, because sv_free_arenas take
34        advantage of this to share code between the he arenas and the SV
35        body arenas  */
36     HE          *hent_next;     /* next entry in chain */
37     HEK         *hent_hek;      /* hash key */
38     union {
39         SV      *hent_val;      /* scalar value that was hashed */
40         Size_t  hent_refcount;  /* references for this shared hash key */
41     } he_valu;
42 };
43
44 /* hash key -- defined separately for use as shared pointer */
45 struct hek {
46     U32         hek_hash;       /* hash of key */
47     I32         hek_len;        /* length of hash key */
48     char        hek_key[1];     /* variable-length hash key */
49     /* the hash-key is \0-terminated */
50     /* after the \0 there is a byte for flags, such as whether the key
51        is UTF-8 */
52 };
53
54 struct shared_he {
55     struct he shared_he_he;
56     struct hek shared_he_hek;
57 };
58
59 /* Subject to change.
60    Don't access this directly.
61    Use the funcs in mro.c
62 */
63
64 struct mro_alg {
65     AV *(*resolve)(pTHX_ HV* stash, U32 level);
66     const char *name;
67     U16 length;
68     U16 kflags; /* For the hash API - set HVhek_UTF8 if name is UTF-8 */
69     U32 hash; /* or 0 */
70 };
71
72 struct mro_meta {
73     /* a hash holding the different MROs private data.  */
74     HV      *mro_linear_all;
75     /* a pointer directly to the current MROs private data.  If mro_linear_all
76        is NULL, this owns the SV reference, else it is just a pointer to a
77        value stored in and owned by mro_linear_all.  */
78     SV      *mro_linear_current;
79     HV      *mro_nextmethod; /* next::method caching */
80     U32     cache_gen;       /* Bumping this invalidates our method cache */
81     U32     pkg_gen;         /* Bumps when local methods/@ISA change */
82     const struct mro_alg *mro_which; /* which mro alg is in use? */
83     HV      *isa;            /* Everything this class @ISA */
84 };
85
86 #define MRO_GET_PRIVATE_DATA(smeta, which)                 \
87     (((smeta)->mro_which && (which) == (smeta)->mro_which) \
88      ? (smeta)->mro_linear_current                         \
89      : Perl_mro_get_private_data(aTHX_ (smeta), (which)))
90
91 /* Subject to change.
92    Don't access this directly.
93 */
94
95 union _xhvnameu {
96     HEK *xhvnameu_name;         /* When xhv_name_count is 0 */
97     HEK **xhvnameu_names;       /* When xhv_name_count is non-0 */
98 };
99
100 struct xpvhv_aux {
101     union _xhvnameu xhv_name_u; /* name, if a symbol table */
102     AV          *xhv_backreferences; /* back references for weak references */
103     HE          *xhv_eiter;     /* current entry of iterator */
104     I32         xhv_riter;      /* current root of iterator */
105
106 /* Concerning xhv_name_count: When non-zero, xhv_name_u contains a pointer 
107  * to an array of HEK pointers, this being the length. The first element is
108  * the name of the stash, which may be NULL. If xhv_name_count is positive,
109  * then *xhv_name is one of the effective names. If xhv_name_count is nega-
110  * tive, then xhv_name_u.xhvnameu_names[1] is the first effective name.
111  */
112     I32         xhv_name_count;
113     struct mro_meta *xhv_mro_meta;
114     HV *        xhv_super;      /* SUPER method cache */
115 #ifdef PERL_HASH_RANDOMIZE_KEYS
116     U32         xhv_rand;       /* random value for hash traversal */
117     U32         xhv_last_rand;  /* last random value for hash traversal,
118                                    used to detect each() after insert for warnings */
119 #endif
120     U32         xhv_fill_lazy;
121 };
122
123 /* hash structure: */
124 /* This structure must match the beginning of struct xpvmg in sv.h. */
125 struct xpvhv {
126     HV*         xmg_stash;      /* class package */
127     union _xmgu xmg_u;
128     STRLEN      xhv_keys;       /* total keys, including placeholders */
129     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
130 };
131
132 /*
133 =head1 Hash Manipulation Functions
134
135 =for apidoc AmU||HEf_SVKEY
136 This flag, used in the length slot of hash entries and magic structures,
137 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
138 is to be expected. (For information only--not to be used).
139
140 =head1 Handy Values
141
142 =for apidoc AmU||Nullhv
143 Null HV pointer.
144
145 (deprecated - use C<(HV *)NULL> instead)
146
147 =head1 Hash Manipulation Functions
148
149 =for apidoc Am|char*|HvNAME|HV* stash
150 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
151 See C<SvSTASH>, C<CvSTASH>.
152
153 =for apidoc Am|STRLEN|HvNAMELEN|HV *stash
154 Returns the length of the stash's name.
155
156 =for apidoc Am|unsigned char|HvNAMEUTF8|HV *stash
157 Returns true if the name is in UTF8 encoding.
158
159 =for apidoc Am|char*|HvENAME|HV* stash
160 Returns the effective name of a stash, or NULL if there is none. The
161 effective name represents a location in the symbol table where this stash
162 resides. It is updated automatically when packages are aliased or deleted.
163 A stash that is no longer in the symbol table has no effective name. This
164 name is preferable to C<HvNAME> for use in MRO linearisations and isa
165 caches.
166
167 =for apidoc Am|STRLEN|HvENAMELEN|HV *stash
168 Returns the length of the stash's effective name.
169
170 =for apidoc Am|unsigned char|HvENAMEUTF8|HV *stash
171 Returns true if the effective name is in UTF8 encoding.
172
173 =for apidoc Am|void*|HeKEY|HE* he
174 Returns the actual pointer stored in the key slot of the hash entry. The
175 pointer may be either C<char*> or C<SV*>, depending on the value of
176 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
177 usually preferable for finding the value of a key.
178
179 =for apidoc Am|STRLEN|HeKLEN|HE* he
180 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
181 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
182 be assigned to. The C<HePV()> macro is usually preferable for finding key
183 lengths.
184
185 =for apidoc Am|SV*|HeVAL|HE* he
186 Returns the value slot (type C<SV*>) stored in the hash entry. Can be assigned
187 to.
188
189   SV *foo= HeVAL(hv);
190   HeVAL(hv)= sv;
191
192
193 =for apidoc Am|U32|HeHASH|HE* he
194 Returns the computed hash stored in the hash entry.
195
196 =for apidoc Am|char*|HePV|HE* he|STRLEN len
197 Returns the key slot of the hash entry as a C<char*> value, doing any
198 necessary dereferencing of possibly C<SV*> keys.  The length of the string
199 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
200 not care about what the length of the key is, you may use the global
201 variable C<PL_na>, though this is rather less efficient than using a local
202 variable.  Remember though, that hash keys in perl are free to contain
203 embedded nulls, so using C<strlen()> or similar is not a good way to find
204 the length of hash keys. This is very similar to the C<SvPV()> macro
205 described elsewhere in this document. See also C<HeUTF8>.
206
207 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
208 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
209 efficient.
210
211 =for apidoc Am|char*|HeUTF8|HE* he
212 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
213 doing any necessary dereferencing of possibly C<SV*> keys.  The value returned
214 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
215 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
216 typedef for C<char>.
217
218 =for apidoc Am|SV*|HeSVKEY|HE* he
219 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
220 contain an C<SV*> key.
221
222 =for apidoc Am|SV*|HeSVKEY_force|HE* he
223 Returns the key as an C<SV*>.  Will create and return a temporary mortal
224 C<SV*> if the hash entry contains only a C<char*> key.
225
226 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
227 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
228 indicate the presence of an C<SV*> key, and returns the same
229 C<SV*>.
230
231 =cut
232 */
233
234 #define PERL_HASH_DEFAULT_HvMAX 7
235
236 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
237 #define HEf_SVKEY       -2      /* hent_key is an SV* */
238
239 #ifndef PERL_CORE
240 #  define Nullhv Null(HV*)
241 #endif
242 #define HvARRAY(hv)     ((hv)->sv_u.svu_hash)
243 #define HvFILL(hv)      Perl_hv_fill(aTHX_ MUTABLE_HV(hv))
244 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
245 /* This quite intentionally does no flag checking first. That's your
246    responsibility.  */
247 #define HvAUX(hv)       ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
248 #define HvRITER(hv)     (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv)))
249 #define HvEITER(hv)     (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv)))
250 #define HvRITER_set(hv,r)       Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r)
251 #define HvEITER_set(hv,e)       Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e)
252 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
253 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
254 #define HvRAND_get(hv)  (SvOOK(hv) ? HvAUX(hv)->xhv_rand : 0)
255 #define HvLASTRAND_get(hv)      (SvOOK(hv) ? HvAUX(hv)->xhv_last_rand : 0)
256
257 #define HvNAME(hv)      HvNAME_get(hv)
258 #define HvNAMELEN(hv)   HvNAMELEN_get(hv)
259 #define HvENAME(hv)     HvENAME_get(hv)
260 #define HvENAMELEN(hv)  HvENAMELEN_get(hv)
261
262 /* Checking that hv is a valid package stash is the
263    caller's responsibility */
264 #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
265                        ? HvAUX(hv)->xhv_mro_meta \
266                        : Perl_mro_meta_init(aTHX_ hv))
267
268 #define HvNAME_HEK_NN(hv)                         \
269  (                                                \
270   HvAUX(hv)->xhv_name_count                       \
271   ? *HvAUX(hv)->xhv_name_u.xhvnameu_names         \
272   : HvAUX(hv)->xhv_name_u.xhvnameu_name           \
273  )
274 /* This macro may go away without notice.  */
275 #define HvNAME_HEK(hv) \
276         (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvNAME_HEK_NN(hv) : NULL)
277 #define HvNAME_get(hv) \
278         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
279                          ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL)
280 #define HvNAMELEN_get(hv) \
281         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
282                                  ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0)
283 #define HvNAMEUTF8(hv) \
284         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
285                                  ? HEK_UTF8(HvNAME_HEK_NN(hv)) : 0)
286 #define HvENAME_HEK_NN(hv)                                             \
287  (                                                                      \
288   HvAUX(hv)->xhv_name_count > 0   ? HvAUX(hv)->xhv_name_u.xhvnameu_names[0] : \
289   HvAUX(hv)->xhv_name_count < -1  ? HvAUX(hv)->xhv_name_u.xhvnameu_names[1] : \
290   HvAUX(hv)->xhv_name_count == -1 ? NULL                              : \
291                                     HvAUX(hv)->xhv_name_u.xhvnameu_name \
292  )
293 #define HvENAME_HEK(hv) \
294         (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvENAME_HEK_NN(hv) : NULL)
295 #define HvENAME_get(hv) \
296    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
297                          ? HEK_KEY(HvENAME_HEK_NN(hv)) : NULL)
298 #define HvENAMELEN_get(hv) \
299    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
300                                  ? HEK_LEN(HvENAME_HEK_NN(hv)) : 0)
301 #define HvENAMEUTF8(hv) \
302    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
303                                  ? HEK_UTF8(HvENAME_HEK_NN(hv)) : 0)
304
305 /* the number of keys (including any placeholders) */
306 #define XHvTOTALKEYS(xhv)       ((xhv)->xhv_keys)
307
308 /*
309  * HvKEYS gets the number of keys that actually exist(), and is provided
310  * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
311  * (keys, excluding placeholders) and HvTOTALKEYS (including placeholders)
312  */
313 #define HvKEYS(hv)              HvUSEDKEYS(hv)
314 #define HvUSEDKEYS(hv)          (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
315 #define HvTOTALKEYS(hv)         XHvTOTALKEYS((XPVHV*)  SvANY(hv))
316 #define HvPLACEHOLDERS(hv)      (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv)))
317 #define HvPLACEHOLDERS_get(hv)  (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0)
318 #define HvPLACEHOLDERS_set(hv,p)        Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p)
319
320 #define HvSHAREKEYS(hv)         (SvFLAGS(hv) & SVphv_SHAREKEYS)
321 #define HvSHAREKEYS_on(hv)      (SvFLAGS(hv) |= SVphv_SHAREKEYS)
322 #define HvSHAREKEYS_off(hv)     (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
323
324 /* This is an optimisation flag. It won't be set if all hash keys have a 0
325  * flag. Currently the only flags relate to utf8.
326  * Hence it won't be set if all keys are 8 bit only. It will be set if any key
327  * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
328  * when retrieved during iteration. It may still be set when there are no longer
329  * any utf8 keys.
330  * See HVhek_ENABLEHVKFLAGS for the trigger.
331  */
332 #define HvHASKFLAGS(hv)         (SvFLAGS(hv) & SVphv_HASKFLAGS)
333 #define HvHASKFLAGS_on(hv)      (SvFLAGS(hv) |= SVphv_HASKFLAGS)
334 #define HvHASKFLAGS_off(hv)     (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
335
336 #define HvLAZYDEL(hv)           (SvFLAGS(hv) & SVphv_LAZYDEL)
337 #define HvLAZYDEL_on(hv)        (SvFLAGS(hv) |= SVphv_LAZYDEL)
338 #define HvLAZYDEL_off(hv)       (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
339
340 #ifndef PERL_CORE
341 #  define Nullhe Null(HE*)
342 #endif
343 #define HeNEXT(he)              (he)->hent_next
344 #define HeKEY_hek(he)           (he)->hent_hek
345 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
346 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
347 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
348 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
349 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
350 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
351 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
352 #define HeVAL(he)               (he)->he_valu.hent_val
353 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
354 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
355                                  SvPV(HeKEY_sv(he),lp) :                \
356                                  ((lp = HeKLEN(he)), HeKEY(he)))
357 #define HeUTF8(he)              ((HeKLEN(he) == HEf_SVKEY) ?            \
358                                  SvUTF8(HeKEY_sv(he)) :                 \
359                                  (U32)HeKUTF8(he))
360
361 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
362                                   HeKLEN(he) == HEf_SVKEY) ?            \
363                                  HeKEY_sv(he) : NULL)
364
365 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
366                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
367                                   HeKEY_sv(he) :                        \
368                                   newSVpvn_flags(HeKEY(he),             \
369                                                  HeKLEN(he), SVs_TEMP)) : \
370                                  &PL_sv_undef)
371 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
372
373 #ifndef PERL_CORE
374 #  define Nullhek Null(HEK*)
375 #endif
376 #define HEK_BASESIZE            STRUCT_OFFSET(HEK, hek_key[0])
377 #define HEK_HASH(hek)           (hek)->hek_hash
378 #define HEK_LEN(hek)            (hek)->hek_len
379 #define HEK_KEY(hek)            (hek)->hek_key
380 #define HEK_FLAGS(hek)  (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
381
382 #define HVhek_UTF8      0x01 /* Key is utf8 encoded. */
383 #define HVhek_WASUTF8   0x02 /* Key is bytes here, but was supplied as utf8. */
384 #define HVhek_UNSHARED  0x08 /* This key isn't a shared hash key. */
385 #define HVhek_FREEKEY   0x100 /* Internal flag to say key is malloc()ed.  */
386 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
387                                * (may change, but Storable is a core module) */
388 #define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form.
389                                     If the string is UTF-8, it cannot be
390                                     converted to bytes. */
391 #define HVhek_MASK      0xFF
392
393 #define HVhek_ENABLEHVKFLAGS        (HVhek_MASK & ~(HVhek_UNSHARED))
394
395 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
396 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
397 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
398 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
399 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
400 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
401
402 /* calculate HV array allocation */
403 #ifndef PERL_USE_LARGE_HV_ALLOC
404 /* Default to allocating the correct size - default to assuming that malloc()
405    is not broken and is efficient at allocating blocks sized at powers-of-two.
406 */   
407 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
408 #else
409 #  define MALLOC_OVERHEAD 16
410 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
411                         (((size) < 64)                                  \
412                          ? (size) * sizeof(HE*)                         \
413                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
414 #endif
415
416 /* Flags for hv_iternext_flags.  */
417 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
418
419 #define hv_iternext(hv) hv_iternext_flags(hv, 0)
420 #define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0)
421 #define hv_undef(hv) Perl_hv_undef_flags(aTHX_ hv, 0)
422
423 #define Perl_sharepvn(pv, len, hash) HEK_KEY(share_hek(pv, len, hash))
424 #define sharepvn(pv, len, hash)      Perl_sharepvn(pv, len, hash)
425
426 #define share_hek_hek(hek)                                              \
427     (++(((struct shared_he *)(((char *)hek)                             \
428                               - STRUCT_OFFSET(struct shared_he,         \
429                                               shared_he_hek)))          \
430         ->shared_he_he.he_valu.hent_refcount),                          \
431      hek)
432
433 #define hv_store_ent(hv, keysv, val, hash)                              \
434     ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE,      \
435                       (val), (hash)))
436
437 #define hv_exists_ent(hv, keysv, hash)                                  \
438     (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \
439      ? TRUE : FALSE)
440 #define hv_fetch_ent(hv, keysv, lval, hash)                             \
441     ((HE *) hv_common((hv), (keysv), NULL, 0, 0,                        \
442                       ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash)))
443 #define hv_delete_ent(hv, key, flags, hash)                             \
444     (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \
445                           NULL, (hash))))
446
447 #define hv_store_flags(hv, key, klen, val, hash, flags)                 \
448     ((SV**) hv_common((hv), NULL, (key), (klen), (flags),               \
449                       (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val),       \
450                       (hash)))
451
452 #define hv_store(hv, key, klen, val, hash)                              \
453     ((SV**) hv_common_key_len((hv), (key), (klen),                      \
454                               (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV),      \
455                               (val), (hash)))
456
457 #define hv_exists(hv, key, klen)                                        \
458     (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \
459      ? TRUE : FALSE)
460
461 #define hv_fetch(hv, key, klen, lval)                                   \
462     ((SV**) hv_common_key_len((hv), (key), (klen), (lval)               \
463                               ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)    \
464                               : HV_FETCH_JUST_SV, NULL, 0))
465
466 #define hv_delete(hv, key, klen, flags)                                 \
467     (MUTABLE_SV(hv_common_key_len((hv), (key), (klen),                  \
468                                   (flags) | HV_DELETE, NULL, 0)))
469
470 /* This refcounted he structure is used for storing the hints used for lexical
471    pragmas. Without threads, it's basically struct he + refcount.
472    With threads, life gets more complex as the structure needs to be shared
473    between threads (because it hangs from OPs, which are shared), hence the
474    alternate definition and mutex.  */
475
476 struct refcounted_he;
477
478 /* flags for the refcounted_he API */
479 #define REFCOUNTED_HE_KEY_UTF8          0x00000001
480 #ifdef PERL_CORE
481 # define REFCOUNTED_HE_EXISTS           0x00000002
482 #endif
483
484 #ifdef PERL_CORE
485
486 /* Gosh. This really isn't a good name any longer.  */
487 struct refcounted_he {
488     struct refcounted_he *refcounted_he_next;   /* next entry in chain */
489 #ifdef USE_ITHREADS
490     U32                   refcounted_he_hash;
491     U32                   refcounted_he_keylen;
492 #else
493     HEK                  *refcounted_he_hek;    /* hint key */
494 #endif
495     union {
496         IV                refcounted_he_u_iv;
497         UV                refcounted_he_u_uv;
498         STRLEN            refcounted_he_u_len;
499         void             *refcounted_he_u_ptr;  /* Might be useful in future */
500     } refcounted_he_val;
501     U32                   refcounted_he_refcnt; /* reference count */
502     /* First byte is flags. Then NUL-terminated value. Then for ithreads,
503        non-NUL terminated key.  */
504     char                  refcounted_he_data[1];
505 };
506
507 /*
508 =for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|const char *key|U32 flags
509
510 Like L</refcounted_he_fetch_pvn>, but takes a literal string instead of
511 a string/length pair, and no precomputed hash.
512
513 =cut
514 */
515
516 #define refcounted_he_fetch_pvs(chain, key, flags) \
517     Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags)
518
519 /*
520 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|const char *key|SV *value|U32 flags
521
522 Like L</refcounted_he_new_pvn>, but takes a literal string instead of
523 a string/length pair, and no precomputed hash.
524
525 =cut
526 */
527
528 #define refcounted_he_new_pvs(parent, key, value, flags) \
529     Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags)
530
531 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
532 #define HVrhek_undef    0x00 /* Value is undef. */
533 #define HVrhek_delete   0x10 /* Value is placeholder - signifies delete. */
534 #define HVrhek_IV       0x20 /* Value is IV. */
535 #define HVrhek_UV       0x30 /* Value is UV. */
536 #define HVrhek_PV       0x40 /* Value is a (byte) string. */
537 #define HVrhek_PV_UTF8  0x50 /* Value is a (utf8) string. */
538 /* Two spare. As these have to live in the optree, you can't store anything
539    interpreter specific, such as SVs. :-( */
540 #define HVrhek_typemask 0x70
541
542 #ifdef USE_ITHREADS
543 /* A big expression to find the key offset */
544 #define REF_HE_KEY(chain)                                               \
545         ((((chain->refcounted_he_data[0] & 0x60) == 0x40)               \
546             ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0)     \
547          + 1 + chain->refcounted_he_data)
548 #endif
549
550 #  ifdef USE_ITHREADS
551 #    define HINTS_REFCNT_LOCK           MUTEX_LOCK(&PL_hints_mutex)
552 #    define HINTS_REFCNT_UNLOCK         MUTEX_UNLOCK(&PL_hints_mutex)
553 #  else
554 #    define HINTS_REFCNT_LOCK           NOOP
555 #    define HINTS_REFCNT_UNLOCK         NOOP
556 #  endif
557 #endif
558
559 #ifdef USE_ITHREADS
560 #  define HINTS_REFCNT_INIT             MUTEX_INIT(&PL_hints_mutex)
561 #  define HINTS_REFCNT_TERM             MUTEX_DESTROY(&PL_hints_mutex)
562 #else
563 #  define HINTS_REFCNT_INIT             NOOP
564 #  define HINTS_REFCNT_TERM             NOOP
565 #endif
566
567 /* Hash actions
568  * Passed in PERL_MAGIC_uvar calls
569  */
570 #define HV_DISABLE_UVAR_XKEY    0x01
571 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
572    is documented as being passed to hv_delete().  */
573 #define HV_FETCH_ISSTORE        0x04
574 #define HV_FETCH_ISEXISTS       0x08
575 #define HV_FETCH_LVALUE         0x10
576 #define HV_FETCH_JUST_SV        0x20
577 #define HV_DELETE               0x40
578 #define HV_FETCH_EMPTY_HE       0x80 /* Leave HeVAL null. */
579
580 /* Must not conflict with HVhek_UTF8 */
581 #define HV_NAME_SETALL          0x02
582
583 /*
584 =for apidoc newHV
585
586 Creates a new HV.  The reference count is set to 1.
587
588 =cut
589 */
590
591 #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
592
593 #include "hv_func.h"
594
595 /*
596  * Local variables:
597  * c-indentation-style: bsd
598  * c-basic-offset: 4
599  * indent-tabs-mode: nil
600  * End:
601  *
602  * ex: set ts=8 sts=4 sw=4 et:
603  */