test/api/hb-test.h

   1 /*
   2  * Copyright © 2011  Google, 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  * Google Author(s): Behdad Esfahbod
  25  */
  26
  27 #ifndef HB_TEST_H
  28 #define HB_TEST_H
  29
  30 #ifdef HAVE_CONFIG_H
  31 #include <config.h>
  32 #endif
  33
  34 #include <hb-glib.h>
  35
  36 #include <stdlib.h>
  37 #include <string.h>
  38 #include <stdio.h>
  39
  40 HB_BEGIN_DECLS
  41
  42 /* Just in case */
  43 #undef G_DISABLE_ASSERT
  44
  45
  46 /* Misc */
  47
  48 /* This is too ugly to be public API, but quite handy. */
  49 #define HB_TAG_CHAR4(s)   (HB_TAG(((const char *) s)[0], \
  50                                   ((const char *) s)[1], \
  51                                   ((const char *) s)[2], \
  52                                   ((const char *) s)[3]))
  53
  54
  55 static inline const char *
  56 srcdir (void)
  57 {
  58   static const char *s;
  59
  60   if (!s) {
  61     s = getenv ("srcdir");
  62
  63 #ifdef SRCDIR
  64     if (!s || !s[0])
  65       s = SRCDIR;
  66 #endif
  67
  68     if (!s || !s[0])
  69       s = ".";
  70   }
  71
  72   return s;
  73 }
  74
  75
  76 /* Helpers */
  77
  78 static inline void
  79 hb_test_init (int *argc, char ***argv)
  80 {
  81   g_test_init (argc, argv, NULL);
  82 }
  83
  84 static inline int
  85 hb_test_run (void)
  86 {
  87   return g_test_run ();
  88 }
  89
  90 /* Bugzilla helpers */
  91
  92 static inline void
  93 hb_test_bug (const char *uri_base, unsigned int number)
  94 {
  95   char *s = g_strdup_printf ("%u", number);
  96
  97   g_test_bug_base (uri_base);
  98   g_test_bug (s);
  99
 100   g_free (s);
 101 }
 102
 103 static inline void
 104 hb_test_bug_freedesktop (unsigned int number)
 105 {
 106   hb_test_bug ("http://bugs.freedesktop.org/", number);
 107 }
 108
 109 static inline void
 110 hb_test_bug_gnome (unsigned int number)
 111 {
 112   hb_test_bug ("http://bugzilla.gnome.org/", number);
 113 }
 114
 115 static inline void
 116 hb_test_bug_mozilla (unsigned int number)
 117 {
 118   hb_test_bug ("http://bugzilla.mozilla.org/", number);
 119 }
 120
 121 static inline void
 122 hb_test_bug_redhat (unsigned int number)
 123 {
 124   hb_test_bug ("http://bugzilla.redhat.com/", number);
 125 }
 126
 127
 128 /* Wrap glib test functions to simplify.  Should have been in glib already. */
 129
 130 /* Drops the "test_" prefix and converts '_' to '/'.
 131  * Essentially builds test path from function name. */
 132 static inline char *
 133 hb_test_normalize_path (const char *path)
 134 {
 135   char *s, *p;
 136
 137   g_assert (0 == strncmp (path, "test_", 5));
 138   path += 4;
 139
 140   s = g_strdup (path);
 141   for (p = s; *p; p++)
 142     if (*p == '_')
 143       *p = '/';
 144
 145   return s;
 146 }
 147
 148
 149 #if GLIB_CHECK_VERSION(2,25,12)
 150 typedef GTestFunc        hb_test_func_t;
 151 typedef GTestDataFunc    hb_test_data_func_t;
 152 typedef GTestFixtureFunc hb_test_fixture_func_t;
 153 #else
 154 typedef void (*hb_test_func_t)         (void);
 155 typedef void (*hb_test_data_func_t)    (gconstpointer user_data);
 156 typedef void (*hb_test_fixture_func_t) (void);
 157 #endif
 158
 159 #if !GLIB_CHECK_VERSION(2,30,0)
 160 #define g_test_fail() g_error("Test failed")
 161 #endif
 162 #ifndef g_assert_true
 163 #define g_assert_true g_assert
 164 #endif
 165 #ifndef g_assert_cmpmem
 166 #define g_assert_cmpmem(m1, l1, m2, l2) g_assert_true (l1 == l2 && memcmp (m1, m2, l1) == 0)
 167 #endif
 168
 169 static inline void hb_test_assert_blobs_equal (hb_blob_t *expected_blob, hb_blob_t *actual_blob)
 170 {
 171   unsigned int expected_length, actual_length;
 172   const char *raw_expected = hb_blob_get_data (expected_blob, &expected_length);
 173   const char *raw_actual = hb_blob_get_data (actual_blob, &actual_length);
 174   g_assert_cmpint(expected_length, ==, actual_length);
 175   g_assert_cmpint(0, ==, memcmp(raw_expected, raw_actual, expected_length));
 176 }
 177
 178 static inline void
 179 hb_test_add_func (const char *test_path,
 180                   hb_test_func_t   test_func)
 181 {
 182   char *normal_path = hb_test_normalize_path (test_path);
 183   g_test_add_func (normal_path, test_func);
 184   g_free (normal_path);
 185 }
 186 #define hb_test_add(Func) hb_test_add_func (#Func, Func)
 187
 188 static inline void
 189 hb_test_add_func_flavor (const char *test_path,
 190                          const char *flavor,
 191                          hb_test_func_t   test_func)
 192 {
 193   char *path = g_strdup_printf ("%s/%s", test_path, flavor);
 194   hb_test_add_func (path, test_func);
 195   g_free (path);
 196 }
 197 #define hb_test_add_flavor(Flavor, Func) hb_test_add_func (#Func, Flavor, Func)
 198
 199 static inline void
 200 hb_test_add_data_func (const char          *test_path,
 201                        gconstpointer        test_data,
 202                        hb_test_data_func_t  test_func)
 203 {
 204   char *normal_path = hb_test_normalize_path (test_path);
 205   g_test_add_data_func (normal_path, test_data, test_func);
 206   g_free (normal_path);
 207 }
 208 #define hb_test_add_data(UserData, Func) hb_test_add_data_func (#Func, UserData, Func)
 209
 210 static inline void
 211 hb_test_add_data_func_flavor (const char          *test_path,
 212                               const char          *flavor,
 213                               gconstpointer        test_data,
 214                               hb_test_data_func_t  test_func)
 215 {
 216   char *path = g_strdup_printf ("%s/%s", test_path, flavor);
 217   hb_test_add_data_func (path, test_data, test_func);
 218   g_free (path);
 219 }
 220 #define hb_test_add_data_flavor(UserData, Flavor, Func) hb_test_add_data_func_flavor (#Func, Flavor, UserData, Func)
 221
 222
 223 static inline void
 224 hb_test_add_vtable (const char             *test_path,
 225                     gsize                   data_size,
 226                     gconstpointer           test_data,
 227                     hb_test_fixture_func_t  data_setup,
 228                     hb_test_fixture_func_t  data_test,
 229                     hb_test_fixture_func_t  data_teardown)
 230 {
 231   char *normal_path = hb_test_normalize_path (test_path);
 232   g_test_add_vtable (normal_path, data_size, test_data, data_setup, data_test, data_teardown);
 233   g_free (normal_path);
 234 }
 235 #define hb_test_add_fixture(FixturePrefix, UserData, Func) \
 236 G_STMT_START { \
 237   typedef G_PASTE (FixturePrefix, _t) Fixture; \
 238   void (*add_vtable) (const char*, gsize, gconstpointer, \
 239                       void (*) (Fixture*, gconstpointer), \
 240                       void (*) (Fixture*, gconstpointer), \
 241                       void (*) (Fixture*, gconstpointer)) \
 242         = (void (*) (const gchar *, gsize, gconstpointer, \
 243                      void (*) (Fixture*, gconstpointer), \
 244                      void (*) (Fixture*, gconstpointer), \
 245                      void (*) (Fixture*, gconstpointer))) hb_test_add_vtable; \
 246   add_vtable (#Func, sizeof (G_PASTE (FixturePrefix, _t)), UserData, \
 247               G_PASTE (FixturePrefix, _init), Func, G_PASTE (FixturePrefix, _finish)); \
 248 } G_STMT_END
 249
 250 static inline void
 251 hb_test_add_vtable_flavor (const char             *test_path,
 252                            const char             *flavor,
 253                            gsize                   data_size,
 254                            gconstpointer           test_data,
 255                            hb_test_fixture_func_t  data_setup,
 256                            hb_test_fixture_func_t  data_test,
 257                            hb_test_fixture_func_t  data_teardown)
 258 {
 259   char *path = g_strdup_printf ("%s/%s", test_path, flavor);
 260   hb_test_add_vtable (path, data_size, test_data, data_setup, data_test, data_teardown);
 261   g_free (path);
 262 }
 263 #define hb_test_add_fixture_flavor(FixturePrefix, UserData, Flavor, Func) \
 264 G_STMT_START { \
 265   typedef G_PASTE (FixturePrefix, _t) Fixture; \
 266   void (*add_vtable) (const char*, const char *, gsize, gconstpointer, \
 267                       void (*) (Fixture*, gconstpointer), \
 268                       void (*) (Fixture*, gconstpointer), \
 269                       void (*) (Fixture*, gconstpointer)) \
 270         = (void (*) (const gchar *, const char *, gsize, gconstpointer, \
 271                      void (*) (Fixture*, gconstpointer), \
 272                      void (*) (Fixture*, gconstpointer), \
 273                      void (*) (Fixture*, gconstpointer))) hb_test_add_vtable_flavor; \
 274   add_vtable (#Func, Flavor, sizeof (G_PASTE (FixturePrefix, _t)), UserData, \
 275               G_PASTE (FixturePrefix, _init), Func, G_PASTE (FixturePrefix, _finish)); \
 276 } G_STMT_END
 277
 278
 279 HB_END_DECLS
 280
 281 #endif /* HB_TEST_H */