Skip to content

Commit

Permalink
Make libfmt or stb either/or
Browse files Browse the repository at this point in the history
  • Loading branch information
@cjappl
cjappl committed Dec 24, 2024
1 parent b1a2933 commit 736330b
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 33 deletions.
3 changes: 2 additions & 1 deletion CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ if(NOT TARGET readerwriterqueue)
FetchContent_MakeAvailable(ReaderWriterQueue)
endif()

if(NOT TARGET stb::stb)
if(NOT RTSAN_USE_FMTLIB AND NOT TARGET stb::stb)
# Avoid warning about DOWNLOAD_EXTRACT_TIMESTAMP in CMake 3.24:
if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
cmake_policy(SET CMP0135 NEW)
Expand Down Expand Up @@ -98,6 +98,7 @@ target_compile_definitions(rtlog
INTERFACE
STB_SPRINTF_IMPLEMENTATION
$<$<BOOL:${RTLOG_USE_FMTLIB}>:RTLOG_USE_FMTLIB>
$<$<NOT:$<BOOL:${RTLOG_USE_FMTLIB}>>:RTLOG_USE_STB>
$<$<CONFIG:Debug>:DEBUG>
$<$<CONFIG:Release>:NDEBUG>
)
Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,9 @@ RealtimeLogger logger;
void SomeRealtimeCallback()
{
logger.Log({ExampleLogLevel::Debug, ExampleLogRegion::Audio}, "Hello, world! %i", 42);
logger.LogFmt({ExampleLogData::Debug, ExampleLogRegion::Audio, FMT_STRING("Hello, world! {}", 42);

// using RTSAN_USE_LIBFMT
logger.Log({ExampleLogData::Debug, ExampleLogRegion::Audio, FMT_STRING("Hello, world! {}", 42);
}

...
Expand Down
23 changes: 15 additions & 8 deletions examples/everlog/everlogmain.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ static rtlog::Logger<LogData, MAX_NUM_LOG_MESSAGES, MAX_LOG_MESSAGE_LENGTH,
PrintMessage({LogLevel::Critical, Region}, ++gSequenceNumber, fstring, \
##__VA_ARGS__)

#ifdef RTLOG_USE_STB
#define EVR_RTLOG_DEBUG(Region, fstring, ...) \
gRealtimeLogger.Log({LogLevel::Debug, Region}, fstring, ##__VA_ARGS__)
#define EVR_RTLOG_INFO(Region, fstring, ...) \
Expand All @@ -129,21 +130,27 @@ static rtlog::Logger<LogData, MAX_NUM_LOG_MESSAGES, MAX_LOG_MESSAGE_LENGTH,
gRealtimeLogger.Log({LogLevel::Warning, Region}, fstring, ##__VA_ARGS__)
#define EVR_RTLOG_CRITICAL(Region, fstring, ...) \
gRealtimeLogger.Log({LogLevel::Critical, Region}, fstring, ##__VA_ARGS__)
#else
#define EVR_RTLOG_DEBUG(Region, fstring, ...) (void)0
#define EVR_RTLOG_INFO(Region, fstring, ...) (void)0
#define EVR_RTLOG_WARNING(Region, fstring, ...) (void)0
#define EVR_RTLOG_CRITICAL(Region, fstring, ...) (void)0
#endif // RTLOG_USE_STB

#ifdef RTLOG_USE_FMTLIB

#define EVR_RTLOG_FMT_DEBUG(Region, fstring, ...) \
gRealtimeLogger.LogFmt({LogLevel::Debug, Region}, FMT_STRING(fstring), \
##__VA_ARGS__)
gRealtimeLogger.Log({LogLevel::Debug, Region}, FMT_STRING(fstring), \
##__VA_ARGS__)
#define EVR_RTLOG_FMT_INFO(Region, fstring, ...) \
gRealtimeLogger.LogFmt({LogLevel::Info, Region}, FMT_STRING(fstring), \
##__VA_ARGS__)
gRealtimeLogger.Log({LogLevel::Info, Region}, FMT_STRING(fstring), \
##__VA_ARGS__)
#define EVR_RTLOG_FMT_WARNING(Region, fstring, ...) \
gRealtimeLogger.LogFmt({LogLevel::Warning, Region}, FMT_STRING(fstring), \
##__VA_ARGS__)
gRealtimeLogger.Log({LogLevel::Warning, Region}, FMT_STRING(fstring), \
##__VA_ARGS__)
#define EVR_RTLOG_FMT_CRITICAL(Region, fstring, ...) \
gRealtimeLogger.LogFmt({LogLevel::Critical, Region}, FMT_STRING(fstring), \
##__VA_ARGS__)
gRealtimeLogger.Log({LogLevel::Critical, Region}, FMT_STRING(fstring), \
##__VA_ARGS__)

#else

Expand Down
13 changes: 11 additions & 2 deletions include/rtlog/rtlog.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,18 @@
#include <cstdio>
#include <thread>

// assert RTLOG_USE_FMTLIB or RTLOG_USE_STB is defined
#if !defined(RTLOG_USE_FMTLIB) && !defined(RTLOG_USE_STB)
#error "You must define RTLOG_USE_FMTLIB or RTLOG_USE_STB"
#endif

#ifdef RTLOG_USE_FMTLIB
#include <fmt/format.h>
#endif // RTLOG_USE_FMTLIB

#include <readerwriterqueue.h>

#ifdef RTLOG_USE_STB
#ifndef STB_SPRINTF_IMPLEMENTATION
#define STB_SPRINTF_IMPLEMENTATION
#endif
Expand All @@ -21,6 +27,7 @@
#endif

#include <stb_sprintf.h>
#endif // RTLOG_USE_STB

#if defined(__has_feature)
#if __has_feature(realtime_sanitizer)
Expand Down Expand Up @@ -96,6 +103,7 @@ class Logger {
* message was truncated, the function returns
* `Status::Error_MessageTruncated`. Otherwise, it returns `Status::Success`.
*/
#ifdef RTLOG_USE_STB
Status Logv(LogData &&inputData, const char *format,
va_list args) noexcept RTLOG_NONBLOCKING {
auto retVal = Status::Success;
Expand Down Expand Up @@ -156,6 +164,7 @@ class Logger {
va_end(args);
return retVal;
}
#endif // RTLOG_USE_STB

#ifdef RTLOG_USE_FMTLIB

Expand Down Expand Up @@ -187,8 +196,8 @@ class Logger {
* `Status::Error_MessageTruncated`. Otherwise, it returns `Status::Success`.
*/
template <typename... T>
Status LogFmt(LogData &&inputData, fmt::format_string<T...> fmtString,
T &&...args) noexcept RTLOG_NONBLOCKING {
Status Log(LogData &&inputData, fmt::format_string<T...> fmtString,
T &&...args) noexcept RTLOG_NONBLOCKING {
auto retVal = Status::Success;

InternalLogData dataToQueue;
Expand Down
45 changes: 24 additions & 21 deletions test/test_rtlog.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ static auto PrintMessage = [](const ExampleLogData &data, size_t sequenceNumber,

using namespace rtlog::test;

#ifdef RTLOG_USE_STB

TEST(RtlogTest, BasicConstruction) {
rtlog::Logger<ExampleLogData, MAX_NUM_LOG_MESSAGES, MAX_LOG_MESSAGE_LENGTH,
gSequenceNumber>
Expand Down Expand Up @@ -193,6 +195,7 @@ TEST(RtlogTest, ErrorsReturnedFromLog) {
};
EXPECT_EQ(truncatedLogger.PrintAndClearLogQueue(InspectLogMessage), 1);
}
#endif // RTLOG_USE_STB

#ifdef RTLOG_USE_FMTLIB

Expand All @@ -201,39 +204,39 @@ TEST(LoggerTest, FormatLibVersionWorksAsIntended) {
gSequenceNumber>
logger;

logger.LogFmt({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}!"), 123l);
logger.LogFmt({ExampleLogLevel::Info, ExampleLogRegion::Game},
FMT_STRING("Hello, {}!"), 123.0f);
logger.LogFmt({ExampleLogLevel::Warning, ExampleLogRegion::Network},
FMT_STRING("Hello, {}!"), 123.0);
logger.LogFmt({ExampleLogLevel::Critical, ExampleLogRegion::Audio},
FMT_STRING("Hello, {}!"), (void *)123);
logger.LogFmt({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}!"), 123);
logger.LogFmt({ExampleLogLevel::Critical, ExampleLogRegion::Audio},
FMT_STRING("Hello, {}!"), "world");
logger.Log({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}!"), 123l);
logger.Log({ExampleLogLevel::Info, ExampleLogRegion::Game},
FMT_STRING("Hello, {}!"), 123.0f);
logger.Log({ExampleLogLevel::Warning, ExampleLogRegion::Network},
FMT_STRING("Hello, {}!"), 123.0);
logger.Log({ExampleLogLevel::Critical, ExampleLogRegion::Audio},
FMT_STRING("Hello, {}!"), (void *)123);
logger.Log({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}!"), 123);
logger.Log({ExampleLogLevel::Critical, ExampleLogRegion::Audio},
FMT_STRING("Hello, {}!"), "world");

EXPECT_EQ(logger.PrintAndClearLogQueue(PrintMessage), 6);
}

TEST(LoggerTest, LogFmtReturnsSuccessOnNormalEnqueue) {
TEST(LoggerTest, LogReturnsSuccessOnNormalEnqueue) {
rtlog::Logger<ExampleLogData, MAX_NUM_LOG_MESSAGES, MAX_LOG_MESSAGE_LENGTH,
gSequenceNumber>
logger;
EXPECT_EQ(logger.LogFmt({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}!"), 123l),
EXPECT_EQ(logger.Log({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}!"), 123l),
rtlog::Status::Success);
}

TEST(LoggerTest, LogFmtHandlesLongMessageTruncation) {
TEST(LoggerTest, LogHandlesLongMessageTruncation) {
const auto maxMessageLength = 10;
rtlog::Logger<ExampleLogData, MAX_NUM_LOG_MESSAGES, maxMessageLength,
gSequenceNumber>
logger;

EXPECT_EQ(logger.LogFmt({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}! xxxxxxxxxxx"), 123l),
EXPECT_EQ(logger.Log({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}! xxxxxxxxxxx"), 123l),
rtlog::Status::Error_MessageTruncated);

auto InspectLogMessage = [=](const ExampleLogData &data,
Expand All @@ -257,7 +260,7 @@ TEST(LoggerTest, LogFmtHandlesLongMessageTruncation) {
EXPECT_EQ(logger.PrintAndClearLogQueue(InspectLogMessage), 1);
}

TEST(LoggerTest, LogFmtHandlesQueueFullError) {
TEST(LoggerTest, LogHandlesQueueFullError) {
const auto maxNumMessages = 10;
rtlog::Logger<ExampleLogData, maxNumMessages, MAX_LOG_MESSAGE_LENGTH,
gSequenceNumber>
Expand All @@ -266,8 +269,8 @@ TEST(LoggerTest, LogFmtHandlesQueueFullError) {
auto status = rtlog::Status::Success;

while (status == rtlog::Status::Success) {
status = logger.LogFmt({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}!"), "world");
status = logger.Log({ExampleLogLevel::Debug, ExampleLogRegion::Engine},
FMT_STRING("Hello, {}!"), "world");
}

EXPECT_EQ(status, rtlog::Status::Error_QueueFull);
Expand Down

0 comments on commit 736330b

Please sign in to comment.