tests/utils/tap/tap.h

   1 /*-
   2  * Copyright (C) 2004 Nik Clayton
   3  * All rights reserved.
   4  *
   5  * SPDX-License-Identifier: BSD-2-Clause
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /* '## __VA_ARGS__' is a gcc'ism. C99 doesn't allow the token pasting
  34    and requires the caller to add the final comma if they've ommitted
  35    the optional arguments */
  36 #ifdef __GNUC__
  37 # define ok(e, test, ...) ((e) ?                                        \
  38                            _gen_result(1, __func__, __FILE__, __LINE__, \
  39                                        test, ## __VA_ARGS__) :          \
  40                            _gen_result(0, __func__, __FILE__, __LINE__, \
  41                                        test, ## __VA_ARGS__))
  42
  43 # define ok1(e) ((e) ?                                                  \
  44                  _gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \
  45                  _gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))
  46
  47 # define pass(test, ...) ok(1, test, ## __VA_ARGS__)
  48 # define fail(test, ...) ok(0, test, ## __VA_ARGS__)
  49
  50 # define skip_start(test, n, fmt, ...)                  \
  51         do {                                            \
  52                 if((test)) {                            \
  53                         skip(n, fmt, ## __VA_ARGS__);   \
  54                         continue;                       \
  55                 }
  56 #elif __STDC_VERSION__ >= 199901L /* __GNUC__ */
  57 # define ok(e, ...) ((e) ?                                              \
  58                      _gen_result(1, __func__, __FILE__, __LINE__,       \
  59                                  __VA_ARGS__) :                         \
  60                      _gen_result(0, __func__, __FILE__, __LINE__,       \
  61                                  __VA_ARGS__))
  62
  63 # define ok1(e) ((e) ?                                                  \
  64                  _gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \
  65                  _gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))
  66
  67 # define pass(...) ok(1, __VA_ARGS__)
  68 # define fail(...) ok(0, __VA_ARGS__)
  69
  70 # define skip_start(test, n, ...)                       \
  71         do {                                            \
  72                 if((test)) {                            \
  73                         skip(n,  __VA_ARGS__);          \
  74                         continue;                       \
  75                 }
  76 #else /* __STDC_VERSION__ */
  77 # error "Needs gcc or C99 compiler for variadic macros."
  78 #endif /* __STDC_VERSION__ */
  79
  80 #define skip_end() } while(0);
  81
  82 unsigned int _gen_result(int, const char *, const char *, unsigned int, const char *, ...);
  83
  84 int plan_no_plan(void);
  85 int plan_skip_all(char *);
  86 int plan_tests(unsigned int);
  87
  88 unsigned int diag(const char *, ...);
  89
  90 int skip(unsigned int, const char *, ...);
  91
  92 void todo_start(char *, ...);
  93 void todo_end(void);
  94
  95 int exit_status(void);
  96
  97 #ifdef __cplusplus
  98 }
  99 #endif