1 /*
2 * Copyright © 2007,2008,2009 Red Hat, Inc.
3 * Copyright © 2011,2012 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 #ifdef HAVE_CONFIG_H
33 #include "config.h"
34 #endif
35
36 #include "hb.h"
37 #define HB_H_IN
38 #ifdef HAVE_OT
39 #include "hb-ot.h"
40 #define HB_OT_H_IN
41 #endif
42
43 #include <stdlib.h>
44 #include <stddef.h>
45 #include <string.h>
46 #include <assert.h>
47
48 /* We only use these two for debug output. However, the debug code is
49 * always seen by the compiler (and optimized out in non-debug builds.
50 * If including these becomes a problem, we can start thinking about
51 * someway around that. */
52 #include <stdio.h>
53 #include <errno.h>
54 #include <stdarg.h>
55
56
57 /* Compiler attributes */
58
59
60 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
61 #define _HB_BOOLEAN_EXPR(expr) ((expr) ? 1 : 0)
62 #define likely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 1))
63 #define unlikely(expr) (__builtin_expect (_HB_BOOLEAN_EXPR(expr), 0))
64 #else
65 #define likely(expr) (expr)
66 #define unlikely(expr) (expr)
67 #endif
68
69 #ifndef __GNUC__
70 #undef __attribute__
71 #define __attribute__(x)
72 #endif
73
74 #if __GNUC__ >= 3
75 #define HB_PURE_FUNC __attribute__((pure))
76 #define HB_CONST_FUNC __attribute__((const))
77 #define HB_PRINTF_FUNC(format_idx, arg_idx) __attribute__((__format__ (__printf__, format_idx, arg_idx)))
78 #else
79 #define HB_PURE_FUNC
80 #define HB_CONST_FUNC
81 #define HB_PRINTF_FUNC(format_idx, arg_idx)
82 #endif
83 #if __GNUC__ >= 4
84 #define HB_UNUSED __attribute__((unused))
85 #else
86 #define HB_UNUSED
87 #endif
88
89 #ifndef HB_INTERNAL
90 # if !defined(__MINGW32__) && !defined(__CYGWIN__)
91 # define HB_INTERNAL __attribute__((__visibility__("hidden")))
92 # else
93 # define HB_INTERNAL
94 # endif
95 #endif
96
97 #if (defined(__WIN32__) && !defined(__WINE__)) || defined(_MSC_VER)
98 #define snprintf _snprintf
99 /* Windows CE only has _strdup, while rest of Windows has both. */
100 #define strdup _strdup
101 #endif
102
103 #ifdef _MSC_VER
104 #undef inline
105 #define inline __inline
106 #endif
107
108 #ifdef __STRICT_ANSI__
109 #undef inline
110 #define inline __inline__
111 #endif
112
113 #if __GNUC__ >= 3
114 #define HB_FUNC __PRETTY_FUNCTION__
115 #elif defined(_MSC_VER)
116 #define HB_FUNC __FUNCSIG__
117 #else
118 #define HB_FUNC __func__
119 #endif
120
121 #if defined(_WIN32) || defined(__CYGWIN__)
122 /* We need Windows Vista for both Uniscribe backend and for
123 * MemoryBarrier. We don't support compiling on Windows XP,
124 * though we run on it fine. */
125 # if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0600
126 # undef _WIN32_WINNT
127 # endif
128 # ifndef _WIN32_WINNT
129 # define _WIN32_WINNT 0x0600
130 # endif
131 # ifndef WIN32_LEAN_AND_MEAN
132 # define WIN32_LEAN_AND_MEAN 1
133 # endif
134 # ifndef STRICT
135 # define STRICT 1
136 # endif
137 #endif
138
139 #ifdef _WIN32_WCE
140 /* Some things not defined on Windows CE. */
141 #define MemoryBarrier()
142 #define getenv(Name) NULL
143 #define setlocale(Category, Locale) "C"
144 static int errno = 0; /* Use something better? */
145 #endif
146
147 #if HAVE_ATEXIT
148 /* atexit() is only safe to be called from shared libraries on certain
149 * platforms. Whitelist.
150 * https://bugs.freedesktop.org/show_bug.cgi?id=82246 */
151 # if defined(__linux) && defined(__GLIBC_PREREQ)
152 # if __GLIBC_PREREQ(2,3)
153 /* From atexit() manpage, it's safe with glibc 2.2.3 on Linux. */
154 # define HB_USE_ATEXIT 1
155 # endif
156 # elif defined(_MSC_VER) || defined(__MINGW32__)
157 /* For MSVC:
158 * http://msdn.microsoft.com/en-ca/library/tze57ck3.aspx
159 * http://msdn.microsoft.com/en-ca/library/zk17ww08.aspx
160 * mingw32 headers say atexit is safe to use in shared libraries.
161 */
162 # define HB_USE_ATEXIT 1
163 # elif defined(__ANDROID__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
164 /* This was fixed in Android NKD r8 or r8b:
165 * https://code.google.com/p/android/issues/detail?id=6455
166 * which introduced GCC 4.6:
167 * https://developer.android.com/tools/sdk/ndk/index.html
168 */
169 # define HB_USE_ATEXIT 1
170 # endif
171 #endif
172
173 /* Basics */
174
175
176 #ifndef NULL
177 # define NULL ((void *) 0)
178 #endif
179
180 #undef MIN
181 template <typename Type>
MIN(const Type & a,const Type & b)182 static inline Type MIN (const Type &a, const Type &b) { return a < b ? a : b; }
183
184 #undef MAX
185 template <typename Type>
MAX(const Type & a,const Type & b)186 static inline Type MAX (const Type &a, const Type &b) { return a > b ? a : b; }
187
DIV_CEIL(const unsigned int a,unsigned int b)188 static inline unsigned int DIV_CEIL (const unsigned int a, unsigned int b)
189 { return (a + (b - 1)) / b; }
190
191
192 #undef ARRAY_LENGTH
193 template <typename Type, unsigned int n>
ARRAY_LENGTH(const Type (&)[n])194 static inline unsigned int ARRAY_LENGTH (const Type (&)[n]) { return n; }
195 /* A const version, but does not detect erratically being called on pointers. */
196 #define ARRAY_LENGTH_CONST(__array) ((signed int) (sizeof (__array) / sizeof (__array[0])))
197
198 #define HB_STMT_START do
199 #define HB_STMT_END while (0)
200
201 #define _ASSERT_STATIC1(_line, _cond) HB_UNUSED typedef int _static_assert_on_line_##_line##_failed[(_cond)?1:-1]
202 #define _ASSERT_STATIC0(_line, _cond) _ASSERT_STATIC1 (_line, (_cond))
203 #define ASSERT_STATIC(_cond) _ASSERT_STATIC0 (__LINE__, (_cond))
204
205 #define ASSERT_STATIC_EXPR(_cond)((void) sizeof (char[(_cond) ? 1 : -1]))
206 #define ASSERT_STATIC_EXPR_ZERO(_cond) (0 * sizeof (char[(_cond) ? 1 : -1]))
207
208 #define _PASTE1(a,b) a##b
209 #define PASTE(a,b) _PASTE1(a,b)
210
211 /* Lets assert int types. Saves trouble down the road. */
212
213 ASSERT_STATIC (sizeof (int8_t) == 1);
214 ASSERT_STATIC (sizeof (uint8_t) == 1);
215 ASSERT_STATIC (sizeof (int16_t) == 2);
216 ASSERT_STATIC (sizeof (uint16_t) == 2);
217 ASSERT_STATIC (sizeof (int32_t) == 4);
218 ASSERT_STATIC (sizeof (uint32_t) == 4);
219 ASSERT_STATIC (sizeof (int64_t) == 8);
220 ASSERT_STATIC (sizeof (uint64_t) == 8);
221
222 ASSERT_STATIC (sizeof (hb_codepoint_t) == 4);
223 ASSERT_STATIC (sizeof (hb_position_t) == 4);
224 ASSERT_STATIC (sizeof (hb_mask_t) == 4);
225 ASSERT_STATIC (sizeof (hb_var_int_t) == 4);
226
227
228 /* We like our types POD */
229
230 #define _ASSERT_TYPE_POD1(_line, _type) union _type_##_type##_on_line_##_line##_is_not_POD { _type instance; }
231 #define _ASSERT_TYPE_POD0(_line, _type) _ASSERT_TYPE_POD1 (_line, _type)
232 #define ASSERT_TYPE_POD(_type) _ASSERT_TYPE_POD0 (__LINE__, _type)
233
234 #ifdef __GNUC__
235 # define _ASSERT_INSTANCE_POD1(_line, _instance) \
236 HB_STMT_START { \
237 typedef __typeof__(_instance) _type_##_line; \
238 _ASSERT_TYPE_POD1 (_line, _type_##_line); \
239 } HB_STMT_END
240 #else
241 # define _ASSERT_INSTANCE_POD1(_line, _instance) typedef int _assertion_on_line_##_line##_not_tested
242 #endif
243 # define _ASSERT_INSTANCE_POD0(_line, _instance) _ASSERT_INSTANCE_POD1 (_line, _instance)
244 # define ASSERT_INSTANCE_POD(_instance) _ASSERT_INSTANCE_POD0 (__LINE__, _instance)
245
246 /* Check _assertion in a method environment */
247 #define _ASSERT_POD1(_line) \
248 HB_UNUSED inline void _static_assertion_on_line_##_line (void) const \
249 { _ASSERT_INSTANCE_POD1 (_line, *this); /* Make sure it's POD. */ }
250 # define _ASSERT_POD0(_line) _ASSERT_POD1 (_line)
251 # define ASSERT_POD() _ASSERT_POD0 (__LINE__)
252
253
254
255 /* Misc */
256
257 /* Void! */
258 struct _hb_void_t {};
259 typedef const _hb_void_t &hb_void_t;
260 #define HB_VOID (* (const _hb_void_t *) NULL)
261
262 /* Return the number of 1 bits in mask. */
263 static inline HB_CONST_FUNC unsigned int
_hb_popcount32(uint32_t mask)264 _hb_popcount32 (uint32_t mask)
265 {
266 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
267 return __builtin_popcount (mask);
268 #else
269 /* "HACKMEM 169" */
270 uint32_t y;
271 y = (mask >> 1) &033333333333;
272 y = mask - y - ((y >>1) & 033333333333);
273 return (((y + (y >> 3)) & 030707070707) % 077);
274 #endif
275 }
276
277 /* Returns the number of bits needed to store number */
278 static inline HB_CONST_FUNC unsigned int
_hb_bit_storage(unsigned int number)279 _hb_bit_storage (unsigned int number)
280 {
281 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
282 return likely (number) ? (sizeof (unsigned int) * 8 - __builtin_clz (number)) : 0;
283 #else
284 unsigned int n_bits = 0;
285 while (number) {
286 n_bits++;
287 number >>= 1;
288 }
289 return n_bits;
290 #endif
291 }
292
293 /* Returns the number of zero bits in the least significant side of number */
294 static inline HB_CONST_FUNC unsigned int
_hb_ctz(unsigned int number)295 _hb_ctz (unsigned int number)
296 {
297 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
298 return likely (number) ? __builtin_ctz (number) : 0;
299 #else
300 unsigned int n_bits = 0;
301 if (unlikely (!number)) return 0;
302 while (!(number & 1)) {
303 n_bits++;
304 number >>= 1;
305 }
306 return n_bits;
307 #endif
308 }
309
310 static inline bool
_hb_unsigned_int_mul_overflows(unsigned int count,unsigned int size)311 _hb_unsigned_int_mul_overflows (unsigned int count, unsigned int size)
312 {
313 return (size > 0) && (count >= ((unsigned int) -1) / size);
314 }
315
316
317 /* Type of bsearch() / qsort() compare function */
318 typedef int (*hb_compare_func_t) (const void *, const void *);
319
320
321
322
323 /* arrays and maps */
324
325
326 #define HB_PREALLOCED_ARRAY_INIT {0, 0, NULL}
327 template <typename Type, unsigned int StaticSize=16>
328 struct hb_prealloced_array_t
329 {
330 unsigned int len;
331 unsigned int allocated;
332 Type *array;
333 Type static_array[StaticSize];
334
inithb_prealloced_array_t335 void init (void) { memset (this, 0, sizeof (*this)); }
336
operator []hb_prealloced_array_t337 inline Type& operator [] (unsigned int i) { return array[i]; }
operator []hb_prealloced_array_t338 inline const Type& operator [] (unsigned int i) const { return array[i]; }
339
pushhb_prealloced_array_t340 inline Type *push (void)
341 {
342 if (!array) {
343 array = static_array;
344 allocated = ARRAY_LENGTH (static_array);
345 }
346 if (likely (len < allocated))
347 return &array[len++];
348
349 /* Need to reallocate */
350 unsigned int new_allocated = allocated + (allocated >> 1) + 8;
351 Type *new_array = NULL;
352
353 if (array == static_array) {
354 new_array = (Type *) calloc (new_allocated, sizeof (Type));
355 if (new_array)
356 memcpy (new_array, array, len * sizeof (Type));
357 } else {
358 bool overflows = (new_allocated < allocated) || _hb_unsigned_int_mul_overflows (new_allocated, sizeof (Type));
359 if (likely (!overflows)) {
360 new_array = (Type *) realloc (array, new_allocated * sizeof (Type));
361 }
362 }
363
364 if (unlikely (!new_array))
365 return NULL;
366
367 array = new_array;
368 allocated = new_allocated;
369 return &array[len++];
370 }
371
pophb_prealloced_array_t372 inline void pop (void)
373 {
374 len--;
375 }
376
removehb_prealloced_array_t377 inline void remove (unsigned int i)
378 {
379 if (unlikely (i >= len))
380 return;
381 memmove (static_cast<void *> (&array[i]),
382 static_cast<void *> (&array[i + 1]),
383 (len - i - 1) * sizeof (Type));
384 len--;
385 }
386
shrinkhb_prealloced_array_t387 inline void shrink (unsigned int l)
388 {
389 if (l < len)
390 len = l;
391 }
392
393 template <typename T>
findhb_prealloced_array_t394 inline Type *find (T v) {
395 for (unsigned int i = 0; i < len; i++)
396 if (array[i] == v)
397 return &array[i];
398 return NULL;
399 }
400 template <typename T>
findhb_prealloced_array_t401 inline const Type *find (T v) const {
402 for (unsigned int i = 0; i < len; i++)
403 if (array[i] == v)
404 return &array[i];
405 return NULL;
406 }
407
qsorthb_prealloced_array_t408 inline void qsort (void)
409 {
410 ::qsort (array, len, sizeof (Type), (hb_compare_func_t) Type::cmp);
411 }
412
qsorthb_prealloced_array_t413 inline void qsort (unsigned int start, unsigned int end)
414 {
415 ::qsort (array + start, end - start, sizeof (Type), (hb_compare_func_t) Type::cmp);
416 }
417
418 template <typename T>
bsearchhb_prealloced_array_t419 inline Type *bsearch (T *key)
420 {
421 return (Type *) ::bsearch (key, array, len, sizeof (Type), (hb_compare_func_t) Type::cmp);
422 }
423 template <typename T>
bsearchhb_prealloced_array_t424 inline const Type *bsearch (T *key) const
425 {
426 return (const Type *) ::bsearch (key, array, len, sizeof (Type), (hb_compare_func_t) Type::cmp);
427 }
428
finishhb_prealloced_array_t429 inline void finish (void)
430 {
431 if (array != static_array)
432 free (array);
433 array = NULL;
434 allocated = len = 0;
435 }
436 };
437
438 template <typename Type>
439 struct hb_auto_array_t : hb_prealloced_array_t <Type>
440 {
hb_auto_array_thb_auto_array_t441 hb_auto_array_t (void) { hb_prealloced_array_t<Type>::init (); }
~hb_auto_array_thb_auto_array_t442 ~hb_auto_array_t (void) { hb_prealloced_array_t<Type>::finish (); }
443 };
444
445
446 #define HB_LOCKABLE_SET_INIT {HB_PREALLOCED_ARRAY_INIT}
447 template <typename item_t, typename lock_t>
448 struct hb_lockable_set_t
449 {
450 hb_prealloced_array_t <item_t, 2> items;
451
inithb_lockable_set_t452 inline void init (void) { items.init (); }
453
454 template <typename T>
replace_or_inserthb_lockable_set_t455 inline item_t *replace_or_insert (T v, lock_t &l, bool replace)
456 {
457 l.lock ();
458 item_t *item = items.find (v);
459 if (item) {
460 if (replace) {
461 item_t old = *item;
462 *item = v;
463 l.unlock ();
464 old.finish ();
465 }
466 else {
467 item = NULL;
468 l.unlock ();
469 }
470 } else {
471 item = items.push ();
472 if (likely (item))
473 *item = v;
474 l.unlock ();
475 }
476 return item;
477 }
478
479 template <typename T>
removehb_lockable_set_t480 inline void remove (T v, lock_t &l)
481 {
482 l.lock ();
483 item_t *item = items.find (v);
484 if (item) {
485 item_t old = *item;
486 *item = items[items.len - 1];
487 items.pop ();
488 l.unlock ();
489 old.finish ();
490 } else {
491 l.unlock ();
492 }
493 }
494
495 template <typename T>
findhb_lockable_set_t496 inline bool find (T v, item_t *i, lock_t &l)
497 {
498 l.lock ();
499 item_t *item = items.find (v);
500 if (item)
501 *i = *item;
502 l.unlock ();
503 return !!item;
504 }
505
506 template <typename T>
find_or_inserthb_lockable_set_t507 inline item_t *find_or_insert (T v, lock_t &l)
508 {
509 l.lock ();
510 item_t *item = items.find (v);
511 if (!item) {
512 item = items.push ();
513 if (likely (item))
514 *item = v;
515 }
516 l.unlock ();
517 return item;
518 }
519
finishhb_lockable_set_t520 inline void finish (lock_t &l)
521 {
522 if (!items.len) {
523 /* No need for locking. */
524 items.finish ();
525 return;
526 }
527 l.lock ();
528 while (items.len) {
529 item_t old = items[items.len - 1];
530 items.pop ();
531 l.unlock ();
532 old.finish ();
533 l.lock ();
534 }
535 items.finish ();
536 l.unlock ();
537 }
538
539 };
540
541
542 /* ASCII tag/character handling */
543
ISALPHA(unsigned char c)544 static inline bool ISALPHA (unsigned char c)
545 { return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'); }
ISALNUM(unsigned char c)546 static inline bool ISALNUM (unsigned char c)
547 { return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9'); }
ISSPACE(unsigned char c)548 static inline bool ISSPACE (unsigned char c)
549 { return c == ' ' || c =='\f'|| c =='\n'|| c =='\r'|| c =='\t'|| c =='\v'; }
TOUPPER(unsigned char c)550 static inline unsigned char TOUPPER (unsigned char c)
551 { return (c >= 'a' && c <= 'z') ? c - 'a' + 'A' : c; }
TOLOWER(unsigned char c)552 static inline unsigned char TOLOWER (unsigned char c)
553 { return (c >= 'A' && c <= 'Z') ? c - 'A' + 'a' : c; }
554
555 #define HB_TAG_CHAR4(s) (HB_TAG(((const char *) s)[0], \
556 ((const char *) s)[1], \
557 ((const char *) s)[2], \
558 ((const char *) s)[3]))
559
560
561 /* C++ helpers */
562
563 /* Makes class uncopyable. Use in private: section. */
564 #define NO_COPY(T) \
565 T (const T &o); \
566 T &operator = (const T &o)
567
568
569 /* Debug */
570
571
572 #ifndef HB_DEBUG
573 #define HB_DEBUG 0
574 #endif
575
576 static inline bool
_hb_debug(unsigned int level,unsigned int max_level)577 _hb_debug (unsigned int level,
578 unsigned int max_level)
579 {
580 return level < max_level;
581 }
582
583 #define DEBUG_LEVEL_ENABLED(WHAT, LEVEL) (_hb_debug ((LEVEL), HB_DEBUG_##WHAT))
584 #define DEBUG_ENABLED(WHAT) (DEBUG_LEVEL_ENABLED (WHAT, 0))
585
586 template <int max_level> static inline void
587 _hb_debug_msg_va (const char *what,
588 const void *obj,
589 const char *func,
590 bool indented,
591 unsigned int level,
592 int level_dir,
593 const char *message,
594 va_list ap) HB_PRINTF_FUNC(7, 0);
595 template <int max_level> static inline void
_hb_debug_msg_va(const char * what,const void * obj,const char * func,bool indented,unsigned int level,int level_dir,const char * message,va_list ap)596 _hb_debug_msg_va (const char *what,
597 const void *obj,
598 const char *func,
599 bool indented,
600 unsigned int level,
601 int level_dir,
602 const char *message,
603 va_list ap)
604 {
605 if (!_hb_debug (level, max_level))
606 return;
607
608 fprintf (stderr, "%-10s", what ? what : "");
609
610 if (obj)
611 fprintf (stderr, "(%0*lx) ", (unsigned int) (2 * sizeof (void *)), (unsigned long) obj);
612 else
613 fprintf (stderr, " %*s ", (unsigned int) (2 * sizeof (void *)), "");
614
615 if (indented) {
616 /* One may want to add ASCII version of these. See:
617 * https://bugs.freedesktop.org/show_bug.cgi?id=50970 */
618 #define VBAR "\342\224\202" /* U+2502 BOX DRAWINGS LIGHT VERTICAL */
619 #define VRBAR "\342\224\234" /* U+251C BOX DRAWINGS LIGHT VERTICAL AND RIGHT */
620 #define DLBAR "\342\225\256" /* U+256E BOX DRAWINGS LIGHT ARC DOWN AND LEFT */
621 #define ULBAR "\342\225\257" /* U+256F BOX DRAWINGS LIGHT ARC UP AND LEFT */
622 #define LBAR "\342\225\264" /* U+2574 BOX DRAWINGS LIGHT LEFT */
623 static const char bars[] = VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR VBAR;
624 fprintf (stderr, "%2u %s" VRBAR "%s",
625 level,
626 bars + sizeof (bars) - 1 - MIN ((unsigned int) sizeof (bars), (unsigned int) (sizeof (VBAR) - 1) * level),
627 level_dir ? (level_dir > 0 ? DLBAR : ULBAR) : LBAR);
628 } else
629 fprintf (stderr, " " VRBAR LBAR);
630
631 if (func)
632 {
633 unsigned int func_len = strlen (func);
634 #ifndef HB_DEBUG_VERBOSE
635 /* Skip "typename" */
636 if (0 == strncmp (func, "typename ", 9))
637 func += 9;
638 /* Skip return type */
639 const char *space = strchr (func, ' ');
640 if (space)
641 func = space + 1;
642 /* Skip parameter list */
643 const char *paren = strchr (func, '(');
644 if (paren)
645 func_len = paren - func;
646 #endif
647 fprintf (stderr, "%.*s: ", func_len, func);
648 }
649
650 if (message)
651 vfprintf (stderr, message, ap);
652
653 fprintf (stderr, "\n");
654 }
655 template <> inline void
_hb_debug_msg_va(const char * what HB_UNUSED,const void * obj HB_UNUSED,const char * func HB_UNUSED,bool indented HB_UNUSED,unsigned int level HB_UNUSED,int level_dir HB_UNUSED,const char * message HB_UNUSED,va_list ap HB_UNUSED)656 _hb_debug_msg_va<0> (const char *what HB_UNUSED,
657 const void *obj HB_UNUSED,
658 const char *func HB_UNUSED,
659 bool indented HB_UNUSED,
660 unsigned int level HB_UNUSED,
661 int level_dir HB_UNUSED,
662 const char *message HB_UNUSED,
663 va_list ap HB_UNUSED) {}
664
665 template <int max_level> static inline void
666 _hb_debug_msg (const char *what,
667 const void *obj,
668 const char *func,
669 bool indented,
670 unsigned int level,
671 int level_dir,
672 const char *message,
673 ...) HB_PRINTF_FUNC(7, 8);
674 template <int max_level> static inline void
_hb_debug_msg(const char * what,const void * obj,const char * func,bool indented,unsigned int level,int level_dir,const char * message,...)675 _hb_debug_msg (const char *what,
676 const void *obj,
677 const char *func,
678 bool indented,
679 unsigned int level,
680 int level_dir,
681 const char *message,
682 ...)
683 {
684 va_list ap;
685 va_start (ap, message);
686 _hb_debug_msg_va<max_level> (what, obj, func, indented, level, level_dir, message, ap);
687 va_end (ap);
688 }
689 template <> inline void
690 _hb_debug_msg<0> (const char *what HB_UNUSED,
691 const void *obj HB_UNUSED,
692 const char *func HB_UNUSED,
693 bool indented HB_UNUSED,
694 unsigned int level HB_UNUSED,
695 int level_dir HB_UNUSED,
696 const char *message HB_UNUSED,
697 ...) HB_PRINTF_FUNC(7, 8);
698 template <> inline void
_hb_debug_msg(const char * what HB_UNUSED,const void * obj HB_UNUSED,const char * func HB_UNUSED,bool indented HB_UNUSED,unsigned int level HB_UNUSED,int level_dir HB_UNUSED,const char * message HB_UNUSED,...)699 _hb_debug_msg<0> (const char *what HB_UNUSED,
700 const void *obj HB_UNUSED,
701 const char *func HB_UNUSED,
702 bool indented HB_UNUSED,
703 unsigned int level HB_UNUSED,
704 int level_dir HB_UNUSED,
705 const char *message HB_UNUSED,
706 ...) {}
707
708 #define DEBUG_MSG_LEVEL(WHAT, OBJ, LEVEL, LEVEL_DIR, ...) _hb_debug_msg<HB_DEBUG_##WHAT> (#WHAT, (OBJ), NULL, true, (LEVEL), (LEVEL_DIR), __VA_ARGS__)
709 #define DEBUG_MSG(WHAT, OBJ, ...) _hb_debug_msg<HB_DEBUG_##WHAT> (#WHAT, (OBJ), NULL, false, 0, 0, __VA_ARGS__)
710 #define DEBUG_MSG_FUNC(WHAT, OBJ, ...) _hb_debug_msg<HB_DEBUG_##WHAT> (#WHAT, (OBJ), HB_FUNC, false, 0, 0, __VA_ARGS__)
711
712
713 /*
714 * Printer
715 */
716
717 template <typename T>
718 struct hb_printer_t {
printhb_printer_t719 const char *print (const T&) { return "something"; }
720 };
721
722 template <>
723 struct hb_printer_t<bool> {
printhb_printer_t724 const char *print (bool v) { return v ? "true" : "false"; }
725 };
726
727 template <>
728 struct hb_printer_t<hb_void_t> {
printhb_printer_t729 const char *print (hb_void_t) { return ""; }
730 };
731
732
733 /*
734 * Trace
735 */
736
737 template <typename T>
_hb_warn_no_return(bool returned)738 static inline void _hb_warn_no_return (bool returned)
739 {
740 if (unlikely (!returned)) {
741 fprintf (stderr, "OUCH, returned with no call to TRACE_RETURN. This is a bug, please report.\n");
742 }
743 }
744 template <>
_hb_warn_no_return(bool returned HB_UNUSED)745 /*static*/ inline void _hb_warn_no_return<hb_void_t> (bool returned HB_UNUSED)
746 {}
747
748 template <int max_level, typename ret_t>
749 struct hb_auto_trace_t {
hb_auto_trace_thb_auto_trace_t750 explicit inline hb_auto_trace_t (unsigned int *plevel_,
751 const char *what_,
752 const void *obj_,
753 const char *func,
754 const char *message,
755 ...) : plevel (plevel_), what (what_), obj (obj_), returned (false)
756 {
757 if (plevel) ++*plevel;
758
759 va_list ap;
760 va_start (ap, message);
761 _hb_debug_msg_va<max_level> (what, obj, func, true, plevel ? *plevel : 0, +1, message, ap);
762 va_end (ap);
763 }
~hb_auto_trace_thb_auto_trace_t764 inline ~hb_auto_trace_t (void)
765 {
766 _hb_warn_no_return<ret_t> (returned);
767 if (!returned) {
768 _hb_debug_msg<max_level> (what, obj, NULL, true, plevel ? *plevel : 1, -1, " ");
769 }
770 if (plevel) --*plevel;
771 }
772
rethb_auto_trace_t773 inline ret_t ret (ret_t v, unsigned int line = 0)
774 {
775 if (unlikely (returned)) {
776 fprintf (stderr, "OUCH, double calls to TRACE_RETURN. This is a bug, please report.\n");
777 return v;
778 }
779
780 _hb_debug_msg<max_level> (what, obj, NULL, true, plevel ? *plevel : 1, -1,
781 "return %s (line %d)",
782 hb_printer_t<ret_t>().print (v), line);
783 if (plevel) --*plevel;
784 plevel = NULL;
785 returned = true;
786 return v;
787 }
788
789 private:
790 unsigned int *plevel;
791 const char *what;
792 const void *obj;
793 bool returned;
794 };
795 template <typename ret_t> /* Optimize when tracing is disabled */
796 struct hb_auto_trace_t<0, ret_t> {
hb_auto_trace_thb_auto_trace_t797 explicit inline hb_auto_trace_t (unsigned int *plevel_ HB_UNUSED,
798 const char *what HB_UNUSED,
799 const void *obj HB_UNUSED,
800 const char *func HB_UNUSED,
801 const char *message HB_UNUSED,
802 ...) {}
803
rethb_auto_trace_t804 inline ret_t ret (ret_t v, unsigned int line HB_UNUSED = 0) { return v; }
805 };
806
807 #define TRACE_RETURN(RET) trace.ret (RET, __LINE__)
808
809 /* Misc */
810
811 template <typename T> class hb_assert_unsigned_t;
812 template <> class hb_assert_unsigned_t<unsigned char> {};
813 template <> class hb_assert_unsigned_t<unsigned short> {};
814 template <> class hb_assert_unsigned_t<unsigned int> {};
815 template <> class hb_assert_unsigned_t<unsigned long> {};
816
817 template <typename T> static inline bool
hb_in_range(T u,T lo,T hi)818 hb_in_range (T u, T lo, T hi)
819 {
820 /* The sizeof() is here to force template instantiation.
821 * I'm sure there are better ways to do this but can't think of
822 * one right now. Declaring a variable won't work as HB_UNUSED
823 * is unsable on some platforms and unused types are less likely
824 * to generate a warning than unused variables. */
825 ASSERT_STATIC (sizeof (hb_assert_unsigned_t<T>) >= 0);
826
827 /* The casts below are important as if T is smaller than int,
828 * the subtract results will become a signed int! */
829 return (T)(u - lo) <= (T)(hi - lo);
830 }
831
832 template <typename T> static inline bool
hb_in_ranges(T u,T lo1,T hi1,T lo2,T hi2)833 hb_in_ranges (T u, T lo1, T hi1, T lo2, T hi2)
834 {
835 return hb_in_range (u, lo1, hi1) || hb_in_range (u, lo2, hi2);
836 }
837
838 template <typename T> static inline bool
hb_in_ranges(T u,T lo1,T hi1,T lo2,T hi2,T lo3,T hi3)839 hb_in_ranges (T u, T lo1, T hi1, T lo2, T hi2, T lo3, T hi3)
840 {
841 return hb_in_range (u, lo1, hi1) || hb_in_range (u, lo2, hi2) || hb_in_range (u, lo3, hi3);
842 }
843
844
845 /* Useful for set-operations on small enums.
846 * For example, for testing "x ∈ {x1, x2, x3}" use:
847 * (FLAG(x) & (FLAG(x1) | FLAG(x2) | FLAG(x3)))
848 */
849 #define FLAG(x) (1<<(x))
850 #define FLAG_RANGE(x,y) (ASSERT_STATIC_EXPR_ZERO ((x) < (y)) + FLAG(y+1) - FLAG(x))
851
852
853 template <typename T, typename T2> static inline void
hb_bubble_sort(T * array,unsigned int len,int (* compar)(const T *,const T *),T2 * array2)854 hb_bubble_sort (T *array, unsigned int len, int(*compar)(const T *, const T *), T2 *array2)
855 {
856 if (unlikely (!len))
857 return;
858
859 unsigned int k = len - 1;
860 do {
861 unsigned int new_k = 0;
862
863 for (unsigned int j = 0; j < k; j++)
864 if (compar (&array[j], &array[j+1]) > 0)
865 {
866 {
867 T t;
868 t = array[j];
869 array[j] = array[j + 1];
870 array[j + 1] = t;
871 }
872 if (array2)
873 {
874 T2 t;
875 t = array2[j];
876 array2[j] = array2[j + 1];
877 array2[j + 1] = t;
878 }
879
880 new_k = j;
881 }
882 k = new_k;
883 } while (k);
884 }
885
886 template <typename T> static inline void
hb_bubble_sort(T * array,unsigned int len,int (* compar)(const T *,const T *))887 hb_bubble_sort (T *array, unsigned int len, int(*compar)(const T *, const T *))
888 {
889 hb_bubble_sort (array, len, compar, (int *) NULL);
890 }
891
892 static inline hb_bool_t
hb_codepoint_parse(const char * s,unsigned int len,int base,hb_codepoint_t * out)893 hb_codepoint_parse (const char *s, unsigned int len, int base, hb_codepoint_t *out)
894 {
895 /* Pain because we don't know whether s is nul-terminated. */
896 char buf[64];
897 len = MIN (ARRAY_LENGTH (buf) - 1, len);
898 strncpy (buf, s, len);
899 buf[len] = '\0';
900
901 char *end;
902 errno = 0;
903 unsigned long v = strtoul (buf, &end, base);
904 if (errno) return false;
905 if (*end) return false;
906 *out = v;
907 return true;
908 }
909
910
911 /* Global runtime options. */
912
913 struct hb_options_t
914 {
915 unsigned int initialized : 1;
916 unsigned int uniscribe_bug_compatible : 1;
917 };
918
919 union hb_options_union_t {
920 unsigned int i;
921 hb_options_t opts;
922 };
923 ASSERT_STATIC (sizeof (int) == sizeof (hb_options_union_t));
924
925 HB_INTERNAL void
926 _hb_options_init (void);
927
928 extern HB_INTERNAL hb_options_union_t _hb_options;
929
930 static inline hb_options_t
hb_options(void)931 hb_options (void)
932 {
933 if (unlikely (!_hb_options.i))
934 _hb_options_init ();
935
936 return _hb_options.opts;
937 }
938
939
940 #endif /* HB_PRIVATE_HH */
941