Description:

This header-file is part of the ALib C++ Framework.

#include "alib/alib.inl"

Macros
#define	LOG_ACQUIRE { alib::lox::Lox& _log= LOG_LOX; _log.Acquire( LOG_CI );
#define	Log_AddDebugLogger()
#define	Log_Assert(...)
#define	LOG_CI ALIB_CALLER
#define	Log_ClearSourcePathTrimRules(...)
#define	Log_Entry(...)
#define	Log_Error(...)
#define	Log_Exception(...)
#define	Log_GetLogger(identifier, name)
#define	Log_GetVerbosity(result, ...)
#define	Log_If(...)
#define	Log_Info(...)
#define	Log_IsActive(result, ...)
#define	Log_LogState(...)
#define	LOG_LOX (*alib::lox::Log::Get())
#define	Log_MapThreadName(...)
#define	Log_Once(...)
#define	Log_Prune(...)
#define	LOG_RELEASE _log.Release(); }
#define	Log_RemoveDebugLogger()
#define	Log_RemoveLogger(logger)
#define	Log_RemoveThreadDomain(...)
#define	Log_Retrieve(data, ...)
#define	Log_SetDomain(...)
#define	Log_SetDomainSubstitutionRule(...)
#define	Log_SetPrefix(...)
#define	Log_SetSourcePathTrimRule(...)
#define	Log_SetStartTime(...)
#define	Log_SetVerbosity(...)
#define	Log_Store(...)
#define	Log_Verbose(...)
#define	Log_Warning(...)
#define	LOX_ACQUIRE { alib::lox::Lox& _lox= LOX_LOX; _lox.Acquire( LOX_CI );
#define	Lox_Assert(...)
#define	LOX_CI ALIB_CALLER
#define	Lox_ClearSourcePathTrimRules(...)
#define	Lox_Entry(...)
#define	Lox_Error(...)
#define	Lox_Exception(...)
#define	Lox_GetLogger(identifier, name)
#define	Lox_GetVerbosity(result, ...)
#define	Lox_If(...)
#define	Lox_Info(...)
#define	Lox_IsActive(result, ...)
#define	Lox_LogState(...)
#define	LOX_LOX
#define	Lox_MapThreadName(...)
#define	Lox_Once(...)
#define	Lox_Prune(...)
#define	LOX_RELEASE _lox.Release(); }
#define	Lox_RemoveLogger(logger)
#define	Lox_RemoveThreadDomain(...)
#define	Lox_Retrieve(data, ...)
#define	Lox_SetDomain(...)
#define	Lox_SetDomainSubstitutionRule(...)
#define	Lox_SetPrefix(...)
#define	Lox_SetSourcePathTrimRule(...)
#define	Lox_SetStartTime(...)
#define	Lox_SetVerbosity(...)
#define	Lox_Store(...)
#define	Lox_Verbose(...)
#define	Lox_Warning(...)

Macro Definition Documentation

◆ LOG_ACQUIRE

#define LOG_ACQUIRE { alib::lox::Lox& _log= LOG_LOX; _log.Acquire( LOG_CI );

Macro that is placed at the beginning of almost all debug logging macros. Provides scope information (provided that ALOX_DBG_LOG_CI is set) to the lox and places the debug lox instance access code using LOG_LOX.

Definition at line 69 of file alox.prepro.hpp.

◆ Log_AddDebugLogger

#define Log_AddDebugLogger ( )

Value:

{ Log_Prune( LOG_ACQUIRE alib::Log::AddDebugLogger ( &_log ); LOG_RELEASE ) }

LOG_RELEASE

#define LOG_RELEASE

Definition alox.prepro.hpp:70

LOG_ACQUIRE

#define LOG_ACQUIRE

Definition alox.prepro.hpp:69

Log_Prune

#define Log_Prune(...)

Definition alox.prepro.hpp:76

alib::lox::Log::AddDebugLogger

static void AddDebugLogger(Lox *lox)

Definition alox.cpp:194

Invokes Log::AddDebugLogger to create, add and configure a default debug logger suitable for the platform and toolset.

Parameters

...	The parameters to pass.

Definition at line 83 of file alox.prepro.hpp.

◆ Log_Assert

#define Log_Assert ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.Assert ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::Assert on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 99 of file alox.prepro.hpp.

