ALib C++ Library
Library Version: 2312 R0
Documentation generated by doxygen
Public Methods | List of all members
AnsiConsoleLogger Class Reference

#include <ansilogger.hpp>

Inheritance diagram for AnsiConsoleLogger:
[legend]
Collaboration diagram for AnsiConsoleLogger:
[legend]

Class Description

A AnsiLogger that logs all messages to the standard output cout. The name of the Logger defaults to "ANSI_CONSOLE".

Provides 'cout' to the constructor of its parent class AnsiLogger. See class AnsiLogger for more information on ANSI escape sequences and their use.

Note
To avoid misunderstandings: This class can not enable the output console (which receives ALox log data) to support ANSI Escape Codes. The opposite is right: this class should be used only if the console supports ANSI Escape Codes.

Definition at line 296 of file ansilogger.hpp.

Public Methods

ALIB_API AnsiConsoleLogger (const NString &name=nullptr)
 
virtual ALIB_API ~AnsiConsoleLogger () override
 
- Public Methods inherited from AnsiLogger
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
 
- Public Methods inherited from TextLogger
virtual ALIB_API ~TextLogger () override
 
virtual ALIB_API void AcknowledgeLox (LoxImpl *lox, ContainerOp op) override
 
virtual ALIB_API void ClearReplacements ()
 
virtual ALIB_API void Log (Domain &domain, Verbosity verbosity, Boxes &logables, ScopeInfo &scope) override
 
virtual ALIB_API void ResetAutoSizes ()
 
virtual ALIB_API void SetReplacement (const String &searched, const String &replacement)
 
- Public Methods inherited from Logger
virtual ~Logger ()
 
const NString & GetName () const
 
const NString & GetTypeName () const
 
- Public Methods inherited from SmartLock
 SmartLock ()
 
void Acquire (const NCString &dbgFile, int dbgLine, const NCString &dbgFunc)
 
ALIB_API int AddAcquirer (ThreadLock *newAcquirer)
 
ALIB_API int CntAcquirers ()
 
ALIB_API void Release ()
 defined(ALIB_DOX) More...
 
ALIB_API int RemoveAcquirer (ThreadLock *acquirer)
 
- Public Methods inherited from ThreadLock
ALIB_API ThreadLock (Safeness safeness=Safeness::Safe)
 
ALIB_API ~ThreadLock ()
 
ALIB_API void Acquire (const NCString &dbgFile, int dbgLine, const NCString &dbgFunc)
 
int CountAcquirements () const
 
Thread * GetOwner () const
 
Safeness GetSafeness () const
 
bool IsOwnedByCurrentThread () const
 
ALIB_API void Release ()
 defined(ALIB_DOX) More...
 
ALIB_API void SetSafeness (Safeness safeness)
 
bool WillRelease () const
 

Additional Inherited Members

- Public Types inherited from TextLogger
enum  LightColorUsage { Auto, Never, Foreground, Background }
 
- Public Static Fields inherited from AnsiLogger
static ALIB_API character ANSI_BG_BLACK [6] { A_CHAR("\033[40m") }
 Select black as background color.
 
static ALIB_API character ANSI_BG_BLUE [6] { A_CHAR("\033[44m") }
 Select blue as background color.
 
static ALIB_API character ANSI_BG_CYAN [6] { A_CHAR("\033[46m") }
 Select cyan as background color.
 
static ALIB_API character ANSI_BG_GRAY [12] { A_CHAR("\033[48;5;240m") }
 Select gray as background color.
 
static ALIB_API character ANSI_BG_GREEN [6] { A_CHAR("\033[42m") }
 Select green as background color.
 
static ALIB_API character ANSI_BG_LIGHT_BLUE [11] { A_CHAR("\033[48;5;12m") }
 Select light blue as background color.
 
static ALIB_API character ANSI_BG_LIGHT_CYAN [11] { A_CHAR("\033[48;5;14m") }
 Select light cyan as background color.
 
