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 36 HB_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_t) -1) 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 **/ 57 typedef struct hb_set_t hb_set_t; 58 59 60 HB_EXTERN hb_set_t * 61 hb_set_create (void); 62 63 HB_EXTERN hb_set_t * 64 hb_set_get_empty (void); 65 66 HB_EXTERN hb_set_t * 67 hb_set_reference (hb_set_t *set); 68 69 HB_EXTERN void 70 hb_set_destroy (hb_set_t *set); 71 72 HB_EXTERN hb_bool_t 73 hb_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 79 HB_EXTERN void * 80 hb_set_get_user_data (hb_set_t *set, 81 hb_user_data_key_t *key); 82 83 84 /* Returns false if allocation has failed before */ 85 HB_EXTERN hb_bool_t 86 hb_set_allocation_successful (const hb_set_t *set); 87 88 HB_EXTERN void 89 hb_set_clear (hb_set_t *set); 90 91 HB_EXTERN hb_bool_t 92 hb_set_is_empty (const hb_set_t *set); 93 94 HB_EXTERN hb_bool_t 95 hb_set_has (const hb_set_t *set, 96 hb_codepoint_t codepoint); 97 98 HB_EXTERN void 99 hb_set_add (hb_set_t *set, 100 hb_codepoint_t codepoint); 101 102 HB_EXTERN void 103 hb_set_add_range (hb_set_t *set, 104 hb_codepoint_t first, 105 hb_codepoint_t last); 106 107 HB_EXTERN void 108 hb_set_del (hb_set_t *set, 109 hb_codepoint_t codepoint); 110 111 HB_EXTERN void 112 hb_set_del_range (hb_set_t *set, 113 hb_codepoint_t first, 114 hb_codepoint_t last); 115 116 HB_EXTERN hb_bool_t 117 hb_set_is_equal (const hb_set_t *set, 118 const hb_set_t *other); 119 120 HB_EXTERN hb_bool_t 121 hb_set_is_subset (const hb_set_t *set, 122 const hb_set_t *larger_set); 123 124 HB_EXTERN void 125 hb_set_set (hb_set_t *set, 126 const hb_set_t *other); 127 128 HB_EXTERN void 129 hb_set_union (hb_set_t *set, 130 const hb_set_t *other); 131 132 HB_EXTERN void 133 hb_set_intersect (hb_set_t *set, 134 const hb_set_t *other); 135 136 HB_EXTERN void 137 hb_set_subtract (hb_set_t *set, 138 const hb_set_t *other); 139 140 HB_EXTERN void 141 hb_set_symmetric_difference (hb_set_t *set, 142 const hb_set_t *other); 143 144 HB_EXTERN unsigned int 145 hb_set_get_population (const hb_set_t *set); 146 147 /* Returns HB_SET_VALUE_INVALID if set empty. */ 148 HB_EXTERN hb_codepoint_t 149 hb_set_get_min (const hb_set_t *set); 150 151 /* Returns HB_SET_VALUE_INVALID if set empty. */ 152 HB_EXTERN hb_codepoint_t 153 hb_set_get_max (const hb_set_t *set); 154 155 /* Pass HB_SET_VALUE_INVALID in to get started. */ 156 HB_EXTERN hb_bool_t 157 hb_set_next (const hb_set_t *set, 158 hb_codepoint_t *codepoint); 159 160 /* Pass HB_SET_VALUE_INVALID in to get started. */ 161 HB_EXTERN hb_bool_t 162 hb_set_previous (const hb_set_t *set, 163 hb_codepoint_t *codepoint); 164 165 /* Pass HB_SET_VALUE_INVALID for first and last to get started. */ 166 HB_EXTERN hb_bool_t 167 hb_set_next_range (const hb_set_t *set, 168 hb_codepoint_t *first, 169 hb_codepoint_t *last); 170 171 /* Pass HB_SET_VALUE_INVALID for first and last to get started. */ 172 HB_EXTERN hb_bool_t 173 hb_set_previous_range (const hb_set_t *set, 174 hb_codepoint_t *first, 175 hb_codepoint_t *last); 176 177 178 HB_END_DECLS 179 180 #endif /* HB_SET_H */ 181