harfbuzz/src/hb-object-private.hh

228 lines
6.0 KiB
C++
Raw Normal View History

2009-07-30 21:33:57 +02:00
/*
2011-04-21 23:14:28 +02:00
* Copyright © 2007 Chris Wilson
* Copyright © 2009,2010 Red Hat, Inc.
* Copyright © 2011,2012 Google, Inc.
2009-07-30 21:33:57 +02:00
*
2010-04-22 06:11:43 +02:00
* This is part of HarfBuzz, a text shaping library.
2009-07-30 21:33:57 +02:00
*
* Permission is hereby granted, without written agreement and without
* license or royalty fees, to use, copy, modify, and distribute this
* software and its documentation for any purpose, provided that the
* above copyright notice and the following two paragraphs appear in
* all copies of this software.
*
* IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
* DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
* IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
* THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
* ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
* PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
*
* Contributor(s):
* Chris Wilson <chris@chris-wilson.co.uk>
2009-08-02 01:30:31 +02:00
* Red Hat Author(s): Behdad Esfahbod
2011-04-21 23:14:28 +02:00
* Google Author(s): Behdad Esfahbod
2009-07-30 21:33:57 +02:00
*/
#ifndef HB_OBJECT_PRIVATE_HH
#define HB_OBJECT_PRIVATE_HH
2009-07-30 21:33:57 +02:00
#include "hb-private.hh"
2012-05-18 02:30:46 +02:00
#include "hb-atomic-private.hh"
#include "hb-mutex-private.hh"
2009-11-06 01:37:58 +01:00
/* Debug */
#ifndef HB_DEBUG_OBJECT
#define HB_DEBUG_OBJECT (HB_DEBUG+0)
#endif
2011-04-28 03:45:51 +02:00
/* reference_count */
#define HB_REFERENCE_COUNT_INVALID_VALUE ((hb_atomic_int_t) -1)
#define HB_REFERENCE_COUNT_INVALID {HB_REFERENCE_COUNT_INVALID_VALUE}
2012-06-03 21:52:51 +02:00
struct hb_reference_count_t
{
hb_atomic_int_t ref_count;
inline void init (int v) { ref_count = v; }
inline int inc (void) { return hb_atomic_int_add (const_cast<hb_atomic_int_t &> (ref_count), 1); }
inline int dec (void) { return hb_atomic_int_add (const_cast<hb_atomic_int_t &> (ref_count), -1); }
inline void finish (void) { ref_count = HB_REFERENCE_COUNT_INVALID_VALUE; }
inline bool is_invalid (void) const { return ref_count == HB_REFERENCE_COUNT_INVALID_VALUE; }
2012-06-03 21:52:51 +02:00
};
2011-04-28 03:45:51 +02:00
/* user_data */
#define HB_USER_DATA_ARRAY_INIT {HB_MUTEX_INIT, HB_LOCKABLE_SET_INIT}
2012-06-03 21:52:51 +02:00
struct hb_user_data_array_t
{
/* TODO Add tracing. */
2011-05-05 20:47:53 +02:00
struct hb_user_data_item_t {
hb_user_data_key_t *key;
void *data;
hb_destroy_func_t destroy;
2011-05-05 20:47:53 +02:00
inline bool operator == (hb_user_data_key_t *other_key) const { return key == other_key; }
inline bool operator == (hb_user_data_item_t &other) const { return key == other.key; }
2011-05-05 20:47:53 +02:00
void finish (void) { if (destroy) destroy (data); }
};
hb_mutex_t lock;
hb_lockable_set_t<hb_user_data_item_t, hb_mutex_t> items;
inline void init (void) { lock.init (); items.init (); }
2011-05-05 21:28:37 +02:00
HB_INTERNAL bool set (hb_user_data_key_t *key,
void * data,
hb_destroy_func_t destroy,
hb_bool_t replace);
HB_INTERNAL void *get (hb_user_data_key_t *key);
inline void finish (void) { items.finish (lock); lock.finish (); }
};
2011-04-28 03:45:51 +02:00
/* object_header */
2012-06-03 21:52:51 +02:00
struct hb_object_header_t
{
hb_reference_count_t ref_count;
hb_user_data_array_t user_data;
#define HB_OBJECT_HEADER_STATIC {HB_REFERENCE_COUNT_INVALID, HB_USER_DATA_ARRAY_INIT}
static inline void *create (unsigned int size) {
hb_object_header_t *obj = (hb_object_header_t *) calloc (1, size);
2009-08-02 01:30:31 +02:00
if (likely (obj))
obj->init ();
return obj;
}
2009-08-02 02:29:22 +02:00
inline void init (void) {
ref_count.init (1);
user_data.init ();
}
inline bool is_inert (void) const {
return unlikely (ref_count.is_invalid ());
}
inline void reference (void) {
if (unlikely (!this || this->is_inert ()))
return;
ref_count.inc ();
}
inline bool destroy (void) {
if (unlikely (!this || this->is_inert ()))
return false;
if (ref_count.dec () != 1)
return false;
ref_count.finish (); /* Do this before user_data */
user_data.finish ();
return true;
}
inline bool set_user_data (hb_user_data_key_t *key,
void * data,
hb_destroy_func_t destroy_func,
hb_bool_t replace) {
if (unlikely (!this || this->is_inert ()))
return false;
return user_data.set (key, data, destroy_func, replace);
}
inline void *get_user_data (hb_user_data_key_t *key) {
if (unlikely (!this || this->is_inert ()))
return NULL;
return user_data.get (key);
}
inline void trace (const char *function) const {
2012-05-11 03:35:08 +02:00
if (unlikely (!this)) return;
2012-06-09 02:35:18 +02:00
/* TODO We cannot use DEBUG_MSG_FUNC here since that one currently only
2012-05-18 02:30:46 +02:00
* prints the class name and throws away the template info. */
DEBUG_MSG (OBJECT, (void *) this,
2012-05-11 03:40:58 +02:00
"%s refcount=%d",
function,
this ? ref_count.ref_count : 0);
}
2012-06-06 09:30:09 +02:00
private:
ASSERT_POD ();
};
2011-04-28 03:45:51 +02:00
/* object */
2011-04-22 00:35:58 +02:00
template <typename Type>
2011-04-27 22:12:12 +02:00
static inline void hb_object_trace (const Type *obj, const char *function)
{
obj->header.trace (function);
}
2011-04-22 00:35:58 +02:00
template <typename Type>
static inline Type *hb_object_create (void)
2011-04-27 22:12:12 +02:00
{
Type *obj = (Type *) hb_object_header_t::create (sizeof (Type));
hb_object_trace (obj, HB_FUNC);
return obj;
}
2011-04-22 00:35:58 +02:00
template <typename Type>
2011-04-27 22:12:12 +02:00
static inline bool hb_object_is_inert (const Type *obj)
{
return unlikely (obj->header.is_inert ());
2011-04-27 22:12:12 +02:00
}
2011-04-22 00:35:58 +02:00
template <typename Type>
2011-04-27 22:12:12 +02:00
static inline Type *hb_object_reference (Type *obj)
{
hb_object_trace (obj, HB_FUNC);
obj->header.reference ();
return obj;
}
2011-04-22 00:35:58 +02:00
template <typename Type>
2011-04-27 22:12:12 +02:00
static inline bool hb_object_destroy (Type *obj)
{
hb_object_trace (obj, HB_FUNC);
return obj->header.destroy ();
}
2011-04-28 03:45:51 +02:00
template <typename Type>
static inline bool hb_object_set_user_data (Type *obj,
hb_user_data_key_t *key,
void * data,
hb_destroy_func_t destroy,
hb_bool_t replace)
2011-04-28 03:45:51 +02:00
{
return obj->header.set_user_data (key, data, destroy, replace);
2011-04-28 03:45:51 +02:00
}
template <typename Type>
static inline void *hb_object_get_user_data (Type *obj,
hb_user_data_key_t *key)
{
return obj->header.get_user_data (key);
}
2011-04-27 22:12:12 +02:00
2011-04-22 00:35:58 +02:00
#endif /* HB_OBJECT_PRIVATE_HH */