hb-object-private.hh revision 0e253e97af71e2a7ead153589f61fd579a247502
16f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/* 26f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Copyright © 2007 Chris Wilson 36f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Copyright © 2009,2010 Red Hat, Inc. 46f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Copyright © 2011 Google, Inc. 56f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 66f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is part of HarfBuzz, a text shaping library. 76f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 86f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Permission is hereby granted, without written agreement and without 96f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * license or royalty fees, to use, copy, modify, and distribute this 106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * software and its documentation for any purpose, provided that the 116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * above copyright notice and the following two paragraphs appear in 126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * all copies of this software. 136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR 156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES 166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN 176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * DAMAGE. 196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, 216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS 236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO 246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Contributor(s): 276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Chris Wilson <chris@chris-wilson.co.uk> 286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Red Hat Author(s): Behdad Esfahbod 296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Google Author(s): Behdad Esfahbod 306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#ifndef HB_OBJECT_PRIVATE_HH 336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define HB_OBJECT_PRIVATE_HH 346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "hb-private.hh" 366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "hb-atomic-private.hh" 386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "hb-mutex-private.hh" 396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/* Debug */ 426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#ifndef HB_DEBUG_OBJECT 446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define HB_DEBUG_OBJECT (HB_DEBUG+0) 456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif 466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/* reference_count */ 496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define HB_REFERENCE_COUNT_INVALID_VALUE ((hb_atomic_int_t) -1) 516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define HB_REFERENCE_COUNT_INVALID {HB_REFERENCE_COUNT_INVALID_VALUE} 526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgstruct hb_reference_count_t 536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org{ 546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_atomic_int_t ref_count; 556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline void init (int v) { ref_count = v; } 576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline int inc (void) { return hb_atomic_int_add (const_cast<hb_atomic_int_t &> (ref_count), 1); } 586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline int dec (void) { return hb_atomic_int_add (const_cast<hb_atomic_int_t &> (ref_count), -1); } 596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline void finish (void) { ref_count = HB_REFERENCE_COUNT_INVALID_VALUE; } 606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline bool is_invalid (void) const { return ref_count == HB_REFERENCE_COUNT_INVALID_VALUE; } 626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org}; 646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/* user_data */ 676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define HB_USER_DATA_ARRAY_INIT {HB_LOCKABLE_SET_INIT} 696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgstruct hb_user_data_array_t 706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org{ 716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org struct hb_user_data_item_t { 726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_user_data_key_t *key; 736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org void *data; 746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_destroy_func_t destroy; 756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline bool operator == (hb_user_data_key_t *other_key) const { return key == other_key; } 776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline bool operator == (hb_user_data_item_t &other) const { return key == other.key; } 786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org void finish (void) { if (destroy) destroy (data); } 806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org }; 816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_lockable_set_t<hb_user_data_item_t, hb_mutex_t> items; 836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline void init (void) { items.init (); } 856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org HB_INTERNAL bool set (hb_user_data_key_t *key, 876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org void * data, 886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_destroy_func_t destroy, 896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_bool_t replace, 906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_mutex_t &lock); 916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org HB_INTERNAL void *get (hb_user_data_key_t *key, 936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_mutex_t &lock); 946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org HB_INTERNAL void finish (hb_mutex_t &lock); 966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org}; 976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/* object_header */ 1006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgstruct hb_object_header_t 1026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org{ 1036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_reference_count_t ref_count; 1046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_mutex_t lock; 1056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_user_data_array_t user_data; 1066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define HB_OBJECT_HEADER_STATIC {HB_REFERENCE_COUNT_INVALID, HB_MUTEX_INIT, HB_USER_DATA_ARRAY_INIT} 1086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static inline void *create (unsigned int size) { 1106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org hb_object_header_t *obj = (hb_object_header_t *) calloc (1, size); 1116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org if (likely (obj)) 1136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org obj->init (); 1146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org return obj; 1166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org } 1176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline void init (void) { 1196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org ref_count.init (1); 1206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org lock.init (); 1216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org user_data.init (); 1226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org } 1236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline bool is_inert (void) const { 1256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org return unlikely (ref_count.is_invalid ()); 1266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org } 1276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline void reference (void) { 1296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org if (unlikely (!this || this->is_inert ())) 1306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org return; 1316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org ref_count.inc (); 1326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org } 1336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org inline bool destroy (void) { 1356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org if (unlikely (!this || this->is_inert ())) 1366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org return false; 137 if (ref_count.dec () != 1) 138 return false; 139 140 ref_count.finish (); /* Do this before user_data */ 141 user_data.finish (lock); 142 lock.finish (); 143 144 return true; 145 } 146 147 inline bool set_user_data (hb_user_data_key_t *key, 148 void * data, 149 hb_destroy_func_t destroy_func, 150 hb_bool_t replace) { 151 if (unlikely (!this || this->is_inert ())) 152 return false; 153 154 return user_data.set (key, data, destroy_func, replace, lock); 155 } 156 157 inline void *get_user_data (hb_user_data_key_t *key) { 158 if (unlikely (!this || this->is_inert ())) 159 return NULL; 160 161 return user_data.get (key, lock); 162 } 163 164 inline void trace (const char *function) const { 165 if (unlikely (!this)) return; 166 /* XXX We cannot use DEBUG_MSG_FUNC here since that one currecntly only 167 * prints the class name and throws away the template info. */ 168 DEBUG_MSG (OBJECT, (void *) this, 169 "%s refcount=%d", 170 function, 171 this ? ref_count.ref_count : 0); 172 } 173 174}; 175 176 177/* object */ 178 179template <typename Type> 180static inline void hb_object_trace (const Type *obj, const char *function) 181{ 182 obj->header.trace (function); 183} 184template <typename Type> 185static inline Type *hb_object_create (void) 186{ 187 Type *obj = (Type *) hb_object_header_t::create (sizeof (Type)); 188 hb_object_trace (obj, HB_FUNC); 189 return obj; 190} 191template <typename Type> 192static inline bool hb_object_is_inert (const Type *obj) 193{ 194 return unlikely (obj->header.is_inert ()); 195} 196template <typename Type> 197static inline Type *hb_object_reference (Type *obj) 198{ 199 hb_object_trace (obj, HB_FUNC); 200 obj->header.reference (); 201 return obj; 202} 203template <typename Type> 204static inline bool hb_object_destroy (Type *obj) 205{ 206 hb_object_trace (obj, HB_FUNC); 207 return obj->header.destroy (); 208} 209template <typename Type> 210static inline bool hb_object_set_user_data (Type *obj, 211 hb_user_data_key_t *key, 212 void * data, 213 hb_destroy_func_t destroy, 214 hb_bool_t replace) 215{ 216 return obj->header.set_user_data (key, data, destroy, replace); 217} 218 219template <typename Type> 220static inline void *hb_object_get_user_data (Type *obj, 221 hb_user_data_key_t *key) 222{ 223 return obj->header.get_user_data (key); 224} 225 226 227#endif /* HB_OBJECT_PRIVATE_HH */ 228