harfbuzz/src/hb-private.hh

335 lines
9.3 KiB
C++
Raw Normal View History

2008-01-23 22:14:38 +01:00
/*
2011-04-21 23:14:28 +02:00
* Copyright © 2007,2008,2009 Red Hat, Inc.
* Copyright © 2011 Google, Inc.
2008-01-23 22:14:38 +01:00
*
2010-04-22 06:11:43 +02:00
* This is part of HarfBuzz, a text shaping library.
2008-01-23 22:14:38 +01: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.
*
* Red Hat Author(s): Behdad Esfahbod
2011-04-21 23:14:28 +02:00
* Google Author(s): Behdad Esfahbod
2008-01-23 22:14:38 +01:00
*/
#ifndef HB_PRIVATE_HH
#define HB_PRIVATE_HH
2006-12-28 12:42:37 +01:00
2009-08-02 02:46:02 +02:00
#if HAVE_CONFIG_H
#include "config.h"
#endif
2009-05-21 18:46:29 +02:00
2010-04-29 07:40:26 +02:00
#include "hb-common.h"
2009-08-05 04:35:36 +02:00
2009-05-21 18:46:29 +02:00
#include <stdlib.h>
2009-07-30 21:33:57 +02:00
#include <string.h>
#include <assert.h>
2010-04-28 19:18:41 +02:00
/* We only use these two for debug output. However, the debug code is
* always seen by the compiler (and optimized out in non-debug builds.
* If including these becomes a problem, we can start thinking about
* someway around that. */
#include <stdio.h>
#include <errno.h>
2009-05-21 18:46:29 +02:00
2010-07-23 21:11:18 +02:00
HB_BEGIN_DECLS
2010-04-29 07:40:26 +02:00
/* Essentials */
#ifndef NULL
# define NULL ((void *) 0)
#endif
#undef FALSE
#define FALSE 0
#undef TRUE
#define TRUE 1
2009-08-02 02:46:02 +02:00
2009-08-06 18:32:35 +02:00
2009-05-21 18:46:29 +02:00
/* Basics */
HB_END_DECLS
2009-05-21 18:46:29 +02:00
#undef MIN
template <typename Type> static inline Type MIN (const Type &a, const Type &b) { return a < b ? a : b; }
2008-01-24 00:02:28 +01:00
#undef MAX
template <typename Type> static inline Type MAX (const Type &a, const Type &b) { return a > b ? a : b; }
HB_BEGIN_DECLS
2009-11-05 00:15:59 +01:00
#undef ARRAY_LENGTH
#define ARRAY_LENGTH(__array) ((signed int) (sizeof (__array) / sizeof (__array[0])))
2009-08-02 01:30:31 +02:00
#define HB_STMT_START do
#define HB_STMT_END while (0)
2006-12-28 12:42:37 +01:00
2008-01-23 06:20:48 +01:00
#define _ASSERT_STATIC1(_line, _cond) typedef int _static_assert_on_line_##_line##_failed[(_cond)?1:-1]
#define _ASSERT_STATIC0(_line, _cond) _ASSERT_STATIC1 (_line, (_cond))
#define ASSERT_STATIC(_cond) _ASSERT_STATIC0 (__LINE__, (_cond))
#define ASSERT_STATIC_EXPR(_cond) ((void) sizeof (char[(_cond) ? 1 : -1]))
2010-04-29 07:40:26 +02:00
2011-04-11 17:47:14 +02:00
/* Lets assert int types. Saves trouble down the road. */
ASSERT_STATIC (sizeof (int8_t) == 1);
ASSERT_STATIC (sizeof (uint8_t) == 1);
ASSERT_STATIC (sizeof (int16_t) == 2);
ASSERT_STATIC (sizeof (uint16_t) == 2);
ASSERT_STATIC (sizeof (int32_t) == 4);
ASSERT_STATIC (sizeof (uint32_t) == 4);
ASSERT_STATIC (sizeof (int64_t) == 8);
ASSERT_STATIC (sizeof (uint64_t) == 8);
2011-04-11 18:29:31 +02:00
ASSERT_STATIC (sizeof (hb_codepoint_t) == 4);
ASSERT_STATIC (sizeof (hb_position_t) == 4);
ASSERT_STATIC (sizeof (hb_mask_t) == 4);
ASSERT_STATIC (sizeof (hb_var_int_t) == 4);
2011-04-11 17:47:14 +02:00
2010-04-29 07:40:26 +02:00
/* Misc */
2009-05-21 18:46:29 +02:00
2009-08-02 02:46:02 +02:00
#if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
#define _HB_BOOLEAN_EXPR(expr) ((expr) ? 1 : 0)
#define likely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 1))
#define unlikely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 0))
2009-08-02 02:46:02 +02:00
#else
#define likely(expr) (expr)
#define unlikely(expr) (expr)
2009-08-02 02:46:02 +02:00
#endif
#ifndef __GNUC__
#undef __attribute__
#define __attribute__(x)
#endif
#if __GNUC__ >= 3
2010-04-29 19:56:44 +02:00
#define HB_PURE_FUNC __attribute__((pure))
#define HB_CONST_FUNC __attribute__((const))
2009-08-02 02:46:02 +02:00
#else
2010-04-29 19:56:44 +02:00
#define HB_PURE_FUNC
#define HB_CONST_FUNC
2009-08-02 02:46:02 +02:00
#endif
#if __GNUC__ >= 4
2010-04-29 19:56:44 +02:00
#define HB_UNUSED __attribute__((unused))
#else
2010-04-29 19:56:44 +02:00
#define HB_UNUSED
#endif
2009-08-02 02:46:02 +02:00
2010-05-13 05:22:55 +02:00
#ifndef HB_INTERNAL
# define HB_INTERNAL __attribute__((__visibility__("hidden")))
2010-05-13 05:22:55 +02:00
#endif
2009-08-02 02:46:02 +02:00
#if (defined(__WIN32__) && !defined(__WINE__)) || defined(_MSC_VER)
#define snprintf _snprintf
#endif
#ifdef _MSC_VER
#undef inline
#define inline __inline
#endif
#ifdef __STRICT_ANSI__
#undef inline
#define inline __inline__
#endif
#if __GNUC__ >= 3
#define HB_FUNC __PRETTY_FUNCTION__
#elif defined(_MSC_VER)
#define HB_FUNC __FUNCSIG__
#else
#define HB_FUNC __func__
#endif
2010-05-20 16:31:12 +02:00
/* Return the number of 1 bits in mask. */
2010-05-11 06:11:36 +02:00
static inline HB_CONST_FUNC unsigned int
2009-05-21 18:46:29 +02:00
_hb_popcount32 (uint32_t mask)
{
#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
2010-05-20 16:31:12 +02:00
return __builtin_popcount (mask);
2009-05-21 18:46:29 +02:00
#else
2010-05-20 16:31:12 +02:00
/* "HACKMEM 169" */
register uint32_t y;
y = (mask >> 1) &033333333333;
y = mask - y - ((y >>1) & 033333333333);
return (((y + (y >> 3)) & 030707070707) % 077);
2009-05-21 18:46:29 +02:00
#endif
}
2010-05-20 16:31:12 +02:00
/* Returns the number of bits needed to store number */
static inline HB_CONST_FUNC unsigned int
_hb_bit_storage (unsigned int number)
{
#if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
return likely (number) ? (sizeof (unsigned int) * 8 - __builtin_clz (number)) : 0;
2010-05-20 16:31:12 +02:00
#else
register unsigned int n_bits = 0;
while (number) {
n_bits++;
number >>= 1;
}
return n_bits;
#endif
}
2009-08-02 02:46:02 +02:00
/* Returns the number of zero bits in the least significant side of number */
static inline HB_CONST_FUNC unsigned int
_hb_ctz (unsigned int number)
{
#if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
return likely (number) ? __builtin_ctz (number) : 0;
#else
register unsigned int n_bits = 0;
if (unlikely (!number)) return 0;
while (!(number & 1)) {
n_bits++;
number >>= 1;
}
return n_bits;
#endif
}
2010-10-09 01:43:48 +02:00
/* Type of bsearch() / qsort() compare function */
typedef int (*hb_compare_func_t) (const void *, const void *);
2010-04-21 08:12:45 +02:00
/* We need external help for these */
#ifdef HAVE_GLIB
#include <glib.h>
2011-04-21 22:16:21 +02:00
typedef volatile int hb_atomic_int_t;
2010-04-21 08:12:45 +02:00
#define hb_atomic_int_fetch_and_add(AI, V) g_atomic_int_exchange_and_add (&(AI), V)
#define hb_atomic_int_get(AI) g_atomic_int_get (&(AI))
#define hb_atomic_int_set(AI, V) g_atomic_int_set (&(AI), V)
typedef GStaticMutex hb_mutex_t;
#define HB_MUTEX_INIT G_STATIC_MUTEX_INIT
#define hb_mutex_init(M) g_static_mutex_init (&M)
#define hb_mutex_lock(M) g_static_mutex_lock (&M)
#define hb_mutex_trylock(M) g_static_mutex_trylock (&M)
#define hb_mutex_unlock(M) g_static_mutex_unlock (&M)
#else
#ifdef _MSC_VER
#define _HB__STR2__(x) #x
#define _HB__STR1__(x) _HB__STR2__(x)
#define _HB__LOC__ __FILE__ "("_HB__STR1__(__LINE__)") : Warning Msg: "
#pragma message(_HB__LOC__"Could not find any system to define platform macros, library will NOT be thread-safe")
2010-04-21 08:12:45 +02:00
#else
#warning "Could not find any system to define platform macros, library will NOT be thread-safe"
#endif
2011-04-21 22:16:21 +02:00
typedef volatile int hb_atomic_int_t;
2010-04-21 08:12:45 +02:00
#define hb_atomic_int_fetch_and_add(AI, V) ((AI) += (V), (AI) - (V))
#define hb_atomic_int_get(AI) (AI)
2010-04-21 08:13:55 +02:00
#define hb_atomic_int_set(AI, V) HB_STMT_START { (AI) = (V); } HB_STMT_END
2010-04-21 08:12:45 +02:00
2011-04-21 22:16:21 +02:00
typedef volatile int hb_mutex_t;
2010-04-21 08:13:55 +02:00
#define HB_MUTEX_INIT 0
#define hb_mutex_init(M) HB_STMT_START { (M) = 0; } HB_STMT_END
#define hb_mutex_lock(M) HB_STMT_START { (M) = 1; } HB_STMT_END
#define hb_mutex_trylock(M) ((M) = 1, 1)
#define hb_mutex_unlock(M) HB_STMT_START { (M) = 0; } HB_STMT_END
2010-04-21 08:12:45 +02:00
#endif
/* A reference count */
typedef struct {
hb_atomic_int_t ref_count;
#define HB_REFERENCE_COUNT_INVALID_VALUE ((hb_atomic_int_t) -1)
#define HB_REFERENCE_COUNT_INVALID {HB_REFERENCE_COUNT_INVALID_VALUE}
inline void init (int v) { ref_count = v; /* non-atomic is fine */ }
inline int inc (void) { return hb_atomic_int_fetch_and_add (ref_count, 1); }
inline int dec (void) { return hb_atomic_int_fetch_and_add (ref_count, -1); }
inline void set (int v) { hb_atomic_int_set (ref_count, v); }
inline int get (void) const { return hb_atomic_int_get (ref_count); }
inline bool is_invalid (void) const { return get () == HB_REFERENCE_COUNT_INVALID_VALUE; }
} hb_reference_count_t;
2010-04-21 08:12:45 +02:00
/* Big-endian handling */
static inline uint16_t hb_be_uint16 (const uint16_t v)
{
const uint8_t *V = (const uint8_t *) &v;
return (uint16_t) (V[0] << 8) + V[1];
}
2010-04-21 08:14:44 +02:00
2010-04-21 09:11:46 +02:00
#define hb_be_uint16_put(v,V) HB_STMT_START { v[0] = (V>>8); v[1] = (V); } HB_STMT_END
2010-04-21 08:14:44 +02:00
#define hb_be_uint16_get(v) (uint16_t) ((v[0] << 8) + v[1])
#define hb_be_uint16_eq(a,b) (a[0] == b[0] && a[1] == b[1])
2010-04-21 08:14:44 +02:00
2010-04-21 09:11:46 +02:00
#define hb_be_uint32_put(v,V) HB_STMT_START { v[0] = (V>>24); v[1] = (V>>16); v[2] = (V>>8); v[3] = (V); } HB_STMT_END
2010-04-21 08:14:44 +02:00
#define hb_be_uint32_get(v) (uint32_t) ((v[0] << 24) + (v[1] << 16) + (v[2] << 8) + v[3])
#define hb_be_uint32_eq(a,b) (a[0] == b[0] && a[1] == b[1] && a[2] == b[2] && a[3] == b[3])
2010-04-21 08:12:45 +02:00
/* ASCII tag/character handling */
2011-04-11 19:16:08 +02:00
static inline unsigned char ISALPHA (unsigned char c)
{ return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'); }
static inline unsigned char ISALNUM (unsigned char c)
{ return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9'); }
static inline unsigned char TOUPPER (unsigned char c)
{ return (c >= 'a' && c <= 'z') ? c - 'a' + 'A' : c; }
static inline unsigned char TOLOWER (unsigned char c)
{ return (c >= 'A' && c <= 'Z') ? c - 'A' + 'a' : c; }
2011-04-11 19:16:08 +02:00
#define HB_TAG_CHAR4(s) (HB_TAG(((const char *) s)[0], \
((const char *) s)[1], \
((const char *) s)[2], \
((const char *) s)[3]))
2011-04-11 19:16:08 +02:00
2010-04-29 07:40:26 +02:00
/* Debug */
#ifndef HB_DEBUG
#define HB_DEBUG 0
#endif
static inline bool /* always returns TRUE */
2010-04-29 07:40:26 +02:00
_hb_trace (const char *what,
const char *function,
const void *obj,
unsigned int depth,
unsigned int max_depth)
{
(void) ((depth < max_depth) && fprintf (stderr, "%s(%p) %-*d-> %s\n", what, obj, depth, depth, function));
2010-04-29 07:40:26 +02:00
return TRUE;
}
2010-04-21 08:12:45 +02:00
2010-07-23 21:11:18 +02:00
HB_END_DECLS
#endif /* HB_PRIVATE_HH */