hb-object-private.hh revision ba8d94ce3360bfaf2c530d01f2af69237018a531
1f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod/*
235a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod * Copyright (C) 2007 Chris Wilson
335a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod * Copyright (C) 2009  Red Hat, Inc.
4f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod *
5f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod *  This is part of HarfBuzz, an OpenType Layout engine library.
6f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod *
7f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * Permission is hereby granted, without written agreement and without
8f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * license or royalty fees, to use, copy, modify, and distribute this
9f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * software and its documentation for any purpose, provided that the
10f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * above copyright notice and the following two paragraphs appear in
11f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * all copies of this software.
12f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod *
13f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
14f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
15f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
16f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
17f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * DAMAGE.
18f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod *
19f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
20f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
22f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
23f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
24f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod *
25f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod * Contributor(s):
26f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod *	Chris Wilson <chris@chris-wilson.co.uk>
2735a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod * Red Hat Author(s): Behdad Esfahbod
28f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod */
29f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
30f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#ifndef HB_REFCOUNT_PRIVATE_H
31f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define HB_REFCOUNT_PRIVATE_H
32f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
33f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbodtypedef int hb_atomic_int_t;
34f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
35f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod/* Encapsulate operations on the object's reference count */
36f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbodtypedef struct {
37f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod  hb_atomic_int_t ref_count;
38f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod} hb_reference_count_t;
39f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
40f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod/* XXX add real atomic ops */
41f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define _hb_reference_count_inc(RC) ((RC).ref_count++)
42f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define _hb_reference_count_dec_and_test(RC) ((RC).ref_count-- == 1)
43f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
44f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define HB_REFERENCE_COUNT_INIT(RC, VALUE) ((RC).ref_count = (VALUE))
45f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
46f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define HB_REFERENCE_COUNT_GET_VALUE(RC) ((RC).ref_count+0)
47f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define HB_REFERENCE_COUNT_SET_VALUE(RC, VALUE) ((RC).ref_count = (VALUE), 0)
48f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
49f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define HB_REFERENCE_COUNT_INVALID_VALUE ((hb_atomic_int_t) -1)
50f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define HB_REFERENCE_COUNT_INVALID {HB_REFERENCE_COUNT_INVALID_VALUE}
51f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
52f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define HB_REFERENCE_COUNT_IS_INVALID(RC) (HB_REFERENCE_COUNT_GET_VALUE (RC) == HB_REFERENCE_COUNT_INVALID_VALUE)
53f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
54f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#define HB_REFERENCE_COUNT_HAS_REFERENCE(RC) (HB_REFERENCE_COUNT_GET_VALUE (RC) > 0)
55f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod
5635a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod
57c62b503770325819f249885dfc9d4683a69c9efdBehdad Esfahbod
5835a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod/* Helper macros */
5935a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod
60c62b503770325819f249885dfc9d4683a69c9efdBehdad Esfahbod#define HB_OBJECT_IS_INERT(obj) \
61c62b503770325819f249885dfc9d4683a69c9efdBehdad Esfahbod    ((obj) == NULL || HB_REFERENCE_COUNT_IS_INVALID ((obj)->ref_count))
62c62b503770325819f249885dfc9d4683a69c9efdBehdad Esfahbod
63ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod#define HB_OBJECT_DO_INIT_EXPR(obj) \
64ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod    HB_REFERENCE_COUNT_INIT (obj->ref_count, 1)
65ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod
66ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod#define HB_OBJECT_DO_INIT(obj) \
6735a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod  HB_STMT_START { \
68ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod    HB_OBJECT_DO_INIT_EXPR (obj); \
6935a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod  } HB_STMT_END
7035a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod
71ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod#define HB_OBJECT_DO_CREATE(obj) \
72ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod  HB_LIKELY (( \
73ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod	     (obj) = calloc (1, sizeof (*(obj))), \
74ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod	     HB_OBJECT_DO_INIT_EXPR (obj), \
75ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod	     (obj) \
76ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod	     ))
77ba8d94ce3360bfaf2c530d01f2af69237018a531Behdad Esfahbod
78c62b503770325819f249885dfc9d4683a69c9efdBehdad Esfahbod#define HB_OBJECT_DO_REFERENCE(obj) \
7935a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod  HB_STMT_START { \
80c62b503770325819f249885dfc9d4683a69c9efdBehdad Esfahbod    if (HB_OBJECT_IS_INERT (obj)) \
8135a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod      return obj; \
8235a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod    assert (HB_REFERENCE_COUNT_HAS_REFERENCE (obj->ref_count)); \
8335a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod    _hb_reference_count_inc (obj->ref_count); \
8435a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod    return obj; \
8535a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod  } HB_STMT_END
8635a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod
87c62b503770325819f249885dfc9d4683a69c9efdBehdad Esfahbod#define HB_OBJECT_DO_DESTROY(obj) \
8835a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod  HB_STMT_START { \
89c62b503770325819f249885dfc9d4683a69c9efdBehdad Esfahbod    if (HB_OBJECT_IS_INERT (obj)) \
9035a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod      return; \
9135a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod    assert (HB_REFERENCE_COUNT_HAS_REFERENCE (obj->ref_count)); \
9235a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod    if (!_hb_reference_count_dec_and_test (obj->ref_count)) \
9335a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod      return; \
9435a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod  } HB_STMT_END
9535a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod
9635a7383c6138fd705560f0d4bb30659cbd1ab64cBehdad Esfahbod
97f0954d1e08ae288eda9904e17108fc73f48c0b98Behdad Esfahbod#endif /* HB_REFCOUNT_PRIVATE_H */
98