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