Skip to content

Fix Logger Macros #609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MMory merged 2 commits into from
Apr 20, 2023
Merged

Fix Logger Macros #609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b70df6
The fix
fabianbs96 Apr 13, 2023
b1721a5
Merge branch 'development' into f-FixLoggerMacros
MMory Apr 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 32 additions & 20 deletions include/phasar/Utils/Logger.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,54 +105,66 @@ class Logger final {
computation; \
}

#define IS_LOG_ENABLED Logger::isLoggingEnabled()
#define IS_LOG_ENABLED ::psr::Logger::isLoggingEnabled()

#define IF_LOG_ENABLED(computation) \
IF_LOG_ENABLED_BOOL(Logger::isLoggingEnabled(), computation)
IF_LOG_ENABLED_BOOL(::psr::Logger::isLoggingEnabled(), computation)

#define PHASAR_LOG_LEVEL(level, message) \
IF_LOG_ENABLED_BOOL( \
Logger::isLoggingEnabled() && (level) >= Logger::getLoggerFilterLevel(), \
::psr::Logger::isLoggingEnabled() && \
(::psr::SeverityLevel::level) >= \
::psr::Logger::getLoggerFilterLevel(), \
do { \
auto &S = Logger::getLogStream(level, std::nullopt); \
Logger::addLinePrefix(S, level, std::nullopt); \
auto &Stream = ::psr::Logger::getLogStream( \
::psr::SeverityLevel::level, std::nullopt); \
::psr::Logger::addLinePrefix(Stream, ::psr::SeverityLevel::level, \
std::nullopt); \
/* NOLINTNEXTLINE(bugprone-macro-parentheses) */ \
S << message << '\n'; \
Stream << message << '\n'; \
} while (false);)

#define PHASAR_LOG(message) PHASAR_LOG_LEVEL(DEBUG, message)

#define PHASAR_LOG_LEVEL_CAT(level, cat, message) \
IF_LOG_ENABLED_BOOL( \
Logger::isLoggingEnabled() && \
(level) >= Logger::getLoggerFilterLevel() && \
Logger::logCategory(cat, level), \
::psr::Logger::isLoggingEnabled() && \
(::psr::SeverityLevel::level) >= \
::psr::Logger::getLoggerFilterLevel() && \
::psr::Logger::logCategory(cat, ::psr::SeverityLevel::level), \
do { \
auto &S = Logger::getLogStream(level, cat); \
Logger::addLinePrefix(S, level, cat); \
auto &Stream = \
::psr::Logger::getLogStream(::psr::SeverityLevel::level, cat); \
::psr::Logger::addLinePrefix(Stream, ::psr::SeverityLevel::level, \
cat); \
/* NOLINTNEXTLINE(bugprone-macro-parentheses) */ \
S << message << '\n'; \
Stream << message << '\n'; \
} while (false);)

#define PHASAR_LOG_CAT(cat, message) \
IF_LOG_ENABLED_BOOL( \
Logger::isLoggingEnabled() && Logger::logCategory(cat, std::nullopt), \
::psr::Logger::isLoggingEnabled() && \
::psr::Logger::logCategory(cat, std::nullopt), \
do { \
auto &S = Logger::getLogStream(std::nullopt, cat); \
Logger::addLinePrefix(S, std::nullopt, cat); \
auto &Stream = ::psr::Logger::getLogStream(std::nullopt, cat); \
::psr::Logger::addLinePrefix(Stream, std::nullopt, cat); \
/* NOLINTNEXTLINE(bugprone-macro-parentheses) */ \
S << message << '\n'; \
Stream << message << '\n'; \
} while (false);)

#else
#define IF_LOG_ENABLED_BOOL(condition, computation) \
{}
#define IF_LOG_ENABLED(computation) \
{}
#define PHASAR_LOG(computation) ((void)0)
#define PHASAR_LOG_CAT(cat, message) ((void)0)
#define PHASAR_LOG_LEVEL_CAT(level, cat, message) ((void)0)
#define PHASAR_LOG_LEVEL(level, message) ((void)0)
#define PHASAR_LOG(computation) \
{}
#define PHASAR_LOG_CAT(cat, message) \
{}
#define PHASAR_LOG_LEVEL_CAT(level, cat, message) \
{}
#define PHASAR_LOG_LEVEL(level, message) \
{}
#define IS_LOG_ENABLED false
#endif

Expand Down
4 changes: 4 additions & 0 deletions unittests/Utils/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ set(UtilsSources
StableVectorTest.cpp
)

if(PHASAR_ENABLE_DYNAMIC_LOG)
list(APPEND UtilsSources LoggerTest.cpp)
endif()

foreach(TEST_SRC ${UtilsSources})
add_phasar_unittest(${TEST_SRC})
endforeach(TEST_SRC)
28 changes: 28 additions & 0 deletions unittests/Utils/LoggerTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
#include "phasar/Utils/Logger.h"

#include "gtest/gtest.h"

TEST(LoggerTest, BasicWithinPsr) {
using namespace psr;
Logger::initializeStderrLogger(SeverityLevel::INFO);
Logger::initializeStderrLogger(SeverityLevel::DEBUG, "LLVMAliasSet");
PHASAR_LOG("This should not be shown");
PHASAR_LOG_LEVEL(INFO, "Basic category-less message");
PHASAR_LOG_LEVEL_CAT(DEBUG, "LLVMAliasSet",
"Some message specific to LLVMAliasSet");
}

TEST(LoggerTest, BasicOutsidePsr) {
psr::Logger::initializeStderrLogger(psr::SeverityLevel::INFO);
psr::Logger::initializeStderrLogger(psr::SeverityLevel::DEBUG,
"LLVMAliasSet");
PHASAR_LOG("This should not be shown");
PHASAR_LOG_LEVEL(INFO, "Basic category-less message");
PHASAR_LOG_LEVEL_CAT(DEBUG, "LLVMAliasSet",
"Some message specific to LLVMAliasSet");
}

int main(int Argc, char **Argv) {
::testing::InitGoogleTest(&Argc, Argv);
return RUN_ALL_TESTS();
}