[lttng-tools.git] / tests / utils / tap / tap.h

/*-
 * Copyright (C) 2004 Nik Clayton
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/* '## __VA_ARGS__' is a gcc'ism. C99 doesn't allow the token pasting
   and requires the caller to add the final comma if they've ommitted
   the optional arguments */
#ifdef __GNUC__
# define ok(e, test, ...) ((e) ?					\
			   _gen_result(1, __func__, __FILE__, __LINE__,	\
				       test, ## __VA_ARGS__) :		\
			   _gen_result(0, __func__, __FILE__, __LINE__,	\
				       test, ## __VA_ARGS__))

# define ok1(e) ((e) ?							\
		 _gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \
		 _gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))

# define pass(test, ...) ok(1, test, ## __VA_ARGS__)
# define fail(test, ...) ok(0, test, ## __VA_ARGS__)

# define skip_start(test, n, fmt, ...)			\
	do {						\
		if((test)) {				\
			skip(n, fmt, ## __VA_ARGS__);	\
			continue;			\
		}
#elif __STDC_VERSION__ >= 199901L /* __GNUC__ */
# define ok(e, ...) ((e) ?						\
		     _gen_result(1, __func__, __FILE__, __LINE__,	\
				 __VA_ARGS__) :				\
		     _gen_result(0, __func__, __FILE__, __LINE__,	\
				 __VA_ARGS__))

# define ok1(e) ((e) ?							\
		 _gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \
		 _gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))

# define pass(...) ok(1, __VA_ARGS__)
# define fail(...) ok(0, __VA_ARGS__)

# define skip_start(test, n, ...)			\
	do {						\
		if((test)) {				\
			skip(n,  __VA_ARGS__);		\
			continue;			\
		}
#else /* __STDC_VERSION__ */
# error "Needs gcc or C99 compiler for variadic macros."
#endif /* __STDC_VERSION__ */

#define skip_end() } while(0);

unsigned int _gen_result(int, const char *, const char *, unsigned int, const char *, ...);

int plan_no_plan(void);
int plan_skip_all(char *);
int plan_tests(unsigned int);

unsigned int diag(const char *, ...);

int skip(unsigned int, const char *, ...);

void todo_start(char *, ...);
void todo_end(void);

int exit_status(void);
Commit	Line	Data
86a96e6c	1	/*-
9d16b343	2	* Copyright (C) 2004 Nik Clayton
86a96e6c CB	3	* All rights reserved.
86a96e6c CB	4	*
9d16b343 MJ	5	* SPDX-License-Identifier: BSD-2-Clause
9d16b343 MJ	6	*
86a96e6c CB	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	/* '## __VA_ARGS__' is a gcc'ism. C99 doesn't allow the token pasting
	30	and requires the caller to add the final comma if they've ommitted
	31	the optional arguments */
	32	#ifdef __GNUC__
	33	# define ok(e, test, ...) ((e) ? \
	34	_gen_result(1, __func__, __FILE__, __LINE__, \
	35	test, ## __VA_ARGS__) : \
	36	_gen_result(0, __func__, __FILE__, __LINE__, \
	37	test, ## __VA_ARGS__))
	38
	39	# define ok1(e) ((e) ? \
	40	_gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \
	41	_gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))
	42
4f002736 SM	43	# define pass(test, ...) ok(1, test, ## __VA_ARGS__)
4f002736 SM	44	# define fail(test, ...) ok(0, test, ## __VA_ARGS__)
86a96e6c CB	45
	46	# define skip_start(test, n, fmt, ...) \
	47	do { \
	48	if((test)) { \
	49	skip(n, fmt, ## __VA_ARGS__); \
	50	continue; \
	51	}
	52	#elif __STDC_VERSION__ >= 199901L /* __GNUC__ */
	53	# define ok(e, ...) ((e) ? \
	54	_gen_result(1, __func__, __FILE__, __LINE__, \
	55	__VA_ARGS__) : \
	56	_gen_result(0, __func__, __FILE__, __LINE__, \
	57	__VA_ARGS__))
	58
	59	# define ok1(e) ((e) ? \
	60	_gen_result(1, __func__, __FILE__, __LINE__, "%s", #e) : \
	61	_gen_result(0, __func__, __FILE__, __LINE__, "%s", #e))
	62
4f002736 SM	63	# define pass(...) ok(1, __VA_ARGS__)
4f002736 SM	64	# define fail(...) ok(0, __VA_ARGS__)
86a96e6c CB	65
	66	# define skip_start(test, n, ...) \
	67	do { \
	68	if((test)) { \
	69	skip(n, __VA_ARGS__); \
	70	continue; \
	71	}
	72	#else /* __STDC_VERSION__ */
	73	# error "Needs gcc or C99 compiler for variadic macros."
	74	#endif /* __STDC_VERSION__ */
	75
	76	#define skip_end() } while(0);
	77
b53d4e59	78	unsigned int _gen_result(int, const char , const char , unsigned int, const char *, ...);
86a96e6c CB	79
	80	int plan_no_plan(void);
	81	int plan_skip_all(char *);
	82	int plan_tests(unsigned int);
	83
b53d4e59	84	unsigned int diag(const char *, ...);
86a96e6c	85
b53d4e59	86	int skip(unsigned int, const char *, ...);
86a96e6c CB	87
	88	void todo_start(char *, ...);
	89	void todo_end(void);
	90
	91	int exit_status(void);