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#include <stdio.h>
37
38HB_BEGIN_DECLS
39
40/* Just in case */
41#undef G_DISABLE_ASSERT
42
43
44/* Misc */
45
46/* This is too ugly to be public API, but quite handy. */
47#define HB_TAG_CHAR4(s)   (HB_TAG(((const char *) s)[0], \
48				  ((const char *) s)[1], \
49				  ((const char *) s)[2], \
50				  ((const char *) s)[3]))
51
52
53static inline const char *
54srcdir (void)
55{
56  static const char *s;
57
58  if (!s) {
59    s = getenv ("srcdir");
60
61#ifdef SRCDIR
62    if (!s || !s[0])
63      s = SRCDIR;
64#endif
65
66    if (!s || !s[0])
67      s = ".";
68  }
69
70  return s;
71}
72
73
74/* Helpers */
75
76static inline void
77hb_test_init (int *argc, char ***argv)
78{
79  g_test_init (argc, argv, NULL);
80}
81
82static inline int
83hb_test_run (void)
84{
85  return g_test_run ();
86}
87
88
89/* Bugzilla helpers */
90
91static inline void
92hb_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
102static inline void
103hb_test_bug_freedesktop (unsigned int number)
104{
105  hb_test_bug ("http://bugs.freedesktop.org/", number);
106}
107
108static inline void
109hb_test_bug_gnome (unsigned int number)
110{
111  hb_test_bug ("http://bugzilla.gnome.org/", number);
112}
113
114static inline void
115hb_test_bug_mozilla (unsigned int number)
116{
117  hb_test_bug ("http://bugzilla.mozilla.org/", number);
118}
119
120static inline void
121hb_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. */
131static inline char *
132hb_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)
149typedef GTestFunc        hb_test_func_t;
150typedef GTestDataFunc    hb_test_data_func_t;
151typedef GTestFixtureFunc hb_test_fixture_func_t;
152#else
153typedef void (*hb_test_func_t)         (void);
154typedef void (*hb_test_data_func_t)    (gconstpointer user_data);
155typedef void (*hb_test_fixture_func_t) (void);
156#endif
157
158#if !GLIB_CHECK_VERSION(2,30,0)
159#define g_test_fail() g_error("Test failed")
160#endif
161
162static inline void
163hb_test_add_func (const char *test_path,
164		  hb_test_func_t   test_func)
165{
166  char *normal_path = hb_test_normalize_path (test_path);
167  g_test_add_func (normal_path, test_func);
168  g_free (normal_path);
169}
170#define hb_test_add(Func) hb_test_add_func (#Func, Func)
171
172static inline void
173hb_test_add_func_flavor (const char *test_path,
174			 const char *flavor,
175			 hb_test_func_t   test_func)
176{
177  char *path = g_strdup_printf ("%s/%s", test_path, flavor);
178  hb_test_add_func (path, test_func);
179  g_free (path);
180}
181#define hb_test_add_flavor(Flavor, Func) hb_test_add_func (#Func, Flavor, Func)
182
183static inline void
184hb_test_add_data_func (const char          *test_path,
185		       gconstpointer        test_data,
186		       hb_test_data_func_t  test_func)
187{
188  char *normal_path = hb_test_normalize_path (test_path);
189  g_test_add_data_func (normal_path, test_data, test_func);
190  g_free (normal_path);
191}
192#define hb_test_add_data(UserData, Func) hb_test_add_data_func (#Func, UserData, Func)
193
194static inline void
195hb_test_add_data_func_flavor (const char          *test_path,
196			      const char          *flavor,
197			      gconstpointer        test_data,
198			      hb_test_data_func_t  test_func)
199{
200  char *path = g_strdup_printf ("%s/%s", test_path, flavor);
201  hb_test_add_data_func (path, test_data, test_func);
202  g_free (path);
203}
204#define hb_test_add_data_flavor(UserData, Flavor, Func) hb_test_add_data_func_flavor (#Func, Flavor, UserData, Func)
205
206
207static inline void
208hb_test_add_vtable (const char             *test_path,
209		    gsize                   data_size,
210		    gconstpointer           test_data,
211		    hb_test_fixture_func_t  data_setup,
212		    hb_test_fixture_func_t  data_test,
213		    hb_test_fixture_func_t  data_teardown)
214{
215  char *normal_path = hb_test_normalize_path (test_path);
216  g_test_add_vtable (normal_path, data_size, test_data, data_setup, data_test, data_teardown);
217  g_free (normal_path);
218}
219#define hb_test_add_fixture(FixturePrefix, UserData, Func) \
220G_STMT_START { \
221  typedef G_PASTE (FixturePrefix, _t) Fixture; \
222  void (*add_vtable) (const char*, gsize, gconstpointer, \
223		      void (*) (Fixture*, gconstpointer), \
224		      void (*) (Fixture*, gconstpointer), \
225		      void (*) (Fixture*, gconstpointer)) \
226	= (void (*) (const gchar *, gsize, gconstpointer, \
227		     void (*) (Fixture*, gconstpointer), \
228		     void (*) (Fixture*, gconstpointer), \
229		     void (*) (Fixture*, gconstpointer))) hb_test_add_vtable; \
230  add_vtable (#Func, sizeof (G_PASTE (FixturePrefix, _t)), UserData, \
231	      G_PASTE (FixturePrefix, _init), Func, G_PASTE (FixturePrefix, _finish)); \
232} G_STMT_END
233
234static inline void
235hb_test_add_vtable_flavor (const char             *test_path,
236			   const char             *flavor,
237			   gsize                   data_size,
238			   gconstpointer           test_data,
239			   hb_test_fixture_func_t  data_setup,
240			   hb_test_fixture_func_t  data_test,
241			   hb_test_fixture_func_t  data_teardown)
242{
243  char *path = g_strdup_printf ("%s/%s", test_path, flavor);
244  hb_test_add_vtable (path, data_size, test_data, data_setup, data_test, data_teardown);
245  g_free (path);
246}
247#define hb_test_add_fixture_flavor(FixturePrefix, UserData, Flavor, Func) \
248G_STMT_START { \
249  typedef G_PASTE (FixturePrefix, _t) Fixture; \
250  void (*add_vtable) (const char*, const char *, gsize, gconstpointer, \
251		      void (*) (Fixture*, gconstpointer), \
252		      void (*) (Fixture*, gconstpointer), \
253		      void (*) (Fixture*, gconstpointer)) \
254	= (void (*) (const gchar *, const char *, gsize, gconstpointer, \
255		     void (*) (Fixture*, gconstpointer), \
256		     void (*) (Fixture*, gconstpointer), \
257		     void (*) (Fixture*, gconstpointer))) hb_test_add_vtable_flavor; \
258  add_vtable (#Func, Flavor, sizeof (G_PASTE (FixturePrefix, _t)), UserData, \
259	      G_PASTE (FixturePrefix, _init), Func, G_PASTE (FixturePrefix, _finish)); \
260} G_STMT_END
261
262
263HB_END_DECLS
264
265#endif /* HB_TEST_H */
266