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#if !defined(HB_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
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 * HB_SET_VALUE_INVALID:
41 *
42 * Unset #hb_set_t value.
43 *
44 * Since: 0.9.21
45 */
46#define HB_SET_VALUE_INVALID HB_CODEPOINT_INVALID
47
48/**
49 * hb_set_t:
50 *
51 * Data type for holding a set of integers. #hb_set_t's are
52 * used to gather and contain glyph IDs, Unicode code
53 * points, and various other collections of discrete
54 * values.
55 *
56 **/
57typedef struct hb_set_t hb_set_t;
58
59
60HB_EXTERN hb_set_t *
61hb_set_create (void);
62
63HB_EXTERN hb_set_t *
64hb_set_get_empty (void);
65
66HB_EXTERN hb_set_t *
67hb_set_reference (hb_set_t *set);
68
69HB_EXTERN void
70hb_set_destroy (hb_set_t *set);
71
72HB_EXTERN hb_bool_t
73hb_set_set_user_data (hb_set_t *set,
74 hb_user_data_key_t *key,
75 void * data,
76 hb_destroy_func_t destroy,
77 hb_bool_t replace);
78
79HB_EXTERN void *
80hb_set_get_user_data (const hb_set_t *set,
81 hb_user_data_key_t *key);
82
83
84/* Returns false if allocation has failed before */
85HB_EXTERN hb_bool_t
86hb_set_allocation_successful (const hb_set_t *set);
87
88HB_EXTERN hb_set_t *
89hb_set_copy (const hb_set_t *set);
90
91HB_EXTERN void
92hb_set_clear (hb_set_t *set);
93
94HB_EXTERN hb_bool_t
95hb_set_is_empty (const hb_set_t *set);
96
97HB_EXTERN void
98hb_set_invert (hb_set_t *set);
99
100HB_EXTERN hb_bool_t
101hb_set_is_inverted (const hb_set_t *set);
102
103HB_EXTERN hb_bool_t
104hb_set_has (const hb_set_t *set,
105 hb_codepoint_t codepoint);
106
107HB_EXTERN void
108hb_set_add (hb_set_t *set,
109 hb_codepoint_t codepoint);
110
111HB_EXTERN void
112hb_set_add_range (hb_set_t *set,
113 hb_codepoint_t first,
114 hb_codepoint_t last);
115
116HB_EXTERN void
117hb_set_add_sorted_array (hb_set_t *set,
118 const hb_codepoint_t *sorted_codepoints,
119 unsigned int num_codepoints);
120
121HB_EXTERN void
122hb_set_del (hb_set_t *set,
123 hb_codepoint_t codepoint);
124
125HB_EXTERN void
126hb_set_del_range (hb_set_t *set,
127 hb_codepoint_t first,
128 hb_codepoint_t last);
129
130HB_EXTERN hb_bool_t
131hb_set_is_equal (const hb_set_t *set,
132 const hb_set_t *other);
133
134HB_EXTERN unsigned int
135hb_set_hash (const hb_set_t *set);
136
137HB_EXTERN hb_bool_t
138hb_set_is_subset (const hb_set_t *set,
139 const hb_set_t *larger_set);
140
141HB_EXTERN void
142hb_set_set (hb_set_t *set,
143 const hb_set_t *other);
144
145HB_EXTERN void
146hb_set_union (hb_set_t *set,
147 const hb_set_t *other);
148
149HB_EXTERN void
150hb_set_intersect (hb_set_t *set,
151 const hb_set_t *other);
152
153HB_EXTERN void
154hb_set_subtract (hb_set_t *set,
155 const hb_set_t *other);
156
157HB_EXTERN void
158hb_set_symmetric_difference (hb_set_t *set,
159 const hb_set_t *other);
160
161HB_EXTERN unsigned int
162hb_set_get_population (const hb_set_t *set);
163
164/* Returns HB_SET_VALUE_INVALID if set empty. */
165HB_EXTERN hb_codepoint_t
166hb_set_get_min (const hb_set_t *set);
167
168/* Returns HB_SET_VALUE_INVALID if set empty. */
169HB_EXTERN hb_codepoint_t
170hb_set_get_max (const hb_set_t *set);
171
172/* Pass HB_SET_VALUE_INVALID in to get started. */
173HB_EXTERN hb_bool_t
174hb_set_next (const hb_set_t *set,
175 hb_codepoint_t *codepoint);
176
177/* Pass HB_SET_VALUE_INVALID in to get started. */
178HB_EXTERN hb_bool_t
179hb_set_previous (const hb_set_t *set,
180 hb_codepoint_t *codepoint);
181
182/* Pass HB_SET_VALUE_INVALID for first and last to get started. */
183HB_EXTERN hb_bool_t
184hb_set_next_range (const hb_set_t *set,
185 hb_codepoint_t *first,
186 hb_codepoint_t *last);
187
188/* Pass HB_SET_VALUE_INVALID for first and last to get started. */
189HB_EXTERN hb_bool_t
190hb_set_previous_range (const hb_set_t *set,
191 hb_codepoint_t *first,
192 hb_codepoint_t *last);
193
194/* Pass HB_SET_VALUE_INVALID in to get started. */
195HB_EXTERN unsigned int
196hb_set_next_many (const hb_set_t *set,
197 hb_codepoint_t codepoint,
198 hb_codepoint_t *out,
199 unsigned int size);
200
201HB_END_DECLS
202
203#endif /* HB_SET_H */
204