#include "./SDL_internal.h"
#include "SDL_error.h"
#include "SDL_log.h"

Include dependency graph for SDL_log.c:

Data Structures
struct	SDL_LogLevel

Macros
#define	DEFAULT_PRIORITY SDL_LOG_PRIORITY_CRITICAL
#define	DEFAULT_ASSERT_PRIORITY SDL_LOG_PRIORITY_WARN
#define	DEFAULT_APPLICATION_PRIORITY SDL_LOG_PRIORITY_INFO
#define	DEFAULT_TEST_PRIORITY SDL_LOG_PRIORITY_VERBOSE

Functions
static void	SDL_LogOutput (void userdata, int category, SDL_LogPriority priority, const char message)
void	SDL_LogSetAllPriority (SDL_LogPriority priority)
	Set the priority of all log categories.
void	SDL_LogSetPriority (int category, SDL_LogPriority priority)
	Set the priority of a particular log category.
SDL_LogPriority	SDL_LogGetPriority (int category)
	Get the priority of a particular log category.
void	SDL_LogResetPriorities (void)
	Reset all priorities to default.
void	SDL_Log (SDL_PRINTF_FORMAT_STRING const char *fmt,...)
	Log a message with SDL_LOG_CATEGORY_APPLICATION and SDL_LOG_PRIORITY_INFO.
void	SDL_LogVerbose (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...)
	Log a message with SDL_LOG_PRIORITY_VERBOSE.
void	SDL_LogDebug (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...)
	Log a message with SDL_LOG_PRIORITY_DEBUG.
void	SDL_LogInfo (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...)
	Log a message with SDL_LOG_PRIORITY_INFO.
void	SDL_LogWarn (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...)
	Log a message with SDL_LOG_PRIORITY_WARN.
void	SDL_LogError (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...)
	Log a message with SDL_LOG_PRIORITY_ERROR.
void	SDL_LogCritical (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...)
	Log a message with SDL_LOG_PRIORITY_CRITICAL.
void	SDL_LogMessage (int category, SDL_LogPriority priority, SDL_PRINTF_FORMAT_STRING const char *fmt,...)
	Log a message with the specified category and priority.
void	SDL_LogMessageV (int category, SDL_LogPriority priority, const char *fmt, va_list ap)
	Log a message with the specified category and priority.
void	SDL_LogGetOutputFunction (SDL_LogOutputFunction callback, void *userdata)
	Get the current log output function.
void	SDL_LogSetOutputFunction (SDL_LogOutputFunction callback, void *userdata)
	This function allows you to replace the default log output function with one of your own.

Variables
static SDL_LogLevel *	SDL_loglevels
static SDL_LogPriority	SDL_default_priority = DEFAULT_PRIORITY
static SDL_LogPriority	SDL_assert_priority = DEFAULT_ASSERT_PRIORITY
static SDL_LogPriority	SDL_application_priority = DEFAULT_APPLICATION_PRIORITY
static SDL_LogPriority	SDL_test_priority = DEFAULT_TEST_PRIORITY
static SDL_LogOutputFunction	SDL_log_function = SDL_LogOutput
static void *	SDL_log_userdata = NULL
static const char *	SDL_priority_prefixes [SDL_NUM_LOG_PRIORITIES]

Macro Definition Documentation

#define DEFAULT_APPLICATION_PRIORITY SDL_LOG_PRIORITY_INFO

Definition at line 42 of file SDL_log.c.

Referenced by SDL_LogResetPriorities().

#define DEFAULT_ASSERT_PRIORITY SDL_LOG_PRIORITY_WARN

Definition at line 41 of file SDL_log.c.

Referenced by SDL_LogResetPriorities().

#define DEFAULT_PRIORITY SDL_LOG_PRIORITY_CRITICAL

Definition at line 40 of file SDL_log.c.

Referenced by SDL_LogResetPriorities().

#define DEFAULT_TEST_PRIORITY SDL_LOG_PRIORITY_VERBOSE

Definition at line 43 of file SDL_log.c.

Referenced by SDL_LogResetPriorities().

Function Documentation

void SDL_Log	(	SDL_PRINTF_FORMAT_STRING const char *	fmt,
			...
	)

Log a message with SDL_LOG_CATEGORY_APPLICATION and SDL_LOG_PRIORITY_INFO.

