1/*
2 * Copyright © 2012 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_SET_H
32#define HB_SET_H
33
34#include "hb-common.h"
35
36HB_BEGIN_DECLS
37
38
39/*
40 * Since: 0.9.21
41 */
42#define HB_SET_VALUE_INVALID ((hb_codepoint_t) -1)
43
44/**
45 * hb_set_t:
46 *
47 * Data type for holding a set of integers. #hb_set_t's are
48 * used to gather and contain glyph IDs, Unicode code
49 * points, and various other collections of discrete
50 * values.
51 *
52 **/
53typedef struct hb_set_t hb_set_t;
54
55
56HB_EXTERN hb_set_t *
57hb_set_create (void);
58
59HB_EXTERN hb_set_t *
60hb_set_get_empty (void);
61
62HB_EXTERN hb_set_t *
63hb_set_reference (hb_set_t *set);
64
65HB_EXTERN void
66hb_set_destroy (hb_set_t *set);
67
68HB_EXTERN hb_bool_t
69hb_set_set_user_data (hb_set_t *set,
70 hb_user_data_key_t *key,
71 void * data,
72 hb_destroy_func_t destroy,
73 hb_bool_t replace);
74
75HB_EXTERN void *
76hb_set_get_user_data (hb_set_t *set,
77 hb_user_data_key_t *key);
78
79
80/* Returns false if allocation has failed before */
81HB_EXTERN hb_bool_t
82hb_set_allocation_successful (const hb_set_t *set);
83
84HB_EXTERN void
85hb_set_clear (hb_set_t *set);
86
87HB_EXTERN hb_bool_t
88hb_set_is_empty (const hb_set_t *set);
89
90HB_EXTERN hb_bool_t
91hb_set_has (const hb_set_t *set,
92 hb_codepoint_t codepoint);
93
94HB_EXTERN void
95hb_set_add (hb_set_t *set,
96 hb_codepoint_t codepoint);
97
98HB_EXTERN void
99hb_set_add_range (hb_set_t *set,
100 hb_codepoint_t first,
101 hb_codepoint_t last);
102
103HB_EXTERN void
104hb_set_del (hb_set_t *set,
105 hb_codepoint_t codepoint);
106
107HB_EXTERN void
108hb_set_del_range (hb_set_t *set,
109 hb_codepoint_t first,
110 hb_codepoint_t last);
111
112HB_EXTERN hb_bool_t
113hb_set_is_equal (const hb_set_t *set,
114 const hb_set_t *other);
115
116HB_EXTERN hb_bool_t
117hb_set_is_subset (const hb_set_t *set,
118 const hb_set_t *larger_set);
119
120HB_EXTERN void
121hb_set_set (hb_set_t *set,
122 const hb_set_t *other);
123
124HB_EXTERN void
125hb_set_union (hb_set_t *set,
126 const hb_set_t *other);
127
128HB_EXTERN void
129hb_set_intersect (hb_set_t *set,
130 const hb_set_t *other);
131
132HB_EXTERN void
133hb_set_subtract (hb_set_t *set,
134 const hb_set_t *other);
135
136HB_EXTERN void
137hb_set_symmetric_difference (hb_set_t *set,
138 const hb_set_t *other);
139
140HB_EXTERN unsigned int
141hb_set_get_population (const hb_set_t *set);
142
143/* Returns HB_SET_VALUE_INVALID if set empty. */
144HB_EXTERN hb_codepoint_t
145hb_set_get_min (const hb_set_t *set);
146
147/* Returns HB_SET_VALUE_INVALID if set empty. */
148HB_EXTERN hb_codepoint_t
149hb_set_get_max (const hb_set_t *set);
150
151/* Pass HB_SET_VALUE_INVALID in to get started. */
152HB_EXTERN hb_bool_t
153hb_set_next (const hb_set_t *set,
154 hb_codepoint_t *codepoint);
155
156/* Pass HB_SET_VALUE_INVALID in to get started. */
157HB_EXTERN hb_bool_t
158hb_set_previous (const hb_set_t *set,
159 hb_codepoint_t *codepoint);
160
161/* Pass HB_SET_VALUE_INVALID for first and last to get started. */
162HB_EXTERN hb_bool_t
163hb_set_next_range (const hb_set_t *set,
164 hb_codepoint_t *first,
165 hb_codepoint_t *last);
166
167/* Pass HB_SET_VALUE_INVALID for first and last to get started. */
168HB_EXTERN hb_bool_t
169hb_set_previous_range (const hb_set_t *set,
170 hb_codepoint_t *first,
171 hb_codepoint_t *last);
172
173
174HB_END_DECLS
175
176#endif /* HB_SET_H */
177

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