eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-25 22:19:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Added SDL_LogTrace()

Browse source
This commit is contained in:
Sam Lantinga 2024-09-17 01:55:22 -07:00
parent 6180da00e1
commit 231ea07617
7 changed files with 58 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

34
include/SDL3/SDL_log.h
View file

@ -121,6 +121,7 @@ typedef enum SDL_LogCategory
typedef enum SDL_LogPriority typedef enum SDL_LogPriority
{ {
SDL_LOG_PRIORITY_INVALID, SDL_LOG_PRIORITY_INVALID,
SDL_LOG_PRIORITY_TRACE,
SDL_LOG_PRIORITY_VERBOSE, SDL_LOG_PRIORITY_VERBOSE,
SDL_LOG_PRIORITY_DEBUG, SDL_LOG_PRIORITY_DEBUG,
SDL_LOG_PRIORITY_INFO, SDL_LOG_PRIORITY_INFO,
@ -228,11 +229,37 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetLogPriorityPrefix(SDL_LogPriority pr
* \sa SDL_LogInfo * \sa SDL_LogInfo
* \sa SDL_LogMessage * \sa SDL_LogMessage
* \sa SDL_LogMessageV * \sa SDL_LogMessageV
* \sa SDL_LogTrace
* \sa SDL_LogVerbose * \sa SDL_LogVerbose
* \sa SDL_LogWarn * \sa SDL_LogWarn
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_Log(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1); extern SDL_DECLSPEC void SDLCALL SDL_Log(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
/**
* Log a message with SDL_LOG_PRIORITY_TRACE.
*
* \param category the category of the message.
* \param fmt a printf() style message format string.
* \param ... additional parameters matching % tokens in the **fmt** string,
* if any.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_Log
* \sa SDL_LogCritical
* \sa SDL_LogDebug
* \sa SDL_LogError
* \sa SDL_LogInfo
* \sa SDL_LogMessage
* \sa SDL_LogMessageV
* \sa SDL_LogTrace
* \sa SDL_LogVerbose
* \sa SDL_LogWarn
*/
extern SDL_DECLSPEC void SDLCALL SDL_LogTrace(int category, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2);
/** /**
* Log a message with SDL_LOG_PRIORITY_VERBOSE. * Log a message with SDL_LOG_PRIORITY_VERBOSE.
* *
@ -274,6 +301,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogVerbose(int category, SDL_PRINTF_FORMAT_
* \sa SDL_LogInfo * \sa SDL_LogInfo
* \sa SDL_LogMessage * \sa SDL_LogMessage
* \sa SDL_LogMessageV * \sa SDL_LogMessageV
* \sa SDL_LogTrace
* \sa SDL_LogVerbose * \sa SDL_LogVerbose
* \sa SDL_LogWarn * \sa SDL_LogWarn
*/ */
@ -297,6 +325,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogDebug(int category, SDL_PRINTF_FORMAT_ST
* \sa SDL_LogError * \sa SDL_LogError
* \sa SDL_LogMessage * \sa SDL_LogMessage
* \sa SDL_LogMessageV * \sa SDL_LogMessageV
* \sa SDL_LogTrace
* \sa SDL_LogVerbose * \sa SDL_LogVerbose
* \sa SDL_LogWarn * \sa SDL_LogWarn
*/ */
@ -321,6 +350,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogInfo(int category, SDL_PRINTF_FORMAT_STR
* \sa SDL_LogInfo * \sa SDL_LogInfo
* \sa SDL_LogMessage * \sa SDL_LogMessage
* \sa SDL_LogMessageV * \sa SDL_LogMessageV
* \sa SDL_LogTrace
* \sa SDL_LogVerbose * \sa SDL_LogVerbose
*/ */
extern SDL_DECLSPEC void SDLCALL SDL_LogWarn(int category, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2); extern SDL_DECLSPEC void SDLCALL SDL_LogWarn(int category, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2);
@ -343,6 +373,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogWarn(int category, SDL_PRINTF_FORMAT_STR
* \sa SDL_LogInfo * \sa SDL_LogInfo
* \sa SDL_LogMessage * \sa SDL_LogMessage
* \sa SDL_LogMessageV * \sa SDL_LogMessageV
* \sa SDL_LogTrace
* \sa SDL_LogVerbose * \sa SDL_LogVerbose
* \sa SDL_LogWarn * \sa SDL_LogWarn
*/ */
@ -366,6 +397,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogError(int category, SDL_PRINTF_FORMAT_ST
* \sa SDL_LogInfo * \sa SDL_LogInfo
* \sa SDL_LogMessage * \sa SDL_LogMessage
* \sa SDL_LogMessageV * \sa SDL_LogMessageV
* \sa SDL_LogTrace
* \sa SDL_LogVerbose * \sa SDL_LogVerbose
* \sa SDL_LogWarn * \sa SDL_LogWarn
*/ */
@ -390,6 +422,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogCritical(int category, SDL_PRINTF_FORMAT
* \sa SDL_LogError * \sa SDL_LogError
* \sa SDL_LogInfo * \sa SDL_LogInfo
* \sa SDL_LogMessageV * \sa SDL_LogMessageV
* \sa SDL_LogTrace
* \sa SDL_LogVerbose * \sa SDL_LogVerbose
* \sa SDL_LogWarn * \sa SDL_LogWarn
*/ */
@ -415,6 +448,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogMessage(int category,
* \sa SDL_LogError * \sa SDL_LogError
* \sa SDL_LogInfo * \sa SDL_LogInfo
* \sa SDL_LogMessage * \sa SDL_LogMessage
* \sa SDL_LogTrace
* \sa SDL_LogVerbose * \sa SDL_LogVerbose
* \sa SDL_LogWarn * \sa SDL_LogWarn
*/ */

22
src/SDL_log.c
View file

@ -75,6 +75,7 @@ static void *SDL_log_userdata SDL_GUARDED_BY(SDL_log_function_lock) = NULL;
// If this list changes, update the documentation for SDL_HINT_LOGGING // If this list changes, update the documentation for SDL_HINT_LOGGING
static const char * const SDL_priority_names[] = { static const char * const SDL_priority_names[] = {
NULL, NULL,
"TRACE",
"VERBOSE", "VERBOSE",
"DEBUG", "DEBUG",
"INFO", "INFO",
@ -107,15 +108,17 @@ SDL_COMPILE_TIME_ASSERT(category_names, SDL_arraysize(SDL_category_names) == SDL
#endif #endif
#ifdef SDL_PLATFORM_ANDROID #ifdef SDL_PLATFORM_ANDROID
static int SDL_android_priority[SDL_LOG_PRIORITY_COUNT] = { static int SDL_android_priority[] = {
ANDROID_LOG_UNKNOWN, ANDROID_LOG_UNKNOWN,
ANDROID_LOG_VERBOSE, ANDROID_LOG_VERBOSE,
ANDROID_LOG_VERBOSE,
ANDROID_LOG_DEBUG, ANDROID_LOG_DEBUG,
ANDROID_LOG_INFO, ANDROID_LOG_INFO,
ANDROID_LOG_WARN, ANDROID_LOG_WARN,
ANDROID_LOG_ERROR, ANDROID_LOG_ERROR,
ANDROID_LOG_FATAL ANDROID_LOG_FATAL
}; };
SDL_COMPILE_TIME_ASSERT(android_priority, SDL_arraysize(SDL_android_priority) == SDL_LOG_PRIORITY_COUNT);
#endif // SDL_PLATFORM_ANDROID #endif // SDL_PLATFORM_ANDROID
static void SDLCALL SDL_LoggingChanged(void *userdata, const char *name, const char *oldValue, const char *hint) static void SDLCALL SDL_LoggingChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
@ -302,7 +305,7 @@ static bool ParseLogPriority(const char *string, size_t length, SDL_LogPriority
*priority = SDL_LOG_PRIORITY_COUNT; *priority = SDL_LOG_PRIORITY_COUNT;
return true; return true;
} }
if (i >= SDL_LOG_PRIORITY_VERBOSE && i < SDL_LOG_PRIORITY_COUNT) { if (i > SDL_LOG_PRIORITY_INVALID && i < SDL_LOG_PRIORITY_COUNT) {
*priority = (SDL_LogPriority)i; *priority = (SDL_LogPriority)i;
return true; return true;
} }
@ -314,7 +317,7 @@ static bool ParseLogPriority(const char *string, size_t length, SDL_LogPriority
return true; return true;
} }
for (i = SDL_LOG_PRIORITY_VERBOSE; i < SDL_LOG_PRIORITY_COUNT; ++i) { for (i = SDL_LOG_PRIORITY_INVALID + 1; i < SDL_LOG_PRIORITY_COUNT; ++i) {
if (SDL_strncasecmp(string, SDL_priority_names[i], length) == 0) { if (SDL_strncasecmp(string, SDL_priority_names[i], length) == 0) {
*priority = (SDL_LogPriority)i; *priority = (SDL_LogPriority)i;
return true; return true;
@ -327,7 +330,7 @@ static void ParseLogPriorities(const char *hint)
{ {
const char *name, *next; const char *name, *next;
int category = DEFAULT_CATEGORY; int category = DEFAULT_CATEGORY;
SDL_LogPriority priority = SDL_LOG_PRIORITY_COUNT; SDL_LogPriority priority = SDL_LOG_PRIORITY_INVALID;
if (SDL_strchr(hint, '=') == NULL) { if (SDL_strchr(hint, '=') == NULL) {
if (ParseLogPriority(hint, SDL_strlen(hint), &priority)) { if (ParseLogPriority(hint, SDL_strlen(hint), &priority)) {
@ -427,7 +430,7 @@ static void CleanupLogPrefixes(void)
static const char *GetLogPriorityPrefix(SDL_LogPriority priority) static const char *GetLogPriorityPrefix(SDL_LogPriority priority)
{ {
if (priority < SDL_LOG_PRIORITY_VERBOSE || priority >= SDL_LOG_PRIORITY_COUNT) { if (priority <= SDL_LOG_PRIORITY_INVALID || priority >= SDL_LOG_PRIORITY_COUNT) {
return ""; return "";
} }
@ -485,6 +488,15 @@ void SDL_Log(SDL_PRINTF_FORMAT_STRING const char *fmt, ...)
va_end(ap); va_end(ap);
} }
void SDL_LogTrace(int category, SDL_PRINTF_FORMAT_STRING const char *fmt, ...)
{
va_list ap;
va_start(ap, fmt);
SDL_LogMessageV(category, SDL_LOG_PRIORITY_TRACE, fmt, ap);
va_end(ap);
}
void SDL_LogVerbose(int category, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) void SDL_LogVerbose(int category, SDL_PRINTF_FORMAT_STRING const char *fmt, ...)
{ {
va_list ap; va_list ap;

2
src/dynapi/SDL_dynapi.c
View file

@ -168,6 +168,7 @@ static void SDL_InitDynamicAPI(void);
jump_table.SDL_LogMessageV(category, priority, fmt, ap); \ jump_table.SDL_LogMessageV(category, priority, fmt, ap); \
va_end(ap); \ va_end(ap); \
} \ } \
SDL_DYNAPI_VARARGS_LOGFN(_static, name, initcall, Trace, TRACE) \
SDL_DYNAPI_VARARGS_LOGFN(_static, name, initcall, Verbose, VERBOSE) \ SDL_DYNAPI_VARARGS_LOGFN(_static, name, initcall, Verbose, VERBOSE) \
SDL_DYNAPI_VARARGS_LOGFN(_static, name, initcall, Debug, DEBUG) \ SDL_DYNAPI_VARARGS_LOGFN(_static, name, initcall, Debug, DEBUG) \
SDL_DYNAPI_VARARGS_LOGFN(_static, name, initcall, Info, INFO) \ SDL_DYNAPI_VARARGS_LOGFN(_static, name, initcall, Info, INFO) \
@ -317,6 +318,7 @@ static void SDLCALL SDL_LogMessage_LOGSDLCALLS(int category, SDL_LogPriority pri
SDL_LogMessageV_REAL(category, SDL_LOG_PRIORITY_##prio, fmt, ap); \ SDL_LogMessageV_REAL(category, SDL_LOG_PRIORITY_##prio, fmt, ap); \
va_end(ap); \ va_end(ap); \
} }
SDL_DYNAPI_VARARGS_LOGFN_LOGSDLCALLS(Trace, TRACE)
SDL_DYNAPI_VARARGS_LOGFN_LOGSDLCALLS(Verbose, VERBOSE) SDL_DYNAPI_VARARGS_LOGFN_LOGSDLCALLS(Verbose, VERBOSE)
SDL_DYNAPI_VARARGS_LOGFN_LOGSDLCALLS(Debug, DEBUG) SDL_DYNAPI_VARARGS_LOGFN_LOGSDLCALLS(Debug, DEBUG)
SDL_DYNAPI_VARARGS_LOGFN_LOGSDLCALLS(Info, INFO) SDL_DYNAPI_VARARGS_LOGFN_LOGSDLCALLS(Info, INFO)

1
src/dynapi/SDL_dynapi.sym
View file

@ -629,6 +629,7 @@ SDL3_0.0.0 {
SDL_LogInfo; SDL_LogInfo;
SDL_LogMessage; SDL_LogMessage;
SDL_LogMessageV; SDL_LogMessageV;
SDL_LogTrace;
SDL_LogVerbose; SDL_LogVerbose;
SDL_LogWarn; SDL_LogWarn;
SDL_MapGPUTransferBuffer; SDL_MapGPUTransferBuffer;

1
src/dynapi/SDL_dynapi_overrides.h
View file

@ -654,6 +654,7 @@
#define SDL_LogInfo SDL_LogInfo_REAL #define SDL_LogInfo SDL_LogInfo_REAL
#define SDL_LogMessage SDL_LogMessage_REAL #define SDL_LogMessage SDL_LogMessage_REAL
#define SDL_LogMessageV SDL_LogMessageV_REAL #define SDL_LogMessageV SDL_LogMessageV_REAL
#define SDL_LogTrace SDL_LogTrace_REAL
#define SDL_LogVerbose SDL_LogVerbose_REAL #define SDL_LogVerbose SDL_LogVerbose_REAL
#define SDL_LogWarn SDL_LogWarn_REAL #define SDL_LogWarn SDL_LogWarn_REAL
#define SDL_MapGPUTransferBuffer SDL_MapGPUTransferBuffer_REAL #define SDL_MapGPUTransferBuffer SDL_MapGPUTransferBuffer_REAL

1
src/dynapi/SDL_dynapi_procs.h
View file

@ -37,6 +37,7 @@ SDL_DYNAPI_PROC(void,SDL_LogDebug,(int a, SDL_PRINTF_FORMAT_STRING const char *b
SDL_DYNAPI_PROC(void,SDL_LogError,(int a, SDL_PRINTF_FORMAT_STRING const char *b, ...),(a,b),) SDL_DYNAPI_PROC(void,SDL_LogError,(int a, SDL_PRINTF_FORMAT_STRING const char *b, ...),(a,b),)
SDL_DYNAPI_PROC(void,SDL_LogInfo,(int a, SDL_PRINTF_FORMAT_STRING const char *b, ...),(a,b),) SDL_DYNAPI_PROC(void,SDL_LogInfo,(int a, SDL_PRINTF_FORMAT_STRING const char *b, ...),(a,b),)
SDL_DYNAPI_PROC(void,SDL_LogMessage,(int a, SDL_LogPriority b, SDL_PRINTF_FORMAT_STRING const char *c, ...),(a,b,c),) SDL_DYNAPI_PROC(void,SDL_LogMessage,(int a, SDL_LogPriority b, SDL_PRINTF_FORMAT_STRING const char *c, ...),(a,b,c),)
SDL_DYNAPI_PROC(void,SDL_LogTrace,(int a, SDL_PRINTF_FORMAT_STRING const char *b, ...),(a,b),)
SDL_DYNAPI_PROC(void,SDL_LogVerbose,(int a, SDL_PRINTF_FORMAT_STRING const char *b, ...),(a,b),) SDL_DYNAPI_PROC(void,SDL_LogVerbose,(int a, SDL_PRINTF_FORMAT_STRING const char *b, ...),(a,b),)
SDL_DYNAPI_PROC(void,SDL_LogWarn,(int a, SDL_PRINTF_FORMAT_STRING const char *b, ...),(a,b),) SDL_DYNAPI_PROC(void,SDL_LogWarn,(int a, SDL_PRINTF_FORMAT_STRING const char *b, ...),(a,b),)
SDL_DYNAPI_PROC(SDL_bool,SDL_SetError,(SDL_PRINTF_FORMAT_STRING const char *a, ...),(a),return) SDL_DYNAPI_PROC(SDL_bool,SDL_SetError,(SDL_PRINTF_FORMAT_STRING const char *a, ...),(a),return)

4
test/testautomation_log.c
View file

@ -138,8 +138,8 @@ static int SDLCALL log_testHint(void *arg)
} }
SDL_SetHint(SDL_HINT_LOGGING, "0=4,3=2,2=0,*=3"); SDL_SetHint(SDL_HINT_LOGGING, "0=5,3=3,2=0,*=4");
SDLTest_AssertPass("SDL_SetHint(SDL_HINT_LOGGING, \"0=4,3=2,2=0,*=3\")"); SDLTest_AssertPass("SDL_SetHint(SDL_HINT_LOGGING, \"0=5,3=3,2=1,*=4\")");
{ {
EnableTestLog(&count); EnableTestLog(&count);
SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION, SDL_LOG_PRIORITY_WARN, "test"); SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION, SDL_LOG_PRIORITY_WARN, "test");