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

/*
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (C) 2004 Nik Clayton
 * Copyright (C) 2017 Jérémie Galarneau
 */

#ifdef __cplusplus
extern "C" {
#endif

/* '## __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);

#ifdef __MINGW_PRINTF_FORMAT
# define TAP_PRINTF_FORMAT __MINGW_PRINTF_FORMAT
#else
# define TAP_PRINTF_FORMAT printf
#endif

__attribute__((format(TAP_PRINTF_FORMAT, 5, 6)))
unsigned int _gen_result(int, const char *, const char *, unsigned int, const char *, ...);

int plan_no_plan(void);
__attribute__((noreturn))
int plan_skip_all(const char *);
int plan_tests(unsigned int);

__attribute__((format(TAP_PRINTF_FORMAT, 1, 2)))
unsigned int diag(const char *, ...);
void diag_multiline(const char *);

__attribute__((format(TAP_PRINTF_FORMAT, 2, 3)))
int skip(unsigned int, const char *, ...);

__attribute__((format(TAP_PRINTF_FORMAT, 1, 2)))
void todo_start(const char *, ...);
void todo_end(void);

int exit_status(void);

#ifdef __cplusplus
}
#endif
Commit	Line	Data
9f4a25d3	1	/*
9d16b343 MJ	2	* SPDX-License-Identifier: BSD-2-Clause
9d16b343 MJ	3	*
9f4a25d3 SM	4	* Copyright (C) 2004 Nik Clayton
9f4a25d3 SM	5	* Copyright (C) 2017 Jérémie Galarneau
86a96e6c CB	6	*/
86a96e6c CB	7
7966af57 SM	8	#ifdef __cplusplus
	9	extern "C" {
	10	#endif
	11
86a96e6c CB	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
4f002736 SM	26	# define pass(test, ...) ok(1, test, ## __VA_ARGS__)
4f002736 SM	27	# define fail(test, ...) ok(0, test, ## __VA_ARGS__)
86a96e6c CB	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
4f002736 SM	46	# define pass(...) ok(1, __VA_ARGS__)
4f002736 SM	47	# define fail(...) ok(0, __VA_ARGS__)
86a96e6c CB	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
9f4a25d3 SM	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)))
b53d4e59	68	unsigned int _gen_result(int, const char , const char , unsigned int, const char *, ...);
86a96e6c CB	69
86a96e6c CB	70	int plan_no_plan(void);
9f4a25d3 SM	71	__attribute__((noreturn))
9f4a25d3 SM	72	int plan_skip_all(const char *);
86a96e6c CB	73	int plan_tests(unsigned int);
86a96e6c CB	74
9f4a25d3	75	__attribute__((format(TAP_PRINTF_FORMAT, 1, 2)))
b53d4e59	76	unsigned int diag(const char *, ...);
9f4a25d3	77	void diag_multiline(const char *);
86a96e6c	78
9f4a25d3	79	__attribute__((format(TAP_PRINTF_FORMAT, 2, 3)))
b53d4e59	80	int skip(unsigned int, const char *, ...);
86a96e6c	81
9f4a25d3 SM	82	__attribute__((format(TAP_PRINTF_FORMAT, 1, 2)))
9f4a25d3 SM	83	void todo_start(const char *, ...);
86a96e6c CB	84	void todo_end(void);
	85
	86	int exit_status(void);
7966af57 SM	87
	88	#ifdef __cplusplus
	89	}
	90	#endif