150 lines
6.6 KiB
C
150 lines
6.6 KiB
C
/* Common macros used by gnulib tests.
|
|
Copyright (C) 2006-2025 Free Software Foundation, Inc.
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>. */
|
|
|
|
|
|
/* This file contains macros that are used by many gnulib tests.
|
|
Put here only frequently used macros, say, used by 10 tests or more. */
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
|
|
#ifndef FALLTHROUGH
|
|
# if (__GNUC__ >= 7) || (__clang_major__ >= 10)
|
|
# define FALLTHROUGH __attribute__ ((__fallthrough__))
|
|
# else
|
|
# define FALLTHROUGH ((void) 0)
|
|
# endif
|
|
#endif
|
|
|
|
/* Define NO_MAIN_HERE before including this file, if this compilation unit
|
|
does not contain a main() function. */
|
|
|
|
/* Optionally define CONTINUE_AFTER_ASSERT to 1 before including this file,
|
|
if you wish execution to continue after an ASSERT or ASSERT_NO_STDIO
|
|
failure. */
|
|
#ifndef CONTINUE_AFTER_ASSERT
|
|
# define CONTINUE_AFTER_ASSERT 0
|
|
#endif
|
|
|
|
/* Define ASSERT_STREAM before including this file if ASSERT must
|
|
target a stream other than stderr. */
|
|
#ifndef ASSERT_STREAM
|
|
# define ASSERT_STREAM stderr
|
|
#endif
|
|
|
|
/* Define print_stack_trace() to a no-op, if the module 'stack-trace' is not
|
|
in use. */
|
|
#if !GNULIB_STACK_TRACE
|
|
# define print_stack_trace() /* nothing */
|
|
#endif
|
|
|
|
/* Exit status of the test.
|
|
Initialized to EXIT_SUCCESS.
|
|
Set to EXIT_FAILURE when an ASSERT or ASSERT_NO_STDIO fails. */
|
|
/* To satisfy the "one definition rule", we define the variable in the
|
|
compilation unit that contains the main() function. */
|
|
#ifdef NO_MAIN_HERE
|
|
extern int volatile test_exit_status;
|
|
#else
|
|
int volatile test_exit_status = EXIT_SUCCESS;
|
|
#endif
|
|
|
|
/* ASSERT (condition);
|
|
verifies that the specified condition is fulfilled. If not, a message
|
|
is printed to ASSERT_STREAM if defined (defaulting to stderr if
|
|
undefined) and the program is terminated with an error code.
|
|
|
|
This macro has the following properties:
|
|
- The programmer specifies the expected condition, not the failure
|
|
condition. This simplifies thinking.
|
|
- The condition is tested always, regardless of compilation flags.
|
|
(Unlike the macro from <assert.h>.)
|
|
- On Unix platforms, the tester can debug the test program with a
|
|
debugger (provided core dumps are enabled: "ulimit -c unlimited").
|
|
- For the sake of platforms where no debugger is available (such as
|
|
some mingw systems), an error message is printed on the error
|
|
stream that includes the source location of the ASSERT invocation.
|
|
*/
|
|
#define ASSERT(expr) \
|
|
do \
|
|
{ \
|
|
if (!(expr)) \
|
|
{ \
|
|
fprintf (ASSERT_STREAM, "%s:%d: assertion '%s' failed\n", \
|
|
__FILE__, __LINE__, #expr); \
|
|
fflush (ASSERT_STREAM); \
|
|
if (CONTINUE_AFTER_ASSERT) \
|
|
{ \
|
|
print_stack_trace (); \
|
|
test_exit_status = EXIT_FAILURE; \
|
|
} \
|
|
else \
|
|
abort (); \
|
|
} \
|
|
} \
|
|
while (0)
|
|
|
|
/* Like ASSERT, except that it uses no stdio.
|
|
Requires #include <string.h> and #include <unistd.h>. */
|
|
#define ASSERT_NO_STDIO(expr) \
|
|
do \
|
|
{ \
|
|
if (!(expr)) \
|
|
{ \
|
|
WRITE_TO_STDERR (__FILE__); \
|
|
WRITE_TO_STDERR (":"); \
|
|
WRITE_MACROEXPANDED_INTEGER_TO_STDERR (__LINE__); \
|
|
WRITE_TO_STDERR (": assertion '"); \
|
|
WRITE_TO_STDERR (#expr); \
|
|
WRITE_TO_STDERR ("' failed\n"); \
|
|
if (CONTINUE_AFTER_ASSERT) \
|
|
{ \
|
|
print_stack_trace (); \
|
|
test_exit_status = EXIT_FAILURE; \
|
|
} \
|
|
else \
|
|
abort (); \
|
|
} \
|
|
} \
|
|
while (0)
|
|
#define WRITE_MACROEXPANDED_INTEGER_TO_STDERR(integer) \
|
|
WRITE_INTEGER_TO_STDERR(integer)
|
|
#define WRITE_INTEGER_TO_STDERR(integer) \
|
|
WRITE_TO_STDERR (#integer)
|
|
#define WRITE_TO_STDERR(string_literal) \
|
|
{ \
|
|
const char *s = string_literal; \
|
|
int ret = write (2, s, strlen (s)); \
|
|
(void) ret; \
|
|
}
|
|
|
|
/* SIZEOF (array)
|
|
returns the number of elements of an array. It works for arrays that are
|
|
declared outside functions and for local variables of array type. It does
|
|
*not* work for function parameters of array type, because they are actually
|
|
parameters of pointer type. */
|
|
#define SIZEOF(array) (sizeof (array) / sizeof (array[0]))
|
|
|
|
/* STREQ (str1, str2)
|
|
Return true if two strings compare equal. */
|
|
#define STREQ(a, b) (strcmp (a, b) == 0)
|
|
|
|
/* Some numbers in the interval [0,1). */
|
|
extern const float randomf[1000];
|
|
extern const double randomd[1000];
|
|
extern const long double randoml[1000];
|
|
/* 4 KiB of random bytes. */
|
|
extern const char randomb[4096];
|