tests/utils/tap.h

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