1/* GLib testing utilities
2 * Copyright (C) 2007 Imendio AB
3 * Authors: Tim Janik
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 */
18
19#ifndef __G_TEST_UTILS_H__
20#define __G_TEST_UTILS_H__
21
22#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
23#error "Only <glib.h> can be included directly."
24#endif
25
26#include <glib/gmessages.h>
27#include <glib/gstring.h>
28#include <glib/gerror.h>
29#include <glib/gslist.h>
30#include <string.h>
31
32G_BEGIN_DECLS
33
34typedef struct GTestCase GTestCase;
35typedef struct GTestSuite GTestSuite;
36typedef void (*GTestFunc) (void);
37typedef void (*GTestDataFunc) (gconstpointer user_data);
38typedef void (*GTestFixtureFunc) (gpointer fixture,
39 gconstpointer user_data);
40
41/* assertion API */
42#define g_assert_cmpstr(s1, cmp, s2) G_STMT_START { \
43 const char *__s1 = (s1), *__s2 = (s2); \
44 if (g_strcmp0 (__s1, __s2) cmp 0) ; else \
45 g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
46 #s1 " " #cmp " " #s2, __s1, #cmp, __s2); \
47 } G_STMT_END
48#define g_assert_cmpint(n1, cmp, n2) G_STMT_START { \
49 gint64 __n1 = (n1), __n2 = (n2); \
50 if (__n1 cmp __n2) ; else \
51 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
52 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'i'); \
53 } G_STMT_END
54#define g_assert_cmpuint(n1, cmp, n2) G_STMT_START { \
55 guint64 __n1 = (n1), __n2 = (n2); \
56 if (__n1 cmp __n2) ; else \
57 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
58 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'i'); \
59 } G_STMT_END
60#define g_assert_cmphex(n1, cmp, n2) G_STMT_START {\
61 guint64 __n1 = (n1), __n2 = (n2); \
62 if (__n1 cmp __n2) ; else \
63 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
64 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'x'); \
65 } G_STMT_END
66#define g_assert_cmpfloat(n1,cmp,n2) G_STMT_START { \
67 long double __n1 = (long double) (n1), __n2 = (long double) (n2); \
68 if (__n1 cmp __n2) ; else \
69 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
70 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'f'); \
71 } G_STMT_END
72#define g_assert_cmpfloat_with_epsilon(n1,n2,epsilon) \
73 G_STMT_START { \
74 double __n1 = (n1), __n2 = (n2), __epsilon = (epsilon); \
75 if (G_APPROX_VALUE (__n1, __n2, __epsilon)) ; else \
76 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
77 #n1 " == " #n2 " (+/- " #epsilon ")", __n1, "==", __n2, 'f'); \
78 } G_STMT_END
79#define g_assert_cmpmem(m1, l1, m2, l2) G_STMT_START {\
80 gconstpointer __m1 = m1, __m2 = m2; \
81 int __l1 = l1, __l2 = l2; \
82 if (__l1 != __l2) \
83 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
84 #l1 " (len(" #m1 ")) == " #l2 " (len(" #m2 "))", \
85 (long double) __l1, "==", (long double) __l2, 'i'); \
86 else if (__l1 != 0 && memcmp (__m1, __m2, __l1) != 0) \
87 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
88 "assertion failed (" #m1 " == " #m2 ")"); \
89 } G_STMT_END
90#define g_assert_cmpvariant(v1, v2) \
91 G_STMT_START \
92 { \
93 GVariant *__v1 = (v1), *__v2 = (v2); \
94 if (!g_variant_equal (__v1, __v2)) \
95 { \
96 gchar *__s1, *__s2, *__msg; \
97 __s1 = g_variant_print (__v1, TRUE); \
98 __s2 = g_variant_print (__v2, TRUE); \
99 __msg = g_strdup_printf ("assertion failed (" #v1 " == " #v2 "): %s does not equal %s", __s1, __s2); \
100 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, __msg); \
101 g_free (__s1); \
102 g_free (__s2); \
103 g_free (__msg); \
104 } \
105 } \
106 G_STMT_END
107#define g_assert_no_error(err) G_STMT_START { \
108 if (err) \
109 g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
110 #err, err, 0, 0); \
111 } G_STMT_END
112#define g_assert_error(err, dom, c) G_STMT_START { \
113 if (!err || (err)->domain != dom || (err)->code != c) \
114 g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
115 #err, err, dom, c); \
116 } G_STMT_END
117#define g_assert_true(expr) G_STMT_START { \
118 if G_LIKELY (expr) ; else \
119 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
120 "'" #expr "' should be TRUE"); \
121 } G_STMT_END
122#define g_assert_false(expr) G_STMT_START { \
123 if G_LIKELY (!(expr)) ; else \
124 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
125 "'" #expr "' should be FALSE"); \
126 } G_STMT_END
127
128/* Use nullptr in C++ to catch misuse of these macros. */
129#if defined(__cplusplus) && __cplusplus >= 201100L
130#define g_assert_null(expr) G_STMT_START { if G_LIKELY ((expr) == nullptr) ; else \
131 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
132 "'" #expr "' should be nullptr"); \
133 } G_STMT_END
134#define g_assert_nonnull(expr) G_STMT_START { \
135 if G_LIKELY ((expr) != nullptr) ; else \
136 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
137 "'" #expr "' should not be nullptr"); \
138 } G_STMT_END
139#else /* not C++ */
140#define g_assert_null(expr) G_STMT_START { if G_LIKELY ((expr) == NULL) ; else \
141 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
142 "'" #expr "' should be NULL"); \
143 } G_STMT_END
144#define g_assert_nonnull(expr) G_STMT_START { \
145 if G_LIKELY ((expr) != NULL) ; else \
146 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
147 "'" #expr "' should not be NULL"); \
148 } G_STMT_END
149#endif
150
151#ifdef G_DISABLE_ASSERT
152#define g_assert_not_reached() G_STMT_START { (void) 0; } G_STMT_END
153#define g_assert(expr) G_STMT_START { (void) 0; } G_STMT_END
154#else /* !G_DISABLE_ASSERT */
155#define g_assert_not_reached() G_STMT_START { g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } G_STMT_END
156#define g_assert(expr) G_STMT_START { \
157 if G_LIKELY (expr) ; else \
158 g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
159 #expr); \
160 } G_STMT_END
161#endif /* !G_DISABLE_ASSERT */
162
163GLIB_AVAILABLE_IN_ALL
164int g_strcmp0 (const char *str1,
165 const char *str2);
166
167/* report performance results */
168GLIB_AVAILABLE_IN_ALL
169void g_test_minimized_result (double minimized_quantity,
170 const char *format,
171 ...) G_GNUC_PRINTF (2, 3);
172GLIB_AVAILABLE_IN_ALL
173void g_test_maximized_result (double maximized_quantity,
174 const char *format,
175 ...) G_GNUC_PRINTF (2, 3);
176
177/* initialize testing framework */
178GLIB_AVAILABLE_IN_ALL
179void g_test_init (int *argc,
180 char ***argv,
181 ...) G_GNUC_NULL_TERMINATED;
182
183/**
184 * G_TEST_OPTION_ISOLATE_DIRS:
185 *
186 * Creates a unique temporary directory for each unit test and uses
187 * g_set_user_dirs() to set XDG directories to point into subdirectories of it
188 * for the duration of the unit test. The directory tree is cleaned up after the
189 * test finishes successfully. Note that this doesn’t take effect until
190 * g_test_run() is called, so calls to (for example) g_get_user_home_dir() will
191 * return the system-wide value when made in a test program’s main() function.
192 *
193 * The following functions will return subdirectories of the temporary directory
194 * when this option is used. The specific subdirectory paths in use are not
195 * guaranteed to be stable API — always use a getter function to retrieve them.
196 *
197 * - g_get_home_dir()
198 * - g_get_user_cache_dir()
199 * - g_get_system_config_dirs()
200 * - g_get_user_config_dir()
201 * - g_get_system_data_dirs()
202 * - g_get_user_data_dir()
203 * - g_get_user_runtime_dir()
204 *
205 * The subdirectories may not be created by the test harness; as with normal
206 * calls to functions like g_get_user_cache_dir(), the caller must be prepared
207 * to create the directory if it doesn’t exist.
208 *
209 * Since: 2.60
210 */
211#define G_TEST_OPTION_ISOLATE_DIRS "isolate_dirs"
212
213/* While we discourage its use, g_assert() is often used in unit tests
214 * (especially in legacy code). g_assert_*() should really be used instead.
215 * g_assert() can be disabled at client program compile time, which can render
216 * tests useless. Highlight that to the user. */
217#ifdef G_DISABLE_ASSERT
218#if defined(G_HAVE_ISO_VARARGS)
219#define g_test_init(argc, argv, ...) \
220 G_STMT_START { \
221 g_printerr ("Tests were compiled with G_DISABLE_ASSERT and are likely no-ops. Aborting.\n"); \
222 exit (1); \
223 } G_STMT_END
224#elif defined(G_HAVE_GNUC_VARARGS)
225#define g_test_init(argc, argv...) \
226 G_STMT_START { \
227 g_printerr ("Tests were compiled with G_DISABLE_ASSERT and are likely no-ops. Aborting.\n"); \
228 exit (1); \
229 } G_STMT_END
230#else /* no varargs */
231 /* do nothing */
232#endif /* varargs support */
233#endif /* G_DISABLE_ASSERT */
234
235/* query testing framework config */
236#define g_test_initialized() (g_test_config_vars->test_initialized)
237#define g_test_quick() (g_test_config_vars->test_quick)
238#define g_test_slow() (!g_test_config_vars->test_quick)
239#define g_test_thorough() (!g_test_config_vars->test_quick)
240#define g_test_perf() (g_test_config_vars->test_perf)
241#define g_test_verbose() (g_test_config_vars->test_verbose)
242#define g_test_quiet() (g_test_config_vars->test_quiet)
243#define g_test_undefined() (g_test_config_vars->test_undefined)
244GLIB_AVAILABLE_IN_2_38
245gboolean g_test_subprocess (void);
246
247/* run all tests under toplevel suite (path: /) */
248GLIB_AVAILABLE_IN_ALL
249int g_test_run (void);
250/* hook up a test functions under test path */
251GLIB_AVAILABLE_IN_ALL
252void g_test_add_func (const char *testpath,
253 GTestFunc test_func);
254
255GLIB_AVAILABLE_IN_ALL
256void g_test_add_data_func (const char *testpath,
257 gconstpointer test_data,
258 GTestDataFunc test_func);
259
260GLIB_AVAILABLE_IN_2_34
261void g_test_add_data_func_full (const char *testpath,
262 gpointer test_data,
263 GTestDataFunc test_func,
264 GDestroyNotify data_free_func);
265
266/* tell about failure */
267GLIB_AVAILABLE_IN_2_30
268void g_test_fail (void);
269GLIB_AVAILABLE_IN_2_38
270void g_test_incomplete (const gchar *msg);
271GLIB_AVAILABLE_IN_2_38
272void g_test_skip (const gchar *msg);
273GLIB_AVAILABLE_IN_2_38
274gboolean g_test_failed (void);
275GLIB_AVAILABLE_IN_2_38
276void g_test_set_nonfatal_assertions (void);
277
278/**
279 * g_test_add:
280 * @testpath: The test path for a new test case.
281 * @Fixture: The type of a fixture data structure.
282 * @tdata: Data argument for the test functions.
283 * @fsetup: The function to set up the fixture data.
284 * @ftest: The actual test function.
285 * @fteardown: The function to tear down the fixture data.
286 *
287 * Hook up a new test case at @testpath, similar to g_test_add_func().
288 * A fixture data structure with setup and teardown functions may be provided,
289 * similar to g_test_create_case().
290 *
291 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
292 * fteardown() callbacks can expect a @Fixture pointer as their first argument
293 * in a type safe manner. They otherwise have type #GTestFixtureFunc.
294 *
295 * Since: 2.16
296 */
297#define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
298 G_STMT_START { \
299 void (*add_vtable) (const char*, \
300 gsize, \
301 gconstpointer, \
302 void (*) (Fixture*, gconstpointer), \
303 void (*) (Fixture*, gconstpointer), \
304 void (*) (Fixture*, gconstpointer)) = (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
305 add_vtable \
306 (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
307 } G_STMT_END
308
309/* add test messages to the test report */
310GLIB_AVAILABLE_IN_ALL
311void g_test_message (const char *format,
312 ...) G_GNUC_PRINTF (1, 2);
313GLIB_AVAILABLE_IN_ALL
314void g_test_bug_base (const char *uri_pattern);
315GLIB_AVAILABLE_IN_ALL
316void g_test_bug (const char *bug_uri_snippet);
317/* measure test timings */
318GLIB_AVAILABLE_IN_ALL
319void g_test_timer_start (void);
320GLIB_AVAILABLE_IN_ALL
321double g_test_timer_elapsed (void); /* elapsed seconds */
322GLIB_AVAILABLE_IN_ALL
323double g_test_timer_last (void); /* repeat last elapsed() result */
324
325/* automatically g_free or g_object_unref upon teardown */
326GLIB_AVAILABLE_IN_ALL
327void g_test_queue_free (gpointer gfree_pointer);
328GLIB_AVAILABLE_IN_ALL
329void g_test_queue_destroy (GDestroyNotify destroy_func,
330 gpointer destroy_data);
331#define g_test_queue_unref(gobject) g_test_queue_destroy (g_object_unref, gobject)
332
333typedef enum {
334 G_TEST_TRAP_SILENCE_STDOUT = 1 << 7,
335 G_TEST_TRAP_SILENCE_STDERR = 1 << 8,
336 G_TEST_TRAP_INHERIT_STDIN = 1 << 9
337} GTestTrapFlags;
338
339GLIB_DEPRECATED_IN_2_38_FOR (g_test_trap_subprocess)
340gboolean g_test_trap_fork (guint64 usec_timeout,
341 GTestTrapFlags test_trap_flags);
342
343typedef enum {
344 G_TEST_SUBPROCESS_INHERIT_STDIN = 1 << 0,
345 G_TEST_SUBPROCESS_INHERIT_STDOUT = 1 << 1,
346 G_TEST_SUBPROCESS_INHERIT_STDERR = 1 << 2
347} GTestSubprocessFlags;
348
349GLIB_AVAILABLE_IN_2_38
350void g_test_trap_subprocess (const char *test_path,
351 guint64 usec_timeout,
352 GTestSubprocessFlags test_flags);
353
354GLIB_AVAILABLE_IN_ALL
355gboolean g_test_trap_has_passed (void);
356GLIB_AVAILABLE_IN_ALL
357gboolean g_test_trap_reached_timeout (void);
358#define g_test_trap_assert_passed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0)
359#define g_test_trap_assert_failed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0)
360#define g_test_trap_assert_stdout(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 2, soutpattern)
361#define g_test_trap_assert_stdout_unmatched(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 3, soutpattern)
362#define g_test_trap_assert_stderr(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 4, serrpattern)
363#define g_test_trap_assert_stderr_unmatched(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 5, serrpattern)
364
365/* provide seed-able random numbers for tests */
366#define g_test_rand_bit() (0 != (g_test_rand_int() & (1 << 15)))
367GLIB_AVAILABLE_IN_ALL
368gint32 g_test_rand_int (void);
369GLIB_AVAILABLE_IN_ALL
370gint32 g_test_rand_int_range (gint32 begin,
371 gint32 end);
372GLIB_AVAILABLE_IN_ALL
373double g_test_rand_double (void);
374GLIB_AVAILABLE_IN_ALL
375double g_test_rand_double_range (double range_start,
376 double range_end);
377
378/*
379 * semi-internal API: non-documented symbols with stable ABI. You
380 * should use the non-internal helper macros instead. However, for
381 * compatibility reason, you may use this semi-internal API.
382 */
383GLIB_AVAILABLE_IN_ALL
384GTestCase* g_test_create_case (const char *test_name,
385 gsize data_size,
386 gconstpointer test_data,
387 GTestFixtureFunc data_setup,
388 GTestFixtureFunc data_test,
389 GTestFixtureFunc data_teardown);
390GLIB_AVAILABLE_IN_ALL
391GTestSuite* g_test_create_suite (const char *suite_name);
392GLIB_AVAILABLE_IN_ALL
393GTestSuite* g_test_get_root (void);
394GLIB_AVAILABLE_IN_ALL
395void g_test_suite_add (GTestSuite *suite,
396 GTestCase *test_case);
397GLIB_AVAILABLE_IN_ALL
398void g_test_suite_add_suite (GTestSuite *suite,
399 GTestSuite *nestedsuite);
400GLIB_AVAILABLE_IN_ALL
401int g_test_run_suite (GTestSuite *suite);
402
403GLIB_AVAILABLE_IN_ALL
404void g_test_trap_assertions (const char *domain,
405 const char *file,
406 int line,
407 const char *func,
408 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
409 const char *pattern);
410GLIB_AVAILABLE_IN_ALL
411void g_assertion_message (const char *domain,
412 const char *file,
413 int line,
414 const char *func,
415 const char *message);
416GLIB_AVAILABLE_IN_ALL
417void g_assertion_message_expr (const char *domain,
418 const char *file,
419 int line,
420 const char *func,
421 const char *expr) G_GNUC_NORETURN;
422GLIB_AVAILABLE_IN_ALL
423void g_assertion_message_cmpstr (const char *domain,
424 const char *file,
425 int line,
426 const char *func,
427 const char *expr,
428 const char *arg1,
429 const char *cmp,
430 const char *arg2);
431GLIB_AVAILABLE_IN_ALL
432void g_assertion_message_cmpnum (const char *domain,
433 const char *file,
434 int line,
435 const char *func,
436 const char *expr,
437 long double arg1,
438 const char *cmp,
439 long double arg2,
440 char numtype);
441GLIB_AVAILABLE_IN_ALL
442void g_assertion_message_error (const char *domain,
443 const char *file,
444 int line,
445 const char *func,
446 const char *expr,
447 const GError *error,
448 GQuark error_domain,
449 int error_code);
450GLIB_AVAILABLE_IN_ALL
451void g_test_add_vtable (const char *testpath,
452 gsize data_size,
453 gconstpointer test_data,
454 GTestFixtureFunc data_setup,
455 GTestFixtureFunc data_test,
456 GTestFixtureFunc data_teardown);
457typedef struct {
458 gboolean test_initialized;
459 gboolean test_quick; /* disable thorough tests */
460 gboolean test_perf; /* run performance tests */
461 gboolean test_verbose; /* extra info */
462 gboolean test_quiet; /* reduce output */
463 gboolean test_undefined; /* run tests that are meant to assert */
464} GTestConfig;
465GLIB_VAR const GTestConfig * const g_test_config_vars;
466
467/* internal logging API */
468typedef enum {
469 G_TEST_RUN_SUCCESS,
470 G_TEST_RUN_SKIPPED,
471 G_TEST_RUN_FAILURE,
472 G_TEST_RUN_INCOMPLETE
473} GTestResult;
474
475typedef enum {
476 G_TEST_LOG_NONE,
477 G_TEST_LOG_ERROR, /* s:msg */
478 G_TEST_LOG_START_BINARY, /* s:binaryname s:seed */
479 G_TEST_LOG_LIST_CASE, /* s:testpath */
480 G_TEST_LOG_SKIP_CASE, /* s:testpath */
481 G_TEST_LOG_START_CASE, /* s:testpath */
482 G_TEST_LOG_STOP_CASE, /* d:status d:nforks d:elapsed */
483 G_TEST_LOG_MIN_RESULT, /* s:blurb d:result */
484 G_TEST_LOG_MAX_RESULT, /* s:blurb d:result */
485 G_TEST_LOG_MESSAGE, /* s:blurb */
486 G_TEST_LOG_START_SUITE,
487 G_TEST_LOG_STOP_SUITE
488} GTestLogType;
489
490typedef struct {
491 GTestLogType log_type;
492 guint n_strings;
493 gchar **strings; /* NULL terminated */
494 guint n_nums;
495 long double *nums;
496} GTestLogMsg;
497typedef struct {
498 /*< private >*/
499 GString *data;
500 GSList *msgs;
501} GTestLogBuffer;
502
503GLIB_AVAILABLE_IN_ALL
504const char* g_test_log_type_name (GTestLogType log_type);
505GLIB_AVAILABLE_IN_ALL
506GTestLogBuffer* g_test_log_buffer_new (void);
507GLIB_AVAILABLE_IN_ALL
508void g_test_log_buffer_free (GTestLogBuffer *tbuffer);
509GLIB_AVAILABLE_IN_ALL
510void g_test_log_buffer_push (GTestLogBuffer *tbuffer,
511 guint n_bytes,
512 const guint8 *bytes);
513GLIB_AVAILABLE_IN_ALL
514GTestLogMsg* g_test_log_buffer_pop (GTestLogBuffer *tbuffer);
515GLIB_AVAILABLE_IN_ALL
516void g_test_log_msg_free (GTestLogMsg *tmsg);
517
518/**
519 * GTestLogFatalFunc:
520 * @log_domain: the log domain of the message
521 * @log_level: the log level of the message (including the fatal and recursion flags)
522 * @message: the message to process
523 * @user_data: user data, set in g_test_log_set_fatal_handler()
524 *
525 * Specifies the prototype of fatal log handler functions.
526 *
527 * Returns: %TRUE if the program should abort, %FALSE otherwise
528 *
529 * Since: 2.22
530 */
531typedef gboolean (*GTestLogFatalFunc) (const gchar *log_domain,
532 GLogLevelFlags log_level,
533 const gchar *message,
534 gpointer user_data);
535GLIB_AVAILABLE_IN_ALL
536void
537g_test_log_set_fatal_handler (GTestLogFatalFunc log_func,
538 gpointer user_data);
539
540GLIB_AVAILABLE_IN_2_34
541void g_test_expect_message (const gchar *log_domain,
542 GLogLevelFlags log_level,
543 const gchar *pattern);
544GLIB_AVAILABLE_IN_2_34
545void g_test_assert_expected_messages_internal (const char *domain,
546 const char *file,
547 int line,
548 const char *func);
549
550typedef enum
551{
552 G_TEST_DIST,
553 G_TEST_BUILT
554} GTestFileType;
555
556GLIB_AVAILABLE_IN_2_38
557gchar * g_test_build_filename (GTestFileType file_type,
558 const gchar *first_path,
559 ...) G_GNUC_NULL_TERMINATED;
560GLIB_AVAILABLE_IN_2_38
561const gchar *g_test_get_dir (GTestFileType file_type);
562GLIB_AVAILABLE_IN_2_38
563const gchar *g_test_get_filename (GTestFileType file_type,
564 const gchar *first_path,
565 ...) G_GNUC_NULL_TERMINATED;
566
567#define g_test_assert_expected_messages() g_test_assert_expected_messages_internal (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC)
568
569G_END_DECLS
570
571#endif /* __G_TEST_UTILS_H__ */
572