2 * Copyright © 2018 Google, Inc.
4 * This is part of HarfBuzz, a text shaping library.
6 * Permission is hereby granted, without written agreement and without
7 * license or royalty fees, to use, copy, modify, and distribute this
8 * software and its documentation for any purpose, provided that the
9 * above copyright notice and the following two paragraphs appear in
10 * all copies of this software.
12 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
13 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
14 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
15 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
18 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
19 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
21 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
22 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
24 * Google Author(s): Behdad Esfahbod
33 * @short_description: Object representing integer to integer mapping
36 * Map objects are integer-to-integer hash-maps. Currently they are
37 * not used in the HarfBuzz public API, but are provided for client's
45 * Creates a new, initially empty map.
47 * Return value: (transfer full): The new #hb_map_t
56 if (!(map
= hb_object_create
<hb_map_t
> ()))
57 return hb_map_get_empty ();
65 * Fetches the singleton empty #hb_map_t.
67 * Return value: (transfer full): The empty #hb_map_t
74 return const_cast<hb_map_t
*> (&Null (hb_map_t
));
78 * hb_map_reference: (skip)
81 * Increases the reference count on a map.
83 * Return value: (transfer full): The map
88 hb_map_reference (hb_map_t
*map
)
90 return hb_object_reference (map
);
94 * hb_map_destroy: (skip)
97 * Decreases the reference count on a map. When
98 * the reference count reaches zero, the map is
99 * destroyed, freeing all memory.
104 hb_map_destroy (hb_map_t
*map
)
106 if (!hb_object_destroy (map
)) return;
112 * hb_map_set_user_data: (skip)
114 * @key: The user-data key to set
115 * @data: A pointer to the user data to set
116 * @destroy: (nullable): A callback to call when @data is not needed anymore
117 * @replace: Whether to replace an existing data with the same key
119 * Attaches a user-data key/data pair to the specified map.
121 * Return value: `true` if success, `false` otherwise
126 hb_map_set_user_data (hb_map_t
*map
,
127 hb_user_data_key_t
*key
,
129 hb_destroy_func_t destroy
,
132 return hb_object_set_user_data (map
, key
, data
, destroy
, replace
);
136 * hb_map_get_user_data: (skip)
138 * @key: The user-data key to query
140 * Fetches the user data associated with the specified key,
141 * attached to the specified map.
143 * Return value: (transfer none): A pointer to the user data
148 hb_map_get_user_data (const hb_map_t
*map
,
149 hb_user_data_key_t
*key
)
151 return hb_object_get_user_data (map
, key
);
156 * hb_map_allocation_successful:
159 * Tests whether memory allocation for a set was successful.
161 * Return value: `true` if allocation succeeded, `false` otherwise
166 hb_map_allocation_successful (const hb_map_t
*map
)
168 return map
->successful
;
175 * Allocate a copy of @map.
177 * Return value: (transfer full): Newly-allocated map.
182 hb_map_copy (const hb_map_t
*map
)
184 hb_map_t
*copy
= hb_map_create ();
185 if (unlikely (copy
->in_error ()))
186 return hb_map_get_empty ();
195 * @key: The key to store in the map
196 * @value: The value to store for @key
198 * Stores @key:@value in the map.
203 hb_map_set (hb_map_t
*map
,
205 hb_codepoint_t value
)
207 /* Immutable-safe. */
208 map
->set (key
, value
);
214 * @key: The key to query
216 * Fetches the value stored for @key in @map.
221 hb_map_get (const hb_map_t
*map
,
224 return map
->get (key
);
230 * @key: The key to delete
232 * Removes @key and its stored value from @map.
237 hb_map_del (hb_map_t
*map
,
240 /* Immutable-safe. */
247 * @key: The key to query
249 * Tests whether @key is an element of @map.
251 * Return value: `true` if @key is found in @map, `false` otherwise
256 hb_map_has (const hb_map_t
*map
,
259 return map
->has (key
);
267 * Clears out the contents of @map.
272 hb_map_clear (hb_map_t
*map
)
274 return map
->clear ();
281 * Tests whether @map is empty (contains no elements).
283 * Return value: `true` if @map is empty
288 hb_map_is_empty (const hb_map_t
*map
)
290 return map
->is_empty ();
294 * hb_map_get_population:
297 * Returns the number of key-value pairs in the map.
299 * Return value: The population of @map
304 hb_map_get_population (const hb_map_t
*map
)
306 return map
->get_population ();
312 * @other: Another map
314 * Tests whether @map and @other are equal (contain the same
317 * Return value: `true` if the two maps are equal, `false` otherwise.
322 hb_map_is_equal (const hb_map_t
*map
,
323 const hb_map_t
*other
)
325 return map
->is_equal (*other
);
332 * Creates a hash representing @map.
340 hb_map_hash (const hb_map_t
*map
)
348 * @other: Another map
350 * Add the contents of @other to @map.
355 hb_map_update (hb_map_t
*map
,
356 const hb_map_t
*other
)
358 map
->update (*other
);
364 * @idx: (inout): Iterator internal state
365 * @key: (out): Key retrieved
366 * @value: (out): Value retrieved
368 * Fetches the next key/value pair in @map.
370 * Set @idx to -1 to get started.
372 * If the map is modified during iteration, the behavior is undefined.
374 * The order in which the key/values are returned is undefined.
376 * Return value: `true` if there was a next value, `false` otherwise
381 hb_map_next (const hb_map_t
*map
,
384 hb_codepoint_t
*value
)
386 return map
->next (idx
, key
, value
);
394 * Add the keys of @map to @keys.
399 hb_map_keys (const hb_map_t
*map
,
402 hb_copy (map
->keys() , *keys
);
410 * Add the values of @map to @values.
415 hb_map_values (const hb_map_t
*map
,
418 hb_copy (map
->values() , *values
);