static ALIB_API character ANSI_BG_LIGHT_GRAY [12] { A_CHAR("\033[48;5;250m") }
 Select light gray as background color.
 
static ALIB_API character ANSI_BG_LIGHT_GREEN [11] { A_CHAR("\033[48;5;10m") }
 Select light green as background color.
 
static ALIB_API character ANSI_BG_LIGHT_MAGENTA [11] { A_CHAR("\033[48;5;13m") }
 Select light magenta as background color.
 
static ALIB_API character ANSI_BG_LIGHT_RED [11] { A_CHAR("\033[48;5;09m") }
 Select light red as background color.
 
static ALIB_API character ANSI_BG_LIGHT_STD_COL [6] { A_CHAR("\033[49m") }
 Select standard background color.
 
static ALIB_API character ANSI_BG_LIGHT_YELLOW [11] { A_CHAR("\033[48;5;11m") }
 Select light yellow as background color.
 
static ALIB_API character ANSI_BG_MAGENTA [6] { A_CHAR("\033[45m") }
 Select magenta as background color.
 
static ALIB_API character ANSI_BG_RED [6] { A_CHAR("\033[41m") }
 Select red as background color.
 
static ALIB_API character ANSI_BG_STD_COL [6] { A_CHAR("\033[49m") }
 Select standard background color.
 
static ALIB_API character ANSI_BG_WHITE [11] { A_CHAR("\033[48;5;15m") }
 Select white as background color.
 
static ALIB_API character ANSI_BG_YELLOW [6] { A_CHAR("\033[43m") }
 Select yellow as background color.
 
static ALIB_API character ANSI_BLACK [6] { A_CHAR("\033[30m") }
 Select black as foreground color.
 
static ALIB_API character ANSI_BLUE [6] { A_CHAR("\033[34m") }
 Select blue as foreground color.
 
static ALIB_API character ANSI_BOLD [5] { A_CHAR("\033[1m") }
 Select bold font style.
 
static ALIB_API character ANSI_CYAN [6] { A_CHAR("\033[36m") }
 Select cyan as foreground color.
 
static ALIB_API character ANSI_GRAY [12] { A_CHAR("\033[38;5;240m") }
 Select gray as foreground color.
 
static ALIB_API character ANSI_GREEN [6] { A_CHAR("\033[32m") }
 Select green as foreground color.
 
static ALIB_API character ANSI_ITALICS [5] { A_CHAR("\033[3m") }
 Select italics font style.
 
static ALIB_API character ANSI_LIGHT_BLUE [11] { A_CHAR("\033[38;5;12m") }
 Select light blue as foreground color.
 
static ALIB_API character ANSI_LIGHT_CYAN [11] { A_CHAR("\033[38;5;14m") }
 Select light cyan as foreground color.
 
static ALIB_API character ANSI_LIGHT_GRAY [12] { A_CHAR("\033[38;5;250m") }
 Select light gray as foreground color.
 
static ALIB_API character ANSI_LIGHT_GREEN [11] { A_CHAR("\033[38;5;10m") }
 Select light green as foreground color.
 
static ALIB_API character ANSI_LIGHT_MAGENTA [11] { A_CHAR("\033[38;5;13m") }
 Select light magenta as foreground color.
 
static ALIB_API character ANSI_LIGHT_RED [11] { A_CHAR("\033[38;5;09m") }
 Select light red as foreground color.
 
static ALIB_API character ANSI_LIGHT_STD_COL [6] { A_CHAR("\033[39m") }
 Select standard foreground color.
 
static ALIB_API character ANSI_LIGHT_YELLOW [11] { A_CHAR("\033[38;5;11m") }
 Select light yellow as foreground color.
 
static ALIB_API character ANSI_MAGENTA [6] { A_CHAR("\033[35m") }
 Select magenta as foreground color.
 
