2 * Copyright © 2007 Chris Wilson
3 * Copyright © 2009,2010 Red Hat, Inc.
4 * Copyright © 2011,2012 Google, Inc.
6 * This is part of HarfBuzz, a text shaping library.
8 * Permission is hereby granted, without written agreement and without
9 * license or royalty fees, to use, copy, modify, and distribute this
10 * software and its documentation for any purpose, provided that the
11 * above copyright notice and the following two paragraphs appear in
12 * all copies of this software.
14 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
15 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
16 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
17 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
20 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
21 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
22 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
23 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
24 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
27 * Chris Wilson <chris@chris-wilson.co.uk>
28 * Red Hat Author(s): Behdad Esfahbod
29 * Google Author(s): Behdad Esfahbod
32 #ifndef HB_OBJECT_PRIVATE_HH
33 #define HB_OBJECT_PRIVATE_HH
35 #include "hb-private.hh"
37 #include "hb-atomic-private.hh"
38 #include "hb-mutex-private.hh"
43 #ifndef HB_DEBUG_OBJECT
44 #define HB_DEBUG_OBJECT (HB_DEBUG+0)
50 #define HB_REFERENCE_COUNT_INVALID_VALUE ((hb_atomic_int_t) -1)
51 #define HB_REFERENCE_COUNT_INVALID {HB_REFERENCE_COUNT_INVALID_VALUE}
52 struct hb_reference_count_t
54 hb_atomic_int_t ref_count;
56 inline void init (int v) { ref_count = v; }
57 inline int inc (void) { return hb_atomic_int_add (const_cast<hb_atomic_int_t &> (ref_count), 1); }
58 inline int dec (void) { return hb_atomic_int_add (const_cast<hb_atomic_int_t &> (ref_count), -1); }
59 inline void finish (void) { ref_count = HB_REFERENCE_COUNT_INVALID_VALUE; }
61 inline bool is_invalid (void) const { return ref_count == HB_REFERENCE_COUNT_INVALID_VALUE; }
68 #define HB_USER_DATA_ARRAY_INIT {HB_LOCKABLE_SET_INIT}
69 struct hb_user_data_array_t
71 /* TODO Add tracing. */
73 struct hb_user_data_item_t {
74 hb_user_data_key_t *key;
76 hb_destroy_func_t destroy;
78 inline bool operator == (hb_user_data_key_t *other_key) const { return key == other_key; }
79 inline bool operator == (hb_user_data_item_t &other) const { return key == other.key; }
81 void finish (void) { if (destroy) destroy (data); }
84 hb_lockable_set_t<hb_user_data_item_t, hb_mutex_t> items;
86 inline void init (void) { items.init (); }
88 HB_INTERNAL bool set (hb_user_data_key_t *key,
90 hb_destroy_func_t destroy,
94 HB_INTERNAL void *get (hb_user_data_key_t *key,
97 HB_INTERNAL void finish (hb_mutex_t &lock);
103 struct hb_object_header_t
105 hb_reference_count_t ref_count;
107 hb_user_data_array_t user_data;
109 #define HB_OBJECT_HEADER_STATIC {HB_REFERENCE_COUNT_INVALID, HB_MUTEX_INIT, HB_USER_DATA_ARRAY_INIT}
111 static inline void *create (unsigned int size) {
112 hb_object_header_t *obj = (hb_object_header_t *) calloc (1, size);
120 inline void init (void) {
126 inline bool is_inert (void) const {
127 return unlikely (ref_count.is_invalid ());
130 inline void reference (void) {
131 if (unlikely (!this || this->is_inert ()))
136 inline bool destroy (void) {
137 if (unlikely (!this || this->is_inert ()))
139 if (ref_count.dec () != 1)
142 ref_count.finish (); /* Do this before user_data */
143 user_data.finish (lock);
149 inline bool set_user_data (hb_user_data_key_t *key,
151 hb_destroy_func_t destroy_func,
153 if (unlikely (!this || this->is_inert ()))
156 return user_data.set (key, data, destroy_func, replace, lock);
159 inline void *get_user_data (hb_user_data_key_t *key) {
160 if (unlikely (!this || this->is_inert ()))
163 return user_data.get (key, lock);
166 inline void trace (const char *function) const {
167 if (unlikely (!this)) return;
168 /* XXX We cannot use DEBUG_MSG_FUNC here since that one currecntly only
169 * prints the class name and throws away the template info. */
170 DEBUG_MSG (OBJECT, (void *) this,
173 this ? ref_count.ref_count : 0);
183 template <typename Type>
184 static inline void hb_object_trace (const Type *obj, const char *function)
186 obj->header.trace (function);
188 template <typename Type>
189 static inline Type *hb_object_create (void)
191 Type *obj = (Type *) hb_object_header_t::create (sizeof (Type));
192 hb_object_trace (obj, HB_FUNC);
195 template <typename Type>
196 static inline bool hb_object_is_inert (const Type *obj)
198 return unlikely (obj->header.is_inert ());
200 template <typename Type>
201 static inline Type *hb_object_reference (Type *obj)
203 hb_object_trace (obj, HB_FUNC);
204 obj->header.reference ();
207 template <typename Type>
208 static inline bool hb_object_destroy (Type *obj)
210 hb_object_trace (obj, HB_FUNC);
211 return obj->header.destroy ();
213 template <typename Type>
214 static inline bool hb_object_set_user_data (Type *obj,
215 hb_user_data_key_t *key,
217 hb_destroy_func_t destroy,
220 return obj->header.set_user_data (key, data, destroy, replace);
223 template <typename Type>
224 static inline void *hb_object_get_user_data (Type *obj,
225 hb_user_data_key_t *key)
227 return obj->header.get_user_data (key);
231 #endif /* HB_OBJECT_PRIVATE_HH */