Base logger class. More...
#include <tomographer/tools/loggers.h>
Inheritance diagram for Tomographer::Logger::LoggerBase< Derived >:Public Types | |
| enum | |
| Shortcuts to properties defined in the traits class. More... | |
Public Member Functions | |
| LoggerBase (int level_=INFO) | |
| Construct the base logger object. More... | |
| bool | enabledFor (int level_) const |
| Check whether messages at the given log level are enabled. More... | |
| int | level () const |
| Get the log level set for this logger. More... | |
| template<ENABLED_IF( staticallyEnabledFor< ERROR >()) > | |
| void | error (const char *origin, const char *fmt,...) |
| emit an error message More... | |
| template<ENABLED_IF( staticallyEnabledFor< ERROR >()) > | |
| void | error (const char *origin, std::string msg) |
| emit an error message More... | |
| template<typename Fn , ENABLED_IF( staticallyEnabledFor< ERROR >() && tomo_internal::IsOstreamArgCallable< Fn >::value) > | |
| void | error (const char *origin, Fn &&f) |
| emit an error message More... | |
| template<ENABLED_IF( !staticallyEnabledFor< ERROR >()) , typename... Args> | |
| void | error (Args &&...) |
| Special-case implementation for messages which are known to be discarded at compile time. | |
| template<ENABLED_IF( staticallyEnabledFor< WARNING >()) > | |
| void | warning (const char *origin, const char *fmt,...) |
| emit a warning message More... | |
| template<ENABLED_IF( staticallyEnabledFor< WARNING >()) > | |
| void | warning (const char *origin, std::string msg) |
| emit a warning message More... | |
| template<typename Fn , ENABLED_IF( staticallyEnabledFor< WARNING >() && tomo_internal::IsOstreamArgCallable< Fn >::value) > | |
| void | warning (const char *origin, Fn &&f) |
| emit a warning message More... | |
| template<ENABLED_IF( !staticallyEnabledFor< WARNING >()) , typename... Args> | |
| void | warning (Args &&...) |
| Special-case implementation for messages which are known to be discarded at compile time. | |
| template<ENABLED_IF( staticallyEnabledFor< INFO >()) > | |
| void | info (const char *origin, const char *fmt,...) |
| emit an information/notice message More... | |
| template<ENABLED_IF( staticallyEnabledFor< INFO >()) > | |
| void | info (const char *origin, std::string msg) |
| emit an information/notice message More... | |
| template<typename Fn , ENABLED_IF( staticallyEnabledFor< INFO >() && tomo_internal::IsOstreamArgCallable< Fn >::value) > | |
| void | info (const char *origin, Fn &&f) |
| emit an information/notice message More... | |
| template<ENABLED_IF( !staticallyEnabledFor< INFO >()) , typename... Args> | |
| void | info (Args &&...) |
| Special-case implementation for messages which are known to be discarded at compile time. | |
| template<ENABLED_IF( staticallyEnabledFor< DEBUG >()) > | |
| void | debug (const char *origin, const char *fmt,...) |
| emit an debug message More... | |
| template<ENABLED_IF( staticallyEnabledFor< DEBUG >()) > | |
| void | debug (const char *origin, std::string msg) |
| emit an debug message More... | |
| template<typename Fn , ENABLED_IF( staticallyEnabledFor< DEBUG >() && tomo_internal::IsOstreamArgCallable< Fn >::value) > | |
| void | debug (const char *origin, Fn &&f) |
| emit an debug message More... | |
| template<ENABLED_IF( !staticallyEnabledFor< DEBUG >()) , typename... Args> | |
| void | debug (Args &&...) |
| Special-case implementation for messages which are known to be discarded at compile time. | |
| template<ENABLED_IF( staticallyEnabledFor< LONGDEBUG >()) > | |
| void | longdebug (const char *origin, const char *fmt,...) |
| emit a very verbose debugging message More... | |
| template<ENABLED_IF( staticallyEnabledFor< LONGDEBUG >()) > | |
| void | longdebug (const char *origin, std::string msg) |
| emit a very verbose debugging message More... | |
| template<typename Fn , ENABLED_IF( staticallyEnabledFor< LONGDEBUG >() && tomo_internal::IsOstreamArgCallable< Fn >::value) > | |
| void | longdebug (const char *origin, Fn &&f) |
| emit a very verbose debugging message More... | |
| template<ENABLED_IF( !staticallyEnabledFor< LONGDEBUG >()) , typename... Args> | |
| void | longdebug (Args &&...) |
| Special-case implementation for messages which are known to be discarded at compile time. | |
| void | log (int level, const char *origin, const char *fmt,...) |
| emit a log message at the given log level. More... | |
| void | log (int level, const char *origin, std::string msg) |
| emit a log message at the given log level. More... | |
| template<typename Fn , ENABLED_IF( tomo_internal::IsOstreamArgCallable< Fn >::value) > | |
| void | log (int level, const char *origin, Fn &&f) |
| emit a log message at the given log level. More... | |
| template<int Level, ENABLED_IF( staticallyEnabledFor< Level >()) > | |
| void | log (const char *origin, const char *fmt,...) |
| emit a log message at the given log level. More... | |
| template<int Level, ENABLED_IF( staticallyEnabledFor< Level >()) > | |
| void | log (const char *origin, const char *fmt, va_list ap) |
| emit a log message at the given log level. More... | |
| template<int Level, ENABLED_IF( staticallyEnabledFor< Level >()) > | |
| void | log (const char *origin, std::string msg) |
| emit a log message at the given log level. More... | |
| template<int Level, typename Fn , ENABLED_IF( staticallyEnabledFor< Level >() && tomo_internal::IsOstreamArgCallable< Fn >::value) > | |
| void | log (const char *origin, Fn f) |
| emit a log message at the given log level. More... | |
| template<int Level, ENABLED_IF( !staticallyEnabledFor< Level >()) , typename ... Args> | |
| void | log (Args &&...) |
| Special-case implementation for messages which are known to be discarded at compile time. | |
Static Public Member Functions | |
| static bool | staticallyEnabledFor (int level) |
| Check whether the logger is statically disabled for some levels. More... | |
| template<int Level> | |
| static constexpr bool | staticallyEnabledFor () |
| Static version of staticallyEnabledFor() More... | |
Protected Member Functions | |
| template<ENABLED_IF( !HasOwnGetLevel) > | |
| int | getLevel () const |
| template<ENABLED_IF( HasOwnGetLevel) > | |
| int | getLevel () const |
| Derived * | derived () |
| const Derived * | derived () const |
| void | setLogLevel (int level) |
| Store a new run-time log level. More... | |
Detailed Description
template<typename Derived>
class Tomographer::Logger::LoggerBase< Derived >
Base logger class.
Please read Logging and Loggers to understand Tomographer's logging framework.
This class serves as base class for logger implementations. It provides storing a current given level, emitting the log only if the level is reached, etc. Don't instantiate this class directly.
See also FileLogger.
A logger always has a level set at run-time, which can always be retrieved by calling level(). By default, this class stores the level given to the constructor. If you want your derived class to store its own level, or simply to relay log messages to a further logger and inherit its level, then you should declare HasOwnGetLevel=1 in your logger traits (see LoggerTraits), and provide your own level() method, which should be const and return an int.
Also, by default there is no public setLevel() method, in case your logger's level is statically fixed or otherwise can't be changed, or if you need a thread-safe logger. Derived classes may set the logger's level (again, only if HasOwnGetLevel=0) by calling the protected setLogLevel(int). You may of course then also expose a public function such as setLevel() which calls setLogLevel(), if you want (see, for example, FileLogger).
Member Enumeration Documentation
§ anonymous enum
| anonymous enum |
Shortcuts to properties defined in the traits class.
| Enumerator | |
|---|---|
| IsThreadSafe | See LoggerTraits<Derived> and DefaultLoggerTraits. |
| StaticMinimumSeverityLevel | See LoggerTraits<Derived> and DefaultLoggerTraits. |
| HasOwnGetLevel | See LoggerTraits<Derived> and DefaultLoggerTraits. |
| HasFilterByOrigin | See LoggerTraits<Derived> and DefaultLoggerTraits. |
Constructor & Destructor Documentation
§ LoggerBase()
|
inline |
Construct the base logger object.
The logging level is set to level, by default Logger::INFO. Any messages with lesser severity will be automatically discarded.
Note that if the derived logger class provides its own level() method, and declares it with LoggerTraits<Derived>::HasOwnGetLevel, then the level provided here is discarded and ignored.
Member Function Documentation
§ debug() [1/3]
|
inline |
emit an debug message
Call this method to report a debugging message with this logger. This will relay the the call to the underlying logger implementation (subclass) if logging at the level Logger::DEBUG is enabled.
This method overload allows you to format messages in a printf -like fashion. The final message will be formatted using an actual function of the sprintf() family.
See Logging and Loggers for more information about Tomographer's logging framework.
- Parameters
-
origin A string which identifies the place in code from where the debugging message is originating. This is useful to trace back error messages. Conventionally, specify the name of the function with its class (e.g. "MyClass::my_method()").fmt A printfformat string... additional arguments for the printfformatting string.
§ debug() [2/3]
|
inline |
emit an debug message
Call this method to report a debugging message with this logger. This will relay the the call to the underlying logger implementation (subclass) if logging at the level Logger::DEBUG is enabled.
This method overload assumes that you have already suitably formatted your message, and will directly provide the given msg to the underlying logger implementation.
See Logging and Loggers for more information about Tomographer's logging framework.
- Parameters
-
origin A string which identifies the place in code from where the debugging message is originating. This is useful to trace back error messages. Conventionally, specify the name of the function with its class (e.g. "MyClass::my_method()").msg the log message to produce.
§ debug() [3/3]
|
inline |
emit an debug message
Call this method to report a debugging message with this logger. This will relay the the call to the underlying logger implementation (subclass) if logging at the level Logger::DEBUG is enabled.
See Logging and Loggers for more information about Tomographer's logging framework.
This method overload allows you to write to the logger using the C++ stream syntax. This function takes as argument a callable f, which will be called with a std::ostream& parameter to which it can write to. This is especially handy combined with C++11 lambdas, for example:
- Parameters
-
origin A string which identifies the place in code from where the debugging message is originating. This is useful to trace back error messages. Conventionally, specify the name of the function with its class (e.g. "MyClass::my_method()").f a callable which accepts a single std::ostream&argument, to which it should write its log message.
Internally, the log message is first written to a std::ostringstream before transmitting it to the underlying logger implementation. (But don't rely on this!)
§ enabledFor()
|
inline |
Check whether messages at the given log level are enabled.
This function returns true if a message at the given level will be emitted, i.e. transmitted to the underlying logger implementation.
The condition for a log message to be emitted is that the message's log level not be explicitly disabled by LoggerTraits::StaticMinimumSeverityLevel, and that the message's log level be at least as important as the current level set for this logger (see level()).
§ error() [1/3]
|
inline |
§ error() [2/3]
|
inline |
emit an error message
Call this method to report an error.
See debug(const char *, std::string) for information about the function arguments.
§ error() [3/3]
|
inline |
emit an error message
Call this method to report an error.
See debug(const char *, Fn&&) for information about the function arguments.
§ info() [1/3]
|
inline |
§ info() [2/3]
|
inline |
emit an information/notice message
Call this method to report an information/notice message.
See debug(const char*, std::string) for information about the function arguments.
§ info() [3/3]
|
inline |
emit an information/notice message
Call this method to report an information/notice message.
See debug(const char *, Fn&&) for information about the function arguments.
§ level()
|
inline |
Get the log level set for this logger.
This is the log level given to the constructor at run-time, or set with the protected setLogLevel() method.
This method is provided for if your own derived class doesn't provide it already, i.e. if the logger traits of your derived class declares HasOwnGetLevel to 0 or doesn't declare it. If you call this function with HasOwnGetLevel set to 1, then the derived class' method will be called. So if you override this method in the derived class with HasOwnGetLevel=1, then don't call the base implementation!
§ log() [1/7]
|
inline |
emit a log message at the given log level.
You should never need to call this method, and I'm not sure it's a good design choice. (Mind that messages logged here may not be statically removed if a static minimum level is set.)
Otherwise, see debug(const char *, const char *, ...) for information about the function arguments.
§ log() [2/7]
|
inline |
emit a log message at the given log level.
You should never need to call this method, and I'm not sure it's a good design choice. (Mind that messages logged here may not be statically removed if a static minimum level is set.)
Otherwise, see debug(const char*, std::string) for information about the function arguments.
§ log() [3/7]
|
inline |
emit a log message at the given log level.
You should never need to call this method, and I'm not sure it's a good design choice. (Mind that messages logged here may not be statically removed if a static minimum level is set.)
Otherwise, see debug(const char *, Fn&&) for information about the function arguments.
§ log() [4/7]
|
inline |
§ log() [5/7]
|
inline |
emit a log message at the given log level.
The log level is given statically. You shouldn't need to call this method directly, it's probably more readable to use debug(), warning(), etc.
This function is a convenience method which accepts an argument list pointer instead of ... . The format string and argument list are expected to be the same as for log(const char * origin, const char * fmt, ...) .
§ log() [6/7]
|
inline |
emit a log message at the given log level.
The log level is given statically. You shouldn't need to call this method directly, it's probably more readable to use debug(), warning(), etc.
Otherwise, see debug(const char*, std::string) for information about the function arguments.
§ log() [7/7]
|
inline |
emit a log message at the given log level.
The log level is given statically. You shouldn't need to call this method directly, it's probably more readable to use debug(), warning(), etc.
Otherwise, see debug(const char *, Fn&&) for information about the function arguments.
§ longdebug() [1/3]
|
inline |
§ longdebug() [2/3]
|
inline |
emit a very verbose debugging message
Call this method to report debugging messages which are emitted very often.
See debug(const char*, std::string) for information about the function arguments.
§ longdebug() [3/3]
|
inline |
emit a very verbose debugging message
Call this method to report debugging messages which are emitted very often.
See debug(const char *, Fn&&) for information about the function arguments.
§ setLogLevel()
|
inlineprotected |
Store a new run-time log level.
See also level().
The base class does not provide a public setLevel() function, in case your logger does not support setting any level, or in case you need your logger to be completely thread-safe, or for any other reason.
Subclasses may, however, change the log level by explicily calling this method. This method however should ONLY be used if your derived class doesn't define its own level() method and thus only if the logger traits HasOwnGetLogger is false. (The method is not exposed otherwise.)
§ staticallyEnabledFor() [1/2]
|
inlinestatic |
Check whether the logger is statically disabled for some levels.
- Template Parameters
-
Level the log level to test for.
- Returns
falseif the logger was explicitly disabled for the level Level via LoggerTraits<Derived>::StaticMinimumSeverityLevel, otherwise returnstrue.
If true was returned, this does not yet mean that a log message at the given level will necessarily be produced; in this case, rather, the message is not expliclty discarded and the logger's level set at run-time will be tested (see enabledFor()).
§ staticallyEnabledFor() [2/2]
|
inlinestatic |
Static version of staticallyEnabledFor()
§ warning() [1/3]
|
inline |
§ warning() [2/3]
|
inline |
emit a warning message
Call this method to report a warning.
See debug(const char*, std::string) for information about the function arguments.
§ warning() [3/3]
|
inline |
emit a warning message
Call this method to report a warning.
See debug(const char *, Fn&&) for information about the function arguments.
The documentation for this class was generated from the following file:
- tomographer/tools/loggers.h (v5.3)