1/*
2 * Copyright © 2018 Google, Inc.
3 *
4 * This is part of HarfBuzz, a text shaping library.
5 *
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.
11 *
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
16 * DAMAGE.
17 *
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.
23 *
24 * Google Author(s): Behdad Esfahbod
25 */
26
27#ifndef HB_H_IN
28#error "Include <hb.h> instead."
29#endif
30
31#ifndef HB_MAP_H
32#define HB_MAP_H
33
34#include "hb-common.h"
35
36HB_BEGIN_DECLS
37
38
39/*
40 * Since: 1.7.7
41 */
42#define HB_MAP_VALUE_INVALID ((hb_codepoint_t) -1)
43
44/**
45 * hb_map_t:
46 *
47 * Data type for holding integer-to-integer hash maps.
48 *
49 **/
50typedef struct hb_map_t hb_map_t;
51
52
53HB_EXTERN hb_map_t *
54hb_map_create (void);
55
56HB_EXTERN hb_map_t *
57hb_map_get_empty (void);
58
59HB_EXTERN hb_map_t *
60hb_map_reference (hb_map_t *map);
61
62HB_EXTERN void
63hb_map_destroy (hb_map_t *map);
64
65HB_EXTERN hb_bool_t
66hb_map_set_user_data (hb_map_t *map,
67 hb_user_data_key_t *key,
68 void * data,
69 hb_destroy_func_t destroy,
70 hb_bool_t replace);
71
72HB_EXTERN void *
73hb_map_get_user_data (hb_map_t *map,
74 hb_user_data_key_t *key);
75
76
77/* Returns false if allocation has failed before */
78HB_EXTERN hb_bool_t
79hb_map_allocation_successful (const hb_map_t *map);
80
81HB_EXTERN void
82hb_map_clear (hb_map_t *map);
83
84HB_EXTERN hb_bool_t
85hb_map_is_empty (const hb_map_t *map);
86
87HB_EXTERN unsigned int
88hb_map_get_population (const hb_map_t *map);
89
90HB_EXTERN void
91hb_map_set (hb_map_t *map,
92 hb_codepoint_t key,
93 hb_codepoint_t value);
94
95HB_EXTERN hb_codepoint_t
96hb_map_get (const hb_map_t *map,
97 hb_codepoint_t key);
98
99HB_EXTERN void
100hb_map_del (hb_map_t *map,
101 hb_codepoint_t key);
102
103HB_EXTERN hb_bool_t
104hb_map_has (const hb_map_t *map,
105 hb_codepoint_t key);
106
107
108HB_END_DECLS
109
110#endif /* HB_MAP_H */
111

source code of include/harfbuzz/hb-map.h