Description:

Struct that collects static functions that provide the implementation of methods of class Lox. Almost all functions expect a pointer to the hidden implementation type LoxImpl as the first parameter.

Definition at line 26 of file loxpimpl.hpp.

#include <loxpimpl.hpp>

Public Static Method Index:
static void	Acquire (LoxImpl *impl, const lang::CallerInfo &ci)
static BoxesMA &	acquireInternalLogables (LoxImpl *impl)
static int	checkScopeInformation (LoxImpl *impl, Scope &scope, const NString &internalDomain)
static LoxImpl *	Construct (const NString &name)
static MonoAllocator &	DbgGetMonoAllocator (LoxImpl *impl)
static void	Destruct (LoxImpl *lox)
static void	dumpStateOnLoggerRemoval (LoxImpl *impl)
static void	Entry (LoxImpl *impl, const NString &domain, Verbosity verbosity)
static void	entryDetectDomainImpl (LoxImpl *impl, Verbosity verbosity)
static detail::Domain *	evaluateResultDomain (LoxImpl *impl, const NString &domainPath)
static detail::Domain *	findDomain (LoxImpl *impl, detail::Domain &domainSystem, NString domainPath)
static void	getAllVerbosities (LoxImpl impl, variables::Variable &variable, detail::Logger logger, detail::Domain &dom)
static void	getDomainPrefixFromConfig (LoxImpl *impl, detail::Domain &dom)
static threads::RecursiveLock &	getLock (LoxImpl *impl)
static BoxesMA &	GetLogableContainer (LoxImpl *impl)
static integer &	GetLogCounter (LoxImpl *impl)
static detail::Logger *	GetLogger (LoxImpl *impl, const NString &loggerName)
static const NString &	GetName (LoxImpl *impl)
static void	GetState (LoxImpl *impl, NAString &buf, StateInfo flags)
static Verbosity	GetVerbosity (LoxImpl impl, const NString &domain, NAString resultDomain)
static void	getVerbosityFromConfig (LoxImpl impl, variables::Variable &variable, detail::Logger logger, detail::Domain &dom)
static void	IncreaseLogCounter (LoxImpl *impl)
static void	init (LoxImpl *impl)
static int	IsActive (LoxImpl impl, Verbosity verbosity, const NString &domain, NAString resultDomain)
static bool	isThreadRelatedScope (LoxImpl *impl, Scope scope)
static void	log (LoxImpl impl, detail::Domain dom, Verbosity verbosity, BoxesMA &logables, lang::Inclusion prefixes)
static void	logInternal (LoxImpl *impl, Verbosity verbosity, const NString &subDomain, BoxesMA &msg)
static void	logInternal (LoxImpl *impl, Verbosity verbosity, const NString &subDomain, const NString &msg)
static void	MapThreadName (LoxImpl *impl, const String &threadName, threads::ThreadID id)
static void	once (LoxImpl *impl, const NString &domain, Verbosity verbosity, const Box &logables, const String &pGroup, Scope scope, int quantity)
static void	Release (LoxImpl *impl)
static detail::Logger *	RemoveLogger (LoxImpl *impl, const NString &loggerName)
static bool	RemoveLogger (LoxImpl impl, detail::Logger logger)
static void	RemoveThreadDomain (LoxImpl impl, const NString &scopeDomain, Scope scope, threads::Thread thread)
static void	Reset (LoxImpl *impl)
static Box	retrieve (LoxImpl *impl, const NString &pKey, Scope scope)
static void	SetDomain (LoxImpl impl, const NString &scopeDomain, Scope scope, threads::Thread thread)
static void	setDomain (LoxImpl impl, const NString &scopeDomain, Scope scope, bool removeNTRSD, threads::Thread thread)
static void	SetDomainSubstitutionRule (LoxImpl *impl, const NString &domainPath, const NString &replacement)
static void	SetFileNameCacheCapacity (LoxImpl *impl, integer numberOfLists, integer entriesPerList)
static void	SetPrefix (LoxImpl *impl, const Box &prefix, const NString &domain, lang::Inclusion otherPLs)
static void	setPrefix (LoxImpl impl, const Box &prefix, Scope scope, threads::Thread thread)
static void	SetSourcePathTrimRule (LoxImpl *impl, const NCString &path, lang::Inclusion includeString, int trimOffset, lang::Case sensitivity, const NString &trimReplacement, lang::Reach reach, Priority priority)
static void	SetStartTime (LoxImpl *impl, const FILETIME &startTime, const NString &loggerName)
static void	SetStartTime (LoxImpl *impl, Ticks startTime, const NString &loggerName)
static void	SetStartTime (LoxImpl *impl, time_t startTime, const NString &loggerName)
static void	SetVerbosity (LoxImpl *impl, const NString &loggerName, Verbosity verbosity, const NString &domain, Priority priority)
static void	SetVerbosity (LoxImpl impl, detail::Logger logger, Verbosity verbosity, const NString &domain, Priority priority)
static void	SetVerbosityExport (LoxImpl *impl, const NString &loggerName, bool value, Priority priority=Priority::Standard)
static void	SetVerbosityExport (LoxImpl impl, detail::Logger logger, bool value, Priority priority=Priority::Standard)
static void	State (LoxImpl *impl, const NString &domain, Verbosity verbosity, const String &headLine, StateInfo flags)
static void	store (LoxImpl *impl, const Box &data, const NString &pKey, Scope scope)
static void	writeVerbositiesOnLoggerRemoval (LoxImpl impl, Logger logger)