◆ LOG_CI

#define LOG_CI ALIB_CALLER

Dependent on ALOX_DBG_LOG_CI, this macro provides comma delimited source information (sourcefile, line number, function name) or corresponding null values.

Definition at line 50 of file alox.prepro.hpp.

◆ Log_ClearSourcePathTrimRules

#define Log_ClearSourcePathTrimRules ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.ClearSourcePathTrimRules( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::ClearSourcePathTrimRules on the debug-singleton of the Lox-instance
defined in the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 82 of file alox.prepro.hpp.

◆ Log_Entry

#define Log_Entry ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.Entry ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::Entry on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 102 of file alox.prepro.hpp.

◆ Log_Error

#define Log_Error ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.Error ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::Error on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 98 of file alox.prepro.hpp.

◆ Log_Exception

#define Log_Exception ( ... )

Value:

{ Log_Prune( alib::lox::LogTools::Exception( LOG_LOX, __VA_ARGS__ ); ) }

LOG_LOX

#define LOG_LOX

Definition alox.prepro.hpp:45

alib::lox::LogTools::Exception

static void Exception(Lox &lox, const exceptions::Exception &e, Verbosity verbosity=Verbosity::Error, const NString &domainPrefix="/ERR", const String &logPrefix=A_CHAR(" "))

Definition logtools.cpp:40

Invokes Exception providing the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 108 of file alox.prepro.hpp.

◆ Log_GetLogger

#define Log_GetLogger	(		identifier,
			name )

Value:

Log_Prune( alib::lox::detail::Logger* identifier; \

LOG_ACQUIRE identifier= _log.GetLogger( name ); LOG_RELEASE )

alib::lox::detail::Logger

Definition logger.inl:36

Invokes Lox::GetLogger on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

identifier	The identifier name of the variable that receives the pointer to the logger.
name	The name of the logger to retrieve.

Definition at line 85 of file alox.prepro.hpp.

◆ Log_GetVerbosity

#define Log_GetVerbosity	(		result,
			... )

Value:

Log_Prune( LOG_ACQUIRE result= _log.GetVerbosity( __VA_ARGS__ ); LOG_RELEASE )

Invokes Lox::GetVerbosity on the object of type Lox defined by the macro LOG_LOX. The result value is assigned to given variable result

Parameters

result	The name of a variable of type Verbosity int that the return value of GetVerbosity() is assigned to.
...	The parameters to pass.

Definition at line 107 of file alox.prepro.hpp.

◆ Log_If

#define Log_If ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.If ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::If(bool, Verbosity, BoxedObjects&& ...) (or one of its overloads) on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 100 of file alox.prepro.hpp.

◆ Log_Info

#define Log_Info ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.Info ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::Info on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 96 of file alox.prepro.hpp.

◆ Log_IsActive

#define Log_IsActive	(		result,
			... )

Value:

Log_Prune( LOG_ACQUIRE result= _log.IsActive( __VA_ARGS__ ); LOG_RELEASE )

Invokes Lox::IsActive on the object of type Lox defined by the macro LOG_LOX. The result value is assigned to given variable result

Parameters

result	The name of a variable of type `int` that the return value of IsActive() is assigned to.
...	The parameters to pass.

Definition at line 106 of file alox.prepro.hpp.

◆ Log_LogState

#define Log_LogState ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.State ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::State on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 94 of file alox.prepro.hpp.

◆ LOG_LOX

#define LOG_LOX (*alib::lox::Log::Get())

The Lox instance used by all debug logging macros. This can be overwritten (prior or after including alox.hpp) to allow different instances of class Lox for debug logging within different source entities. However, other ways to structure log output and to separate log information into different streams exists in ALox and overwriting this macro is not recommended for standard use cases.

Note: The definition must provide a reference (not a pointer) to the Lox object.

Definition at line 45 of file alox.prepro.hpp.

◆ Log_MapThreadName

#define Log_MapThreadName ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.MapThreadName( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::MapThreadName on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 93 of file alox.prepro.hpp.

◆ Log_Once

#define Log_Once ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.Once ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::Once(Verbosity, const Box&, int) (or one of its overloads) on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 101 of file alox.prepro.hpp.

◆ Log_Prune

#define Log_Prune ( ... )

