A logger that writes to the console. Includes color support. More...
#include <Logging.h>
Inheritance diagram for esi::ConsoleLogger:
Collaboration diagram for esi::ConsoleLogger:
Public Member Functions | |
| ConsoleLogger (Level minLevel) | |
| Create a stream logger that logs to stdout, stderr. | |
| void | logImpl (Level level, const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details) override |
| Subclasses must implement this method to log messages. | |
 Public Member Functions inherited from esi::TSLogger | |
| void | log (Level level, const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details) override final |
| Grabs the lock and calls logImpl. | |
| Logger (bool debugEnabled) | |
| Public Member Functions inherited from esi::Logger | |
| Logger (bool debugEnabled) | |
| virtual | ~Logger ()=default |
| bool | getDebugEnabled () |
| virtual void | error (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details=nullptr) |
| Report an error. | |
| virtual void | warning (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details=nullptr) |
| Report a warning. | |
| virtual void | info (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details=nullptr) |
| Report an informational message. | |
| void | debug (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details=nullptr) |
| Report a debug message. | |
| void | debug (std::function< void(std::string &subsystem, std::string &msg, std::unique_ptr< std::map< std::string, std::any > > &details)> debugFunc) |
| Call the debug function callback only if debug is enabled then log a debug message. | |
Private Attributes | |
| Level | minLevel |
| The minimum log level to emit. | |
Additional Inherited Members | |
| Public Types inherited from esi::Logger | |
| enum class | Level { Debug , Info , Warning , Error } |
| Protected Member Functions inherited from esi::Logger | |
| virtual void | debugImpl (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details) |
| Overrideable version of debug. Only gets called if debug is enabled. | |
| virtual void | debugImpl (std::function< void(std::string &subsystem, std::string &msg, std::unique_ptr< std::map< std::string, std::any > > &details)> debugFunc) |
| Overrideable version of debug. Only gets called if debug is enabled. | |
| Protected Attributes inherited from esi::TSLogger | |
| std::mutex | mutex |
| Mutex to protect the stream from interleaved logging writes. | |
| Protected Attributes inherited from esi::Logger | |
| bool | debugEnabled = false |
| Enable or disable debug messages. | |
Detailed Description
A logger that writes to the console. Includes color support.
Constructor & Destructor Documentation
◆ ConsoleLogger()
| ConsoleLogger::ConsoleLogger | ( | Level | minLevel | ) |
Create a stream logger that logs to stdout, stderr.
Definition at line 78 of file Logging.cpp.
Member Function Documentation
◆ logImpl()
|
overridevirtual |
Subclasses must implement this method to log messages.
Implements esi::TSLogger.
Definition at line 81 of file Logging.cpp.
References esi::Logger::Debug, esi::Logger::Error, esi::Logger::Info, minLevel, esi::toString(), and esi::Logger::Warning.
Member Data Documentation
◆ minLevel
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/include/esi/Logging.h
- /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/lib/Logging.cpp
