include/SDL_test_assert.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 04 Jan 2019 22:01:14 -0800
changeset 12503 806492103856
parent 11811 5d94cb6b24d3
permissions -rw-r--r--
Updated copyright for 2019
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2019 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  *  \file SDL_test_assert.h
    24  *
    25  *  Include file for SDL test framework.
    26  *
    27  *  This code is a part of the SDL2_test library, not the main SDL library.
    28  */
    29 
    30 /*
    31  *
    32  * Assert API for test code and test cases
    33  *
    34  */
    35 
    36 #ifndef SDL_test_assert_h_
    37 #define SDL_test_assert_h_
    38 
    39 #include "begin_code.h"
    40 /* Set up for C function definitions, even when using C++ */
    41 #ifdef __cplusplus
    42 extern "C" {
    43 #endif
    44 
    45 /**
    46  * \brief Fails the assert.
    47  */
    48 #define ASSERT_FAIL     0
    49 
    50 /**
    51  * \brief Passes the assert.
    52  */
    53 #define ASSERT_PASS     1
    54 
    55 /**
    56  * \brief Assert that logs and break execution flow on failures.
    57  *
    58  * \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
    59  * \param assertDescription Message to log with the assert describing it.
    60  */
    61 void SDLTest_Assert(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2);
    62 
    63 /**
    64  * \brief Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters.
    65  *
    66  * \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
    67  * \param assertDescription Message to log with the assert describing it.
    68  *
    69  * \returns Returns the assertCondition so it can be used to externally to break execution flow if desired.
    70  */
    71 int SDLTest_AssertCheck(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2);
    72 
    73 /**
    74  * \brief Explicitly pass without checking an assertion condition. Updates assertion counter.
    75  *
    76  * \param assertDescription Message to log with the assert describing it.
    77  */
    78 void SDLTest_AssertPass(SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(1);
    79 
    80 /**
    81  * \brief Resets the assert summary counters to zero.
    82  */
    83 void SDLTest_ResetAssertSummary(void);
    84 
    85 /**
    86  * \brief Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR.
    87  */
    88 void SDLTest_LogAssertSummary(void);
    89 
    90 
    91 /**
    92  * \brief Converts the current assert summary state to a test result.
    93  *
    94  * \returns TEST_RESULT_PASSED, TEST_RESULT_FAILED, or TEST_RESULT_NO_ASSERT
    95  */
    96 int SDLTest_AssertSummaryToTestResult(void);
    97 
    98 #ifdef __cplusplus
    99 }
   100 #endif
   101 #include "close_code.h"
   102 
   103 #endif /* SDL_test_assert_h_ */
   104 
   105 /* vi: set ts=4 sw=4 expandtab: */