src/hb-private.h

   1 /*
   2  * Copyright (C) 2007,2008,2009  Red Hat, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Red Hat Author(s): Behdad Esfahbod
  25  */
  26
  27 #ifndef HB_PRIVATE_H
  28 #define HB_PRIVATE_H
  29
  30 #if HAVE_CONFIG_H
  31 #include "config.h"
  32 #endif
  33
  34 #include "hb-common.h"
  35
  36 #include <stdlib.h>
  37 #include <string.h>
  38 #include <assert.h>
  39
  40 /* We only use these two for debug output.  However, the debug code is
  41  * always seen by the compiler (and optimized out in non-debug builds.
  42  * If including these becomes a problem, we can start thinking about
  43  * someway around that. */
  44 #include <stdio.h>
  45 #include <errno.h>
  46
  47
  48 /* Essentials */
  49
  50 #ifndef NULL
  51 # define NULL ((void *) 0)
  52 #endif
  53
  54 #undef FALSE
  55 #define FALSE 0
  56
  57 #undef TRUE
  58 #define TRUE 1
  59
  60
  61 /* Basics */
  62
  63 #undef MIN
  64 #define MIN(a,b) ((a) < (b) ? (a) : (b))
  65
  66 #undef MAX
  67 #define MAX(a,b) ((a) > (b) ? (a) : (b))
  68
  69 #ifndef HB_INTERNAL
  70 # define HB_INTERNAL extern
  71 #endif
  72
  73 #undef  ARRAY_LENGTH
  74 #define ARRAY_LENGTH(__array) ((signed int) (sizeof (__array) / sizeof (__array[0])))
  75
  76 #define HB_STMT_START do
  77 #define HB_STMT_END   while (0)
  78
  79 #define _ASSERT_STATIC1(_line, _cond) typedef int _static_assert_on_line_##_line##_failed[(_cond)?1:-1]
  80 #define _ASSERT_STATIC0(_line, _cond) _ASSERT_STATIC1 (_line, (_cond))
  81 #define ASSERT_STATIC(_cond) _ASSERT_STATIC0 (__LINE__, (_cond))
  82
  83
  84 /* Misc */
  85
  86 #define ASSERT_SIZE(_type, _size) ASSERT_STATIC (sizeof (_type) == (_size))
  87
  88 /* Size signifying variable-sized array */
  89 #define VAR 1
  90
  91 #define VAR0 (VAR+0)
  92 #define ASSERT_SIZE_VAR(_type, _size, _var_type) \
  93         ASSERT_STATIC (sizeof (_type) == (_size) + VAR0 * sizeof (_var_type))
  94 #define ASSERT_SIZE_VAR2(_type, _size, _var_type1, _var_type2) \
  95         ASSERT_STATIC (sizeof (_type) == (_size) + VAR0 * sizeof (_var_type1) + VAR0 * sizeof (_var_type2))
  96
  97 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
  98 #define _HB_BOOLEAN_EXPR(expr) \
  99   __extension__ ({ \
 100      int _hb_boolean_var_; \
 101      if (expr) \
 102         _hb_boolean_var_ = 1; \
 103      else \
 104         _hb_boolean_var_ = 0; \
 105      _hb_boolean_var_; \
 106   })
 107 #define likely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 1))
 108 #define unlikely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 0))
 109 #else
 110 #define likely(expr) (expr)
 111 #define unlikely(expr) (expr)
 112 #endif
 113
 114 #ifndef __GNUC__
 115 #undef __attribute__
 116 #define __attribute__(x)
 117 #endif
 118
 119 #if __GNUC__ >= 3
 120 #define HB_PURE_FUNC    __attribute__((pure))
 121 #define HB_CONST_FUNC   __attribute__((const))
 122 #else
 123 #define HB_PURE_FUNC
 124 #define HB_CONST_FUNC
 125 #endif
 126 #if __GNUC__ >= 4
 127 #define HB_UNUSED       __attribute__((unused))
 128 #else
 129 #define HB_UNUSED
 130 #endif
 131
 132
 133 #if (defined(__WIN32__) && !defined(__WINE__)) || defined(_MSC_VER)
 134 #define snprintf _snprintf
 135 #endif
 136
 137 #ifdef _MSC_VER
 138 #undef inline
 139 #define inline __inline
 140 #endif
 141
 142 #ifdef __STRICT_ANSI__
 143 #undef inline
 144 #define inline __inline__
 145 #endif
 146
 147
 148 #if __GNUC__ >= 3
 149 #define HB_FUNC __PRETTY_FUNCTION__
 150 #elif defined(_MSC_VER)
 151 #define HB_FUNC __FUNCSIG__
 152 #else
 153 #define HB_FUNC __func__
 154 #endif
 155
 156
 157 /* Return the number of 1 bits in mask.
 158  *
 159  * GCC 3.4 supports a "population count" builtin, which on many targets is
 160  * implemented with a single instruction. There is a fallback definition
 161  * in libgcc in case a target does not have one, which should be just as
 162  * good as the open-coded solution below, (which is "HACKMEM 169").
 163  */
 164 static inline unsigned int
 165 _hb_popcount32 (uint32_t mask)
 166 {
 167 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 168     return __builtin_popcount (mask);
 169 #else
 170     register uint32_t y;
 171
 172     y = (mask >> 1) &033333333333;
 173     y = mask - y - ((y >>1) & 033333333333);
 174     return (((y + (y >> 3)) & 030707070707) % 077);
 175 #endif
 176 }
 177
 178
 179 /* Multiplies a 16dot16 value by another value, then truncates the result */
 180 #define _hb_16dot16_mul_round(A,B) (((int64_t) (A) * (B) + 0x8000) / 0x10000)
 181
 182
 183 /* We need external help for these */
 184
 185 #ifdef HAVE_GLIB
 186
 187 #include <glib.h>
 188
 189 typedef int hb_atomic_int_t;
 190 #define hb_atomic_int_fetch_and_add(AI, V)      g_atomic_int_exchange_and_add (&(AI), V)
 191 #define hb_atomic_int_get(AI)                   g_atomic_int_get (&(AI))
 192 #define hb_atomic_int_set(AI, V)                g_atomic_int_set (&(AI), V)
 193
 194 typedef GStaticMutex hb_mutex_t;
 195 #define HB_MUTEX_INIT                   G_STATIC_MUTEX_INIT
 196 #define hb_mutex_init(M)                g_static_mutex_init (&M)
 197 #define hb_mutex_lock(M)                g_static_mutex_lock (&M)
 198 #define hb_mutex_trylock(M)             g_static_mutex_trylock (&M)
 199 #define hb_mutex_unlock(M)              g_static_mutex_unlock (&M)
 200
 201 #else
 202
 203 #ifdef _MSC_VER
 204 #pragma message(__LOC__"Could not find any system to define platform macros, library will NOT be thread-safe")
 205 #else
 206 #warning "Could not find any system to define platform macros, library will NOT be thread-safe"
 207 #endif
 208
 209 typedef int hb_atomic_int_t;
 210 #define hb_atomic_int_fetch_and_add(AI, V)      ((AI) += (V), (AI) - (V))
 211 #define hb_atomic_int_get(AI)                   (AI)
 212 #define hb_atomic_int_set(AI, V)                HB_STMT_START { (AI) = (V); } HB_STMT_END
 213
 214 typedef int hb_mutex_t;
 215 #define HB_MUTEX_INIT                           0
 216 #define hb_mutex_init(M)                        HB_STMT_START { (M) = 0; } HB_STMT_END
 217 #define hb_mutex_lock(M)                        HB_STMT_START { (M) = 1; } HB_STMT_END
 218 #define hb_mutex_trylock(M)                     ((M) = 1, 1)
 219 #define hb_mutex_unlock(M)                      HB_STMT_START { (M) = 0; } HB_STMT_END
 220
 221 #endif
 222
 223
 224 /* Big-endian handling */
 225
 226 #define hb_be_uint16(v)         ((uint16_t) ((((const uint8_t *)&(v))[0] << 8) + (((const uint8_t *)&(v))[1])))
 227
 228 #define hb_be_uint16_put(v,V)   HB_STMT_START { v[0] = (V>>8); v[1] = (V); } HB_STMT_END
 229 #define hb_be_uint16_get(v)     (uint16_t) ((v[0] << 8) + v[1])
 230 #define hb_be_uint16_cmp(a,b)   (a[0] == b[0] && a[1] == b[1])
 231
 232 #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
 233 #define hb_be_uint32_get(v)     (uint32_t) ((v[0] << 24) + (v[1] << 16) + (v[2] << 8) + v[3])
 234 #define hb_be_uint32_cmp(a,b)   (a[0] == b[0] && a[1] == b[1] && a[2] == b[2] && a[3] == b[3])
 235
 236
 237 /* Debug */
 238
 239 #ifndef HB_DEBUG
 240 #define HB_DEBUG 0
 241 #endif
 242
 243 static inline hb_bool_t /* always returns TRUE */
 244 _hb_trace (const char *what,
 245            const char *function,
 246            const void *obj,
 247            unsigned int depth,
 248            unsigned int max_depth)
 249 {
 250   if (depth < max_depth)
 251     fprintf (stderr, "%s(%p) %-*d-> %s\n", what, obj, depth, depth, function);
 252   return TRUE;
 253 }
 254
 255
 256 #include "hb-object-private.h"
 257
 258 #endif /* HB_PRIVATE_H */