Home | History | Annotate | Download | only in src
      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 
     36 HB_BEGIN_DECLS
     37 
     38 
     39 typedef struct hb_set_t hb_set_t;
     40 
     41 
     42 hb_set_t *
     43 hb_set_create (void);
     44 
     45 hb_set_t *
     46 hb_set_get_empty (void);
     47 
     48 hb_set_t *
     49 hb_set_reference (hb_set_t *set);
     50 
     51 void
     52 hb_set_destroy (hb_set_t *set);
     53 
     54 hb_bool_t
     55 hb_set_set_user_data (hb_set_t           *set,
     56 		      hb_user_data_key_t *key,
     57 		      void *              data,
     58 		      hb_destroy_func_t   destroy,
     59 		      hb_bool_t           replace);
     60 
     61 void *
     62 hb_set_get_user_data (hb_set_t           *set,
     63 		      hb_user_data_key_t *key);
     64 
     65 
     66 /* Returns false if allocation has failed before */
     67 hb_bool_t
     68 hb_set_allocation_successful (const hb_set_t *set);
     69 
     70 void
     71 hb_set_clear (hb_set_t *set);
     72 
     73 hb_bool_t
     74 hb_set_is_empty (const hb_set_t *set);
     75 
     76 hb_bool_t
     77 hb_set_has (const hb_set_t *set,
     78 	    hb_codepoint_t  codepoint);
     79 
     80 /* Right now limited to 16-bit integers.  Eventually will do full codepoint range, sans -1
     81  * which we will use as a sentinel. */
     82 void
     83 hb_set_add (hb_set_t       *set,
     84 	    hb_codepoint_t  codepoint);
     85 
     86 void
     87 hb_set_add_range (hb_set_t       *set,
     88 		  hb_codepoint_t  first,
     89 		  hb_codepoint_t  last);
     90 
     91 void
     92 hb_set_del (hb_set_t       *set,
     93 	    hb_codepoint_t  codepoint);
     94 
     95 void
     96 hb_set_del_range (hb_set_t       *set,
     97 		  hb_codepoint_t  first,
     98 		  hb_codepoint_t  last);
     99 
    100 hb_bool_t
    101 hb_set_is_equal (const hb_set_t *set,
    102 		 const hb_set_t *other);
    103 
    104 void
    105 hb_set_set (hb_set_t       *set,
    106 	    const hb_set_t *other);
    107 
    108 void
    109 hb_set_union (hb_set_t       *set,
    110 	      const hb_set_t *other);
    111 
    112 void
    113 hb_set_intersect (hb_set_t       *set,
    114 		  const hb_set_t *other);
    115 
    116 void
    117 hb_set_subtract (hb_set_t       *set,
    118 		 const hb_set_t *other);
    119 
    120 void
    121 hb_set_symmetric_difference (hb_set_t       *set,
    122 			     const hb_set_t *other);
    123 
    124 void
    125 hb_set_invert (hb_set_t *set);
    126 
    127 unsigned int
    128 hb_set_get_population (const hb_set_t *set);
    129 
    130 /* Returns -1 if set empty. */
    131 hb_codepoint_t
    132 hb_set_get_min (const hb_set_t *set);
    133 
    134 /* Returns -1 if set empty. */
    135 hb_codepoint_t
    136 hb_set_get_max (const hb_set_t *set);
    137 
    138 /* Pass -1 in to get started. */
    139 hb_bool_t
    140 hb_set_next (const hb_set_t *set,
    141 	     hb_codepoint_t *codepoint);
    142 
    143 /* Pass -1 for first and last to get started. */
    144 hb_bool_t
    145 hb_set_next_range (const hb_set_t *set,
    146 		   hb_codepoint_t *first,
    147 		   hb_codepoint_t *last);
    148 
    149 
    150 HB_END_DECLS
    151 
    152 #endif /* HB_SET_H */
    153