diff options
author | 3gg <3gg@shellblade.net> | 2025-08-30 16:53:58 -0700 |
---|---|---|
committer | 3gg <3gg@shellblade.net> | 2025-08-30 16:53:58 -0700 |
commit | 6aaedb813fa11ba0679c3051bc2eb28646b9506c (patch) | |
tree | 34acbfc9840e02cb4753e6306ea7ce978bf8b58e /src/contrib/SDL-3.2.20/include/SDL3/SDL_test_assert.h | |
parent | 8f228ade99dd3d4c8da9b78ade1815c9adf85c8f (diff) |
Update to SDL3
Diffstat (limited to 'src/contrib/SDL-3.2.20/include/SDL3/SDL_test_assert.h')
-rw-r--r-- | src/contrib/SDL-3.2.20/include/SDL3/SDL_test_assert.h | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/src/contrib/SDL-3.2.20/include/SDL3/SDL_test_assert.h b/src/contrib/SDL-3.2.20/include/SDL3/SDL_test_assert.h new file mode 100644 index 0000000..c067608 --- /dev/null +++ b/src/contrib/SDL-3.2.20/include/SDL3/SDL_test_assert.h | |||
@@ -0,0 +1,98 @@ | |||
1 | /* | ||
2 | Simple DirectMedia Layer | ||
3 | Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org> | ||
4 | |||
5 | This software is provided 'as-is', without any express or implied | ||
6 | warranty. In no event will the authors be held liable for any damages | ||
7 | arising from the use of this software. | ||
8 | |||
9 | Permission is granted to anyone to use this software for any purpose, | ||
10 | including commercial applications, and to alter it and redistribute it | ||
11 | freely, subject to the following restrictions: | ||
12 | |||
13 | 1. The origin of this software must not be misrepresented; you must not | ||
14 | claim that you wrote the original software. If you use this software | ||
15 | in a product, an acknowledgment in the product documentation would be | ||
16 | appreciated but is not required. | ||
17 | 2. Altered source versions must be plainly marked as such, and must not be | ||
18 | misrepresented as being the original software. | ||
19 | 3. This notice may not be removed or altered from any source distribution. | ||
20 | */ | ||
21 | |||
22 | /** | ||
23 | * Assertion functions of SDL test framework. | ||
24 | * | ||
25 | * This code is a part of the SDL test library, not the main SDL library. | ||
26 | */ | ||
27 | |||
28 | /* | ||
29 | * | ||
30 | * Assert API for test code and test cases | ||
31 | * | ||
32 | */ | ||
33 | |||
34 | #ifndef SDL_test_assert_h_ | ||
35 | #define SDL_test_assert_h_ | ||
36 | |||
37 | #include <SDL3/SDL_stdinc.h> | ||
38 | |||
39 | #include <SDL3/SDL_begin_code.h> | ||
40 | /* Set up for C function definitions, even when using C++ */ | ||
41 | #ifdef __cplusplus | ||
42 | extern "C" { | ||
43 | #endif | ||
44 | |||
45 | /* Fails the assert. */ | ||
46 | #define ASSERT_FAIL 0 | ||
47 | |||
48 | /* Passes the assert. */ | ||
49 | #define ASSERT_PASS 1 | ||
50 | |||
51 | /* | ||
52 | * Assert that logs and break execution flow on failures. | ||
53 | * | ||
54 | * \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0). | ||
55 | * \param assertDescription Message to log with the assert describing it. | ||
56 | */ | ||
57 | void SDLCALL SDLTest_Assert(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2); | ||
58 | |||
59 | /* | ||
60 | * Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters. | ||
61 | * | ||
62 | * \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0). | ||
63 | * \param assertDescription Message to log with the assert describing it. | ||
64 | * | ||
65 | * \returns the assertCondition so it can be used to externally to break execution flow if desired. | ||
66 | */ | ||
67 | int SDLCALL SDLTest_AssertCheck(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2); | ||
68 | |||
69 | /* | ||
70 | * Explicitly pass without checking an assertion condition. Updates assertion counter. | ||
71 | * | ||
72 | * \param assertDescription Message to log with the assert describing it. | ||
73 | */ | ||
74 | void SDLCALL SDLTest_AssertPass(SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(1); | ||
75 | |||
76 | /* | ||
77 | * Resets the assert summary counters to zero. | ||
78 | */ | ||
79 | void SDLCALL SDLTest_ResetAssertSummary(void); | ||
80 | |||
81 | /* | ||
82 | * Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR. | ||
83 | */ | ||
84 | void SDLCALL SDLTest_LogAssertSummary(void); | ||
85 | |||
86 | /* | ||
87 | * Converts the current assert summary state to a test result. | ||
88 | * | ||
89 | * \returns TEST_RESULT_PASSED, TEST_RESULT_FAILED, or TEST_RESULT_NO_ASSERT | ||
90 | */ | ||
91 | int SDLCALL SDLTest_AssertSummaryToTestResult(void); | ||
92 | |||
93 | #ifdef __cplusplus | ||
94 | } | ||
95 | #endif | ||
96 | #include <SDL3/SDL_close_code.h> | ||
97 | |||
98 | #endif /* SDL_test_assert_h_ */ | ||