xref: /aosp_15_r20/external/harfbuzz_ng/src/hb-set.hh (revision 2d1272b857b1f7575e6e246373e1cb218663db8a)
1*2d1272b8SAndroid Build Coastguard Worker /*
2*2d1272b8SAndroid Build Coastguard Worker  * Copyright © 2012,2017  Google, Inc.
3*2d1272b8SAndroid Build Coastguard Worker  * Copyright © 2021 Behdad Esfahbod
4*2d1272b8SAndroid Build Coastguard Worker  *
5*2d1272b8SAndroid Build Coastguard Worker  *  This is part of HarfBuzz, a text shaping library.
6*2d1272b8SAndroid Build Coastguard Worker  *
7*2d1272b8SAndroid Build Coastguard Worker  * Permission is hereby granted, without written agreement and without
8*2d1272b8SAndroid Build Coastguard Worker  * license or royalty fees, to use, copy, modify, and distribute this
9*2d1272b8SAndroid Build Coastguard Worker  * software and its documentation for any purpose, provided that the
10*2d1272b8SAndroid Build Coastguard Worker  * above copyright notice and the following two paragraphs appear in
11*2d1272b8SAndroid Build Coastguard Worker  * all copies of this software.
12*2d1272b8SAndroid Build Coastguard Worker  *
13*2d1272b8SAndroid Build Coastguard Worker  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
14*2d1272b8SAndroid Build Coastguard Worker  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
15*2d1272b8SAndroid Build Coastguard Worker  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
16*2d1272b8SAndroid Build Coastguard Worker  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
17*2d1272b8SAndroid Build Coastguard Worker  * DAMAGE.
18*2d1272b8SAndroid Build Coastguard Worker  *
19*2d1272b8SAndroid Build Coastguard Worker  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
20*2d1272b8SAndroid Build Coastguard Worker  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21*2d1272b8SAndroid Build Coastguard Worker  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
22*2d1272b8SAndroid Build Coastguard Worker  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
23*2d1272b8SAndroid Build Coastguard Worker  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
24*2d1272b8SAndroid Build Coastguard Worker  *
25*2d1272b8SAndroid Build Coastguard Worker  * Google Author(s): Behdad Esfahbod
26*2d1272b8SAndroid Build Coastguard Worker  */
27*2d1272b8SAndroid Build Coastguard Worker 
28*2d1272b8SAndroid Build Coastguard Worker #ifndef HB_SET_HH
29*2d1272b8SAndroid Build Coastguard Worker #define HB_SET_HH
30*2d1272b8SAndroid Build Coastguard Worker 
31*2d1272b8SAndroid Build Coastguard Worker #include "hb.hh"
32*2d1272b8SAndroid Build Coastguard Worker #include "hb-bit-set-invertible.hh"
33*2d1272b8SAndroid Build Coastguard Worker 
34*2d1272b8SAndroid Build Coastguard Worker 
35*2d1272b8SAndroid Build Coastguard Worker template <typename impl_t>
36*2d1272b8SAndroid Build Coastguard Worker struct hb_sparseset_t
37*2d1272b8SAndroid Build Coastguard Worker {
38*2d1272b8SAndroid Build Coastguard Worker   static constexpr bool realloc_move = true;
39*2d1272b8SAndroid Build Coastguard Worker 
40*2d1272b8SAndroid Build Coastguard Worker   hb_object_header_t header;
41*2d1272b8SAndroid Build Coastguard Worker   impl_t s;
42*2d1272b8SAndroid Build Coastguard Worker 
hb_sparseset_thb_sparseset_t43*2d1272b8SAndroid Build Coastguard Worker   hb_sparseset_t () { init (); }
~hb_sparseset_thb_sparseset_t44*2d1272b8SAndroid Build Coastguard Worker   ~hb_sparseset_t () { fini (); }
45*2d1272b8SAndroid Build Coastguard Worker 
hb_sparseset_thb_sparseset_t46*2d1272b8SAndroid Build Coastguard Worker   hb_sparseset_t (const hb_sparseset_t& other) : hb_sparseset_t () { set (other); }
hb_sparseset_thb_sparseset_t47*2d1272b8SAndroid Build Coastguard Worker   hb_sparseset_t (hb_sparseset_t&& other)  noexcept : hb_sparseset_t () { s = std::move (other.s); }
operator =hb_sparseset_t48*2d1272b8SAndroid Build Coastguard Worker   hb_sparseset_t& operator = (const hb_sparseset_t& other) { set (other); return *this; }
operator =hb_sparseset_t49*2d1272b8SAndroid Build Coastguard Worker   hb_sparseset_t& operator = (hb_sparseset_t&& other)  noexcept { s = std::move (other.s); return *this; }
swap(hb_sparseset_t & a,hb_sparseset_t & b)50*2d1272b8SAndroid Build Coastguard Worker   friend void swap (hb_sparseset_t& a, hb_sparseset_t& b)  noexcept { hb_swap (a.s, b.s); }
51*2d1272b8SAndroid Build Coastguard Worker 
hb_sparseset_thb_sparseset_t52*2d1272b8SAndroid Build Coastguard Worker   hb_sparseset_t (std::initializer_list<hb_codepoint_t> lst) : hb_sparseset_t ()
53*2d1272b8SAndroid Build Coastguard Worker   {
54*2d1272b8SAndroid Build Coastguard Worker     for (auto&& item : lst)
55*2d1272b8SAndroid Build Coastguard Worker       add (item);
56*2d1272b8SAndroid Build Coastguard Worker   }
57*2d1272b8SAndroid Build Coastguard Worker   template <typename Iterable,
58*2d1272b8SAndroid Build Coastguard Worker            hb_requires (hb_is_iterable (Iterable))>
hb_sparseset_thb_sparseset_t59*2d1272b8SAndroid Build Coastguard Worker   hb_sparseset_t (const Iterable &o) : hb_sparseset_t ()
60*2d1272b8SAndroid Build Coastguard Worker   {
61*2d1272b8SAndroid Build Coastguard Worker     hb_copy (o, *this);
62*2d1272b8SAndroid Build Coastguard Worker   }
63*2d1272b8SAndroid Build Coastguard Worker 
inithb_sparseset_t64*2d1272b8SAndroid Build Coastguard Worker   void init ()
65*2d1272b8SAndroid Build Coastguard Worker   {
66*2d1272b8SAndroid Build Coastguard Worker     hb_object_init (this);
67*2d1272b8SAndroid Build Coastguard Worker     s.init ();
68*2d1272b8SAndroid Build Coastguard Worker   }
finihb_sparseset_t69*2d1272b8SAndroid Build Coastguard Worker   void fini ()
70*2d1272b8SAndroid Build Coastguard Worker   {
71*2d1272b8SAndroid Build Coastguard Worker     hb_object_fini (this);
72*2d1272b8SAndroid Build Coastguard Worker     s.fini ();
73*2d1272b8SAndroid Build Coastguard Worker   }
74*2d1272b8SAndroid Build Coastguard Worker 
operator boolhb_sparseset_t75*2d1272b8SAndroid Build Coastguard Worker   explicit operator bool () const { return !is_empty (); }
76*2d1272b8SAndroid Build Coastguard Worker 
errhb_sparseset_t77*2d1272b8SAndroid Build Coastguard Worker   void err () { s.err (); }
in_errorhb_sparseset_t78*2d1272b8SAndroid Build Coastguard Worker   bool in_error () const { return s.in_error (); }
79*2d1272b8SAndroid Build Coastguard Worker 
allochb_sparseset_t80*2d1272b8SAndroid Build Coastguard Worker   void alloc (unsigned sz) { s.alloc (sz); }
resethb_sparseset_t81*2d1272b8SAndroid Build Coastguard Worker   void reset () { s.reset (); }
clearhb_sparseset_t82*2d1272b8SAndroid Build Coastguard Worker   void clear () { s.clear (); }
inverthb_sparseset_t83*2d1272b8SAndroid Build Coastguard Worker   void invert () { s.invert (); }
is_invertedhb_sparseset_t84*2d1272b8SAndroid Build Coastguard Worker   bool is_inverted () const { return s.is_inverted (); }
is_emptyhb_sparseset_t85*2d1272b8SAndroid Build Coastguard Worker   bool is_empty () const { return s.is_empty (); }
hashhb_sparseset_t86*2d1272b8SAndroid Build Coastguard Worker   uint32_t hash () const { return s.hash (); }
87*2d1272b8SAndroid Build Coastguard Worker 
addhb_sparseset_t88*2d1272b8SAndroid Build Coastguard Worker   void add (hb_codepoint_t g) { s.add (g); }
add_rangehb_sparseset_t89*2d1272b8SAndroid Build Coastguard Worker   bool add_range (hb_codepoint_t first, hb_codepoint_t last) { return s.add_range (first, last); }
90*2d1272b8SAndroid Build Coastguard Worker 
91*2d1272b8SAndroid Build Coastguard Worker   template <typename T>
add_arrayhb_sparseset_t92*2d1272b8SAndroid Build Coastguard Worker   void add_array (const T *array, unsigned int count, unsigned int stride=sizeof(T))
93*2d1272b8SAndroid Build Coastguard Worker   { s.add_array (array, count, stride); }
94*2d1272b8SAndroid Build Coastguard Worker   template <typename T>
add_arrayhb_sparseset_t95*2d1272b8SAndroid Build Coastguard Worker   void add_array (const hb_array_t<const T>& arr) { add_array (&arr, arr.len ()); }
96*2d1272b8SAndroid Build Coastguard Worker 
97*2d1272b8SAndroid Build Coastguard Worker   /* Might return false if array looks unsorted.
98*2d1272b8SAndroid Build Coastguard Worker    * Used for faster rejection of corrupt data. */
99*2d1272b8SAndroid Build Coastguard Worker   template <typename T>
add_sorted_arrayhb_sparseset_t100*2d1272b8SAndroid Build Coastguard Worker   bool add_sorted_array (const T *array, unsigned int count, unsigned int stride=sizeof(T))
101*2d1272b8SAndroid Build Coastguard Worker   { return s.add_sorted_array (array, count, stride); }
102*2d1272b8SAndroid Build Coastguard Worker   template <typename T>
add_sorted_arrayhb_sparseset_t103*2d1272b8SAndroid Build Coastguard Worker   bool add_sorted_array (const hb_sorted_array_t<const T>& arr) { return add_sorted_array (&arr, arr.len ()); }
104*2d1272b8SAndroid Build Coastguard Worker 
delhb_sparseset_t105*2d1272b8SAndroid Build Coastguard Worker   void del (hb_codepoint_t g) { s.del (g); }
del_rangehb_sparseset_t106*2d1272b8SAndroid Build Coastguard Worker   void del_range (hb_codepoint_t a, hb_codepoint_t b) { s.del_range (a, b); }
107*2d1272b8SAndroid Build Coastguard Worker 
gethb_sparseset_t108*2d1272b8SAndroid Build Coastguard Worker   bool get (hb_codepoint_t g) const { return s.get (g); }
109*2d1272b8SAndroid Build Coastguard Worker 
110*2d1272b8SAndroid Build Coastguard Worker   /* Has interface. */
operator []hb_sparseset_t111*2d1272b8SAndroid Build Coastguard Worker   bool operator [] (hb_codepoint_t k) const { return get (k); }
hashb_sparseset_t112*2d1272b8SAndroid Build Coastguard Worker   bool has (hb_codepoint_t k) const { return (*this)[k]; }
113*2d1272b8SAndroid Build Coastguard Worker 
114*2d1272b8SAndroid Build Coastguard Worker   /* Predicate. */
operator ()hb_sparseset_t115*2d1272b8SAndroid Build Coastguard Worker   bool operator () (hb_codepoint_t k) const { return has (k); }
116*2d1272b8SAndroid Build Coastguard Worker 
117*2d1272b8SAndroid Build Coastguard Worker   /* Sink interface. */
operator <<hb_sparseset_t118*2d1272b8SAndroid Build Coastguard Worker   hb_sparseset_t& operator << (hb_codepoint_t v)
119*2d1272b8SAndroid Build Coastguard Worker   { add (v); return *this; }
operator <<hb_sparseset_t120*2d1272b8SAndroid Build Coastguard Worker   hb_sparseset_t& operator << (const hb_codepoint_pair_t& range)
121*2d1272b8SAndroid Build Coastguard Worker   { add_range (range.first, range.second); return *this; }
122*2d1272b8SAndroid Build Coastguard Worker 
intersectshb_sparseset_t123*2d1272b8SAndroid Build Coastguard Worker   bool intersects (hb_codepoint_t first, hb_codepoint_t last) const
124*2d1272b8SAndroid Build Coastguard Worker   { return s.intersects (first, last); }
125*2d1272b8SAndroid Build Coastguard Worker 
sethb_sparseset_t126*2d1272b8SAndroid Build Coastguard Worker   void set (const hb_sparseset_t &other) { s.set (other.s); }
127*2d1272b8SAndroid Build Coastguard Worker 
is_equalhb_sparseset_t128*2d1272b8SAndroid Build Coastguard Worker   bool is_equal (const hb_sparseset_t &other) const { return s.is_equal (other.s); }
operator ==hb_sparseset_t129*2d1272b8SAndroid Build Coastguard Worker   bool operator == (const hb_set_t &other) const { return is_equal (other); }
operator !=hb_sparseset_t130*2d1272b8SAndroid Build Coastguard Worker   bool operator != (const hb_set_t &other) const { return !is_equal (other); }
131*2d1272b8SAndroid Build Coastguard Worker 
is_subsethb_sparseset_t132*2d1272b8SAndroid Build Coastguard Worker   bool is_subset (const hb_sparseset_t &larger_set) const { return s.is_subset (larger_set.s); }
133*2d1272b8SAndroid Build Coastguard Worker 
union_hb_sparseset_t134*2d1272b8SAndroid Build Coastguard Worker   void union_ (const hb_sparseset_t &other) { s.union_ (other.s); }
intersecthb_sparseset_t135*2d1272b8SAndroid Build Coastguard Worker   void intersect (const hb_sparseset_t &other) { s.intersect (other.s); }
subtracthb_sparseset_t136*2d1272b8SAndroid Build Coastguard Worker   void subtract (const hb_sparseset_t &other) { s.subtract (other.s); }
symmetric_differencehb_sparseset_t137*2d1272b8SAndroid Build Coastguard Worker   void symmetric_difference (const hb_sparseset_t &other) { s.symmetric_difference (other.s); }
138*2d1272b8SAndroid Build Coastguard Worker 
nexthb_sparseset_t139*2d1272b8SAndroid Build Coastguard Worker   bool next (hb_codepoint_t *codepoint) const { return s.next (codepoint); }
previoushb_sparseset_t140*2d1272b8SAndroid Build Coastguard Worker   bool previous (hb_codepoint_t *codepoint) const { return s.previous (codepoint); }
next_rangehb_sparseset_t141*2d1272b8SAndroid Build Coastguard Worker   bool next_range (hb_codepoint_t *first, hb_codepoint_t *last) const
142*2d1272b8SAndroid Build Coastguard Worker   { return s.next_range (first, last); }
previous_rangehb_sparseset_t143*2d1272b8SAndroid Build Coastguard Worker   bool previous_range (hb_codepoint_t *first, hb_codepoint_t *last) const
144*2d1272b8SAndroid Build Coastguard Worker   { return s.previous_range (first, last); }
next_manyhb_sparseset_t145*2d1272b8SAndroid Build Coastguard Worker   unsigned int next_many (hb_codepoint_t codepoint, hb_codepoint_t *out, unsigned int size) const
146*2d1272b8SAndroid Build Coastguard Worker   { return s.next_many (codepoint, out, size); }
147*2d1272b8SAndroid Build Coastguard Worker 
get_populationhb_sparseset_t148*2d1272b8SAndroid Build Coastguard Worker   unsigned int get_population () const { return s.get_population (); }
get_minhb_sparseset_t149*2d1272b8SAndroid Build Coastguard Worker   hb_codepoint_t get_min () const { return s.get_min (); }
get_maxhb_sparseset_t150*2d1272b8SAndroid Build Coastguard Worker   hb_codepoint_t get_max () const { return s.get_max (); }
151*2d1272b8SAndroid Build Coastguard Worker 
152*2d1272b8SAndroid Build Coastguard Worker   static constexpr hb_codepoint_t INVALID = impl_t::INVALID;
153*2d1272b8SAndroid Build Coastguard Worker 
154*2d1272b8SAndroid Build Coastguard Worker   /*
155*2d1272b8SAndroid Build Coastguard Worker    * Iterator implementation.
156*2d1272b8SAndroid Build Coastguard Worker    */
157*2d1272b8SAndroid Build Coastguard Worker   using iter_t = typename impl_t::iter_t;
iterhb_sparseset_t158*2d1272b8SAndroid Build Coastguard Worker   iter_t iter () const { return iter_t (this->s); }
operator iter_thb_sparseset_t159*2d1272b8SAndroid Build Coastguard Worker   operator iter_t () const { return iter (); }
160*2d1272b8SAndroid Build Coastguard Worker };
161*2d1272b8SAndroid Build Coastguard Worker 
162*2d1272b8SAndroid Build Coastguard Worker struct hb_set_t : hb_sparseset_t<hb_bit_set_invertible_t>
163*2d1272b8SAndroid Build Coastguard Worker {
164*2d1272b8SAndroid Build Coastguard Worker   using sparseset = hb_sparseset_t<hb_bit_set_invertible_t>;
165*2d1272b8SAndroid Build Coastguard Worker 
166*2d1272b8SAndroid Build Coastguard Worker   ~hb_set_t () = default;
hb_set_thb_set_t167*2d1272b8SAndroid Build Coastguard Worker   hb_set_t () : sparseset () {};
hb_set_thb_set_t168*2d1272b8SAndroid Build Coastguard Worker   hb_set_t (const hb_set_t &o) : sparseset ((sparseset &) o) {};
hb_set_thb_set_t169*2d1272b8SAndroid Build Coastguard Worker   hb_set_t (hb_set_t&& o)  noexcept : sparseset (std::move ((sparseset &) o)) {}
170*2d1272b8SAndroid Build Coastguard Worker   hb_set_t& operator = (const hb_set_t&) = default;
171*2d1272b8SAndroid Build Coastguard Worker   hb_set_t& operator = (hb_set_t&&) = default;
hb_set_thb_set_t172*2d1272b8SAndroid Build Coastguard Worker   hb_set_t (std::initializer_list<hb_codepoint_t> lst) : sparseset (lst) {}
173*2d1272b8SAndroid Build Coastguard Worker   template <typename Iterable,
174*2d1272b8SAndroid Build Coastguard Worker 	    hb_requires (hb_is_iterable (Iterable))>
hb_set_thb_set_t175*2d1272b8SAndroid Build Coastguard Worker   hb_set_t (const Iterable &o) : sparseset (o) {}
176*2d1272b8SAndroid Build Coastguard Worker 
operator <<hb_set_t177*2d1272b8SAndroid Build Coastguard Worker   hb_set_t& operator << (hb_codepoint_t v)
178*2d1272b8SAndroid Build Coastguard Worker   { sparseset::operator<< (v); return *this; }
operator <<hb_set_t179*2d1272b8SAndroid Build Coastguard Worker   hb_set_t& operator << (const hb_codepoint_pair_t& range)
180*2d1272b8SAndroid Build Coastguard Worker   { sparseset::operator<< (range); return *this; }
181*2d1272b8SAndroid Build Coastguard Worker };
182*2d1272b8SAndroid Build Coastguard Worker 
183*2d1272b8SAndroid Build Coastguard Worker static_assert (hb_set_t::INVALID == HB_SET_VALUE_INVALID, "");
184*2d1272b8SAndroid Build Coastguard Worker 
185*2d1272b8SAndroid Build Coastguard Worker 
186*2d1272b8SAndroid Build Coastguard Worker #endif /* HB_SET_HH */
187