SDL3pp
A slim C++ wrapper for SDL3
Loading...
Searching...
No Matches
SDL3pp_log.h
1#ifndef SDL3PP_LOG_H_
2#define SDL3PP_LOG_H_
3
4#include <format>
5#include <SDL3/SDL_log.h>
6#include "SDL3pp_callbackWrapper.h"
7#include "SDL3pp_error.h"
8#include "SDL3pp_strings.h"
9
10namespace SDL {
11
63using LogCategoryRaw = SDL_LogCategory;
64
65// Forward decl
66struct LogCategory;
67
81using LogPriority = SDL_LogPriority;
82
84 SDL_LOG_PRIORITY_INVALID;
85
86constexpr LogPriority LOG_PRIORITY_TRACE = SDL_LOG_PRIORITY_TRACE;
87
89 SDL_LOG_PRIORITY_VERBOSE;
90
91constexpr LogPriority LOG_PRIORITY_DEBUG = SDL_LOG_PRIORITY_DEBUG;
92
93constexpr LogPriority LOG_PRIORITY_INFO = SDL_LOG_PRIORITY_INFO;
94
95constexpr LogPriority LOG_PRIORITY_WARN = SDL_LOG_PRIORITY_WARN;
96
97constexpr LogPriority LOG_PRIORITY_ERROR = SDL_LOG_PRIORITY_ERROR;
98
100 SDL_LOG_PRIORITY_CRITICAL;
101
102constexpr LogPriority LOG_PRIORITY_COUNT = SDL_LOG_PRIORITY_COUNT;
103
105
128{
129 LogCategoryRaw m_category;
130
131public:
137 constexpr LogCategory(
138 LogCategoryRaw category = SDL_LOG_CATEGORY_APPLICATION) noexcept
139 : m_category(category)
140 {
141 }
142
148 constexpr explicit LogCategory(int category)
149 : m_category(SDL_LogCategory(category))
150 {
151 }
152
158 constexpr operator LogCategoryRaw() const noexcept { return m_category; }
159
173 void SetLogPriority(LogPriority priority) const;
174
187
208 void LogUnformatted(LogPriority priority, StringParam message) const
209 {
210 SDL_LogMessage(m_category, priority, "%s", (const char*)(message));
211 }
212
238 template<class... ARGS>
239 void LogMessage(LogPriority priority,
240 std::string_view fmt,
241 ARGS... args) const;
242
266 template<class... ARGS>
267 void LogTrace(std::string_view fmt, ARGS&&... args) const;
268
292 template<class... ARGS>
293 void LogVerbose(std::string_view fmt, ARGS&&... args) const;
294
319 template<class... ARGS>
320 void LogDebug(std::string_view fmt, ARGS&&... args) const;
321
346 template<class... ARGS>
347 void LogInfo(std::string_view fmt, ARGS&&... args) const;
348
373 template<class... ARGS>
374 void LogWarn(std::string_view fmt, ARGS&&... args) const;
375
400 template<class... ARGS>
401 void LogError(std::string_view fmt, ARGS&&... args) const;
402
428 template<class... ARGS>
429 void LogCritical(std::string_view fmt, ARGS&&... args) const;
430};
431
433 SDL_LOG_CATEGORY_APPLICATION;
434
435constexpr LogCategory LOG_CATEGORY_ERROR = SDL_LOG_CATEGORY_ERROR;
436
437constexpr LogCategory LOG_CATEGORY_ASSERT = SDL_LOG_CATEGORY_ASSERT;
438
439constexpr LogCategory LOG_CATEGORY_SYSTEM = SDL_LOG_CATEGORY_SYSTEM;
440
441constexpr LogCategory LOG_CATEGORY_AUDIO = SDL_LOG_CATEGORY_AUDIO;
442
443constexpr LogCategory LOG_CATEGORY_VIDEO = SDL_LOG_CATEGORY_VIDEO;
444
445constexpr LogCategory LOG_CATEGORY_RENDER = SDL_LOG_CATEGORY_RENDER;
446
447constexpr LogCategory LOG_CATEGORY_INPUT = SDL_LOG_CATEGORY_INPUT;
448
449constexpr LogCategory LOG_CATEGORY_TEST = SDL_LOG_CATEGORY_TEST;
450
451constexpr LogCategory LOG_CATEGORY_GPU = SDL_LOG_CATEGORY_GPU;
452
454 SDL_LOG_CATEGORY_RESERVED2;
455
457 SDL_LOG_CATEGORY_RESERVED3;
458
460 SDL_LOG_CATEGORY_RESERVED4;
461
463 SDL_LOG_CATEGORY_RESERVED5;
464
466 SDL_LOG_CATEGORY_RESERVED6;
467
469 SDL_LOG_CATEGORY_RESERVED7;
470
472 SDL_LOG_CATEGORY_RESERVED8;
473
475 SDL_LOG_CATEGORY_RESERVED9;
476
478 SDL_LOG_CATEGORY_RESERVED10;
479
480constexpr LogCategory LOG_CATEGORY_CUSTOM = SDL_LOG_CATEGORY_CUSTOM;
481
494inline void SetLogPriorities(LogPriority priority)
495{
496 SDL_SetLogPriorities(priority);
497}
498
513inline void SetLogPriority(int category, LogPriority priority)
514{
515 SDL_SetLogPriority(category, priority);
516}
517
518inline void LogCategory::SetLogPriority(LogPriority priority) const
519{
520 SDL::SetLogPriority(m_category, priority);
521}
522
535inline LogPriority GetLogPriority(int category)
536{
537 return SDL_GetLogPriority(category);
538}
539
541{
542 return SDL::GetLogPriority(m_category);
543}
544
557inline void ResetLogPriorities() { SDL_ResetLogPriorities(); }
558
580inline void SetLogPriorityPrefix(LogPriority priority, StringParam prefix)
581{
582 CheckError(SDL_SetLogPriorityPrefix(priority, prefix));
583}
584
607inline void LogUnformatted(LogCategory category,
608 LogPriority priority,
609 StringParam message)
610{
611 SDL_LogMessage(category, priority, "%s", static_cast<const char*>(message));
612}
613
633inline void LogUnformatted(StringParam message)
634{
635 SDL_Log("%s", static_cast<const char*>(message));
636}
637
665template<class... ARGS>
666inline void Log(std::string_view fmt, ARGS&&... args)
667{
668 LOG_CATEGORY_APPLICATION.LogInfo(fmt, std::forward<ARGS>(args)...);
669}
670
694template<class... ARGS>
695inline void LogMessage(LogCategory category,
696 LogPriority priority,
697 std::string_view fmt,
698 ARGS... args)
699{
701 category, priority, std::vformat(fmt, std::make_format_args(args...)));
702}
703
704template<class... ARGS>
706 std::string_view fmt,
707 ARGS... args) const
708{
709 SDL::LogMessage(m_category, priority, fmt, args...);
710}
711
735template<class... ARGS>
736inline void LogTrace(LogCategory category, std::string_view fmt, ARGS&&... args)
737{
738 LogMessage(category, LOG_PRIORITY_TRACE, fmt, args...);
739}
740
741template<class... ARGS>
742inline void LogCategory::LogTrace(std::string_view fmt, ARGS&&... args) const
743{
744 SDL::LogTrace(m_category, fmt, args...);
745}
746
768template<class... ARGS>
769inline void LogVerbose(LogCategory category,
770 std::string_view fmt,
771 ARGS&&... args)
772{
773 LogMessage(category, LOG_PRIORITY_VERBOSE, fmt, args...);
774}
775
776template<class... ARGS>
777inline void LogCategory::LogVerbose(std::string_view fmt, ARGS&&... args) const
778{
779 SDL::LogVerbose(m_category, fmt, args...);
780}
781
804template<class... ARGS>
805inline void LogDebug(LogCategory category, std::string_view fmt, ARGS&&... args)
806{
807 LogMessage(category, LOG_PRIORITY_DEBUG, fmt, args...);
808}
809
810template<class... ARGS>
811inline void LogCategory::LogDebug(std::string_view fmt, ARGS&&... args) const
812{
813 SDL::LogDebug(m_category, fmt, args...);
814}
815
838template<class... ARGS>
839inline void LogInfo(LogCategory category, std::string_view fmt, ARGS&&... args)
840{
841 LogMessage(category, LOG_PRIORITY_INFO, fmt, args...);
842}
843
844template<class... ARGS>
845inline void LogCategory::LogInfo(std::string_view fmt, ARGS&&... args) const
846{
847 SDL::LogInfo(m_category, fmt, args...);
848}
849
872template<class... ARGS>
873inline void LogWarn(LogCategory category, std::string_view fmt, ARGS&&... args)
874{
875 LogMessage(category, SDL_LOG_PRIORITY_WARN, fmt, args...);
876}
877
878template<class... ARGS>
879inline void LogCategory::LogWarn(std::string_view fmt, ARGS&&... args) const
880{
881 SDL::LogWarn(m_category, fmt, args...);
882}
883
906template<class... ARGS>
907inline void LogError(LogCategory category, std::string_view fmt, ARGS&&... args)
908{
909 LogMessage(category, SDL_LOG_PRIORITY_ERROR, fmt, args...);
910}
911
912template<class... ARGS>
913inline void LogCategory::LogError(std::string_view fmt, ARGS&&... args) const
914{
915 SDL::LogError(m_category, fmt, args...);
916}
917
940template<class... ARGS>
941inline void LogCritical(LogCategory category,
942 std::string_view fmt,
943 ARGS&&... args)
944{
945 LogMessage(category, SDL_LOG_PRIORITY_CRITICAL, fmt, args...);
946}
947
948template<class... ARGS>
949inline void LogCategory::LogCritical(std::string_view fmt, ARGS&&... args) const
950{
951 SDL::LogCritical(m_category, fmt, args...);
952}
953
968using LogOutputFunction = void(SDLCALL*)(void* userdata,
969 int category,
970 LogPriority priority,
971 const char* message);
972
991 void(int category, LogPriority priority, const char* message)>;
992
1006{
1007 return SDL_GetDefaultLogOutputFunction();
1008}
1009
1024inline void GetLogOutputFunction(LogOutputFunction* callback, void** userdata)
1025{
1026 SDL_GetLogOutputFunction(callback, userdata);
1027}
1028
1043inline void SetLogOutputFunction(LogOutputFunction callback, void* userdata)
1044{
1045 SDL_SetLogOutputFunction(callback, userdata);
1046}
1047
1062{
1063 SetLogOutputFunction(callback.wrapper, callback.data);
1064}
1065
1077{
1079}
1080
1082
1083} // namespace SDL
1084
1085#endif /* SDL3PP_LOG_H_ */
The predefined log categories.
Definition: SDL3pp_log.h:128
Helpers to use C++ strings parameters.
Definition: SDL3pp_strings.h:43
constexpr void CheckError(bool result)
Check and throw if returned value from SDL is an error.
Definition: SDL3pp_error.h:197
void SetLogPriorities(LogPriority priority)
Set the priority of all log categories.
Definition: SDL3pp_log.h:494
constexpr LogCategory LOG_CATEGORY_ASSERT
ASSERT.
Definition: SDL3pp_log.h:437
constexpr LogCategory LOG_CATEGORY_AUDIO
AUDIO.
Definition: SDL3pp_log.h:441
void LogWarn(std::string_view fmt, ARGS &&... args) const
Log a message with LOG_PRIORITY_WARN.
Definition: SDL3pp_log.h:879
constexpr LogCategory LOG_CATEGORY_VIDEO
VIDEO.
Definition: SDL3pp_log.h:443
SDL_LogCategory LogCategoryRaw
Alias to raw representation for LogCategory.
Definition: SDL3pp_log.h:63
constexpr LogCategory LOG_CATEGORY_RESERVED10
RESERVED10.
Definition: SDL3pp_log.h:477
void LogVerbose(LogCategory category, std::string_view fmt, ARGS &&... args)
Log a message with LOG_PRIORITY_VERBOSE.
Definition: SDL3pp_log.h:769
void SetLogPriorityPrefix(LogPriority priority, StringParam prefix)
Set the text prepended to log messages of a given priority.
Definition: SDL3pp_log.h:580
LogPriority GetLogPriority(int category)
Get the priority of a particular log category.
Definition: SDL3pp_log.h:535
void SetLogPriority(int category, LogPriority priority)
Set the priority of a particular log category.
Definition: SDL3pp_log.h:513
void LogTrace(LogCategory category, std::string_view fmt, ARGS &&... args)
Log a message with LOG_PRIORITY_TRACE.
Definition: SDL3pp_log.h:736
void LogUnformatted(LogPriority priority, StringParam message) const
Log an unformatted message with the specified priority.
Definition: SDL3pp_log.h:208
constexpr LogPriority LOG_PRIORITY_INVALID
INVALID.
Definition: SDL3pp_log.h:83
void SetLogOutputFunction(LogOutputFunction callback, void *userdata)
Replace the default log output function with one of your own.
Definition: SDL3pp_log.h:1043
constexpr LogCategory LOG_CATEGORY_INPUT
INPUT.
Definition: SDL3pp_log.h:447
constexpr LogCategory LOG_CATEGORY_ERROR
ERROR.
Definition: SDL3pp_log.h:435
void LogInfo(std::string_view fmt, ARGS &&... args) const
Log a message with LOG_PRIORITY_INFO.
Definition: SDL3pp_log.h:845
constexpr LogCategory(int category)
Wraps LogCategory.
Definition: SDL3pp_log.h:148
constexpr LogCategory LOG_CATEGORY_RESERVED5
RESERVED5.
Definition: SDL3pp_log.h:462
void LogVerbose(std::string_view fmt, ARGS &&... args) const
Log a message with LOG_PRIORITY_VERBOSE.
Definition: SDL3pp_log.h:777
void LogCritical(LogCategory category, std::string_view fmt, ARGS &&... args)
Log a message with LOG_PRIORITY_CRITICAL.
Definition: SDL3pp_log.h:941
void LogTrace(std::string_view fmt, ARGS &&... args) const
Log a message with LOG_PRIORITY_TRACE.
Definition: SDL3pp_log.h:742
void ResetLogOutputFunction()
Replace the current log output function with the default one.
Definition: SDL3pp_log.h:1076
constexpr LogPriority LOG_PRIORITY_CRITICAL
CRITICAL.
Definition: SDL3pp_log.h:99
void LogCritical(std::string_view fmt, ARGS &&... args) const
Log a message with LOG_PRIORITY_CRITICAL.
Definition: SDL3pp_log.h:949
void LogDebug(LogCategory category, std::string_view fmt, ARGS &&... args)
Log a message with LOG_PRIORITY_DEBUG.
Definition: SDL3pp_log.h:805
constexpr LogCategory LOG_CATEGORY_RESERVED8
RESERVED8.
Definition: SDL3pp_log.h:471
LogPriority GetLogPriority() const
Get the priority of a particular log category.
Definition: SDL3pp_log.h:540
SDL_LogPriority LogPriority
The predefined log priorities.
Definition: SDL3pp_log.h:81
void LogError(std::string_view fmt, ARGS &&... args) const
Log a message with LOG_PRIORITY_ERROR.
Definition: SDL3pp_log.h:913
constexpr LogCategory LOG_CATEGORY_RESERVED7
RESERVED7.
Definition: SDL3pp_log.h:468
constexpr LogPriority LOG_PRIORITY_WARN
WARN.
Definition: SDL3pp_log.h:95
void LogUnformatted(LogCategory category, LogPriority priority, StringParam message)
Log an unformatted message with LOG_CATEGORY_APPLICATION and LOG_PRIORITY_INFO.
Definition: SDL3pp_log.h:607
void LogMessage(LogPriority priority, std::string_view fmt, ARGS... args) const
Log a message with the specified priority.
Definition: SDL3pp_log.h:705
void LogDebug(std::string_view fmt, ARGS &&... args) const
Log a message with LOG_PRIORITY_DEBUG.
Definition: SDL3pp_log.h:811
void LogError(LogCategory category, std::string_view fmt, ARGS &&... args)
Log a message with LOG_PRIORITY_ERROR.
Definition: SDL3pp_log.h:907
constexpr LogCategory LOG_CATEGORY_TEST
TEST.
Definition: SDL3pp_log.h:449
constexpr LogCategory LOG_CATEGORY_RESERVED2
RESERVED2.
Definition: SDL3pp_log.h:453
constexpr LogPriority LOG_PRIORITY_DEBUG
DEBUG.
Definition: SDL3pp_log.h:91
void LogMessage(LogCategory category, LogPriority priority, std::string_view fmt, ARGS... args)
Log a message with the specified category and priority.
Definition: SDL3pp_log.h:695
void Log(std::string_view fmt, ARGS &&... args)
Log a message with LOG_CATEGORY_APPLICATION and LOG_PRIORITY_INFO.
Definition: SDL3pp_log.h:666
constexpr LogCategory LOG_CATEGORY_RENDER
RENDER.
Definition: SDL3pp_log.h:445
constexpr LogCategory LOG_CATEGORY_APPLICATION
APPLICATION.
Definition: SDL3pp_log.h:432
void GetLogOutputFunction(LogOutputFunction *callback, void **userdata)
Get the current log output function.
Definition: SDL3pp_log.h:1024
constexpr LogCategory LOG_CATEGORY_GPU
GPU.
Definition: SDL3pp_log.h:451
void LogInfo(LogCategory category, std::string_view fmt, ARGS &&... args)
Log a message with LOG_PRIORITY_INFO.
Definition: SDL3pp_log.h:839
constexpr LogCategory LOG_CATEGORY_SYSTEM
SYSTEM.
Definition: SDL3pp_log.h:439
void SetLogPriority(LogPriority priority) const
Set the priority of a particular log category.
Definition: SDL3pp_log.h:518
void ResetLogPriorities()
Reset all priorities to default.
Definition: SDL3pp_log.h:557
constexpr LogPriority LOG_PRIORITY_ERROR
ERROR.
Definition: SDL3pp_log.h:97
void(SDLCALL *)(void *userdata, int category, LogPriority priority, const char *message) LogOutputFunction
The prototype for the log output callback function.
Definition: SDL3pp_log.h:971
constexpr LogPriority LOG_PRIORITY_COUNT
COUNT.
Definition: SDL3pp_log.h:102
void LogWarn(LogCategory category, std::string_view fmt, ARGS &&... args)
Log a message with LOG_PRIORITY_WARN.
Definition: SDL3pp_log.h:873
LogOutputFunction GetDefaultLogOutputFunction()
Get the default log output function.
Definition: SDL3pp_log.h:1005
constexpr LogPriority LOG_PRIORITY_VERBOSE
VERBOSE.
Definition: SDL3pp_log.h:88
constexpr LogCategory(LogCategoryRaw category=SDL_LOG_CATEGORY_APPLICATION) noexcept
Wraps LogCategory.
Definition: SDL3pp_log.h:137
constexpr LogPriority LOG_PRIORITY_INFO
INFO.
Definition: SDL3pp_log.h:93
constexpr LogCategory LOG_CATEGORY_RESERVED9
RESERVED9.
Definition: SDL3pp_log.h:474
constexpr LogCategory LOG_CATEGORY_RESERVED4
RESERVED4.
Definition: SDL3pp_log.h:459
constexpr LogPriority LOG_PRIORITY_TRACE
TRACE.
Definition: SDL3pp_log.h:86
constexpr LogCategory LOG_CATEGORY_CUSTOM
CUSTOM.
Definition: SDL3pp_log.h:480
constexpr LogCategory LOG_CATEGORY_RESERVED3
RESERVED3.
Definition: SDL3pp_log.h:456
constexpr LogCategory LOG_CATEGORY_RESERVED6
RESERVED6.
Definition: SDL3pp_log.h:465
Main include header for the SDL3pp library.
Definition: SDL3pp_callbackWrapper.h:169