src/hb-private.hh

   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_HH
  28 #define HB_PRIVATE_HH
  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 HB_BEGIN_DECLS
  48
  49
  50 /* Essentials */
  51
  52 #ifndef NULL
  53 # define NULL ((void *) 0)
  54 #endif
  55
  56 #undef FALSE
  57 #define FALSE 0
  58
  59 #undef TRUE
  60 #define TRUE 1
  61
  62
  63 /* Basics */
  64
  65 #undef MIN
  66 #define MIN(a,b) ((a) < (b) ? (a) : (b))
  67
  68 #undef MAX
  69 #define MAX(a,b) ((a) > (b) ? (a) : (b))
  70
  71 #undef  ARRAY_LENGTH
  72 #define ARRAY_LENGTH(__array) ((signed int) (sizeof (__array) / sizeof (__array[0])))
  73
  74 #define HB_STMT_START do
  75 #define HB_STMT_END   while (0)
  76
  77 #define _ASSERT_STATIC1(_line, _cond) typedef int _static_assert_on_line_##_line##_failed[(_cond)?1:-1]
  78 #define _ASSERT_STATIC0(_line, _cond) _ASSERT_STATIC1 (_line, (_cond))
  79 #define ASSERT_STATIC(_cond) _ASSERT_STATIC0 (__LINE__, (_cond))
  80
  81
  82 /* Lets assert int types.  Saves trouble down the road. */
  83
  84 ASSERT_STATIC (sizeof (int8_t) == 1);
  85 ASSERT_STATIC (sizeof (uint8_t) == 1);
  86 ASSERT_STATIC (sizeof (int16_t) == 2);
  87 ASSERT_STATIC (sizeof (uint16_t) == 2);
  88 ASSERT_STATIC (sizeof (int32_t) == 4);
  89 ASSERT_STATIC (sizeof (uint32_t) == 4);
  90 ASSERT_STATIC (sizeof (int64_t) == 8);
  91 ASSERT_STATIC (sizeof (uint64_t) == 8);
  92
  93 ASSERT_STATIC (sizeof (hb_codepoint_t) == 4);
  94 ASSERT_STATIC (sizeof (hb_position_t) == 4);
  95 ASSERT_STATIC (sizeof (hb_mask_t) == 4);
  96 ASSERT_STATIC (sizeof (hb_var_int_t) == 4);
  97
  98 /* Misc */
  99
 100
 101 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
 102 #define _HB_BOOLEAN_EXPR(expr) ((expr) ? 1 : 0)
 103 #define likely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 1))
 104 #define unlikely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 0))
 105 #else
 106 #define likely(expr) (expr)
 107 #define unlikely(expr) (expr)
 108 #endif
 109
 110 #ifndef __GNUC__
 111 #undef __attribute__
 112 #define __attribute__(x)
 113 #endif
 114
 115 #if __GNUC__ >= 3
 116 #define HB_PURE_FUNC    __attribute__((pure))
 117 #define HB_CONST_FUNC   __attribute__((const))
 118 #else
 119 #define HB_PURE_FUNC
 120 #define HB_CONST_FUNC
 121 #endif
 122 #if __GNUC__ >= 4
 123 #define HB_UNUSED       __attribute__((unused))
 124 #else
 125 #define HB_UNUSED
 126 #endif
 127
 128 #ifndef HB_INTERNAL
 129 # define HB_INTERNAL __attribute__((__visibility__("hidden")))
 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 static inline HB_CONST_FUNC unsigned int
 159 _hb_popcount32 (uint32_t mask)
 160 {
 161 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 162   return __builtin_popcount (mask);
 163 #else
 164   /* "HACKMEM 169" */
 165   register uint32_t y;
 166   y = (mask >> 1) &033333333333;
 167   y = mask - y - ((y >>1) & 033333333333);
 168   return (((y + (y >> 3)) & 030707070707) % 077);
 169 #endif
 170 }
 171
 172 /* Returns the number of bits needed to store number */
 173 static inline HB_CONST_FUNC unsigned int
 174 _hb_bit_storage (unsigned int number)
 175 {
 176 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
 177   return likely (number) ? (sizeof (unsigned int) * 8 - __builtin_clz (number)) : 0;
 178 #else
 179   register unsigned int n_bits = 0;
 180   while (number) {
 181     n_bits++;
 182     number >>= 1;
 183   }
 184   return n_bits;
 185 #endif
 186 }
 187
 188 /* Returns the number of zero bits in the least significant side of number */
 189 static inline HB_CONST_FUNC unsigned int
 190 _hb_ctz (unsigned int number)
 191 {
 192 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
 193   return likely (number) ? __builtin_ctz (number) : 0;
 194 #else
 195   register unsigned int n_bits = 0;
 196   if (unlikely (!number)) return 0;
 197   while (!(number & 1)) {
 198     n_bits++;
 199     number >>= 1;
 200   }
 201   return n_bits;
 202 #endif
 203 }
 204
 205 /* Type of bsearch() / qsort() compare function */
 206 typedef int (*hb_compare_func_t) (const void *, const void *);
 207
 208
 209 /* We need external help for these */
 210
 211 #ifdef HAVE_GLIB
 212
 213 #include <glib.h>
 214
 215 typedef int hb_atomic_int_t;
 216 #define hb_atomic_int_fetch_and_add(AI, V)      g_atomic_int_exchange_and_add (&(AI), V)
 217 #define hb_atomic_int_get(AI)                   g_atomic_int_get (&(AI))
 218 #define hb_atomic_int_set(AI, V)                g_atomic_int_set (&(AI), V)
 219
 220 typedef GStaticMutex hb_mutex_t;
 221 #define HB_MUTEX_INIT                   G_STATIC_MUTEX_INIT
 222 #define hb_mutex_init(M)                g_static_mutex_init (&M)
 223 #define hb_mutex_lock(M)                g_static_mutex_lock (&M)
 224 #define hb_mutex_trylock(M)             g_static_mutex_trylock (&M)
 225 #define hb_mutex_unlock(M)              g_static_mutex_unlock (&M)
 226
 227 #else
 228
 229 #ifdef _MSC_VER
 230 #define _HB__STR2__(x) #x
 231 #define _HB__STR1__(x) _HB__STR2__(x)
 232 #define _HB__LOC__ __FILE__ "("_HB__STR1__(__LINE__)") : Warning Msg: "
 233 #pragma message(_HB__LOC__"Could not find any system to define platform macros, library will NOT be thread-safe")
 234 #else
 235 #warning "Could not find any system to define platform macros, library will NOT be thread-safe"
 236 #endif
 237
 238 typedef int hb_atomic_int_t;
 239 #define hb_atomic_int_fetch_and_add(AI, V)      ((AI) += (V), (AI) - (V))
 240 #define hb_atomic_int_get(AI)                   (AI)
 241 #define hb_atomic_int_set(AI, V)                HB_STMT_START { (AI) = (V); } HB_STMT_END
 242
 243 typedef int hb_mutex_t;
 244 #define HB_MUTEX_INIT                           0
 245 #define hb_mutex_init(M)                        HB_STMT_START { (M) = 0; } HB_STMT_END
 246 #define hb_mutex_lock(M)                        HB_STMT_START { (M) = 1; } HB_STMT_END
 247 #define hb_mutex_trylock(M)                     ((M) = 1, 1)
 248 #define hb_mutex_unlock(M)                      HB_STMT_START { (M) = 0; } HB_STMT_END
 249
 250 #endif
 251
 252
 253 /* Big-endian handling */
 254
 255 #define hb_be_uint16(v)         ((uint16_t) ((((const uint8_t *)&(v))[0] << 8) + (((const uint8_t *)&(v))[1])))
 256
 257 #define hb_be_uint16_put(v,V)   HB_STMT_START { v[0] = (V>>8); v[1] = (V); } HB_STMT_END
 258 #define hb_be_uint16_get(v)     (uint16_t) ((v[0] << 8) + v[1])
 259 #define hb_be_uint16_cmp(a,b)   (a[0] == b[0] && a[1] == b[1])
 260
 261 #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
 262 #define hb_be_uint32_get(v)     (uint32_t) ((v[0] << 24) + (v[1] << 16) + (v[2] << 8) + v[3])
 263 #define hb_be_uint32_cmp(a,b)   (a[0] == b[0] && a[1] == b[1] && a[2] == b[2] && a[3] == b[3])
 264
 265
 266 /* ASCII tag/character handling */
 267
 268 #define ISALPHA(c) (((c) >= 'a' && (c) <= 'z') || ((c) >= 'A' && (c) <= 'Z'))
 269 #define TOUPPER(c) (((c) >= 'a' && (c) <= 'z') ? (c) - 'a' + 'A' : (c))
 270 #define TOLOWER(c) (((c) >= 'A' && (c) <= 'Z') ? (c) - 'A' + 'a' : (c))
 271
 272 #define HB_TAG_CHAR4(s)   (HB_TAG(((const char *) s)[0], \
 273                                   ((const char *) s)[1], \
 274                                   ((const char *) s)[2], \
 275                                   ((const char *) s)[3]))
 276
 277
 278 /* Debug */
 279
 280 #ifndef HB_DEBUG
 281 #define HB_DEBUG 0
 282 #endif
 283
 284 static inline hb_bool_t /* always returns TRUE */
 285 _hb_trace (const char *what,
 286            const char *function,
 287            const void *obj,
 288            unsigned int depth,
 289            unsigned int max_depth)
 290 {
 291   (void) ((depth < max_depth) && fprintf (stderr, "%s(%p) %-*d-> %s\n", what, obj, depth, depth, function));
 292   return TRUE;
 293 }
 294
 295
 296 #include "hb-object-private.hh"
 297
 298
 299 HB_END_DECLS
 300
 301 #endif /* HB_PRIVATE_HH */