include/SDL_test_assert.h
author Andreas Schiffler <aschiffler@ferzkopp.net>
Tue, 04 Dec 2012 19:21:10 -0800
changeset 6721 53b71f45a53a
parent 6718 918ba414168b
child 6727 1b5280cd5885
permissions -rw-r--r--
Added to harness in test lib (work in progress)
aschiffler@6717
     1
/*
aschiffler@6717
     2
  Simple DirectMedia Layer
aschiffler@6717
     3
  Copyright (C) 1997-2012 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
aschiffler@6717
    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
aschiffler@6717
    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
/* *INDENT-OFF* */
aschiffler@6717
    43
extern "C" {
aschiffler@6717
    44
/* *INDENT-ON* */
aschiffler@6717
    45
#endif
aschiffler@6717
    46
aschiffler@6717
    47
/**
aschiffler@6718
    48
 * \brief Fails the assert.
aschiffler@6718
    49
 */
aschiffler@6718
    50
#define ASSERT_FAIL		0
aschiffler@6718
    51
aschiffler@6718
    52
/**
aschiffler@6718
    53
 * \brief Passes the assert.
aschiffler@6718
    54
 */
aschiffler@6718
    55
#define ASSERT_PASS		1
aschiffler@6718
    56
aschiffler@6721
    57
/*! \brief counts the failed asserts */
aschiffler@6721
    58
static Uint32 SDLTest_AssertsFailed = 0;
aschiffler@6721
    59
aschiffler@6721
    60
/*! \brief counts the passed asserts */
aschiffler@6721
    61
static Uint32 SDLTest_AssertsPassed = 0;
aschiffler@6721
    62
aschiffler@6718
    63
/**
aschiffler@6717
    64
 * \brief Assert that logs and break execution flow on failures.
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@6717
    68
 */
aschiffler@6717
    69
void SDLTest_Assert(int assertCondition, char *assertDescription);
aschiffler@6717
    70
aschiffler@6717
    71
/**
aschiffler@6717
    72
 * \brief Assert for test cases that logs but does not break execution flow on failures.
aschiffler@6717
    73
 *
aschiffler@6717
    74
 * \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
aschiffler@6717
    75
 * \param assertDescription Message to log with the assert describing it.
aschiffler@6718
    76
 *
aschiffler@6718
    77
 * \returns Returns the assertCondition so it can be used to externall to break execution flow if desired.
aschiffler@6717
    78
 */
aschiffler@6718
    79
int SDLTest_AssertCheck(int assertCondition, char *assertDescription);
aschiffler@6717
    80
aschiffler@6717
    81
/**
aschiffler@6717
    82
 * \brief Resets the assert summary counters to zero.
aschiffler@6717
    83
 */
aschiffler@6717
    84
void SDLTest_ResetAssertSummary();
aschiffler@6717
    85
aschiffler@6717
    86
/**
aschiffler@6717
    87
 * \brief Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR.
aschiffler@6717
    88
 *
aschiffler@6717
    89
 */
aschiffler@6717
    90
void SDLTest_LogAssertSummary();
aschiffler@6717
    91
aschiffler@6717
    92
#ifdef __cplusplus
aschiffler@6717
    93
/* *INDENT-OFF* */
aschiffler@6717
    94
}
aschiffler@6717
    95
/* *INDENT-ON* */
aschiffler@6717
    96
#endif
aschiffler@6717
    97
#include "close_code.h"
aschiffler@6717
    98
aschiffler@6717
    99
#endif /* _SDL_test_assert_h */
aschiffler@6717
   100
aschiffler@6717
   101
/* vi: set ts=4 sw=4 expandtab: */