t/test.h

   1 /*
   2  * Copyright © 2012, 2020, 2022-2024 Nick Bowler
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef CDECL_TEST_H_
  19 #define CDECL_TEST_H_
  20
  21 #include <stddef.h>
  22 #include <stdbool.h>
  23 #include <limits.h>
  24 #include <assert.h>
  25
  26 #ifndef _
  27 #  define _(x) (x)
  28 #endif
  29
  30 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  31 #define MAX(a, b) ((a) > (b) ? (a) : (b))
  32
  33 /*
  34  * The test_uintmax typedef is interchangeable with cdecl_uintmax defined in
  35  * <cdecl.h>, but we may want to avoid including that header for some tests.
  36  */
  37 #if HAVE_UNSIGNED_LONG_LONG_INT
  38 typedef unsigned long long test_uintmax;
  39 #elif HAVE_UNSIGNED___INT64
  40 typedef unsigned __int64 test_uintmax;
  41 #else
  42 typedef unsigned long test_uintmax;
  43 #endif
  44
  45 struct cdecl_declspec;
  46 struct option;
  47 struct cdecl;
  48
  49 struct test_rng;
  50
  51 void print_error(const char *fmt, ...);
  52
  53 void *malloc_nofail(size_t size);
  54 void *realloc_nofail(void *ptr, size_t size);
  55
  56 bool test_strtoumax(test_uintmax *out, const char *s, test_uintmax limit);
  57
  58 static inline bool test_strtoul(unsigned long *val, const char *str)
  59 {
  60         test_uintmax v;
  61         bool rc;
  62
  63         rc = test_strtoumax(&v, str, (unsigned long)-1);
  64         *val = v;
  65         return rc;
  66 }
  67
  68 void test_print_options(const struct option *lopts);
  69
  70 /*
  71  * Allocate a new random number generator with the given seed string (which
  72  * should normally be a command-line argument).  The string is parsed as an
  73  * integer value as if by strtoull with a base of 0.
  74  */
  75 struct test_rng *test_rng_alloc(const char *seed);
  76
  77 /*
  78  * Free the random number generator rng.
  79  */
  80 void test_rng_free(struct test_rng *rng);
  81
  82 /*
  83  * Return a random integer uniformly on the closed interval [0, limit-1]
  84  */
  85 unsigned test_rng_uniform_int(struct test_rng *rng, unsigned limit);
  86
  87 /*
  88  * Return false or true with 50% probablility either way.
  89  */
  90 static inline int test_rng_50_50(struct test_rng *rng)
  91 {
  92         return test_rng_uniform_int(rng, 2) == 0;
  93 }
  94
  95 #define VERSION_NO_COPYRIGHT_SYMBOL 1
  96 #include "version.h"
  97
  98 #ifdef PROGNAME
  99 const char *progname = PROGNAME;
 100 #endif
 101
 102 #define test_print_version(s) \
 103         do_print_version(s " (" PACKAGE_NAME ") " PACKAGE_VERSION)
 104
 105 #endif