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