src/hb-private.hh

   1 /*
   2  * Copyright © 2007,2008,2009  Red Hat, Inc.
   3  * Copyright © 2011  Google, Inc.
   4  *
   5  *  This is part of HarfBuzz, a text shaping library.
   6  *
   7  * Permission is hereby granted, without written agreement and without
   8  * license or royalty fees, to use, copy, modify, and distribute this
   9  * software and its documentation for any purpose, provided that the
  10  * above copyright notice and the following two paragraphs appear in
  11  * all copies of this software.
  12  *
  13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  17  * DAMAGE.
  18  *
  19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  24  *
  25  * Red Hat Author(s): Behdad Esfahbod
  26  * Google Author(s): Behdad Esfahbod
  27  */
  28
  29 #ifndef HB_PRIVATE_HH
  30 #define HB_PRIVATE_HH
  31
  32 #if HAVE_CONFIG_H
  33 #include "config.h"
  34 #endif
  35
  36 #include "hb-common.h"
  37
  38 #include <stdlib.h>
  39 #include <string.h>
  40 #include <assert.h>
  41
  42 /* We only use these two for debug output.  However, the debug code is
  43  * always seen by the compiler (and optimized out in non-debug builds.
  44  * If including these becomes a problem, we can start thinking about
  45  * someway around that. */
  46 #include <stdio.h>
  47 #include <errno.h>
  48
  49 HB_BEGIN_DECLS
  50
  51
  52 /* Essentials */
  53
  54 #ifndef NULL
  55 # define NULL ((void *) 0)
  56 #endif
  57
  58 #undef FALSE
  59 #define FALSE 0
  60
  61 #undef TRUE
  62 #define TRUE 1
  63
  64
  65 /* Basics */
  66
  67 HB_END_DECLS
  68
  69 #undef MIN
  70 template <typename Type> static inline Type MIN (const Type &a, const Type &b) { return a < b ? a : b; }
  71
  72 #undef MAX
  73 template <typename Type> static inline Type MAX (const Type &a, const Type &b) { return a > b ? a : b; }
  74
  75 HB_BEGIN_DECLS
  76
  77 #undef  ARRAY_LENGTH
  78 #define ARRAY_LENGTH(__array) ((signed int) (sizeof (__array) / sizeof (__array[0])))
  79
  80 #define HB_STMT_START do
  81 #define HB_STMT_END   while (0)
  82
  83 #define _ASSERT_STATIC1(_line, _cond) typedef int _static_assert_on_line_##_line##_failed[(_cond)?1:-1]
  84 #define _ASSERT_STATIC0(_line, _cond) _ASSERT_STATIC1 (_line, (_cond))
  85 #define ASSERT_STATIC(_cond) _ASSERT_STATIC0 (__LINE__, (_cond))
  86
  87 #define ASSERT_STATIC_EXPR(_cond) ((void) sizeof (char[(_cond) ? 1 : -1]))
  88
  89
  90 /* Lets assert int types.  Saves trouble down the road. */
  91
  92 ASSERT_STATIC (sizeof (int8_t) == 1);
  93 ASSERT_STATIC (sizeof (uint8_t) == 1);
  94 ASSERT_STATIC (sizeof (int16_t) == 2);
  95 ASSERT_STATIC (sizeof (uint16_t) == 2);
  96 ASSERT_STATIC (sizeof (int32_t) == 4);
  97 ASSERT_STATIC (sizeof (uint32_t) == 4);
  98 ASSERT_STATIC (sizeof (int64_t) == 8);
  99 ASSERT_STATIC (sizeof (uint64_t) == 8);
 100
 101 ASSERT_STATIC (sizeof (hb_codepoint_t) == 4);
 102 ASSERT_STATIC (sizeof (hb_position_t) == 4);
 103 ASSERT_STATIC (sizeof (hb_mask_t) == 4);
 104 ASSERT_STATIC (sizeof (hb_var_int_t) == 4);
 105
 106 /* Misc */
 107
 108
 109 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
 110 #define _HB_BOOLEAN_EXPR(expr) ((expr) ? 1 : 0)
 111 #define likely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 1))
 112 #define unlikely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 0))
 113 #else
 114 #define likely(expr) (expr)
 115 #define unlikely(expr) (expr)
 116 #endif
 117
 118 #ifndef __GNUC__
 119 #undef __attribute__
 120 #define __attribute__(x)
 121 #endif
 122
 123 #if __GNUC__ >= 3
 124 #define HB_PURE_FUNC    __attribute__((pure))
 125 #define HB_CONST_FUNC   __attribute__((const))
 126 #else
 127 #define HB_PURE_FUNC
 128 #define HB_CONST_FUNC
 129 #endif
 130 #if __GNUC__ >= 4
 131 #define HB_UNUSED       __attribute__((unused))
 132 #else
 133 #define HB_UNUSED
 134 #endif
 135
 136 #ifndef HB_INTERNAL
 137 # define HB_INTERNAL __attribute__((__visibility__("hidden")))
 138 #endif
 139
 140
 141 #if (defined(__WIN32__) && !defined(__WINE__)) || defined(_MSC_VER)
 142 #define snprintf _snprintf
 143 #endif
 144
 145 #ifdef _MSC_VER
 146 #undef inline
 147 #define inline __inline
 148 #endif
 149
 150 #ifdef __STRICT_ANSI__
 151 #undef inline
 152 #define inline __inline__
 153 #endif
 154
 155
 156 #if __GNUC__ >= 3
 157 #define HB_FUNC __PRETTY_FUNCTION__
 158 #elif defined(_MSC_VER)
 159 #define HB_FUNC __FUNCSIG__
 160 #else
 161 #define HB_FUNC __func__
 162 #endif
 163
 164
 165 /* Return the number of 1 bits in mask. */
 166 static inline HB_CONST_FUNC unsigned int
 167 _hb_popcount32 (uint32_t mask)
 168 {
 169 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 170   return __builtin_popcount (mask);
 171 #else
 172   /* "HACKMEM 169" */
 173   register uint32_t y;
 174   y = (mask >> 1) &033333333333;
 175   y = mask - y - ((y >>1) & 033333333333);
 176   return (((y + (y >> 3)) & 030707070707) % 077);
 177 #endif
 178 }
 179
 180 /* Returns the number of bits needed to store number */
 181 static inline HB_CONST_FUNC unsigned int
 182 _hb_bit_storage (unsigned int number)
 183 {
 184 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
 185   return likely (number) ? (sizeof (unsigned int) * 8 - __builtin_clz (number)) : 0;
 186 #else
 187   register unsigned int n_bits = 0;
 188   while (number) {
 189     n_bits++;
 190     number >>= 1;
 191   }
 192   return n_bits;
 193 #endif
 194 }
 195
 196 /* Returns the number of zero bits in the least significant side of number */
 197 static inline HB_CONST_FUNC unsigned int
 198 _hb_ctz (unsigned int number)
 199 {
 200 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
 201   return likely (number) ? __builtin_ctz (number) : 0;
 202 #else
 203   register unsigned int n_bits = 0;
 204   if (unlikely (!number)) return 0;
 205   while (!(number & 1)) {
 206     n_bits++;
 207     number >>= 1;
 208   }
 209   return n_bits;
 210 #endif
 211 }
 212
 213 static inline bool
 214 _hb_unsigned_int_mul_overflows (unsigned int count, unsigned int size)
 215 {
 216   return (size > 0) && (count >= ((unsigned int) -1) / size);
 217 }
 218
 219
 220 /* Type of bsearch() / qsort() compare function */
 221 typedef int (*hb_compare_func_t) (const void *, const void *);
 222
 223
 224 /* We need external help for these */
 225
 226 #ifdef HAVE_GLIB
 227
 228 #include <glib.h>
 229
 230 typedef volatile int hb_atomic_int_t;
 231 #define hb_atomic_int_fetch_and_add(AI, V)      g_atomic_int_exchange_and_add (&(AI), V)
 232 #define hb_atomic_int_get(AI)                   g_atomic_int_get (&(AI))
 233 #define hb_atomic_int_set(AI, V)                g_atomic_int_set (&(AI), V)
 234
 235 typedef GStaticMutex hb_mutex_t;
 236 #define HB_MUTEX_INIT                   G_STATIC_MUTEX_INIT
 237 #define hb_mutex_init(M)                g_static_mutex_init (&M)
 238 #define hb_mutex_lock(M)                g_static_mutex_lock (&M)
 239 #define hb_mutex_trylock(M)             g_static_mutex_trylock (&M)
 240 #define hb_mutex_unlock(M)              g_static_mutex_unlock (&M)
 241
 242 #else
 243
 244 #ifdef _MSC_VER
 245 #define _HB__STR2__(x) #x
 246 #define _HB__STR1__(x) _HB__STR2__(x)
 247 #define _HB__LOC__ __FILE__ "("_HB__STR1__(__LINE__)") : Warning Msg: "
 248 #pragma message(_HB__LOC__"Could not find any system to define platform macros, library will NOT be thread-safe")
 249 #else
 250 #warning "Could not find any system to define platform macros, library will NOT be thread-safe"
 251 #endif
 252
 253 typedef volatile int hb_atomic_int_t;
 254 #define hb_atomic_int_fetch_and_add(AI, V)      ((AI) += (V), (AI) - (V))
 255 #define hb_atomic_int_get(AI)                   (AI)
 256 #define hb_atomic_int_set(AI, V)                ((void) ((AI) = (V)))
 257
 258 typedef volatile int hb_mutex_t;
 259 #define HB_MUTEX_INIT                           0
 260 #define hb_mutex_init(M)                        HB_STMT_START { (M) = 0; } HB_STMT_END
 261 #define hb_mutex_lock(M)                        HB_STMT_START { (M) = 1; } HB_STMT_END
 262 #define hb_mutex_trylock(M)                     ((M) = 1, 1)
 263 #define hb_mutex_unlock(M)                      HB_STMT_START { (M) = 0; } HB_STMT_END
 264
 265 #endif
 266
 267
 268 HB_END_DECLS
 269
 270
 271 /* arrays and maps */
 272
 273
 274 template <typename Type, unsigned int StaticSize>
 275 struct hb_static_array_t {
 276
 277   unsigned int len;
 278   unsigned int allocated;
 279   Type *array;
 280   Type static_array[StaticSize];
 281
 282   void finish (void) { for (unsigned i = 0; i < len; i++) array[i].finish (); }
 283
 284   inline Type& operator [] (unsigned int i)
 285   {
 286     return array[i];
 287   }
 288
 289   inline Type *push (void)
 290   {
 291     if (!array) {
 292       array = static_array;
 293       allocated = ARRAY_LENGTH (static_array);
 294     }
 295     if (likely (len < allocated))
 296       return &array[len++];
 297
 298     /* Need to reallocate */
 299     unsigned int new_allocated = allocated + (allocated >> 1) + 8;
 300     Type *new_array = NULL;
 301
 302     if (array == static_array) {
 303       new_array = (Type *) calloc (new_allocated, sizeof (Type));
 304       if (new_array)
 305         memcpy (new_array, array, len * sizeof (Type));
 306     } else {
 307       bool overflows = (new_allocated < allocated) || _hb_unsigned_int_mul_overflows (new_allocated, sizeof (Type));
 308       if (likely (!overflows)) {
 309         new_array = (Type *) realloc (array, new_allocated * sizeof (Type));
 310       }
 311     }
 312
 313     if (unlikely (!new_array))
 314       return NULL;
 315
 316     array = new_array;
 317     allocated = new_allocated;
 318     return &array[len++];
 319   }
 320
 321   inline void pop (void)
 322   {
 323     len--;
 324     /* TODO: shrink array if needed */
 325   }
 326 };
 327
 328 template <typename Type>
 329 struct hb_array_t : hb_static_array_t<Type, 2> {};
 330
 331
 332 template <typename Key, typename Value>
 333 struct hb_map_t
 334 {
 335   struct item_t {
 336     Key key;
 337     /* unsigned int hash; */
 338     Value value;
 339
 340     void finish (void) { value.finish (); }
 341   };
 342
 343   hb_array_t <item_t> items;
 344
 345   private:
 346
 347   inline item_t *find (Key key) {
 348     if (unlikely (!key)) return NULL;
 349     for (unsigned int i = 0; i < items.len; i++)
 350       if (key == items[i].key)
 351         return &items[i];
 352     return NULL;
 353   }
 354
 355   public:
 356
 357   inline bool set (Key   key,
 358                    Value &value)
 359   {
 360     if (unlikely (!key)) return NULL;
 361     item_t *item;
 362     item = find (key);
 363     if (item)
 364       item->finish ();
 365     else
 366       item = items.push ();
 367     if (unlikely (!item)) return false;
 368     item->key = key;
 369     item->value = value;
 370     return true;
 371   }
 372
 373   inline void unset (Key &key)
 374   {
 375     item_t *item;
 376     item = find (key);
 377     if (!item) return;
 378
 379     item->finish ();
 380     *item = items[items.len - 1];
 381     items.pop ();
 382   }
 383
 384   inline Value *get (Key key)
 385   {
 386     item_t *item = find (key);
 387     return item ? &item->value : NULL;
 388   }
 389
 390   void finish (void) { items.finish (); }
 391 };
 392
 393
 394 HB_BEGIN_DECLS
 395
 396
 397 /* Big-endian handling */
 398
 399 static inline uint16_t hb_be_uint16 (const uint16_t v)
 400 {
 401   const uint8_t *V = (const uint8_t *) &v;
 402   return (uint16_t) (V[0] << 8) + V[1];
 403 }
 404
 405 #define hb_be_uint16_put(v,V)   HB_STMT_START { v[0] = (V>>8); v[1] = (V); } HB_STMT_END
 406 #define hb_be_uint16_get(v)     (uint16_t) ((v[0] << 8) + v[1])
 407 #define hb_be_uint16_eq(a,b)    (a[0] == b[0] && a[1] == b[1])
 408
 409 #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
 410 #define hb_be_uint32_get(v)     (uint32_t) ((v[0] << 24) + (v[1] << 16) + (v[2] << 8) + v[3])
 411 #define hb_be_uint32_eq(a,b)    (a[0] == b[0] && a[1] == b[1] && a[2] == b[2] && a[3] == b[3])
 412
 413
 414 /* ASCII tag/character handling */
 415
 416 static inline unsigned char ISALPHA (unsigned char c)
 417 { return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'); }
 418 static inline unsigned char ISALNUM (unsigned char c)
 419 { return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9'); }
 420 static inline unsigned char TOUPPER (unsigned char c)
 421 { return (c >= 'a' && c <= 'z') ? c - 'a' + 'A' : c; }
 422 static inline unsigned char TOLOWER (unsigned char c)
 423 { return (c >= 'A' && c <= 'Z') ? c - 'A' + 'a' : c; }
 424
 425 #define HB_TAG_CHAR4(s)   (HB_TAG(((const char *) s)[0], \
 426                                   ((const char *) s)[1], \
 427                                   ((const char *) s)[2], \
 428                                   ((const char *) s)[3]))
 429
 430
 431 /* Debug */
 432
 433 #ifndef HB_DEBUG
 434 #define HB_DEBUG 0
 435 #endif
 436
 437 static inline bool /* always returns TRUE */
 438 _hb_trace (const char *what,
 439            const char *function,
 440            const void *obj,
 441            unsigned int depth,
 442            unsigned int max_depth)
 443 {
 444   (void) ((depth < max_depth) && fprintf (stderr, "%s(%p) %-*d-> %s\n", what, obj, depth, depth, function));
 445   return TRUE;
 446 }
 447
 448
 449 HB_END_DECLS
 450
 451 #endif /* HB_PRIVATE_HH */