Miguel Ruiz / SDL_lib2

SDL Library

Dependents:   H261_decoder

SDL_test_assert.h@0:7fb6877b5d7c, 2016-09-22 (annotated)

Committer:
miruga27
Date:
Thu Sep 22 00:03:09 2016 +0000
Revision:
0:7fb6877b5d7c
SDL

Who changed what in which revision?

UserRevisionLine numberNew contents of line
miruga27 0:7fb6877b5d7c 1 /*
miruga27 0:7fb6877b5d7c 2 Simple DirectMedia Layer
miruga27 0:7fb6877b5d7c 3 Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
miruga27 0:7fb6877b5d7c 4
miruga27 0:7fb6877b5d7c 5 This software is provided 'as-is', without any express or implied
miruga27 0:7fb6877b5d7c 6 warranty. In no event will the authors be held liable for any damages
miruga27 0:7fb6877b5d7c 7 arising from the use of this software.
miruga27 0:7fb6877b5d7c 8
miruga27 0:7fb6877b5d7c 9 Permission is granted to anyone to use this software for any purpose,
miruga27 0:7fb6877b5d7c 10 including commercial applications, and to alter it and redistribute it
miruga27 0:7fb6877b5d7c 11 freely, subject to the following restrictions:
miruga27 0:7fb6877b5d7c 12
miruga27 0:7fb6877b5d7c 13 1. The origin of this software must not be misrepresented; you must not
miruga27 0:7fb6877b5d7c 14 claim that you wrote the original software. If you use this software
miruga27 0:7fb6877b5d7c 15 in a product, an acknowledgment in the product documentation would be
miruga27 0:7fb6877b5d7c 16 appreciated but is not required.
miruga27 0:7fb6877b5d7c 17 2. Altered source versions must be plainly marked as such, and must not be
miruga27 0:7fb6877b5d7c 18 misrepresented as being the original software.
miruga27 0:7fb6877b5d7c 19 3. This notice may not be removed or altered from any source distribution.
miruga27 0:7fb6877b5d7c 20 */
miruga27 0:7fb6877b5d7c 21
miruga27 0:7fb6877b5d7c 22 /**
miruga27 0:7fb6877b5d7c 23 * \file SDL_test_assert.h
miruga27 0:7fb6877b5d7c 24 *
miruga27 0:7fb6877b5d7c 25 * Include file for SDL test framework.
miruga27 0:7fb6877b5d7c 26 *
miruga27 0:7fb6877b5d7c 27 * This code is a part of the SDL2_test library, not the main SDL library.
miruga27 0:7fb6877b5d7c 28 */
miruga27 0:7fb6877b5d7c 29
miruga27 0:7fb6877b5d7c 30 /*
miruga27 0:7fb6877b5d7c 31 *
miruga27 0:7fb6877b5d7c 32 * Assert API for test code and test cases
miruga27 0:7fb6877b5d7c 33 *
miruga27 0:7fb6877b5d7c 34 */
miruga27 0:7fb6877b5d7c 35
miruga27 0:7fb6877b5d7c 36 #ifndef _SDL_test_assert_h
miruga27 0:7fb6877b5d7c 37 #define _SDL_test_assert_h
miruga27 0:7fb6877b5d7c 38
miruga27 0:7fb6877b5d7c 39 #include "begin_code.h"
miruga27 0:7fb6877b5d7c 40 /* Set up for C function definitions, even when using C++ */
miruga27 0:7fb6877b5d7c 41 #ifdef __cplusplus
miruga27 0:7fb6877b5d7c 42 extern "C" {
miruga27 0:7fb6877b5d7c 43 #endif
miruga27 0:7fb6877b5d7c 44
miruga27 0:7fb6877b5d7c 45 /**
miruga27 0:7fb6877b5d7c 46 * \brief Fails the assert.
miruga27 0:7fb6877b5d7c 47 */
miruga27 0:7fb6877b5d7c 48 #define ASSERT_FAIL 0
miruga27 0:7fb6877b5d7c 49
miruga27 0:7fb6877b5d7c 50 /**
miruga27 0:7fb6877b5d7c 51 * \brief Passes the assert.
miruga27 0:7fb6877b5d7c 52 */
miruga27 0:7fb6877b5d7c 53 #define ASSERT_PASS 1
miruga27 0:7fb6877b5d7c 54
miruga27 0:7fb6877b5d7c 55 /**
miruga27 0:7fb6877b5d7c 56 * \brief Assert that logs and break execution flow on failures.
miruga27 0:7fb6877b5d7c 57 *
miruga27 0:7fb6877b5d7c 58 * \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
miruga27 0:7fb6877b5d7c 59 * \param assertDescription Message to log with the assert describing it.
miruga27 0:7fb6877b5d7c 60 */
miruga27 0:7fb6877b5d7c 61 void SDLTest_Assert(int assertCondition, const char *assertDescription, ...);
miruga27 0:7fb6877b5d7c 62
miruga27 0:7fb6877b5d7c 63 /**
miruga27 0:7fb6877b5d7c 64 * \brief Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters.
miruga27 0:7fb6877b5d7c 65 *
miruga27 0:7fb6877b5d7c 66 * \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
miruga27 0:7fb6877b5d7c 67 * \param assertDescription Message to log with the assert describing it.
miruga27 0:7fb6877b5d7c 68 *
miruga27 0:7fb6877b5d7c 69 * \returns Returns the assertCondition so it can be used to externally to break execution flow if desired.
miruga27 0:7fb6877b5d7c 70 */
miruga27 0:7fb6877b5d7c 71 int SDLTest_AssertCheck(int assertCondition, const char *assertDescription, ...);
miruga27 0:7fb6877b5d7c 72
miruga27 0:7fb6877b5d7c 73 /**
miruga27 0:7fb6877b5d7c 74 * \brief Explicitely pass without checking an assertion condition. Updates assertion counter.
miruga27 0:7fb6877b5d7c 75 *
miruga27 0:7fb6877b5d7c 76 * \param assertDescription Message to log with the assert describing it.
miruga27 0:7fb6877b5d7c 77 */
miruga27 0:7fb6877b5d7c 78 void SDLTest_AssertPass(const char *assertDescription, ...);
miruga27 0:7fb6877b5d7c 79
miruga27 0:7fb6877b5d7c 80 /**
miruga27 0:7fb6877b5d7c 81 * \brief Resets the assert summary counters to zero.
miruga27 0:7fb6877b5d7c 82 */
miruga27 0:7fb6877b5d7c 83 void SDLTest_ResetAssertSummary();
miruga27 0:7fb6877b5d7c 84
miruga27 0:7fb6877b5d7c 85 /**
miruga27 0:7fb6877b5d7c 86 * \brief Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR.
miruga27 0:7fb6877b5d7c 87 */
miruga27 0:7fb6877b5d7c 88 void SDLTest_LogAssertSummary();
miruga27 0:7fb6877b5d7c 89
miruga27 0:7fb6877b5d7c 90
miruga27 0:7fb6877b5d7c 91 /**
miruga27 0:7fb6877b5d7c 92 * \brief Converts the current assert summary state to a test result.
miruga27 0:7fb6877b5d7c 93 *
miruga27 0:7fb6877b5d7c 94 * \returns TEST_RESULT_PASSED, TEST_RESULT_FAILED, or TEST_RESULT_NO_ASSERT
miruga27 0:7fb6877b5d7c 95 */
miruga27 0:7fb6877b5d7c 96 int SDLTest_AssertSummaryToTestResult();
miruga27 0:7fb6877b5d7c 97
miruga27 0:7fb6877b5d7c 98 #ifdef __cplusplus
miruga27 0:7fb6877b5d7c 99 }
miruga27 0:7fb6877b5d7c 100 #endif
miruga27 0:7fb6877b5d7c 101 #include "close_code.h"
miruga27 0:7fb6877b5d7c 102
miruga27 0:7fb6877b5d7c 103 #endif /* _SDL_test_assert_h */
miruga27 0:7fb6877b5d7c 104
miruga27 0:7fb6877b5d7c 105 /* vi: set ts=4 sw=4 expandtab: */