include/SDL_test_log.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 04 Jun 2014 10:56:56 -0700
changeset 8820 0e935d5b193a
parent 8149 681eb46b8ac4
child 9619 b94b6d0bff0f
permissions -rw-r--r--
Added annotations to help code analysis tools

CR: Bruce Dawson
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 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_log.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  *  Wrapper to log in the TEST category
    33  *
    34  */
    35 
    36 #ifndef _SDL_test_log_h
    37 #define _SDL_test_log_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 Prints given message with a timestamp in the TEST category and INFO priority.
    47  *
    48  * \param fmt Message to be logged
    49  */
    50 void SDLTest_Log(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
    51 
    52 /**
    53  * \brief Prints given message with a timestamp in the TEST category and the ERROR priority.
    54  *
    55  * \param fmt Message to be logged
    56  */
    57 void SDLTest_LogError(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
    58 
    59 /* Ends C function definitions when using C++ */
    60 #ifdef __cplusplus
    61 }
    62 #endif
    63 #include "close_code.h"
    64 
    65 #endif /* _SDL_test_log_h */
    66 
    67 /* vi: set ts=4 sw=4 expandtab: */