ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::lox::loggers::ConsoleLogger Class Reference

Description:

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

ALox text logger escape sequences (see class ESC) are removed and ignored.

Definition at line 24 of file consolelogger.inl.

Inheritance diagram for alib::lox::loggers::ConsoleLogger:
[legend]
Collaboration diagram for alib::lox::loggers::ConsoleLogger:
[legend]

Public Method Index:

 ConsoleLogger (const NString &name=nullptr)
 
virtual ~ConsoleLogger () override
 Destructs a ConsoleLogger.
 
- Public Method Index: inherited from alib::lox::textlogger::TextLogger
virtual ALIB_DLL ~TextLogger () override
 Destructs a TextLogger.
 
virtual ALIB_DLL void AcknowledgeLox (detail::LoxImpl *lox, lang::ContainerOp op) override
 
virtual ALIB_DLL void ClearReplacements ()
 Removes all pairs of searched strings and their replacement value.
 
FormatAutoSizesGetAutoSizes ()
 
FormatDateTimeGetFormatDate ()
 
FormatMetaInfoGetFormatMetaInfo ()
 
FormatMultiLineGetFormatMultiLine ()
 
FormatOtherGetFormatOther ()
 
FormatTimeDiffGetFormatTimeDiff ()
 
ReplacementsGetReplacements ()
 
virtual ALIB_DLL void Log (detail::Domain &domain, Verbosity verbosity, BoxesMA &logables, detail::ScopeInfo &scope) override
 
virtual ALIB_DLL void ResetAutoSizes ()
 
virtual ALIB_DLL void SetReplacement (const String &searched, const String &replacement)
 
- Public Method Index: inherited from alib::lox::detail::Logger
virtual ~Logger () override
 Destructs a logger.
 
const NStringGetName () const
 
const NStringGetTypeName () const
 
- Public Method Index: inherited from alib::threads::RecursiveLock
 ~RecursiveLock () override
 Destructor. With debug-compilations, asserts that this lock is not acquired.
 
ALIB_DLL void AcquireRecursive (ALIB_DBG_TAKE_CI)
 
virtual ALIB_DLL bool DCSIsAcquired () const override
 
virtual ALIB_DLL bool DCSIsSharedAcquired () const override
 
ALIB_DLL void ReleaseRecursive (ALIB_DBG_TAKE_CI)
 
ALIB_DLL bool TryAcquire (ALIB_DBG_TAKE_CI)
 
- Public Method Index: inherited from alib::lang::DbgCriticalSections::AssociatedLock
virtual ~AssociatedLock ()
 Virtual Destructor.
 

Protected Field Index:

StringWriter writer
 The encapsulated output stream.
 
- Protected Field Index: inherited from alib::lox::textlogger::TextLogger
strings::util::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 alib::lox::detail::Logger
NString32 Name
 
NString32 TypeName
 
- Protected Field Index: inherited from alib::threads::RecursiveLock
std::recursive_mutex mutex
 

Protected Method Index:

virtual ALIB_DLL integer logSubstring (const String &buffer, integer start, integer length) override
 
virtual ALIB_DLL bool notifyLogOp (lang::Phase phase) override
 
virtual void notifyMultiLineOp (lang::Phase) override
 Empty implementation, not needed for this class.
 
- Protected Method Index: inherited from alib::lox::textlogger::PlainTextLogger
 PlainTextLogger (const NString &name, const NString &typeName, bool pUsesStdStreams)
 
virtual ~PlainTextLogger () override
 Destructs a MemoryLogger.
 
virtual ALIB_DLL void logText (detail::Domain &domain, Verbosity verbosity, AString &msg, detail::ScopeInfo &scope, int lineNumber) override
 
- Protected Method Index: inherited from alib::lox::textlogger::TextLogger
ALIB_DLL TextLogger (const NString &pName, const NString &typeName, bool pUsesStdStreams)
 
virtual ALIB_DLL void processVariable (const NString &domainPath, Verbosity verbosity, detail::ScopeInfo &scope, AString &dest, Substring &variable)
 
virtual ALIB_DLL void writeMetaInfo (AString &buffer, detail::Domain &domain, Verbosity verbosity, detail::ScopeInfo &scope)
 
virtual ALIB_DLL void writeTimeDiff (AString &buffer, int64_t diffNanos)
 
- Protected Method Index: inherited from alib::lox::detail::Logger
 Logger (const NString &name, const NString &typeName)
 
virtual void AcknowledgeLox (LoxImpl *lox, lang::ContainerOp op)
 

Additional Inherited Members

- Public Field Index: inherited from alib::lox::textlogger::PlainTextLogger
bool PruneESCSequences = true
 
- Public Field Index: inherited from alib::lox::textlogger::TextLogger
ObjectConverterConverter = nullptr
 
TickConverter DateConverter
 
bool FormatWarningOnce = false
 
- Public Field Index: inherited from alib::lox::detail::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 alib::threads::RecursiveLock
DbgLockAsserter Dbg
 The debug tool instance.
 

Field Details:

◆ writer

StringWriter alib::lox::loggers::ConsoleLogger::writer
protected

The encapsulated output stream.

Definition at line 28 of file consolelogger.inl.

Constructor(s) / Destructor Details:

◆ ConsoleLogger()

alib::lox::loggers::ConsoleLogger::ConsoleLogger ( const NString & name = nullptr)
inlineexplicit

Creates a ConsoleLogger.

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

Definition at line 38 of file consolelogger.inl.

Here is the call graph for this function:

◆ ~ConsoleLogger()

virtual alib::lox::loggers::ConsoleLogger::~ConsoleLogger ( )
inlineoverridevirtual

Destructs a ConsoleLogger.

Definition at line 46 of file consolelogger.inl.

Method Details:

◆ logSubstring()

alib::integer ConsoleLogger::logSubstring ( const String & buffer,
integer start,
integer length )
overrideprotectedvirtual

Writes the given region of the given string to the console.

Parameters
bufferThe string to write a portion of.
startThe start of the portion in buffer to write out.
lengthThe length of the portion in buffer to write out.
Returns
The number of characters written, -1 on error.

Implements alib::lox::textlogger::PlainTextLogger.

Definition at line 38 of file consolelogger.cpp.

Here is the call graph for this function:

◆ notifyLogOp()

bool ConsoleLogger::notifyLogOp ( lang::Phase phase)
overrideprotectedvirtual

Starts/ends log line. Appends a new-line character sequence to previously logged lines.

Parameters
phaseIndicates the beginning or end of a log line.
Returns
Always returns true.

Implements alib::lox::textlogger::PlainTextLogger.

Definition at line 31 of file consolelogger.cpp.

◆ notifyMultiLineOp()

virtual void alib::lox::loggers::ConsoleLogger::notifyMultiLineOp ( lang::Phase )
inlineoverrideprotectedvirtual

Empty implementation, not needed for this class.

Implements alib::lox::textlogger::TextLogger.

Definition at line 77 of file consolelogger.inl.


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