Value:

__VA_ARGS__

This very simple macro is used for pruning debug Log Statements. While it is used as a building block of all other macros for debug logging, for code entities using ALox, it provides an easy way to prune code lines that get inserted purely to support logging, e.g., to create ALox loggers or to prepare more complex log output. (The alternative way is to enclose such code within #ifdef ALOX_DBG_LOG / #endif preprocessor lines.

Depends on ALOX_DBG_LOG. If this is set, the macro just copies the code provided, else it does not copy it, hence removes the code.

Definition at line 76 of file alox.prepro.hpp.

◆ LOG_RELEASE

#define LOG_RELEASE _log.Release(); }

Macro that is placed at the end of almost all debug logging macros. Releases the lox which was acquired when passing scope information (in macro LOG_ACQUIRE.).

Definition at line 70 of file alox.prepro.hpp.

◆ Log_RemoveDebugLogger

#define Log_RemoveDebugLogger ( )

Value:

{ Log_Prune( LOG_ACQUIRE alib::Log::RemoveDebugLogger( &_log ); LOG_RELEASE ) }

alib::lox::Log::RemoveDebugLogger

static void RemoveDebugLogger(Lox *lox)

Definition alox.cpp:256

Invokes Log::RemoveDebugLogger to remove and delete a debug logger created by Log::AddDebugLogger.

Parameters

...	The parameters to pass.

Definition at line 84 of file alox.prepro.hpp.

◆ Log_RemoveLogger

#define Log_RemoveLogger ( logger )

Value:

{ Log_Prune( LOG_ACQUIRE _log.RemoveLogger ( logger ); LOG_RELEASE ) }

Invokes Lox::RemoveLogger(const NString&) (or its overload) on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

logger Either the name of or a pointer to the logger to remove.

Definition at line 87 of file alox.prepro.hpp.

◆ Log_RemoveThreadDomain

#define Log_RemoveThreadDomain ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.RemoveThreadDomain( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::RemoveThreadDomain on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 89 of file alox.prepro.hpp.

◆ Log_Retrieve

#define Log_Retrieve	(		data,
			... )

Value:

Log_Prune( Box data; LOG_ACQUIRE data= _log.Retrieve( __VA_ARGS__ ); LOG_RELEASE )

Invokes Lox::Retrieve(Scope) (or its overload) on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

data	The identifier name of the Box object to take the retrieved data.
...	The parameters to pass.

Definition at line 105 of file alox.prepro.hpp.

◆ Log_SetDomain

#define Log_SetDomain ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.SetDomain ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::SetDomain(const NString&, Scope) (or its overload) on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 88 of file alox.prepro.hpp.

◆ Log_SetDomainSubstitutionRule

#define Log_SetDomainSubstitutionRule ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.SetDomainSubstitutionRule( __VA_ARGS__); LOG_RELEASE ) }

Invokes Lox::SetDomainSubstitutionRule on the debug-singleton of the Lox-instance
defined in the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 90 of file alox.prepro.hpp.

◆ Log_SetPrefix

#define Log_SetPrefix ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.SetPrefix ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::SetPrefix(const Box&, Scope) (or one of its overloads) on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 103 of file alox.prepro.hpp.

◆ Log_SetSourcePathTrimRule

#define Log_SetSourcePathTrimRule ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.SetSourcePathTrimRule( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::SetSourcePathTrimRule on the debug-singleton of the Lox-instance
defined in the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 81 of file alox.prepro.hpp.

◆ Log_SetStartTime

#define Log_SetStartTime ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.SetStartTime ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::SetStartTime(Ticks, const NString&) (or one of its overloads) on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 92 of file alox.prepro.hpp.

◆ Log_SetVerbosity

#define Log_SetVerbosity ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.SetVerbosity ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes one of the overloaded methods Lox::SetVerbosity (or one of its overloads) on the debug-singleton of the Lox-instance defined in macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 91 of file alox.prepro.hpp.

◆ Log_Store

#define Log_Store ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.Store ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::Store(const Box&, Scope) or an overloaded version on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 104 of file alox.prepro.hpp.

◆ Log_Verbose

#define Log_Verbose ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.Verbose ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::Verbose on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 95 of file alox.prepro.hpp.

◆ Log_Warning

