tests/utils/tap.h

   1 /*
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (C) 2004 Nik Clayton
   5  * Copyright (C) 2017 Jérémie Galarneau
   6  */
   7
   8 #ifdef __cplusplus
   9 extern "C" {
  10 #endif
  11
  12 /* '## __VA_ARGS__' is a gcc'ism. C99 doesn't allow the token pasting
  13    and requires the caller to add the final comma if they've ommitted
  14    the optional arguments */
  15 #ifdef __GNUC__
  16 # define ok(e, test, ...) ((e) ?                                        \
  17                            _gen_result(1, __func__, __FILE__, __LINE__, \
  18                                        test, ## __VA_ARGS__) :          \
  19                            _gen_result(0, __func__, __FILE__, __LINE__, \
  20                                        test, ## __VA_ARGS__))
  21
  22 # define ok1(e) ((e) ?                                                  \
  23                  _gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \
  24                  _gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))
  25
  26 # define pass(test, ...) ok(1, test, ## __VA_ARGS__);
  27 # define fail(test, ...) ok(0, test, ## __VA_ARGS__);
  28
  29 # define skip_start(test, n, fmt, ...)                  \
  30         do {                                            \
  31                 if((test)) {                            \
  32                         skip(n, fmt, ## __VA_ARGS__);   \
  33                         continue;                       \
  34                 }
  35 #elif __STDC_VERSION__ >= 199901L /* __GNUC__ */
  36 # define ok(e, ...) ((e) ?                                              \
  37                      _gen_result(1, __func__, __FILE__, __LINE__,       \
  38                                  __VA_ARGS__) :                         \
  39                      _gen_result(0, __func__, __FILE__, __LINE__,       \
  40                                  __VA_ARGS__))
  41
  42 # define ok1(e) ((e) ?                                                  \
  43                  _gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \
  44                  _gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))
  45
  46 # define pass(...) ok(1, __VA_ARGS__);
  47 # define fail(...) ok(0, __VA_ARGS__);
  48
  49 # define skip_start(test, n, ...)                       \
  50         do {                                            \
  51                 if((test)) {                            \
  52                         skip(n,  __VA_ARGS__);          \
  53                         continue;                       \
  54                 }
  55 #else /* __STDC_VERSION__ */
  56 # error "Needs gcc or C99 compiler for variadic macros."
  57 #endif /* __STDC_VERSION__ */
  58
  59 #define skip_end() } while(0);
  60
  61 #ifdef __MINGW_PRINTF_FORMAT
  62 # define TAP_PRINTF_FORMAT __MINGW_PRINTF_FORMAT
  63 #else
  64 # define TAP_PRINTF_FORMAT printf
  65 #endif
  66
  67 __attribute__((format(TAP_PRINTF_FORMAT, 5, 6)))
  68 unsigned int _gen_result(int, const char *, const char *, unsigned int, const char *, ...);
  69
  70 int plan_no_plan(void);
  71 __attribute__((noreturn))
  72 int plan_skip_all(const char *);
  73 int plan_tests(unsigned int);
  74
  75 __attribute__((format(TAP_PRINTF_FORMAT, 1, 2)))
  76 unsigned int diag(const char *, ...);
  77 void diag_multiline(const char *);
  78
  79 __attribute__((format(TAP_PRINTF_FORMAT, 2, 3)))
  80 int skip(unsigned int, const char *, ...);
  81
  82 __attribute__((format(TAP_PRINTF_FORMAT, 1, 2)))
  83 void todo_start(const char *, ...);
  84 void todo_end(void);
  85
  86 int exit_status(void);
  87
  88 void tap_disable(void);
  89
  90 unsigned int rdiag_start(void);
  91 __attribute__((format(TAP_PRINTF_FORMAT, 1, 2)))
  92 unsigned int rdiag(const char *fmt, ...);
  93 unsigned int rdiag_end(void);
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif