Fix REUSE licensing/copyright issues in `tests/utils`

[babeltrace.git] / src / common / macros.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 */

#ifndef _BABELTRACE_INTERNAL_H
#define _BABELTRACE_INTERNAL_H

#ifdef __cplusplus
extern "C" {
#endif

#ifdef __cplusplus
#define BT_EXTERN_C extern "C"
#else
#define BT_EXTERN_C
#endif

#define bt_max_t(type, a, b)	\
	((type) (a) > (type) (b) ? (type) (a) : (type) (b))

/*
 * BT_EXPORT: set the visibility for exported functions.
 */
#if defined(_WIN32) || defined(__CYGWIN__)
#define BT_EXPORT
#else
#define BT_EXPORT __attribute__((visibility("default")))
#endif

/*
 * Yield `ref`'s value while setting `ref` to NULL.
 *
 * This can be used to give a strong reference to a callee:
 *
 *   add_foo_to_list(list, BT_MOVE_REF(foo));
 *
 * or in a simple assignment:
 *
 *   my_struct->foo = BT_MOVE_REF(foo);
 *
 * When moving a reference in a function call, the reference is given to the
 * callee even if that function call fails, so make sure the called function
 * is written accordingly.
 */

#define BT_MOVE_REF(ref) 		\
	({				\
		__typeof__(ref) _ref = ref;	\
		ref = NULL;		\
		_ref;			\
	})

/* Wrapper for g_array_index that adds bound checking.  */
#define bt_g_array_index(a, t, i)		\
	g_array_index((a), t, ({ BT_ASSERT_DBG((i) < (a)->len); (i); }))

/*
 * Copied from:
 * <https://stackoverflow.com/questions/37411809/how-to-elegantly-fix-this-unused-variable-warning/37412551#37412551>:
 *
 * * sizeof() ensures that the expression is not evaluated at all, so
 *   its side-effects don't happen. That is to be consistent with the
 *   usual behaviour of debug-only constructs, such as assert().
 *
 * * `((_expr), 0)` uses the comma operator to swallow the actual type
 *   of `(_expr)`. This is to prevent VLAs from triggering evaluation.
 *
 * * `(void)` explicitly ignores the result of `(_expr)` and sizeof() so
 *   no "unused value" warning appears.
 */

#define BT_USE_EXPR(_expr)		((void) sizeof((void) (_expr), 0))
#define BT_USE_EXPR2(_expr1, _expr2)					\
	((void) sizeof((void) (_expr1), (void) (_expr2), 0))
#define BT_USE_EXPR3(_expr1, _expr2, _expr3)				\
	((void) sizeof((void) (_expr1), (void) (_expr2), (void) (_expr3), 0))
#define BT_USE_EXPR4(_expr1, _expr2, _expr3, _expr4)			\
	((void) sizeof((void) (_expr1), (void) (_expr2),		\
		(void) (_expr3), (void) (_expr4), 0))
#define BT_USE_EXPR5(_expr1, _expr2, _expr3, _expr4, _expr5)		\
	((void) sizeof((void) (_expr1), (void) (_expr2),		\
		(void) (_expr3), (void) (_expr4), (void) (_expr5), 0))

#if defined __clang__
#  if __has_warning("-Wunused-but-set-variable")
#    define BT_DIAG_IGNORE_UNUSED_BUT_SET_VARIABLE \
	_Pragma("GCC diagnostic ignored \"-Wunused-but-set-variable\"")
#  endif
#endif

#if !defined BT_DIAG_IGNORE_UNUSED_BUT_SET_VARIABLE
#  define BT_DIAG_IGNORE_UNUSED_BUT_SET_VARIABLE
#endif

#ifdef __cplusplus
}
#endif

#endif