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