Definition at line 171 of file SDL_log.c.

References SDL_LOG_CATEGORY_APPLICATION, SDL_LOG_PRIORITY_INFO, and SDL_LogMessageV.

{
    va_list ap;
    va_start(ap, fmt);
    SDL_LogMessageV(SDL_LOG_CATEGORY_APPLICATION, SDL_LOG_PRIORITY_INFO, fmt, ap);
    va_end(ap);
}

void SDL_LogCritical	(	int	category,
		SDL_PRINTF_FORMAT_STRING const char *	fmt,
			...
	)

Log a message with SDL_LOG_PRIORITY_CRITICAL.

Definition at line 231 of file SDL_log.c.

References SDL_LOG_PRIORITY_CRITICAL, and SDL_LogMessageV.

{
    va_list ap;
    va_start(ap, fmt);
    SDL_LogMessageV(category, SDL_LOG_PRIORITY_CRITICAL, fmt, ap);
    va_end(ap);
}

void SDL_LogDebug	(	int	category,
		SDL_PRINTF_FORMAT_STRING const char *	fmt,
			...
	)

Log a message with SDL_LOG_PRIORITY_DEBUG.

Definition at line 191 of file SDL_log.c.

References SDL_LOG_PRIORITY_DEBUG, and SDL_LogMessageV.

{
    va_list ap;
    va_start(ap, fmt);
    SDL_LogMessageV(category, SDL_LOG_PRIORITY_DEBUG, fmt, ap);
    va_end(ap);
}

void SDL_LogError	(	int	category,
		SDL_PRINTF_FORMAT_STRING const char *	fmt,
			...
	)

Log a message with SDL_LOG_PRIORITY_ERROR.

Definition at line 221 of file SDL_log.c.

References SDL_LOG_PRIORITY_ERROR, and SDL_LogMessageV.

{
    va_list ap;
    va_start(ap, fmt);
    SDL_LogMessageV(category, SDL_LOG_PRIORITY_ERROR, fmt, ap);
    va_end(ap);
}

void SDL_LogGetOutputFunction	(	SDL_LogOutputFunction *	callback,
		void **	userdata
	)

Get the current log output function.

Definition at line 433 of file SDL_log.c.

References SDL_log_function, and SDL_log_userdata.

{
    if (callback) {
        *callback = SDL_log_function;
    }
    if (userdata) {
        *userdata = SDL_log_userdata;
    }
}

SDL_LogPriority SDL_LogGetPriority ( int category )

Get the priority of a particular log category.

Definition at line 132 of file SDL_log.c.

References SDL_LogLevel::category, SDL_LogLevel::next, SDL_LogLevel::priority, SDL_application_priority, SDL_assert_priority, SDL_default_priority, SDL_LOG_CATEGORY_APPLICATION, SDL_LOG_CATEGORY_ASSERT, SDL_LOG_CATEGORY_TEST, and SDL_test_priority.

{
    SDL_LogLevel *entry;
    for (entry = SDL_loglevels; entry; entry = entry->next) {
        if (entry->category == category) {
            return entry->priority;
        }
    }
    if (category == SDL_LOG_CATEGORY_TEST) {
        return SDL_test_priority;
    } else if (category == SDL_LOG_CATEGORY_APPLICATION) {
        return SDL_application_priority;
    } else if (category == SDL_LOG_CATEGORY_ASSERT) {
        return SDL_assert_priority;
    } else {
        return SDL_default_priority;
    }
}

void SDL_LogInfo	(	int	category,
		SDL_PRINTF_FORMAT_STRING const char *	fmt,
			...
	)

Log a message with SDL_LOG_PRIORITY_INFO.

Definition at line 201 of file SDL_log.c.

References SDL_LOG_PRIORITY_INFO, and SDL_LogMessageV.

{
    va_list ap;
    va_start(ap, fmt);
    SDL_LogMessageV(category, SDL_LOG_PRIORITY_INFO, fmt, ap);
    va_end(ap);
}

void SDL_LogMessage	(	int	category,
		SDL_LogPriority	priority,
		SDL_PRINTF_FORMAT_STRING const char *	fmt,
			...
	)

Log a message with the specified category and priority.

