A logger that logs all messages to the std::basic_ostream instance provided in the constructor. The name of the Logger defaults to "ANSI_LOGGER".
ALox text logger escape sequences (see class ESC) are translated to ANSI escape sequences. Support for ANSI escape sequences (also referred to as VT100 terminal emulation) is available on most unix terminal windows. Besides text colors, bold and italics font style can be set. ANSI escape sequences are also available in various IDE output windows.
Foreground and background colors can be set to be either light/dark or dark/light. This improves the readability of log output a lot and even allows reading if foreground and background colors are the same (they then still differ). However, the right setting for this is dependent on the color scheme of the final output device (window). To manipulate the right setting, see field CFP and also configuration variable ALOX/CONSOLE_LIGHT_COLORS.
In the method AcknowledgeLox, the default meta info string and color settings are changed to fit this logger.
There is not 100% match between the ANSI sequences and the definitions in ESC. For example ESC does not provide all ANSI colors and no blinking. On the other hand, ANSI does not allow to reset the style without resetting the colors. Of course, it is no problem to log other ANSI codes directly into an AnsiLogger. In this case, other Loggers that might be attached to the same Lox and that do not support ANSI must be equipped with corresponding replacement information. In other words: To support the same log output into different loggers, it is recommended to use ESC sequences instead of directly using ANSI codes.
The ANSI codes used by this class are exposed through a list of fields. They might be useful for manipulating the attributes of the various inherited format variables, which of course might contain native ANSI sequences. (In contrast to the log messages themselves, this meta-information is specific to a logger instance and this way it does not need to be replaced in other loggers).
Definition at line 59 of file ansilogger.hpp.
#include <ansilogger.hpp>
Public Static Field Index: | |
static constexpr character | ANSI_BG_BLACK [6] { A_CHAR("\033[40m") } |
Select black as background color. | |
static constexpr character | ANSI_BG_BLUE [6] { A_CHAR("\033[44m") } |
Select blue as background color. | |
static constexpr character | ANSI_BG_CYAN [6] { A_CHAR("\033[46m") } |
Select cyan as background color. | |
static constexpr character | ANSI_BG_GRAY [12] { A_CHAR("\033[48;5;240m")} |
Select gray as background color. | |
static constexpr character | ANSI_BG_GREEN [6] { A_CHAR("\033[42m") } |
Select green as background color. | |
static constexpr character | ANSI_BG_LIGHT_BLUE [11] { A_CHAR("\033[48;5;12m") } |
Select light blue as background color. | |
static constexpr character | ANSI_BG_LIGHT_CYAN [11] { A_CHAR("\033[48;5;14m") } |
Select light cyan as background color. | |
static constexpr character | ANSI_BG_LIGHT_GRAY [12] { A_CHAR("\033[48;5;250m")} |
Select light gray as background color. | |
static constexpr character | ANSI_BG_LIGHT_GREEN [11] { A_CHAR("\033[48;5;10m") } |
Select light green as background color. | |
static constexpr character | ANSI_BG_LIGHT_MAGENTA [11] { A_CHAR("\033[48;5;13m") } |
Select light magenta as background color. | |
static constexpr character | ANSI_BG_LIGHT_RED [11] { A_CHAR("\033[48;5;09m") } |
Select light red as background color. | |
static constexpr character | ANSI_BG_LIGHT_STD_COL [6] { A_CHAR("\033[49m") } |
Select standard background color. | |
static constexpr character | ANSI_BG_LIGHT_YELLOW [11] { A_CHAR("\033[48;5;11m") } |
Select light yellow as background color. | |
static constexpr character | ANSI_BG_MAGENTA [6] { A_CHAR("\033[45m") } |
Select magenta as background color. | |
static constexpr character | ANSI_BG_RED [6] { A_CHAR("\033[41m") } |
Select red as background color. | |
static constexpr character | ANSI_BG_STD_COL [6] { A_CHAR("\033[49m") } |
Select standard background color. | |
static constexpr character | ANSI_BG_WHITE [11] { A_CHAR("\033[48;5;15m") } |
Select white as background color. | |
static constexpr character | ANSI_BG_YELLOW [6] { A_CHAR("\033[43m") } |
Select yellow as background color. | |
static constexpr character | ANSI_BLACK [6] { A_CHAR("\033[30m") } |
Select black as foreground color. | |
static constexpr character | ANSI_BLUE [6] { A_CHAR("\033[34m") } |
Select blue as foreground color. | |
static constexpr character | ANSI_BOLD [5] { A_CHAR("\033[1m") } |
Select bold font style. | |
static constexpr character | ANSI_CYAN [6] { A_CHAR("\033[36m") } |
Select cyan as foreground color. | |
static constexpr character | ANSI_GRAY [12] { A_CHAR("\033[38;5;240m")} |
Select gray as foreground color. | |
static constexpr character | ANSI_GREEN [6] { A_CHAR("\033[32m") } |
Select green as foreground color. | |
static constexpr character | ANSI_ITALICS [5] { A_CHAR("\033[3m") } |
Select italics font style. | |
static constexpr character | ANSI_LIGHT_BLUE [11] { A_CHAR("\033[38;5;12m") } |
Select light blue as foreground color. | |
static constexpr character | ANSI_LIGHT_CYAN [11] { A_CHAR("\033[38;5;14m") } |
Select light cyan as foreground color. | |
static constexpr character | ANSI_LIGHT_GRAY [12] { A_CHAR("\033[38;5;250m")} |
Select light gray as foreground color. | |
static constexpr character | ANSI_LIGHT_GREEN [11] { A_CHAR("\033[38;5;10m") } |
Select light green as foreground color. | |
static constexpr character | ANSI_LIGHT_MAGENTA [11] { A_CHAR("\033[38;5;13m") } |
Select light magenta as foreground color. | |
static constexpr character | ANSI_LIGHT_RED [11] { A_CHAR("\033[38;5;09m") } |
Select light red as foreground color. | |
static constexpr character | ANSI_LIGHT_STD_COL [6] { A_CHAR("\033[39m") } |
Select standard foreground color. | |
static constexpr character | ANSI_LIGHT_YELLOW [11] { A_CHAR("\033[38;5;11m") } |
Select light yellow as foreground color. | |
static constexpr character | ANSI_MAGENTA [6] { A_CHAR("\033[35m") } |
Select magenta as foreground color. | |
static constexpr character | ANSI_RED [6] { A_CHAR("\033[31m") } |
Select red as foreground color. | |
static constexpr character | ANSI_RESET [5] { A_CHAR("\033[0m") } |
Reset colors and font style. | |
static constexpr character | ANSI_STD_COL [6] { A_CHAR("\033[39m") } |
Select standard foreground color. | |
static constexpr character | ANSI_STD_STYLE [5] { A_CHAR("\033[0m") } |
Select standard font style. | |
static constexpr character | ANSI_WHITE [11] { A_CHAR("\033[38;5;15m") } |
Select white as foreground color. | |
static constexpr character | ANSI_YELLOW [6] { A_CHAR("\033[33m") } |
Select yellow as foreground color. | |
Public Field Index: | |
textlogger::ColorfulLoggerParameters | CFP |
Public Field Index: inherited from TextLogger | |
ObjectConverter * | Converter = nullptr |
TickConverter | DateConverter |
bool | FormatWarningOnce = false |
Public Field Index: inherited from Logger | |
integer | CntLogs =0 |
time::Ticks | TimeOfCreation |
The creation time of the Logger. | |
time::Ticks | TimeOfLastLog |
Timestamp of the last log operation. | |
Public Field Index: inherited from RecursiveLock | |
DbgLockAsserter | Dbg |
The debug tool instance. | |
Public Method Index: | |
ALIB_API | AnsiLogger (const NString &name=nullptr, const NString &typeName="ANSI") |
ALIB_API | AnsiLogger (std::ostream *pOStream, const NString &name=nullptr, const NString &typeName="ANSI") |
virtual ALIB_API | ~AnsiLogger () override |
Destructs an AnsiLogger. | |
Public Method Index: inherited from TextLogger | |
virtual ALIB_API | ~TextLogger () override |
Destructs a TextLogger. | |
virtual ALIB_API void | ClearReplacements () |
Removes all pairs of searched strings and their replacement value. | |
FormatAutoSizes & | GetAutoSizes () |
FormatDateTime & | GetFormatDate () |
FormatMetaInfo & | GetFormatMetaInfo () |
FormatMultiLine & | GetFormatMultiLine () |
FormatOther & | GetFormatOther () |
FormatTimeDiff & | GetFormatTimeDiff () |
Replacements & | GetReplacements () |
virtual ALIB_API void | Log (detail::Domain &domain, Verbosity verbosity, BoxesMA &logables, detail::ScopeInfo &scope) override |
virtual ALIB_API void | ResetAutoSizes () |
virtual ALIB_API void | SetReplacement (const String &searched, const String &replacement) |
Public Method Index: inherited from Logger | |
virtual | ~Logger () override |
Destructs a logger. | |
const NString & | GetName () const |
const NString & | GetTypeName () const |
Public Method Index: inherited from RecursiveLock | |
~RecursiveLock () override | |
Destructor. With debug-compilations, asserts that this lock is not acquired. | |
ALIB_API void | AcquireRecursive (ALIB_DBG_TAKE_CI) |
virtual ALIB_API bool | DCSIsAcquired () const override |
virtual ALIB_API bool | DCSIsSharedAcquired () const override |
ALIB_API void | ReleaseRecursive (ALIB_DBG_TAKE_CI) |
ALIB_API bool | TryAcquire (ALIB_DBG_TAKE_CI) |
Public Method Index: inherited from DbgCriticalSections::AssociatedLock | |
virtual | ~AssociatedLock () |
Virtual Destructor. | |
Protected Field Index: | |
StringWriter | writer |
Protected Field Index: inherited from TextLogger | |
lang::system::CalendarDateTime | callerDateTime |
AString | logBuf |
The internal log Buffer. | |
AString | msgBuf |
The buffers for converting the logables. | |
bool | usesStdStreams |
Variable | varFormatAutoSizes |
Variable | varFormatDateTime |
Variable | varFormatMetaInfo |
Variable | varFormatMultiLine |
Variable | varFormatOther |
Variable | varFormatTimeDiff |
Variable | varReplacements |
Protected Field Index: inherited from Logger | |
NString32 | Name |
NString32 | TypeName |
Protected Field Index: inherited from RecursiveLock | |
std::recursive_mutex | mutex |
Protected Method Index: | |
virtual ALIB_API void | AcknowledgeLox (detail::LoxImpl *lox, lang::ContainerOp op) override |
virtual ALIB_API void | logText (detail::Domain &domain, Verbosity verbosity, AString &msg, detail::ScopeInfo &scope, int lineNumber) override |
virtual void | notifyMultiLineOp (lang::Phase) override |
Empty implementation. | |
Protected Method Index: inherited from TextLogger | |
ALIB_API | TextLogger (const NString &pName, const NString &typeName, bool pUsesStdStreams) |
virtual ALIB_API void | processVariable (const NString &domainPath, Verbosity verbosity, detail::ScopeInfo &scope, AString &dest, Substring &variable) |
virtual ALIB_API void | writeMetaInfo (AString &buffer, detail::Domain &domain, Verbosity verbosity, detail::ScopeInfo &scope) |
virtual ALIB_API void | writeTimeDiff (AString &buffer, int64_t diffNanos) |
Protected Method Index: inherited from Logger | |
Logger (const NString &name, const NString &typeName) | |
Select black as background color.
Definition at line 82 of file ansilogger.hpp.
Select blue as background color.
Definition at line 79 of file ansilogger.hpp.
Select cyan as background color.
Definition at line 81 of file ansilogger.hpp.
Select gray as background color.
Definition at line 84 of file ansilogger.hpp.
Select green as background color.
Definition at line 77 of file ansilogger.hpp.
Select light blue as background color.
Definition at line 99 of file ansilogger.hpp.
Select light cyan as background color.
Definition at line 101 of file ansilogger.hpp.
Select light gray as background color.
Definition at line 102 of file ansilogger.hpp.
Select light green as background color.
Definition at line 97 of file ansilogger.hpp.
Select light magenta as background color.
Definition at line 100 of file ansilogger.hpp.
Select light red as background color.
Definition at line 96 of file ansilogger.hpp.
Select standard background color.
Definition at line 103 of file ansilogger.hpp.
Select light yellow as background color.
Definition at line 98 of file ansilogger.hpp.
Select magenta as background color.
Definition at line 80 of file ansilogger.hpp.
Select red as background color.
Definition at line 76 of file ansilogger.hpp.
Select standard background color.
Definition at line 85 of file ansilogger.hpp.
Select white as background color.
Definition at line 83 of file ansilogger.hpp.
Select yellow as background color.
Definition at line 78 of file ansilogger.hpp.
Select black as foreground color.
Definition at line 71 of file ansilogger.hpp.
Select blue as foreground color.
Definition at line 68 of file ansilogger.hpp.
Select bold font style.
Definition at line 105 of file ansilogger.hpp.
Select cyan as foreground color.
Definition at line 70 of file ansilogger.hpp.
Select gray as foreground color.
Definition at line 73 of file ansilogger.hpp.
Select green as foreground color.
Definition at line 66 of file ansilogger.hpp.
Select italics font style.
Definition at line 106 of file ansilogger.hpp.
Select light blue as foreground color.
Definition at line 90 of file ansilogger.hpp.
Select light cyan as foreground color.
Definition at line 92 of file ansilogger.hpp.
Select light gray as foreground color.
Definition at line 93 of file ansilogger.hpp.
Select light green as foreground color.
Definition at line 88 of file ansilogger.hpp.
Select light magenta as foreground color.
Definition at line 91 of file ansilogger.hpp.
Select light red as foreground color.
Definition at line 87 of file ansilogger.hpp.
Select standard foreground color.
Definition at line 94 of file ansilogger.hpp.
Select light yellow as foreground color.
Definition at line 89 of file ansilogger.hpp.
Select magenta as foreground color.
Definition at line 69 of file ansilogger.hpp.
Select red as foreground color.
Definition at line 65 of file ansilogger.hpp.
Reset colors and font style.
Definition at line 108 of file ansilogger.hpp.
Select standard foreground color.
Definition at line 74 of file ansilogger.hpp.
Select standard font style.
Definition at line 107 of file ansilogger.hpp.
Select white as foreground color.
Definition at line 72 of file ansilogger.hpp.
Select yellow as foreground color.
Definition at line 67 of file ansilogger.hpp.
As of today, this parameter struct has only one value of type LightColorUsage. With this logger, this flag is used as follows.
Foreground and background colors chosen by this class might differ in their intensity. This increases the overall readability by increasing the contrast. If the background color of a console window is dark, then the background colors of colored log output should be darker colors than the foreground colors - and vice versa.
Depending on the setting of this field, ALox escape codes for colors are translated to normal ANSI colors or lighter ones:
The configuration variable ALOX/CONSOLE_LIGHT_COLORS allows externally modifying this flag. It is read once within the constructor.
Definition at line 149 of file ansilogger.hpp.
|
protected |
Encapsulates std::cout
, std::wcout
or the output stream provided in the corresponding constructor.
Definition at line 118 of file ansilogger.hpp.
|
inlineexplicit |
Creates an AnsiLogger using std::cout
respectively std::wcout
.
name | The name of the Logger, defaults to what is provided with parameter typeName. |
typeName | The type of the Logger, defaults to "ANSI". |
Definition at line 162 of file ansilogger.hpp.
|
inlineexplicit |
Creates an AnsiLogger using the given output stream.
std::cout
respectively std::wcout
must not be provided here. Instead, the alternative constructor omitting parameter pOStream is to be used. pOStream | The output stream to write into. |
name | The name of the Logger, defaults to what is provided with parameter typeName. |
typeName | The type of the Logger, defaults to "ANSI". |
Definition at line 175 of file ansilogger.hpp.
|
overridevirtual |
Destructs an AnsiLogger.
Definition at line 51 of file ansilogger.cpp.
|
overrideprotectedvirtual |
Invokes parent method. Then reads and interprets configuration variable ALOX/CONSOLE_LIGHT_COLORS. Finally it is checked if variable ALOX/LOGGERNAME/FORMAT has priority of default values, and if yes, such values are overwritten to include ANSI color codes. These color codes are retrieved from resources named "Var_D21A"
.
lox | The Lox to acknowledge insertion or removal |
op | The operation. Either ContainerOp::Insert or ContainerOp::Remove. |
Reimplemented from TextLogger.
Definition at line 21 of file ansilogger.cpp.
|
overrideprotectedvirtual |
Implementation of the abstract method of parent class TextLogger. Logs messages to the basic output stream provided in the constructor. Replaces ALox ESC escape sequences with ANSI escape sequences.
domain | The Log Domain. |
verbosity | The verbosity. This has been checked to be active already on this stage and is provided to be able to be logged out only. |
msg | The log message. |
scope | Information about the scope of the Log Statement.. |
lineNumber | The line number of a multi-line message, starting with 0. For single line messages this is -1. |
Implements TextLogger.
Definition at line 60 of file ansilogger.cpp.
|
inlineoverrideprotectedvirtual |