nanocoat/tests/include/test.h

   1 /* -*- Mode: C; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // -------------------------------------------------------------------------*/
   9
  10 /**
  11  * SquirrelJME test support header.
  12  *
  13  * @since 2023/08/09
  14  */
  15
  16 #ifndef SQUIRRELJME_TEST_H
  17 #define SQUIRRELJME_TEST_H
  18
  19 #include <setjmp.h>
  20
  21 #include "sjme/nvm/nvm.h"
  22 #include "sjme/debug.h"
  23 #include "sjme/error.h"
  24 #include "sjme/test/externTest.h"
  25
  26 /* Anti-C++. */
  27 #ifdef __cplusplus
  28         #ifndef SJME_CXX_IS_EXTERNED
  29                 #define SJME_CXX_IS_EXTERNED
  30                 #define SJME_CXX_SQUIRRELJME_TEST_H
  31 extern "C" {
  32         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  33 #endif     /* #ifdef __cplusplus */
  34
  35 /*--------------------------------------------------------------------------*/
  36
  37 /**
  38  * The result of a test.
  39  *
  40  * @since 2023/08/09
  41  */
  42 typedef enum sjme_testResult
  43 {
  44         /** The test passed. */
  45         SJME_TEST_RESULT_PASS = 0,
  46
  47         /** The test failed. */
  48         SJME_TEST_RESULT_FAIL = 1,
  49
  50         /** The test skipped. */
  51         SJME_TEST_RESULT_SKIP = 2,
  52 } sjme_testResult;
  53
  54 /**
  55  * Basic test information structure.
  56  *
  57  * @since 2023/08/09
  58  */
  59 typedef struct sjme_test
  60 {
  61         /** Base jump point for short circuits. */
  62         jmp_buf jumpPoint;
  63
  64         /** Allocation pool for tests, so one not need be setup. */
  65         sjme_alloc_pool* pool;
  66
  67         /** Any extra global value that is needed. */
  68         sjme_pointer global;
  69
  70         /** Error code. */
  71         sjme_errorCode error;
  72 } sjme_test;
  73
  74 /**
  75  * Basic test function.
  76  *
  77  * @param test The current test information.
  78  * @return The result of the test.
  79  * @since 2023/08/09
  80  */
  81 typedef sjme_testResult (*sjme_basicTestFunc)(sjme_test* test);
  82
  83 /**
  84  * A test which is available.
  85  *
  86  * @since 2023/08/09
  87  */
  88 typedef struct sjme_availableTest
  89 {
  90         /** The name of the test. */
  91         sjme_lpcstr name;
  92
  93         /** The function which contains the test code. */
  94         sjme_basicTestFunc function;
  95 } sjme_availableTest;
  96
  97 /**
  98  * Declares a test.
  99  *
 100  * @param name The name of the test.
 101  * @since 2023/11/21
 102  */
 103 #define SJME_TEST_DECLARE(name) \
 104         sjme_attrUnused sjme_testResult name(sjme_attrUnused sjme_test* test)
 105
 106 #if defined(SJME_CONFIG_DEBUG)
 107 /**
 108  * Checks for leaks.
 109  *
 110  * @param pool The pool to check.
 111  * @return Any resultant error, if any.
 112  * @since 2024/09/28
 113  */
 114 void sjme_test_leakCheck(sjme_alloc_pool* pool);
 115 #endif
 116
 117 /*--------------------------------------------------------------------------*/
 118
 119 /* Anti-C++. */
 120 #ifdef __cplusplus
 121         #ifdef SJME_CXX_SQUIRRELJME_TEST_H
 122 }
 123                 #undef SJME_CXX_SQUIRRELJME_TEST_H
 124                 #undef SJME_CXX_IS_EXTERNED
 125         #endif /* #ifdef SJME_CXX_SQUIRRELJME_TEST_H */
 126 #endif     /* #ifdef __cplusplus */
 127
 128 #endif /* SQUIRRELJME_TEST_H */