Definition at line 241 of file SDL_log.c.

References SDL_LogMessageV.

{
    va_list ap;
    va_start(ap, fmt);
    SDL_LogMessageV(category, priority, fmt, ap);
    va_end(ap);
}

void SDL_LogMessageV	(	int	category,
		SDL_LogPriority	priority,
		const char *	fmt,
		va_list	ap
	)

Log a message with the specified category and priority.

Definition at line 265 of file SDL_log.c.

References SDL_log_function, SDL_log_userdata, SDL_LogGetPriority, SDL_MAX_LOG_MESSAGE, SDL_NUM_LOG_PRIORITIES, SDL_stack_alloc, SDL_stack_free, SDL_strlen, and SDL_vsnprintf.

{
    char *message;
    size_t len;
    /* Nothing to do if we don't have an output function */
    if (!SDL_log_function) {
        return;
    }
    /* Make sure we don't exceed array bounds */
    if ((int)priority < 0 || priority >= SDL_NUM_LOG_PRIORITIES) {
        return;
    }
    /* See if we want to do anything with this message */
    if (priority < SDL_LogGetPriority(category)) {
        return;
    }
    message = SDL_stack_alloc(char, SDL_MAX_LOG_MESSAGE);
    if (!message) {
        return;
    }
    SDL_vsnprintf(message, SDL_MAX_LOG_MESSAGE, fmt, ap);
    /* Chop off final endline. */
    len = SDL_strlen(message);
    if ((len > 0) && (message[len-1] == '\n')) {
        message[--len] = '\0';
        if ((len > 0) && (message[len-1] == '\r')) {  /* catch "\r\n", too. */
            message[--len] = '\0';
        }
    }
    SDL_log_function(SDL_log_userdata, category, priority, message);
    SDL_stack_free(message);
}

static void SDL_LogOutput	(	void *	userdata,
		int	category,
		SDL_LogPriority	priority,
		const char *	message
	)

static

Definition at line 314 of file SDL_log.c.

References NULL, sort_controllers::output, SDL_arraysize, SDL_free, SDL_MAX_LOG_MESSAGE, SDL_priority_prefixes, SDL_snprintf, SDL_stack_alloc, SDL_stack_free, SDL_strlen, text, and WIN_UTF8ToString.