Public Method Index:
void	Reset ()

Method Details:

◆ Acquire()

void alib::lox::detail::LI::Acquire	(	LoxImpl *	impl,
		const lang::CallerInfo &	ci )

static

Implementation of the method void Acquire(const lang::CallerInfo&) .

Parameters

impl	The implementation struct of the `Lox`.
ci	The source location that the call is placed at. Usually macro ALIB_CALLER is passed here.

Definition at line 253 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ acquireInternalLogables()

BoxesMA & alib::lox::detail::LI::acquireInternalLogables ( LoxImpl * impl )

static

Returns a reference to a list of boxes to be used by internal logging. Each invocation has to be followed by an invocation to logInternal which releases the logables.

Parameters

impl	The implementation struct of the `Lox`.

Returns: A list of boxes.

Definition at line 1875 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ checkScopeInformation()

int alib::lox::detail::LI::checkScopeInformation	(	LoxImpl *	impl,
		Scope &	scope,
		const NString &	internalDomain )

static

Checks if given scope needs information that is not available. In addition, the in/out parameter scope is changed to Path, in case a level was added.

Parameters

	impl	The implementation struct of the `Lox`.
[in,out]	scope	A reference to the scope that is to be checked (and eventually modified.
	internalDomain	The internal subdomain to log any error/warning into.

Returns: A positive value providing the path level deduced from scope if all is fine, -1 else.

Definition at line 1730 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ Construct()

LoxImpl * alib::lox::detail::LI::Construct ( const NString & name )

static

Implementation of the constructor the constructor of class Lox.

Parameters

name	The name of the Lox. Will be copied and converted to upper case.

Returns: The implementation for the calling Lox.

Definition at line 225 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ DbgGetMonoAllocator()

MonoAllocator & alib::lox::detail::LI::DbgGetMonoAllocator ( LoxImpl * impl )

static

Implementation of the method MonoAllocator & DbgGetMonoAllocator() .

Parameters

impl	The implementation struct of the `Lox`.

Returns: The monotonic allocator of this Lox.

Definition at line 345 of file loxpimpl.cpp.

◆ Destruct()

void alib::lox::detail::LI::Destruct ( LoxImpl * lox )

static

Destructs a lox.

Parameters

lox	The `Lox` that is to be destructed.

Definition at line 235 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ dumpStateOnLoggerRemoval()

void alib::lox::detail::LI::dumpStateOnLoggerRemoval ( LoxImpl * impl )

static

Implements functionality for configuration variable LOXNAME_DUMP_STATE_ON_EXIT. Is called when a logger is removed.

Parameters

impl	The implementation struct of the `Lox`.

Definition at line 452 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ Entry()

void alib::lox::detail::LI::Entry	(	LoxImpl *	impl,
		const NString &	domain,
		Verbosity	verbosity )

static

Implementation of the method void Entry(const NString&, Verbosity) .

Parameters

impl	The implementation struct of the `Lox`.
domain	The domain.
verbosity	The verbosity.

Definition at line 1283 of file loxpimpl.cpp.

◆ entryDetectDomainImpl()

void alib::lox::detail::LI::entryDetectDomainImpl	(	LoxImpl *	impl,
		Verbosity	verbosity )

static

Implementation of the method void EntryDetectDomain(Verbosity, BoxedObjects&& ...) .

Parameters

impl	The implementation struct of the `Lox`.
verbosity	The verbosity.

Definition at line 1368 of file loxpimpl.cpp.

◆ evaluateResultDomain()

Domain * alib::lox::detail::LI::evaluateResultDomain	(	LoxImpl *	impl,
		const NString &	domainPath )

static

Assembles the resulting domain from the given domainPath and the Scope Domain paths (see SetDomain) according to the scope identified by scopeInfo. The resulting full domain string is assembled from inner to outer scope. If domainPath, respectively as soon as any of the Scope Domain's paths start with the character defined with Domain::Separator, the evaluation is stopped (the path is interpreted as absolute).

Parameters

impl	The implementation struct of the `Lox`.
domainPath	The domain path. If starting with the character defined with Domain::Separator, no scope domains are applied.

Returns: The resulting Domain.

Definition at line 1411 of file loxpimpl.cpp.

◆ findDomain()

Domain * alib::lox::detail::LI::findDomain	(	LoxImpl *	impl,
		detail::Domain &	domainSystem,
		NString	domainPath )

static

Invokes Find on the given domain and logs internal message when the domain was not known before.

Parameters

impl	The implementation struct of the `Lox`.
domainSystem	The domain system. Either the standard or the internal one.
domainPath	The domain path.

Returns: The resulting Domain.

Definition at line 1568 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ getAllVerbosities()

void alib::lox::detail::LI::getAllVerbosities	(	LoxImpl *	impl,
		variables::Variable &	variable,
		detail::Logger *	logger,
		detail::Domain &	dom )

static

Reads the verbosity for the given logger and domain from the ALib variable system. This internal method is used when a new logger is added. Walks recursively for all existing domains.

Parameters

impl	The implementation struct of the `Lox`.
variable	The loaded variable with verbosity information.
logger	The logger to set the verbosity for.
dom	The domain to set the verbosity for.

Definition at line 1558 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ getDomainPrefixFromConfig()

void alib::lox::detail::LI::getDomainPrefixFromConfig	(	LoxImpl *	impl,
		detail::Domain &	dom )

static

Reads a prefix string from the ALib variable system. This internal method is used when a new domain is created,

Parameters

impl	The implementation struct of the `Lox`.
dom	The domain to set the verbosity for.

Definition at line 1495 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ getLock()

RecursiveLock & alib::lox::detail::LI::getLock ( LoxImpl * impl )

static

Returns the internal lock.

Parameters

impl	The implementation struct of the `Lox`.

Returns: The internal RecursiveLock of this Lox.

Definition at line 246 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ GetLogableContainer()

BoxesMA & alib::lox::detail::LI::GetLogableContainer ( LoxImpl * impl )

static

Implementation of the method BoxesMA & GetLogableContainer() .

Parameters

impl	The implementation struct of the `Lox`.

Returns: An empty list of boxes.

Definition at line 1272 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ GetLogCounter()

integer & alib::lox::detail::LI::GetLogCounter ( LoxImpl * impl )

static

Implementation of the method integer & GetLogCounter() .

Parameters

impl	The implementation struct of the `Lox`.

Returns: The name of this Lox.

Definition at line 243 of file loxpimpl.cpp.

◆ GetLogger()

Logger * alib::lox::detail::LI::GetLogger	(	LoxImpl *	impl,
		const NString &	loggerName )

static

Implementation of the method detail::Logger * GetLogger(const NString&) .

Parameters

impl	The implementation struct of the `Lox`.
loggerName	The name of the Logger to search for (case-insensitive).

Returns: The logger, nullptr if not found.

Definition at line 371 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ GetName()

const NString & alib::lox::detail::LI::GetName ( LoxImpl * impl )

static

Implementation of the method const NString & GetName() .

Parameters

impl	The implementation struct of the `Lox`.

Returns: The name of this Lox.

Definition at line 241 of file loxpimpl.cpp.

◆ GetState()

void alib::lox::detail::LI::GetState	(	LoxImpl *	impl,
		NAString &	buf,
		StateInfo	flags )

static

Implementation of the method void GetState(NAString&, StateInfo) .

Parameters

impl	The implementation struct of the `Lox`.
buf	The target string.
flags	Bits that define which state information is collected.

Definition at line 1951 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ GetVerbosity()

Verbosity alib::lox::detail::LI::GetVerbosity	(	LoxImpl *	impl,
		const NString &	domain,
		NAString *	resultDomain )

static

Implementation of the method Verbosity GetVerbosity(const NString&, NAString*) .

Parameters

impl	The implementation struct of the `Lox`.
domain	The log domain. All rules for resolving the effective log domain apply as with normal log statements.
resultDomain	An optional pointer to an `AString`. If given, the resulting domain is appended to the string. (The domain that results from the optional domain and all ALox rules that apply at the place of invocation).

Returns: The "lowest" verbosity that has an active logger.

Definition at line 1335 of file loxpimpl.cpp.

◆ getVerbosityFromConfig()

void alib::lox::detail::LI::getVerbosityFromConfig	(	LoxImpl *	impl,
		variables::Variable &	variable,
		detail::Logger *	logger,
		detail::Domain &	dom )

static

Reads the verbosity for the given logger and domain from the ALib variable system. This internal method is used in two occasions:

when a new logger is added: recursively for all existing domains (configStr is given)
when a new domain is created on the fly(configStr is not given)

The variable is already read and found in an internal instance.

Parameters

impl	The implementation struct of the `Lox`.
variable	The loaded variable with verbosity information.
logger	The logger to set the verbosity for.
dom	The domain to set the verbosity for.

Definition at line 1443 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ IncreaseLogCounter()

void alib::lox::detail::LI::IncreaseLogCounter ( LoxImpl * impl )

static

Increases the internal log counter of impl.

Parameters

impl	The implementation struct of the `Lox`.

Definition at line 1366 of file loxpimpl.cpp.

◆ init()

void alib::lox::detail::LI::init ( LoxImpl * impl )

static

Used on construction and with Reset.

Parameters

impl	The implementation struct of the `Lox`.

Definition at line 272 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ IsActive()

int alib::lox::detail::LI::IsActive	(	LoxImpl *	impl,
		Verbosity	verbosity,
		const NString &	domain,
		NAString *	resultDomain )

static

Implementation of the method int IsActive(Verbosity, const NString&, NAString*) .

Parameters

impl	The implementation struct of the `Lox`.
verbosity	The verbosity to query for activity.
domain	The log domain. All rules for resolving the effective log domain apply as with normal log statements.
resultDomain	An optional pointer to an `AString`. If given, the resulting domain is appended to the string. (The domain that results from the optional domain and all ALox rules that apply at the place of invocation).

Returns: The number of active loggers.

Definition at line 1308 of file loxpimpl.cpp.

◆ isThreadRelatedScope()

bool alib::lox::detail::LI::isThreadRelatedScope	(	LoxImpl *	impl,
		Scope	scope )

static

Checks if given scope is thread-related.

Parameters

impl	The implementation struct of the `Lox`.
scope	The scope that is to be checked.

Returns: true if scope is thread-related, false else.

Definition at line 1749 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ log()

void alib::lox::detail::LI::log	(	LoxImpl *	impl,
		detail::Domain *	dom,
		Verbosity	verbosity,
		BoxesMA &	logables,
		lang::Inclusion	prefixes )

static

This method is looping over the Loggers, checking their verbosity against the given one, and, if they match, invoke the log method of the Logger. With the first logger identified to be active, the Prefix Objects get collected from the scope store.

Parameters

impl	The implementation struct of the `Lox`.
dom	The domain to log on
verbosity	The verbosity.
logables	The objects to log.
prefixes	Denotes if prefixes should be included or not.

Definition at line 1778 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ logInternal() [1/2]

void alib::lox::detail::LI::logInternal	(	LoxImpl *	impl,
		Verbosity	verbosity,
		const NString &	subDomain,
		BoxesMA &	msg )

static

Logs an internal error message using the internal domain tree as defined in Lox::InternalDomains.

Parameters

impl	The implementation struct of the `Lox`.
verbosity	The verbosity.
subDomain	The subdomain of the internal domain to log into.
msg	The message.

Definition at line 1884 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ logInternal() [2/2]

void alib::lox::detail::LI::logInternal	(	LoxImpl *	impl,
		Verbosity	verbosity,
		const NString &	subDomain,
		const NString &	msg )

static

Overloaded version accepting a string to log.

Parameters

impl	The implementation struct of the `Lox`.
verbosity	The verbosity.
subDomain	The subdomain of the internal domain to log into.
msg	The message.

Definition at line 1891 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ MapThreadName()

void alib::lox::detail::LI::MapThreadName	(	LoxImpl *	impl,
		const String &	threadName,
		threads::ThreadID	id )

static

Implementation of the method void MapThreadName(const String&, threads::ThreadID) .

Parameters

impl	The implementation struct of the `Lox`.
threadName	The name of the thread as it should be displayed in the logs.
id	The thread ID.

Definition at line 1039 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ once()

void alib::lox::detail::LI::once	(	LoxImpl *	impl,
		const NString &	domain,
		Verbosity	verbosity,
		const Box &	logables,
		const String &	pGroup,
		Scope	scope,
		int	quantity )

static

Internal method serving public interface Lox::Once.

Parameters

impl	The implementation struct of the `Lox`.
domain	Optional Log Domain which is combined with Scope Domains set for the Scope of invocation.
verbosity	The verbosity of the Log Statement (if performed).
logables	The objects to log (Multiple objects may be provided within container class Boxes.)
pGroup	The optional name of the statement group. If used, all statements that share the same group name are working on the same counter (according to the scope.) If omitted (or empty or nullptr), the counter is bound to the Scope provided. If omitted and scope is Scope::Global, then the counter is associated exclusively with the single Log Statement itself.
scope	The Scope that the group or counter is bound to.
quantity	The number of logs to be performed. As the name of the method indicates, this defaults to `1`.

Definition at line 1070 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ Release()

void alib::lox::detail::LI::Release ( LoxImpl * impl )

static

Implementation of the method void Release() .

Parameters

impl	The implementation struct of the `Lox`.

Definition at line 264 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ RemoveLogger() [1/2]

Logger * alib::lox::detail::LI::RemoveLogger	(	LoxImpl *	impl,
		const NString &	loggerName )

static

Implementation of the method RemoveLogger(const NString&).

Parameters

impl	The implementation struct of the `Lox`.
loggerName	The name of the Logger(s) to be removed (case-insensitive).

Returns: The logger that was removed, nullptr if not found.

Definition at line 545 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ RemoveLogger() [2/2]

bool alib::lox::detail::LI::RemoveLogger	(	LoxImpl *	impl,
		detail::Logger *	logger )

static

Implementation of the method RemoveLogger(detail::Logger*).

Parameters

impl	The implementation struct of the `Lox`.
logger	The logger to be removed.

Returns: true, if the Logger was found and removed, false otherwise.

Definition at line 517 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ RemoveThreadDomain()

void alib::lox::detail::LI::RemoveThreadDomain	(	LoxImpl *	impl,
		const NString &	scopeDomain,
		Scope	scope,
		threads::Thread *	thread )

static

Implementation of the method void RemoveThreadDomain(const NString&, Scope, threads::Thread*) .

Parameters

impl	The implementation struct of the `Lox`.
scopeDomain	The domain path to register.
scope	Either Scope::ThreadOuter or Scope::ThreadInner. With other values, an internal error is logged.
thread	The thread to set/unset a thread-related Scope Domains for.

Definition at line 806 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ Reset() [1/2]

void alib::lox::detail::LI::Reset ( )

Resets this object. Concretely, the following steps are performed:

If the debug lox singleton exists, it is deleted.
It is asserted that no other lox object is registered.
The ALox path of the configuration is deleted.

Attention: This method was introduced to support resetting ALox in the unit tests. In real applications, this method should NOT be used. Side effects might appear using this method and it is not tested otherwise than used in tests!

◆ Reset() [2/2]

void alib::lox::detail::LI::Reset ( LoxImpl * impl )

static

Implementation of the method void Reset() .

Parameters

impl	The implementation struct of the `Lox`.

Definition at line 315 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ retrieve()

Box alib::lox::detail::LI::retrieve	(	LoxImpl *	impl,
		const NString &	pKey,
		Scope	scope )

static

Internal method serving public interface Lox::Retrieve.

Parameters

impl	The implementation struct of the `Lox`.
pKey	The key to the data.
scope	The Scope that the data is bound to.

Returns: The data, a nulled box if no value was found.

Definition at line 1213 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetDomain()

void alib::lox::detail::LI::SetDomain	(	LoxImpl *	impl,
		const NString &	scopeDomain,
		Scope	scope,
		threads::Thread *	thread )

static

Implementation of the method SetDomain(const NString&, Scope, threads::Thread*).

Parameters

impl	The implementation struct of the `Lox`.
scopeDomain	The domain path to register.
scope	Either Scope::ThreadOuter or Scope::ThreadInner. With other values, an internal error is logged.
thread	The thread to set/unset a thread-related Scope Domains for.

Definition at line 361 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ setDomain()

void alib::lox::detail::LI::setDomain	(	LoxImpl *	impl,
		const NString &	scopeDomain,
		Scope	scope,
		bool	removeNTRSD,
		threads::Thread *	thread )

static

Implementation of the interface method fetching all possible parameters.

Parameters

impl	The implementation struct of the `Lox`.
scopeDomain	The domain path to register.
scope	The scope that the given domain should be registered for. Available Scope definitions are platform/language dependent.
removeNTRSD	Used to remove a named thread-related Scope Domain (and is true only when invoked by interface method RemoveThreadDomain.
thread	The thread to set/unset a thread-related Scope Domain for.

Definition at line 735 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetDomainSubstitutionRule()

void alib::lox::detail::LI::SetDomainSubstitutionRule	(	LoxImpl *	impl,
		const NString &	domainPath,
		const NString &	replacement )

static

Implementation of the method void SetDomainSubstitutionRule(const NString&, const NString&) .

Parameters

impl	The implementation struct of the `Lox`.
domainPath	The path to search. Has to start with either `'/'` or `'*'`.
replacement	The replacement path.

Definition at line 826 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetFileNameCacheCapacity()

void alib::lox::detail::LI::SetFileNameCacheCapacity	(	LoxImpl *	impl,
		integer	numberOfLists,
		integer	entriesPerList )

static

Implementation of the method void SetFileNameCacheCapacity(integer, integer) .

Parameters

impl	The implementation struct of the `Lox`.
numberOfLists	The number of LRU-lists to use.
entriesPerList	The maximum length of each cache list.

Definition at line 341 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetPrefix()

void alib::lox::detail::LI::SetPrefix	(	LoxImpl *	impl,
		const Box &	prefix,
		const NString &	domain,
		lang::Inclusion	otherPLs )

static

Implementation of the method void SetPrefix(const Box&, const NString&, lang::Inclusion) .

Parameters

impl	The implementation struct of the `Lox`.
prefix	The Prefix Logable to set.
domain	The domain path. Defaults to `nullptr`, resulting in evaluated Scope Domain path.
otherPLs	If set to `Inclusion::Exclude`, scope-related Prefix Logables are ignored and only domain-related Prefix Logables are passed to the Loggers.

Definition at line 941 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ setPrefix()

void alib::lox::detail::LI::setPrefix	(	LoxImpl *	impl,
		const Box &	prefix,
		Scope	scope,
		threads::Thread *	thread )

static

Implementation of the interface method fetching all possible parameters.

Parameters

impl	The implementation struct of the `Lox`.
prefix	The Prefix Logable to set.
scope	The scope that the given logable should be registered for. Available Scope definitions are platform/language dependent.
thread	The thread to set/unset a thread-related Prefix Logable for.

Definition at line 885 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetSourcePathTrimRule()

void alib::lox::detail::LI::SetSourcePathTrimRule	(	LoxImpl *	impl,
		const NCString &	path,
		lang::Inclusion	includeString,
		int	trimOffset,
		lang::Case	sensitivity,
		const NString &	trimReplacement,
		lang::Reach	reach,
		Priority	priority )

static

Implementation of the method void SetSourcePathTrimRule(const NCString&, lang::Inclusion, int, lang::Case, const NString&, lang::Reach, Priority) .

Parameters

impl	The implementation struct of the `Lox`.
path	The path to search for. If not starting with `'*'`, a prefix is searched.
includeString	Determines if path should be included in the trimmed path or not. Optional and defaults to `Exclude`.
trimOffset	Adjusts the portion of path that is trimmed. Optional and defaults to `0`.
sensitivity	Determines if the comparison of path with a source file's path is performed case-sensitive or not. Optional and defaults to `Ignore`.
trimReplacement	Replacement string for trimmed portion of the path. Optional and defaults to `NULL_STRING`.
reach	Denotes whether the rule is applied locally (to this `Lox` only) or applies to all instances of class `Lox`. Defaults to `Global`.
priority	The priority of the setting. Defaults to DefaultValues.

Definition at line 348 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetStartTime() [1/3]

void alib::lox::detail::LI::SetStartTime	(	LoxImpl *	impl,
		const FILETIME &	startTime,
		const NString &	loggerName )

static

Implementation of the method SetStartTime(const FILETIME&, const NString&).

Parameters

impl	The implementation struct of the `Lox`.
startTime	The new start time in system-specific time unit.
loggerName	The name of the Logger whose start time is to be set (case insensitive). Defaults to empty string, which indicates that all loggers are to be affected.

◆ SetStartTime() [2/3]

void alib::lox::detail::LI::SetStartTime	(	LoxImpl *	impl,
		Ticks	startTime,
		const NString &	loggerName )

static

Implementation of the method SetStartTime(Ticks, const NString&).

Parameters

impl	The implementation struct of the `Lox`.
startTime	Optional parameter with the new start time. Defaults to current time if omitted.
loggerName	The name of the Logger(s) whose start time is to be set (case-insensitive). Defaults to nullptr, which indicates that all loggers are to be affected.

Definition at line 998 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetStartTime() [3/3]

void alib::lox::detail::LI::SetStartTime	(	LoxImpl *	impl,
		time_t	startTime,
		const NString &	loggerName )

static

Implementation of the method SetStartTime(Ticks, const NString&).

Parameters

impl	The implementation struct of the `Lox`.
startTime	The new start time in system-specific time unit.
loggerName	The name of the Logger whose start time is to be set (case insensitive). Defaults to empty string, which indicates that all loggers are to be affected.

Definition at line 982 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetVerbosity() [1/2]

void alib::lox::detail::LI::SetVerbosity	(	LoxImpl *	impl,
		const NString &	loggerName,
		Verbosity	verbosity,
		const NString &	domain,
		Priority	priority )

static

Implementation of the method SetVerbosity.

Parameters

impl	The implementation struct of the `Lox`.
loggerName	The logger to be affected, identified by its name (case-insensitive).
verbosity	The 'level of verboseness' to be set.
domain	The parent (start) domain to be set. The use of absolute paths starting with `'/'` are recommended. Defaults to root domain "/".
priority	The priority of the setting. Defaults to DefaultValues.

Definition at line 678 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetVerbosity() [2/2]

void alib::lox::detail::LI::SetVerbosity	(	LoxImpl *	impl,
		detail::Logger *	logger,
		Verbosity	verbosity,
		const NString &	domain,
		Priority	priority )

static

Implementation of the method SetVerbosity.

Parameters

impl	The implementation struct of the `Lox`.
logger	The logger to be affected (case-insensitive).
verbosity	The 'level of verboseness' to be set.
domain	The parent (start) domain to be set. The use of absolute paths starting with `'/'` are recommended. Defaults to root domain "/".
priority	The priority of the setting. Defaults to DefaultValues.

Definition at line 580 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetVerbosityExport() [1/2]

void alib::lox::detail::LI::SetVerbosityExport	(	LoxImpl *	impl,
		const NString &	loggerName,
		bool	value,
		Priority	priority = Priority::Standard )

static

Implementation of the method SetVerbosityExport.

Parameters

impl	The implementation struct of the `Lox`.
loggerName	The logger to be affected, identified by its name (case-insensitive).
value	The value to set.
priority	The priority of the setting. Defaults to Standard.

Definition at line 726 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ SetVerbosityExport() [2/2]

void alib::lox::detail::LI::SetVerbosityExport	(	LoxImpl *	impl,
		detail::Logger *	logger,
		bool	value,
		Priority	priority = Priority::Standard )

static

Implementation of the method SetVerbosityExport.

Parameters

impl	The implementation struct of the `Lox`.
logger	The logger to be affected.
value	The value to set.
priority	The priority of the setting. Defaults to Standard.

Definition at line 710 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ State()

void alib::lox::detail::LI::State	(	LoxImpl *	impl,
		const NString &	domain,
		Verbosity	verbosity,
		const String &	headLine,
		StateInfo	flags )

static

Implementation of the method void State(const NString&, Verbosity, const String&, StateInfo) .

Parameters

impl	The implementation struct of the `Lox`.
domain	Optional Log Domain which is combined with Scope Domains set for the Scope of invocation.
verbosity	The verbosity.
headLine	If given, a separated headline will be logged at first place.
flags	Flag bits that define which state information is logged.

Definition at line 1254 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ store()

void alib::lox::detail::LI::store	(	LoxImpl *	impl,
		const Box &	data,
		const NString &	pKey,
		Scope	scope )

static

Internal method serving public interface Lox::Store.

Parameters

impl	The implementation struct of the `Lox`.
data	The data object to store. In C++, has to be heap allocated and will be deleted by this `Lox` when overwritten or this lox is deleted.
pKey	The key to the data.
scope	The Scope that the data is bound to.

Definition at line 1143 of file loxpimpl.cpp.

Here is the call graph for this function:

◆ writeVerbositiesOnLoggerRemoval()

void alib::lox::detail::LI::writeVerbositiesOnLoggerRemoval	(	LoxImpl *	impl,
		Logger *	logger )

static

Implements functionality for configuration variable LOXNAME_LOGGERNAME_VERBOSITY. Is called when a logger is removed.

Parameters

impl	The implementation struct of the `Lox`.
logger	The logger to write the verbosity for.

Definition at line 401 of file loxpimpl.cpp.

Here is the call graph for this function:

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

Description:

Public Static Method Index:

Public Method Index:

Method Details:

◆ Acquire()

◆ acquireInternalLogables()

◆ checkScopeInformation()

◆ Construct()

◆ DbgGetMonoAllocator()

◆ Destruct()

◆ dumpStateOnLoggerRemoval()

◆ Entry()

◆ entryDetectDomainImpl()

◆ evaluateResultDomain()

◆ findDomain()

◆ getAllVerbosities()

◆ getDomainPrefixFromConfig()

◆ getLock()

◆ GetLogableContainer()

◆ GetLogCounter()

◆ GetLogger()

◆ GetName()

◆ GetState()

◆ GetVerbosity()

◆ getVerbosityFromConfig()

◆ IncreaseLogCounter()

◆ init()

◆ IsActive()

◆ isThreadRelatedScope()

◆ log()

◆ logInternal() [1/2]

◆ logInternal() [2/2]

◆ MapThreadName()

◆ once()

◆ Release()

◆ RemoveLogger() [1/2]

◆ RemoveLogger() [2/2]

◆ RemoveThreadDomain()

◆ Reset() [1/2]

◆ Reset() [2/2]

◆ retrieve()

◆ SetDomain()

◆ setDomain()

◆ SetDomainSubstitutionRule()

◆ SetFileNameCacheCapacity()

◆ SetPrefix()

◆ setPrefix()

◆ SetSourcePathTrimRule()

◆ SetStartTime() [1/3]

◆ SetStartTime() [2/3]

◆ SetStartTime() [3/3]

◆ SetVerbosity() [1/2]

◆ SetVerbosity() [2/2]

◆ SetVerbosityExport() [1/2]

◆ SetVerbosityExport() [2/2]

◆ State()

◆ store()

◆ writeVerbositiesOnLoggerRemoval()