tap/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 omitted
  29    the optional arguments */
  30 #ifdef __GNUC__
  31 #       define ok(e, test, ...)                                                                                                               \
  32                 ((e) ? _gen_result(1, __func__, __FILE__, __LINE__, test, ##__VA_ARGS__)                                                           \
  33                          : _gen_result(0, __func__, __FILE__, __LINE__, test, ##__VA_ARGS__))
  34
  35 #       define ok1(e) ((e) ? _gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : _gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))
  36
  37 #       define pass(test, ...) ok(1, test, ##__VA_ARGS__);
  38 #       define fail(test, ...) ok(0, test, ##__VA_ARGS__);
  39
  40 #       define skip_start(test, n, fmt, ...)                                                                                                  \
  41                 do {                                                                                                                               \
  42                         if ((test)) {                                                                                                                  \
  43                                 skip(n, fmt, ##__VA_ARGS__);                                                                                               \
  44                                 continue;                                                                                                                  \
  45                         }
  46 #else /* __GNUC__ */
  47 /* The original tap.h used to test if __STDC_VERSION__ >= 199901L here. This
  48  * doesn't seem to work on HP-UX even though the code compile fine. I'm not
  49  * sure how to add an exception here for HP-UX so I just removed the check
  50  * for now */
  51 #       define ok(e, ...)                                                                                                                     \
  52                 ((e) ? _gen_result(1, __func__, __FILE__, __LINE__, __VA_ARGS__) : _gen_result(0, __func__, __FILE__, __LINE__, __VA_ARGS__))
  53
  54 #       define ok1(e) ((e) ? _gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : _gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))
  55
  56 #       define pass(...) ok(1, __VA_ARGS__);
  57 #       define fail(...) ok(0, __VA_ARGS__);
  58
  59 #       define skip_start(test, n, ...)                                                                                                       \
  60                 do {                                                                                                                               \
  61                         if ((test)) {                                                                                                                  \
  62                                 skip(n, __VA_ARGS__);                                                                                                      \
  63                                 continue;                                                                                                                  \
  64                         }
  65 #endif /* __GNUC__ */
  66
  67 #define skip_end                                                                                                                           \
  68         }                                                                                                                                      \
  69         while (0)                                                                                                                              \
  70                 ;
  71
  72 unsigned int _gen_result(int, const char *, char *, unsigned int, char *, ...);
  73
  74 int plan_no_plan(void);
  75 int plan_skip_all(char *);
  76 int plan_tests(unsigned int);
  77
  78 unsigned int diag(char *, ...);
  79
  80 int skip(unsigned int, char *, ...);
  81
  82 void todo_start(char *, ...);
  83 void todo_end(void);
  84
  85 int exit_status(void);