{
#if defined(__WIN32__) || defined(__WINRT__)
    /* Way too many allocations here, urgh */
    /* Note: One can't call SDL_SetError here, since that function itself logs. */
    {
        char *output;
        size_t length;
        LPTSTR tstr;
#if !defined(HAVE_STDIO_H) && !defined(__WINRT__)
        BOOL attachResult;
        DWORD attachError;
        unsigned long charsWritten; 
        DWORD consoleMode;
        /* Maybe attach console and get stderr handle */
        if (consoleAttached == 0) {
            attachResult = AttachConsole(ATTACH_PARENT_PROCESS);
            if (!attachResult) {
                    attachError = GetLastError();
                    if (attachError == ERROR_INVALID_HANDLE) {
                        /* This is expected when running from Visual Studio */
                        /*OutputDebugString(TEXT("Parent process has no console\r\n"));*/
                        consoleAttached = -1;
                    } else if (attachError == ERROR_GEN_FAILURE) {
                         OutputDebugString(TEXT("Could not attach to console of parent process\r\n"));
                         consoleAttached = -1;
                    } else if (attachError == ERROR_ACCESS_DENIED) {  
                         /* Already attached */
                        consoleAttached = 1;
                    } else {
                        OutputDebugString(TEXT("Error attaching console\r\n"));
                        consoleAttached = -1;
                    }
                } else {
                    /* Newly attached */
                    consoleAttached = 1;
                }
                if (consoleAttached == 1) {
                        stderrHandle = GetStdHandle(STD_ERROR_HANDLE);
                        if (GetConsoleMode(stderrHandle, &consoleMode) == 0) {
                            /* WriteConsole fails if the output is redirected to a file. Must use WriteFile instead. */
                            consoleAttached = 2;
                        }
                }
        }
#endif /* !defined(HAVE_STDIO_H) && !defined(__WINRT__) */
        length = SDL_strlen(SDL_priority_prefixes[priority]) + 2 + SDL_strlen(message) + 1 + 1 + 1;
        output = SDL_stack_alloc(char, length);
        SDL_snprintf(output, length, "%s: %s\r\n", SDL_priority_prefixes[priority], message);
        tstr = WIN_UTF8ToString(output);
        
        /* Output to debugger */
        OutputDebugString(tstr);
       
#if !defined(HAVE_STDIO_H) && !defined(__WINRT__)
        /* Screen output to stderr, if console was attached. */
        if (consoleAttached == 1) {
                if (!WriteConsole(stderrHandle, tstr, lstrlen(tstr), &charsWritten, NULL)) {
                    OutputDebugString(TEXT("Error calling WriteConsole\r\n"));
                    if (GetLastError() == ERROR_NOT_ENOUGH_MEMORY) {
                        OutputDebugString(TEXT("Insufficient heap memory to write message\r\n"));
                    }
                }
        } else if (consoleAttached == 2) {
            if (!WriteFile(stderrHandle, output, lstrlenA(output), &charsWritten, NULL)) {
                OutputDebugString(TEXT("Error calling WriteFile\r\n"));
            }
        }
#endif /* !defined(HAVE_STDIO_H) && !defined(__WINRT__) */
        SDL_free(tstr);
        SDL_stack_free(output);
    }
#elif defined(__ANDROID__)
    {
        char tag[32];
        SDL_snprintf(tag, SDL_arraysize(tag), "SDL/%s", GetCategoryPrefix(category));
        __android_log_write(SDL_android_priority[priority], tag, message);
    }
#elif defined(__APPLE__) && defined(SDL_VIDEO_DRIVER_COCOA)
    /* Technically we don't need SDL_VIDEO_DRIVER_COCOA, but that's where this function is defined for now.
    */
    extern void SDL_NSLog(const char *text);
    {
        char *text;
        text = SDL_stack_alloc(char, SDL_MAX_LOG_MESSAGE);
        if (text) {
            SDL_snprintf(text, SDL_MAX_LOG_MESSAGE, "%s: %s", SDL_priority_prefixes[priority], message);
            SDL_NSLog(text);
            SDL_stack_free(text);
            return;
        }
    }
#elif defined(__PSP__)
    {
        FILE*        pFile;
        pFile = fopen ("SDL_Log.txt", "a");
        fprintf(pFile, "%s: %s\n", SDL_priority_prefixes[priority], message);
        fclose (pFile);
    }
#endif
#if HAVE_STDIO_H
    fprintf(stderr, "%s: %s\n", SDL_priority_prefixes[priority], message);
#if __NACL__
    fflush(stderr);
#endif
#endif
}

void SDL_LogResetPriorities ( void )

Reset all priorities to default.

Note: This is called in SDL_Quit().

Definition at line 154 of file SDL_log.c.

References DEFAULT_APPLICATION_PRIORITY, DEFAULT_ASSERT_PRIORITY, DEFAULT_PRIORITY, DEFAULT_TEST_PRIORITY, SDL_LogLevel::next, SDL_application_priority, SDL_assert_priority, SDL_default_priority, SDL_free, SDL_loglevels, and SDL_test_priority.

{
    SDL_LogLevel *entry;
    while (SDL_loglevels) {
        entry = SDL_loglevels;
        SDL_loglevels = entry->next;
        SDL_free(entry);
    }
    SDL_default_priority = DEFAULT_PRIORITY;
    SDL_assert_priority = DEFAULT_ASSERT_PRIORITY;
    SDL_application_priority = DEFAULT_APPLICATION_PRIORITY;
    SDL_test_priority = DEFAULT_TEST_PRIORITY;
}

void SDL_LogSetAllPriority ( SDL_LogPriority priority )

Set the priority of all log categories.

Definition at line 97 of file SDL_log.c.

References SDL_LogLevel::next, SDL_LogLevel::priority, SDL_application_priority, SDL_assert_priority, and SDL_default_priority.

{
    SDL_LogLevel *entry;
    for (entry = SDL_loglevels; entry; entry = entry->next) {
        entry->priority = priority;
    }
    SDL_default_priority = priority;
    SDL_assert_priority = priority;
    SDL_application_priority = priority;
}

void SDL_LogSetOutputFunction	(	SDL_LogOutputFunction	callback,
		void *	userdata
	)

