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 int test_getline(char **linebuf, size_t *n);
  57
  58 bool test_strtoumax(test_uintmax *out, const char *s, test_uintmax limit);
  59
  60 static inline bool test_strtoul(unsigned long *val, const char *str)
  61 {
  62         test_uintmax v;
  63         bool rc;
  64
  65         rc = test_strtoumax(&v, str, (unsigned long)-1);
  66         *val = v;
  67         return rc;
  68 }
  69
  70 void test_print_options(const struct option *lopts);
  71
  72 /*
  73  * Allocate a new random number generator with the given seed string (which
  74  * should normally be a command-line argument).  The string is parsed as an
  75  * integer value as if by strtoull with a base of 0.
  76  */
  77 struct test_rng *test_rng_alloc(const char *seed);
  78
  79 /*
  80  * Free the random number generator rng.
  81  */
  82 void test_rng_free(struct test_rng *rng);
  83
  84 /*
  85  * Return a random integer uniformly on the closed interval [0, limit-1]
  86  */
  87 unsigned test_rng_uniform_int(struct test_rng *rng, unsigned limit);
  88
  89 /*
  90  * Return false or true with 50% probablility either way.
  91  */
  92 static inline int test_rng_50_50(struct test_rng *rng)
  93 {
  94         return test_rng_uniform_int(rng, 2) == 0;
  95 }
  96
  97 #define VERSION_NO_COPYRIGHT_SYMBOL 1
  98 #include "version.h"
  99
 100 #ifdef PROGNAME
 101 const char *progname = PROGNAME;
 102 #endif
 103
 104 #define test_print_version(s) \
 105         do_print_version(s " (" PACKAGE_NAME ") " PACKAGE_VERSION)
 106
 107 #endif