#define Log_Warning ( ... )

Value:

{ Log_Prune( LOG_ACQUIRE _log.Warning ( __VA_ARGS__ ); LOG_RELEASE ) }

Invokes Lox::Warning on the debug-singleton of the Lox-instance defined by the macro LOG_LOX.

Parameters

...	The parameters to pass.

Definition at line 97 of file alox.prepro.hpp.

◆ LOX_ACQUIRE

#define LOX_ACQUIRE { alib::lox::Lox& _lox= LOX_LOX; _lox.Acquire( LOX_CI );

Macro that is placed at the beginning of almost all release logging macros. Provides scope information (provided that ALOX_REL_LOG_CI is set) to the lox and places the release lox instance access code using LOX_LOX.

Definition at line 71 of file alox.prepro.hpp.

◆ Lox_Assert

#define Lox_Assert ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.Assert ( __VA_ARGS__); LOX_RELEASE ) }

LOX_RELEASE

#define LOX_RELEASE

Definition alox.prepro.hpp:72

Lox_Prune

#define Lox_Prune(...)

Definition alox.prepro.hpp:116

LOX_ACQUIRE

#define LOX_ACQUIRE

Definition alox.prepro.hpp:71

Invokes Lox::Assert on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 136 of file alox.prepro.hpp.

◆ LOX_CI

#define LOX_CI ALIB_CALLER

Dependent on ALOX_REL_LOG_CI, this macro provides comma delimited source information (sourcefile, line number, function name) or corresponding null values.

Definition at line 60 of file alox.prepro.hpp.

◆ Lox_ClearSourcePathTrimRules

#define Lox_ClearSourcePathTrimRules ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.ClearSourcePathTrimRules( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::ClearSourcePathTrimRules on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 122 of file alox.prepro.hpp.

◆ Lox_Entry

#define Lox_Entry ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.Entry ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::Entry(const NString&, Verbosity) (or its overload) on the object of type Lox defined by the macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 139 of file alox.prepro.hpp.

◆ Lox_Error

#define Lox_Error ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.Error ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::Error on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 135 of file alox.prepro.hpp.

◆ Lox_Exception

#define Lox_Exception ( ... )

Value:

{ Lox_Prune( alib::lox::LogTools::Exception( LOX_LOX, __VA_ARGS__ ); ) }

LOX_LOX

#define LOX_LOX

Definition alox.prepro.hpp:113

Invokes Exception providing the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 145 of file alox.prepro.hpp.

◆ Lox_GetLogger

#define Lox_GetLogger	(		identifier,
			name )

Value:

Lox_Prune( alib::lox::detail::Logger* identifier; LOX_ACQUIRE identifier= _lox.GetLogger ( name ); LOX_RELEASE )

Invokes Lox::GetLogger on the object of type Lox defined in macro LOX_LOX.

Parameters

identifier	The identifier name of the variable that receives the pointer to the logger.
name	The name of the logger to retrieve.

Definition at line 123 of file alox.prepro.hpp.

◆ Lox_GetVerbosity

#define Lox_GetVerbosity	(		result,
			... )

Value:

{ Lox_Prune( LOX_ACQUIRE result= _lox.GetVerbosity( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::GetVerbosity on the object of type Lox defined in macro LOX_LOX. The result value is assigned to given variable result

Parameters

result	The name of a variable of type Verbosity that the return value of GetVerbosity() is assigned to.
...	The parameters to pass.

Definition at line 144 of file alox.prepro.hpp.

◆ Lox_If

#define Lox_If ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.If ( __VA_ARGS__); LOX_RELEASE ) }

Invokes Lox::If(bool, Verbosity, BoxedObjects&& ...) (or its overload) on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 137 of file alox.prepro.hpp.

◆ Lox_Info

#define Lox_Info ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.Info ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::Info on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 133 of file alox.prepro.hpp.

◆ Lox_IsActive

#define Lox_IsActive	(		result,
			... )

Value:

{ Lox_Prune( LOX_ACQUIRE result= _lox.IsActive( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::IsActive on the object of type Lox defined in macro LOX_LOX. The result value is assigned to given variable result

Parameters

result	The name of a variable of type `int` that the return value of IsActive() is assigned to.
...	The parameters to pass.

Definition at line 143 of file alox.prepro.hpp.

◆ Lox_LogState

#define Lox_LogState ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.State ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::State on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 131 of file alox.prepro.hpp.

◆ LOX_LOX

#define LOX_LOX

The Lox instance that is used by all release logging macros. This has to be set (prior or after including alox.hpp) to provide access to a, dedicated instance of class Lox created for release logging within software.
It is of course allowed to use different instances within different source entities. However, other ways to structure log output and separate log streams exist in ALox and should be evaluated before introducing different instances of class Lox.

Note: The definition must provide a reference (not a pointer) to the Lox object.

Definition at line 113 of file alox.prepro.hpp.

◆ Lox_MapThreadName

#define Lox_MapThreadName ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.MapThreadName( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::MapThreadName on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 130 of file alox.prepro.hpp.

◆ Lox_Once

#define Lox_Once ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.Once ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::Once(const Box&, int) (or one of its overloads) on the object of type Lox defined by the macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 138 of file alox.prepro.hpp.

◆ Lox_Prune

#define Lox_Prune ( ... )

Value:

__VA_ARGS__

This very simple macro is used for pruning release Log Statements at the moment release logging gets disabled (what in standard release scenarios is not done).

While it is used as a building block of all other macros for release logging, for code entities using ALox, it provides an easy way to prune code lines that get inserted purely to support logging, e.g., to create ALox loggers or to prepare more complex log output. (The alternative way is to enclose such code within #ifdef ALOX_REL_LOG / #endif preprocessor lines.

Depends on ALOX_REL_LOG. If this is set, the macro just copies the code provided, else it does not copy it, hence removes the code.

Parameters

...	The code to prune.

Definition at line 116 of file alox.prepro.hpp.

◆ LOX_RELEASE

#define LOX_RELEASE _lox.Release(); }

Macro that is placed at the end of almost all release logging macros. Releases the lox which was acquired when passing scope information (in macro LOG_ACQUIRE.).

Definition at line 72 of file alox.prepro.hpp.

◆ Lox_RemoveLogger

#define Lox_RemoveLogger ( logger )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.RemoveLogger ( logger ); LOX_RELEASE ) }

Invokes Lox::RemoveLogger(const NString&) (or its overload) on the object of type Lox defined in macro LOX_LOX.

Parameters

logger Either the name of or a pointer to the logger to remove.

Definition at line 124 of file alox.prepro.hpp.

◆ Lox_RemoveThreadDomain

#define Lox_RemoveThreadDomain ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.RemoveThreadDomain( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::RemoveThreadDomain on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 126 of file alox.prepro.hpp.

◆ Lox_Retrieve

#define Lox_Retrieve	(		data,
			... )

Value:

{ Lox_Prune( LOX_ACQUIRE LogData* data= _lox.Retrieve( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::Retrieve(Scope) (or its overload) on the object of type Lox defined in macro LOX_LOX.

Parameters

data	The identifier name of the Box object to take the retrieved data.
...	The parameters to pass.

Definition at line 141 of file alox.prepro.hpp.

◆ Lox_SetDomain

#define Lox_SetDomain ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.SetDomain (__VA_ARGS__); LOX_RELEASE ) }

Invokes Lox::SetDomain(const NString&, Scope) (or its overload) on the object of type Lox defined in macro LOX_LOX.

Attention: If ALOX_REL_LOG_CI is not set, which is the default for release logging, and when used with language-related Scopes, this method will log an internal warning and will not be effective in respect to Scope::Path, Scope::Filename, and Scope::Method. See ALib Module ALox - Programmer's Manual for detailed information.

If Scope Domains based on source-related scopes should be supported in release logging, the ALib Build as well as the software entity have to be compiled with the configuration macro ALOX_REL_LOG_CI. Note that one effect of setting this macro is, that information on source code paths and file names, as well as method names make their way into the release executable. This may not be wanted.

Parameters

...	The parameters to pass.

Definition at line 125 of file alox.prepro.hpp.

◆ Lox_SetDomainSubstitutionRule

#define Lox_SetDomainSubstitutionRule ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.SetDomainSubstitutionRule( __VA_ARGS__ );LOX_RELEASE ) }

Invokes Lox::SetDomainSubstitutionRule on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 127 of file alox.prepro.hpp.

◆ Lox_SetPrefix

#define Lox_SetPrefix ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.SetPrefix ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::SetPrefix(const Box&, Scope) (or one of its overloads) on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 142 of file alox.prepro.hpp.

◆ Lox_SetSourcePathTrimRule

#define Lox_SetSourcePathTrimRule ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.SetSourcePathTrimRule( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::SetSourcePathTrimRule on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 121 of file alox.prepro.hpp.

◆ Lox_SetStartTime

#define Lox_SetStartTime ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.SetStartTime ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::SetStartTime(Ticks, const NString&) (or one of its overloads) on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 129 of file alox.prepro.hpp.

◆ Lox_SetVerbosity

#define Lox_SetVerbosity ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.SetVerbosity ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes one of the overloaded methods Lox::SetVerbosity (or its overload) on the object of type Lox defined by the macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 128 of file alox.prepro.hpp.

◆ Lox_Store

#define Lox_Store ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.Store ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::Store(const Box&, Scope) (or its overload) on the object of type Lox defined by the macro LOX_LOX.

Attention: If ALOX_REL_LOG_CI is not set, which is the default for release logging statements, Log Data cannot be used in conjunction with language-related Scopes.
If Log Data should be supported in release logging, the ALib Build as well as the software entity have to be compiled with the configuration macro ALOX_REL_LOG_CI. Note that one effect of setting this macro is, that information on source code paths and file names, as well as method names make their way into the release executable. This may not be wanted.
In general, methods Lox::Store and Lox::Retrieve should exclusively be used for debug logging. See user manual for more information.

Parameters

...	The parameters to pass.

Definition at line 140 of file alox.prepro.hpp.

◆ Lox_Verbose

#define Lox_Verbose ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.Verbose ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::Verbose on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 132 of file alox.prepro.hpp.

◆ Lox_Warning

#define Lox_Warning ( ... )

Value:

{ Lox_Prune( LOX_ACQUIRE _lox.Warning ( __VA_ARGS__ ); LOX_RELEASE ) }

Invokes Lox::Warning on the object of type Lox defined in macro LOX_LOX.

Parameters

...	The parameters to pass.

Definition at line 134 of file alox.prepro.hpp.

Description:

Macros

Macro Definition Documentation

◆ LOG_ACQUIRE

◆ Log_AddDebugLogger

◆ Log_Assert

◆ LOG_CI

◆ Log_ClearSourcePathTrimRules

◆ Log_Entry

◆ Log_Error

◆ Log_Exception

◆ Log_GetLogger

◆ Log_GetVerbosity

◆ Log_If

◆ Log_Info

◆ Log_IsActive

◆ Log_LogState

◆ LOG_LOX

◆ Log_MapThreadName

◆ Log_Once

◆ Log_Prune

◆ LOG_RELEASE

◆ Log_RemoveDebugLogger

◆ Log_RemoveLogger

◆ Log_RemoveThreadDomain

◆ Log_Retrieve

◆ Log_SetDomain

◆ Log_SetDomainSubstitutionRule

◆ Log_SetPrefix

◆ Log_SetSourcePathTrimRule

◆ Log_SetStartTime

◆ Log_SetVerbosity

◆ Log_Store

◆ Log_Verbose

◆ Log_Warning

◆ LOX_ACQUIRE

◆ Lox_Assert

◆ LOX_CI

◆ Lox_ClearSourcePathTrimRules

◆ Lox_Entry

◆ Lox_Error

◆ Lox_Exception

◆ Lox_GetLogger

◆ Lox_GetVerbosity

◆ Lox_If

◆ Lox_Info

◆ Lox_IsActive

◆ Lox_LogState

◆ LOX_LOX

◆ Lox_MapThreadName

◆ Lox_Once

◆ Lox_Prune

◆ LOX_RELEASE

◆ Lox_RemoveLogger

◆ Lox_RemoveThreadDomain

◆ Lox_Retrieve

◆ Lox_SetDomain

◆ Lox_SetDomainSubstitutionRule

◆ Lox_SetPrefix

◆ Lox_SetSourcePathTrimRule

◆ Lox_SetStartTime

◆ Lox_SetVerbosity

◆ Lox_Store

◆ Lox_Verbose

◆ Lox_Warning