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