xref: /openbsd-src/lib/libexpat/tests/minicheck.h (revision bd8f1dc3b0e01803a74947836eef57849c13acb0)

/* Miniature re-implementation of the "check" library.

   This is intended to support just enough of check to run the Expat
   tests.  This interface is based entirely on the portion of the
   check library being used.

   This is *source* compatible, but not necessary *link* compatible.
                            __  __            _
                         ___\ \/ /_ __   __ _| |_
                        / _ \\  /| '_ \ / _` | __|
                       |  __//  \| |_) | (_| | |_
                        \___/_/\_\ .__/ \__,_|\__|
                                 |_| XML parser

   Copyright (c) 2004-2006 Fred L. Drake, Jr. <fdrake@users.sourceforge.net>
   Copyright (c) 2006-2012 Karl Waclawek <karl@waclawek.net>
   Copyright (c) 2016-2024 Sebastian Pipping <sebastian@pipping.org>
   Copyright (c) 2022      Rhodri James <rhodri@wildebeest.org.uk>
   Copyright (c) 2023-2024 Sony Corporation / Snild Dolkow <snild@sony.com>
   Licensed under the MIT license:

   Permission is  hereby granted,  free of charge,  to any  person obtaining
   a  copy  of  this  software   and  associated  documentation  files  (the
   "Software"),  to  deal in  the  Software  without restriction,  including
   without  limitation the  rights  to use,  copy,  modify, merge,  publish,
   distribute, sublicense, and/or sell copies of the Software, and to permit
   persons  to whom  the Software  is  furnished to  do so,  subject to  the
   following conditions:

   The above copyright  notice and this permission notice  shall be included
   in all copies or substantial portions of the Software.

   THE  SOFTWARE  IS  PROVIDED  "AS  IS",  WITHOUT  WARRANTY  OF  ANY  KIND,
   EXPRESS  OR IMPLIED,  INCLUDING  BUT  NOT LIMITED  TO  THE WARRANTIES  OF
   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
   NO EVENT SHALL THE AUTHORS OR  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
   DAMAGES OR  OTHER LIABILITY, WHETHER  IN AN  ACTION OF CONTRACT,  TORT OR
   OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
   USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifdef __cplusplus
extern "C" {
#endif

#ifndef XML_MINICHECK_H
#  define XML_MINICHECK_H

#  define CK_NOFORK 0
#  define CK_FORK 1

#  define CK_SILENT 0
#  define CK_NORMAL 1
#  define CK_VERBOSE 2

/* Workaround for Microsoft's compiler and Tru64 Unix systems where the
   C compiler has a working __func__, but the C++ compiler only has a
   working __FUNCTION__.  This could be fixed in configure.in, but it's
   not worth it right now. */
#  if defined(_MSC_VER) || (defined(__osf__) && defined(__cplusplus))
#    define __func__ __FUNCTION__
#  endif

/* PRINTF_LIKE has two effects:
    1. Make clang's -Wformat-nonliteral stop warning about non-literal format
       strings in annotated functions' code.
    2. Make both clang and gcc's -Wformat-nonliteral warn about *callers* of
       the annotated function that use a non-literal format string.
*/
#  if defined(__GNUC__)
#    define PRINTF_LIKE(fmtpos, argspos)                                       \
      __attribute__((format(printf, fmtpos, argspos)))
#  else
#    define PRINTF_LIKE(fmtpos, argspos)
#  endif

#  define START_TEST(testname)                                                 \
    static void testname(void) {                                               \
      _check_set_test_info(__func__, __FILE__, __LINE__);                      \
      {
#  define END_TEST                                                             \
    }                                                                          \
    }

void PRINTF_LIKE(1, 2) set_subtest(char const *fmt, ...);

#  define fail(msg) _fail(__FILE__, __LINE__, msg)
#  define assert_true(cond)                                                    \
    do {                                                                       \
      if (! (cond)) {                                                          \
        _fail(__FILE__, __LINE__, "check failed: " #cond);                     \
      }                                                                        \
    } while (0)

typedef void (*tcase_setup_function)(void);
typedef void (*tcase_teardown_function)(void);
typedef void (*tcase_test_function)(void);

typedef struct SRunner SRunner;
typedef struct Suite Suite;
typedef struct TCase TCase;

struct SRunner {
  Suite *suite;
  int nchecks;
  int nfailures;
};

struct Suite {
  const char *name;
  TCase *tests;
};

struct TCase {
  const char *name;
  tcase_setup_function setup;
  tcase_teardown_function teardown;
  tcase_test_function *tests;
  int ntests;
  int allocated;
  TCase *next_tcase;
};

/* Internal helper. */
void _check_set_test_info(char const *function, char const *filename,
                          int lineno);

/*
 * Prototypes for the actual implementation.
 */

#  if defined(__GNUC__)
__attribute__((noreturn))
#  endif
void
_fail(const char *file, int line, const char *msg);
Suite *suite_create(const char *name);
TCase *tcase_create(const char *name);
void suite_add_tcase(Suite *suite, TCase *tc);
void tcase_add_checked_fixture(TCase *tc, tcase_setup_function setup,
                               tcase_teardown_function teardown);
void tcase_add_test(TCase *tc, tcase_test_function test);
SRunner *srunner_create(Suite *suite);
void srunner_run_all(SRunner *runner, const char *context, int verbosity);
void srunner_summarize(SRunner *runner, int verbosity);
int srunner_ntests_failed(SRunner *runner);
void srunner_free(SRunner *runner);

#endif /* XML_MINICHECK_H */

#ifdef __cplusplus
}
#endif