Description:

This is a very simple file logger for textual log outputs. The file name string provided in the constructor is not verified. The fileName may be changed by simply setting the public member FileName.

In alignment with ALox principles (ALox does not throw!), the logger does not throw i/o exceptions. In debug-compilations, ALib warnings are issued. Recent system io/ errors are stored in public field# LastSystemError. The constructor tries to open/close the file with write permissions. For many applications, it should be enough to check this field after construction and take according actions on failure. Otherwise, errors may periodically be checked by an application (e.g., no space left on device, etc.).

Definition at line 30 of file textfilelogger.hpp.

#include <textfilelogger.hpp>

Inheritance diagram for TextFileLogger:

[legend]

Collaboration diagram for TextFileLogger:

[legend]

Public Field Index:
alib::AString	FileName
	The path and fileName to the log file.

SystemErrors	LastSystemError = SystemErrors::None

Public Field Index: inherited from PlainTextLogger
bool	PruneESCSequences = true

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	TextFileLogger (const alib::String &fileName, const alib::NString &loggerName=nullptr)

virtual	~TextFileLogger () override
	Destructs a TextFileLogger.

Public Method Index: inherited from TextLogger
virtual ALIB_API	~TextLogger () override
	Destructs a TextLogger.

virtual ALIB_API void	AcknowledgeLox (detail::LoxImpl *lox, lang::ContainerOp op) override

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:
bool	currentlyInMultiLineOp = false
	Flag to prevent file open/close operations when multi line text logging is performed.

StringWriter	writer
	Encapsulates the text file stream in a system dependent way.

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:
ALIB_API void	closeFile ()
	Closes the file.

virtual ALIB_API integer	logSubstring (const String &buffer, integer start, integer length) override

virtual ALIB_API bool	notifyLogOp (lang::Phase phase) override

virtual ALIB_API void	notifyMultiLineOp (lang::Phase phase) override

ALIB_API void	openFile ()
	Opens the file.

Protected Method Index: inherited from PlainTextLogger
	PlainTextLogger (const NString &name, const NString &typeName, bool pUsesStdStreams)

virtual	~PlainTextLogger () override
	Destructs a MemoryLogger.

virtual ALIB_API void	logText (detail::Domain &domain, Verbosity verbosity, AString &msg, detail::ScopeInfo &scope, int lineNumber) override

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)

Field Details:

◆ currentlyInMultiLineOp

bool currentlyInMultiLineOp = false

protected

Flag to prevent file open/close operations when multi line text logging is performed.

Definition at line 41 of file textfilelogger.hpp.

◆ FileName

alib::AString FileName

The path and fileName to the log file.

Definition at line 49 of file textfilelogger.hpp.

◆ LastSystemError

SystemErrors LastSystemError = SystemErrors::None

Errors that usually indicate i/o problems. With construction of the logger, the file is tried to be opened and closed, which might indicate major problems (permissions, path, etc) with this public field very early.

Definition at line 54 of file textfilelogger.hpp.

◆ writer

StringWriter writer

protected

Encapsulates the text file stream in a system dependent way.

Definition at line 38 of file textfilelogger.hpp.

Constructor(s) / Destructor Details:

◆ TextFileLogger()

TextFileLogger	(	const alib::String &	fileName,
		const alib::NString &	loggerName = nullptr )

explicit

Creates a TextFileLogger.

Parameters

fileName	The filename (potentially including a path) of the output log file.
loggerName	The name of the Logger. Defaults to "TEXTFILE".

Definition at line 18 of file textfilelogger.cpp.

◆ ~TextFileLogger()

virtual ~TextFileLogger ( )

inlineoverridevirtual

Destructs a TextFileLogger.

Definition at line 73 of file textfilelogger.hpp.

Method Details:

◆ closeFile()

void closeFile ( )

protected

Closes the file.

Definition at line 59 of file textfilelogger.cpp.

Here is the call graph for this function:

◆ logSubstring()

integer logSubstring	(	const String &	buffer,
		integer	start,
		integer	length )

overrideprotectedvirtual

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

Parameters

buffer	The string to write a portion of.
start	The start of the portion in buffer to write out.
length	The length of the portion in buffer to write out.

Returns: The number of characters written, -1 on error.

Implements PlainTextLogger.

Definition at line 102 of file textfilelogger.cpp.

Here is the call graph for this function:

◆ notifyLogOp()

bool notifyLogOp ( lang::Phase phase )

overrideprotectedvirtual

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

Parameters

phase Indicates the beginning or end of a log line.

Returns: Always returns true.

Implements PlainTextLogger.

Definition at line 84 of file textfilelogger.cpp.

Here is the call graph for this function:

◆ notifyMultiLineOp()

void notifyMultiLineOp ( lang::Phase phase )

overrideprotectedvirtual

Empty implementation, not needed for this class

Parameters

phase Indicates the beginning or end of a multi-line operation.

Implements TextLogger.

Definition at line 72 of file textfilelogger.cpp.

Here is the call graph for this function:

◆ openFile()

void openFile ( )

protected

Opens the file.

Definition at line 40 of file textfilelogger.cpp.

Here is the call graph for this function:

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

Description:

Public Field Index:

Public Method Index:

Protected Field Index:

Protected Method Index:

Field Details:

◆ currentlyInMultiLineOp

◆ FileName

◆ LastSystemError

◆ writer

Constructor(s) / Destructor Details:

◆ TextFileLogger()

◆ ~TextFileLogger()

Method Details:

◆ closeFile()

◆ logSubstring()

◆ notifyLogOp()

◆ notifyMultiLineOp()

◆ openFile()