This function allows you to replace the default log output function with one of your own.

Definition at line 444 of file SDL_log.c.

References callback(), SDL_log_function, and SDL_log_userdata.

{
    SDL_log_function = callback;
    SDL_log_userdata = userdata;
}

void SDL_LogSetPriority	(	int	category,
		SDL_LogPriority	priority
	)

Set the priority of a particular log category.

Definition at line 110 of file SDL_log.c.

References SDL_LogLevel::category, SDL_LogLevel::next, SDL_LogLevel::priority, SDL_loglevels, and SDL_malloc.

{
    SDL_LogLevel *entry;
    for (entry = SDL_loglevels; entry; entry = entry->next) {
        if (entry->category == category) {
            entry->priority = priority;
            return;
        }
    }
    /* Create a new entry */
    entry = (SDL_LogLevel *)SDL_malloc(sizeof(*entry));
    if (entry) {
        entry->category = category;
        entry->priority = priority;
        entry->next = SDL_loglevels;
        SDL_loglevels = entry;
    }
}

void SDL_LogVerbose	(	int	category,
		SDL_PRINTF_FORMAT_STRING const char *	fmt,
			...
	)

Log a message with SDL_LOG_PRIORITY_VERBOSE.

Definition at line 181 of file SDL_log.c.

References SDL_LOG_PRIORITY_VERBOSE, and SDL_LogMessageV.

{
    va_list ap;
    va_start(ap, fmt);
    SDL_LogMessageV(category, SDL_LOG_PRIORITY_VERBOSE, fmt, ap);
    va_end(ap);
}

void SDL_LogWarn	(	int	category,
		SDL_PRINTF_FORMAT_STRING const char *	fmt,
			...
	)

Log a message with SDL_LOG_PRIORITY_WARN.

Definition at line 211 of file SDL_log.c.

References SDL_LOG_PRIORITY_WARN, and SDL_LogMessageV.

{
    va_list ap;
    va_start(ap, fmt);
    SDL_LogMessageV(category, SDL_LOG_PRIORITY_WARN, fmt, ap);
    va_end(ap);
}

Variable Documentation

SDL_LogPriority SDL_application_priority = DEFAULT_APPLICATION_PRIORITY

static

Definition at line 58 of file SDL_log.c.

Referenced by SDL_LogGetPriority(), SDL_LogResetPriorities(), and SDL_LogSetAllPriority().

SDL_LogPriority SDL_assert_priority = DEFAULT_ASSERT_PRIORITY

static

Definition at line 57 of file SDL_log.c.

Referenced by SDL_LogGetPriority(), SDL_LogResetPriorities(), and SDL_LogSetAllPriority().

SDL_LogPriority SDL_default_priority = DEFAULT_PRIORITY

static

Definition at line 56 of file SDL_log.c.

Referenced by SDL_LogGetPriority(), SDL_LogResetPriorities(), and SDL_LogSetAllPriority().

SDL_LogOutputFunction SDL_log_function = SDL_LogOutput

static

Definition at line 60 of file SDL_log.c.

Referenced by SDL_LogGetOutputFunction(), SDL_LogMessageV(), and SDL_LogSetOutputFunction().

void* SDL_log_userdata = NULL

static

Definition at line 61 of file SDL_log.c.

Referenced by SDL_LogGetOutputFunction(), SDL_LogMessageV(), and SDL_LogSetOutputFunction().

SDL_LogLevel* SDL_loglevels

static

Definition at line 55 of file SDL_log.c.

Referenced by SDL_LogResetPriorities(), and SDL_LogSetPriority().

const char* SDL_priority_prefixes[SDL_NUM_LOG_PRIORITIES]

static

Initial value:

 {
    NULL,
    "VERBOSE",
    "DEBUG",
    "INFO",
    "WARN",
    "ERROR",
    "CRITICAL"
}

Definition at line 63 of file SDL_log.c.

Referenced by SDL_LogOutput().

SDL_LogPriority SDL_test_priority = DEFAULT_TEST_PRIORITY

static

Definition at line 59 of file SDL_log.c.

Referenced by SDL_LogGetPriority(), and SDL_LogResetPriorities().

Data Structures

Macros

Functions

Variables

Macro Definition Documentation

Function Documentation

Variable Documentation