src/test/SDL_test_log.c
author Andreas Schiffler <aschiffler@ferzkopp.net>
Fri, 30 Nov 2012 23:25:34 -0800
changeset 6717 2acd95060548
child 6718 918ba414168b
permissions -rw-r--r--
Add log, assert and harness (partial) to test lib
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
aschiffler@6717
    24
 Used by the test framework and test cases. 
aschiffler@6717
    25
aschiffler@6717
    26
*/
aschiffler@6717
    27
aschiffler@6717
    28
#include "SDL_config.h"
aschiffler@6717
    29
aschiffler@6717
    30
#include <stdarg.h> /* va_list */
aschiffler@6717
    31
#include <time.h>
aschiffler@6717
    32
aschiffler@6717
    33
#include "SDL_test.h"
aschiffler@6717
    34
aschiffler@6717
    35
/* 
aschiffler@6717
    36
 * Note: Maximum size of SDLTest log message is less than SDLs limit 
aschiffler@6717
    37
 * to ensure we can fit additional information such as the timestamp. 
aschiffler@6717
    38
 */
aschiffler@6717
    39
#define SDLTEST_MAX_LOGMESSAGE_LENGTH	3584
aschiffler@6717
    40
aschiffler@6717
    41
/*!
aschiffler@6717
    42
 * Converts unix timestamp to its ascii representation in localtime
aschiffler@6717
    43
 *
aschiffler@6717
    44
 * Note: Uses a static buffer internally, so the return value
aschiffler@6717
    45
 * isn't valid after the next call of this function. If you
aschiffler@6717
    46
 * want to retain the return value, make a copy of it.
aschiffler@6717
    47
 *
aschiffler@6717
    48
 * \param timestamp A Timestamp, i.e. time(0)
aschiffler@6717
    49
 *
aschiffler@6717
    50
 * \return Ascii representation of the timestamp in localtime
aschiffler@6717
    51
 */
aschiffler@6717
    52
char *SDLTest_TimestampToString(const time_t timestamp) 
aschiffler@6717
    53
{
aschiffler@6717
    54
	time_t copy;
aschiffler@6717
    55
	static char buffer[256];
aschiffler@6717
    56
	struct tm *local;
aschiffler@6717
    57
aschiffler@6717
    58
	memset(buffer, 0, sizeof(buffer));\
aschiffler@6717
    59
	copy = timestamp;
aschiffler@6717
    60
	local = localtime(&copy);
aschiffler@6717
    61
	strftime(buffer, sizeof(buffer), "%a %Y-%m-%d %H:%M:%S %Z", local);
aschiffler@6717
    62
aschiffler@6717
    63
	return buffer;
aschiffler@6717
    64
}
aschiffler@6717
    65
aschiffler@6717
    66
/*
aschiffler@6717
    67
 * Prints given message with a timestamp in the TEST category and INFO priority.
aschiffler@6717
    68
 */
aschiffler@6717
    69
void SDLTest_Log(char *fmt, ...)
aschiffler@6717
    70
{
aschiffler@6717
    71
	va_list list;
aschiffler@6717
    72
	char logMessage[SDLTEST_MAX_LOGMESSAGE_LENGTH];
aschiffler@6717
    73
aschiffler@6717
    74
	// Print log message into a buffer
aschiffler@6717
    75
	memset(logMessage, 0, SDLTEST_MAX_LOGMESSAGE_LENGTH);
aschiffler@6717
    76
	va_start(list, fmt);
aschiffler@6717
    77
	SDL_vsnprintf(logMessage, SDLTEST_MAX_LOGMESSAGE_LENGTH - 1, fmt, list);
aschiffler@6717
    78
	va_end(list);
aschiffler@6717
    79
aschiffler@6717
    80
	// Log with timestamp and newline
aschiffler@6717
    81
	SDL_LogMessage(SDL_LOG_CATEGORY_TEST, SDL_LOG_PRIORITY_INFO, "%s: %s\n", SDLTest_TimestampToString(time(0)), logMessage);
aschiffler@6717
    82
}
aschiffler@6717
    83
aschiffler@6717
    84
/*
aschiffler@6717
    85
 * Prints given message with a timestamp in the TEST category and the ERROR priority.
aschiffler@6717
    86
 */
aschiffler@6717
    87
void SDLTest_LogError(char *fmt, ...)
aschiffler@6717
    88
{
aschiffler@6717
    89
	va_list list;
aschiffler@6717
    90
	char logMessage[SDLTEST_MAX_LOGMESSAGE_LENGTH];
aschiffler@6717
    91
aschiffler@6717
    92
	// Print log message into a buffer
aschiffler@6717
    93
	memset(logMessage, 0, SDLTEST_MAX_LOGMESSAGE_LENGTH);
aschiffler@6717
    94
	va_start(list, fmt);
aschiffler@6717
    95
	SDL_vsnprintf(logMessage, SDLTEST_MAX_LOGMESSAGE_LENGTH - 1, fmt, list);
aschiffler@6717
    96
	va_end(list);
aschiffler@6717
    97
aschiffler@6717
    98
	// Log with timestamp and newline
aschiffler@6717
    99
	SDL_LogMessage(SDL_LOG_CATEGORY_TEST, SDL_LOG_PRIORITY_ERROR, "%s: %s\n", SDLTest_TimestampToString(time(0)), logMessage);
aschiffler@6717
   100
}