static ALIB_API character ANSI_RED [6] { A_CHAR("\033[31m") }
 Select red as foreground color.
 
static ALIB_API character ANSI_RESET [5] { A_CHAR("\033[0m") }
 Reset colors and font style.
 
static ALIB_API character ANSI_STD_COL [6] { A_CHAR("\033[39m") }
 Select standard foreground color.
 
static ALIB_API character ANSI_STD_STYLE [5] { A_CHAR("\033[0m") }
 Select standard font style.
 
static ALIB_API character ANSI_WHITE [11] { A_CHAR("\033[38;5;15m") }
 Select white as foreground color.
 
static ALIB_API character ANSI_YELLOW [6] { A_CHAR("\033[33m") }
 Select yellow as foreground color.
 
- Public Static Fields inherited from SmartLock
static ALIB_API SmartLock StdOutputStreams
 
- Public Fields inherited from AnsiLogger
LightColorUsage UseLightColors
 
- Public Fields inherited from TextLogger
lib::strings::util::AutoSizes AutoSizes
 
ObjectConverter * Converter = nullptr
 
String16 FmtMsgSuffix
 
String64 FmtMultiLineMsgHeadline = A_CHAR("ALox: Multi line message follows: ")
 
String16 FmtMultiLinePrefix = A_CHAR(">> ")
 
String16 FmtMultiLineSuffix = A_CHAR("")
 
textlogger::MetaInfo * MetaInfo
 
AString MultiLineDelimiter
 
String16 MultiLineDelimiterRepl = A_CHAR("\\r")
 
int MultiLineMsgMode =2
 
- Public Fields inherited from Logger
integer CntLogs =0
 
lib::time::Ticks TimeOfCreation
 
lib::time::Ticks TimeOfLastLog
 
- Public Fields inherited from ThreadLock
NCString DbgOwnerFile =nullptr
 
NCString DbgOwnerFunc =nullptr
 
int DbgOwnerLine
 
uint16_t DbgRecursionWarningThreshold =10
 
integer DbgWarningAfterWaitTimeInMillis =2000L
 
- Protected Fields inherited from AnsiLogger
StringWriter writer
 
- Protected Fields inherited from TextLogger
AString logBuf
 
AString msgBuf
 
std::vector< AString > replacements
 
int stdStreamLockRegistrationCounter =0
 
bool usesStdStreams
 
- Protected Fields inherited from Logger
NString32 Name
 
NString32 TypeName
 
- Protected Fields inherited from SmartLock
std::vector< ThreadLock * > acquirers
 
ThreadLockNR lock
 
- Protected Fields inherited from ThreadLock
uint16_t cntAcquirements =0
 
std::mutex mutex
 
std::condition_variable mutexNotifier
 
std::thread::id owner
 
Safeness safeness
 
- Protected Methods inherited from AnsiLogger
ALIB_API void construct ()
 
virtual ALIB_API void logText (detail::Domain &domain, Verbosity verbosity, AString &msg, detail::ScopeInfo &scope, int lineNumber) override
 
virtual void notifyMultiLineOp (Phase) override
 
- Protected Methods inherited from TextLogger
ALIB_API TextLogger (const NString &pName, const NString &typeName, bool pUsesStdStreams)
 
- Protected Methods inherited from Logger
 Logger (const NString &name, const NString &typeName)
 

Constructor & Destructor Documentation

◆ AnsiConsoleLogger()

AnsiConsoleLogger ( const NString &  name = nullptr)
explicit

Creates an AnsiConsoleLogger.

Parameters
name(Optional) The name of the Logger, defaults to "CONSOLE".

Definition at line 370 of file ansilogger.cpp.

◆ ~AnsiConsoleLogger()

~AnsiConsoleLogger ( )
overridevirtual

Destructs an AnsiConsoleLogger

Definition at line 375 of file ansilogger.cpp.

The documentation for this class was generated from the following files: