Description:

template<typename T, bool TStackedThreadValues>
class alib::lox::detail::ScopeStore< T, TStackedThreadValues >

This class is responsible for scope-related functionality of class Lox.

Note: This is a pure internal helper-class. Documentation may be limited.

Template Parameters

T	The stored object type.
TStackedThreadValues	If true, values stored for thread scopes will be always replaced instead of appended. This is, for example, `false` for Log Data and Log Once and `true` for Scope Domains and Prefix Logables.

Definition at line 77 of file scopestore.hpp.

#include <scopestore.hpp>

Collaboration diagram for alib::lox::detail::ScopeStore< T, TStackedThreadValues >:

[legend]

Inner Type Index:
struct	BoolThreadIDHash
	Hash functor for `std::pair<bool,ThreadID>`. More...

Public Type Index:
using	ThreadMapKey = std::pair<bool,threads::ThreadID>
	Key type for the thread store.
using	TLanguageStore
using	TThreadMapValue = std::conditional_t<TStackedThreadValues, StdVectorMA<T>, T>

Public Field Index:
T	globalStore
	The value of the global scope.
TLanguageStore	languageStore
	`StringTree` to store data for language-related scopes (path,source,method).
HashMap< MonoAllocator, ThreadMapKey, TThreadMapValue, BoolThreadIDHash >	threadStore

Public Method Index:
	ScopeStore (ScopeInfo &scopeInfo, MonoAllocator &monoAllocator)
	~ScopeStore ()
	Destructor.
T	Get ()
void	InitAccess (Scope scope, int pathLevel, threads::ThreadID threadID)
void	InitWalk (Scope startScope, const T localObject)
T	Remove (T value)
T	Store (T value)
T	Walk ()

Protected Field Index:
int	actPathLevel
	The path level when using access methods.
Scope	actScope
	The actual scope of a walk.
TLanguageStore::Cursor	actStringTreeNode
	The actual language related scope's map node.
threads::ThreadID	actThreadID
	Actual thread ID.
bool	lazyLanguageNode
	Flag used to lazily create the key to language-related scope values.
ScopeInfo &	scopeInfo
	ScopeInfo of 'our' lox.
bool	walking
	Indicates if currently a scope walk is active.
T	walkLocalObject
	The 'local object' returned by a walk after Scope::ThreadInner and before Scope::Method.
int	walkNextThreadIdx
	The next value of a walk during Scope::ThreadInner/Outer.
TThreadMapValue *	walkThreadValues
	The list of values of Scope::ThreadOuter/Inner during a walk.

Protected Method Index:
T	access (int cmd, T value)
void	initCursor (bool create)

Type Definition Details:

◆ ThreadMapKey

template<typename T, bool TStackedThreadValues>

using alib::lox::detail::ScopeStore< T, TStackedThreadValues >::ThreadMapKey = std::pair<bool,threads::ThreadID>

Key type for the thread store.

Definition at line 105 of file scopestore.hpp.

◆ TLanguageStore

template<typename T, bool TStackedThreadValues>

using alib::lox::detail::ScopeStore< T, TStackedThreadValues >::TLanguageStore

Initial value:

containers::StringTree< MonoAllocator,
                                                 T,
                                                 StringTreeNamesAlloc<character> >

Alias name for the string tree template used for storing language-related data. The language store uses a StringTree with a monotonic allocator. This does not lead to memory leaks, because during the life-time of a Lox objects are only added, but never deleted. If a value is unset, the node is not deleted but set to a nulled value. This makes the language store very memory efficient (and fast).

Definition at line 88 of file scopestore.hpp.

◆ TThreadMapValue

template<typename T, bool TStackedThreadValues>

using alib::lox::detail::ScopeStore< T, TStackedThreadValues >::TThreadMapValue = std::conditional_t<TStackedThreadValues, StdVectorMA<T>, T>

The type of object stored for the thread values. This depends on whether multiple (a stack of) values can be stored, which is not true for log data and log once, as those operate with hash maps.

Definition at line 95 of file scopestore.hpp.

Field Details:

◆ actPathLevel

template<typename T, bool TStackedThreadValues>

int alib::lox::detail::ScopeStore< T, TStackedThreadValues >::actPathLevel

protected

The path level when using access methods.

Definition at line 147 of file scopestore.hpp.

◆ actScope

template<typename T, bool TStackedThreadValues>

Scope alib::lox::detail::ScopeStore< T, TStackedThreadValues >::actScope

protected

The actual scope of a walk.

Definition at line 141 of file scopestore.hpp.

◆ actStringTreeNode

template<typename T, bool TStackedThreadValues>

TLanguageStore::Cursor alib::lox::detail::ScopeStore< T, TStackedThreadValues >::actStringTreeNode

protected

The actual language related scope's map node.

Definition at line 144 of file scopestore.hpp.

◆ actThreadID

template<typename T, bool TStackedThreadValues>

threads::ThreadID alib::lox::detail::ScopeStore< T, TStackedThreadValues >::actThreadID

protected

Actual thread ID.

Definition at line 151 of file scopestore.hpp.

◆ globalStore

template<typename T, bool TStackedThreadValues>

T alib::lox::detail::ScopeStore< T, TStackedThreadValues >::globalStore

The value of the global scope.

Definition at line 98 of file scopestore.hpp.

◆ languageStore

template<typename T, bool TStackedThreadValues>

TLanguageStore alib::lox::detail::ScopeStore< T, TStackedThreadValues >::languageStore

StringTree to store data for language-related scopes (path,source,method).

Definition at line 101 of file scopestore.hpp.

◆ lazyLanguageNode

template<typename T, bool TStackedThreadValues>

bool alib::lox::detail::ScopeStore< T, TStackedThreadValues >::lazyLanguageNode

protected

Flag used to lazily create the key to language-related scope values.

Definition at line 135 of file scopestore.hpp.

◆ scopeInfo

template<typename T, bool TStackedThreadValues>

ScopeInfo& alib::lox::detail::ScopeStore< T, TStackedThreadValues >::scopeInfo

protected

ScopeInfo of 'our' lox.

Definition at line 132 of file scopestore.hpp.

◆ threadStore

template<typename T, bool TStackedThreadValues>

HashMap<MonoAllocator, ThreadMapKey, TThreadMapValue, BoolThreadIDHash > alib::lox::detail::ScopeStore< T, TStackedThreadValues >::threadStore

The inner/outer thread map of values. The boolean value of the key is true for the inner store and false for the outer.

Definition at line 122 of file scopestore.hpp.

◆ walking

template<typename T, bool TStackedThreadValues>

bool alib::lox::detail::ScopeStore< T, TStackedThreadValues >::walking

protected

Indicates if currently a scope walk is active.

Definition at line 138 of file scopestore.hpp.

◆ walkLocalObject

template<typename T, bool TStackedThreadValues>

T alib::lox::detail::ScopeStore< T, TStackedThreadValues >::walkLocalObject

protected

The 'local object' returned by a walk after Scope::ThreadInner and before Scope::Method.

Definition at line 155 of file scopestore.hpp.

◆ walkNextThreadIdx

template<typename T, bool TStackedThreadValues>

int alib::lox::detail::ScopeStore< T, TStackedThreadValues >::walkNextThreadIdx

protected

The next value of a walk during Scope::ThreadInner/Outer.

Definition at line 158 of file scopestore.hpp.

◆ walkThreadValues

template<typename T, bool TStackedThreadValues>

TThreadMapValue* alib::lox::detail::ScopeStore< T, TStackedThreadValues >::walkThreadValues

protected

The list of values of Scope::ThreadOuter/Inner during a walk.

Definition at line 161 of file scopestore.hpp.

Constructor(s) / Destructor Details:

◆ ScopeStore()

template<typename T, bool TStackedThreadValues>

alib::lox::detail::ScopeStore< T, TStackedThreadValues >::ScopeStore	(	ScopeInfo &	scopeInfo,
		MonoAllocator &	monoAllocator )

Constructor

Parameters

scopeInfo	The ScopeInfo singleton of 'our' Lox.
monoAllocator	The monotonic allocator used for the StringTree needed by member languageStore.

Definition at line 17 of file scopestore.cpp.

◆ ~ScopeStore()

template<typename T, bool TStackedThreadValues>

alib::lox::detail::ScopeStore< T, TStackedThreadValues >::~ScopeStore ( )

Destructor.

Definition at line 30 of file scopestore.cpp.

Method Details:

◆ access()

template<typename T, bool TStackedThreadValues>

T alib::lox::detail::ScopeStore< T, TStackedThreadValues >::access	(	int	cmd,
		T	value )

inlineprotected

Receives, inserts or removes a value.

Parameters

cmd	0= insert, 1= remove, 2= get.
value	The new value or the one to be removed.

Returns: Returns the previous value stored.

Definition at line 231 of file scopestore.hpp.

Here is the call graph for this function:

◆ Get()

template<typename T, bool TStackedThreadValues>

T alib::lox::detail::ScopeStore< T, TStackedThreadValues >::Get ( )

inline

Retrieves the value.

Returns: Returns the current value stored.

Definition at line 202 of file scopestore.hpp.

Here is the call graph for this function:

◆ InitAccess()

template<typename T, bool TStackedThreadValues>

void alib::lox::detail::ScopeStore< T, TStackedThreadValues >::InitAccess	(	Scope	scope,
		int	pathLevel,
		threads::ThreadID	threadID )

Initializes access methods Store, Get and Remove and has to be invoked before using them

Parameters

scope	Scope to use.
pathLevel	Used only if parameter scope equals Path to reference parent directories. Optional and defaults to `0`.
threadID	ID of the associated thread (for thread-related scopes only). If UNDEFINED is given, the ID provided in scopeInfo is used.

Definition at line 448 of file scopestore.cpp.

◆ initCursor()

template<typename T, bool TStackedThreadValues>

void alib::lox::detail::ScopeStore< T, TStackedThreadValues >::initCursor ( bool create )

protected

Retrieves and optionally creates an entry in the map that stores language-related scope information. The result is stored in field actStringTreeNode.

Parameters

create If true, a non-existing entry is created.

Definition at line 396 of file scopestore.cpp.

Here is the call graph for this function:

◆ InitWalk()

template<typename T, bool TStackedThreadValues>

void alib::lox::detail::ScopeStore< T, TStackedThreadValues >::InitWalk	(	Scope	startScope,
		const T	localObject )

Initializes a scope 'walk' by storing the given scope information and setting fields of our walk 'state-machine' to proper start values.

Parameters

startScope	The Scope to start searching for.
localObject	The 'local object' returned by a walk after Scope::ThreadInner and before Scope::Method

Definition at line 37 of file scopestore.cpp.

◆ Remove()

template<typename T, bool TStackedThreadValues>

T alib::lox::detail::ScopeStore< T, TStackedThreadValues >::Remove ( T value )

inline

Removes a value.

Parameters

value The value to remove (must only be given for thread-related Scopes).

Returns: Returns the previous value stored.

Definition at line 198 of file scopestore.hpp.

Here is the call graph for this function:

◆ Store()

template<typename T, bool TStackedThreadValues>

T alib::lox::detail::ScopeStore< T, TStackedThreadValues >::Store ( T value )

inline

Stores a new value.

Parameters

value The value to set.

Returns: Returns the previous value stored.

Definition at line 193 of file scopestore.hpp.

Here is the call graph for this function:

◆ Walk()

template<typename T, bool TStackedThreadValues>

T alib::lox::detail::ScopeStore< T, TStackedThreadValues >::Walk ( )

inline

Searches next value in the actual scope. While not found, moves walk state to next outer state and continues there.

Returns: The next object found in the current or any next outer scope.

Definition at line 216 of file scopestore.hpp.

Here is the call graph for this function:

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

Description:

Inner Type Index:

Public Type Index:

Public Field Index:

Public Method Index:

Protected Field Index:

Protected Method Index:

Type Definition Details:

◆ ThreadMapKey

◆ TLanguageStore

◆ TThreadMapValue

Field Details:

◆ actPathLevel

◆ actScope

◆ actStringTreeNode

◆ actThreadID

◆ globalStore

◆ languageStore

◆ lazyLanguageNode

◆ scopeInfo

◆ threadStore

◆ walking

◆ walkLocalObject

◆ walkNextThreadIdx

◆ walkThreadValues

Constructor(s) / Destructor Details:

◆ ScopeStore()

◆ ~ScopeStore()

Method Details:

◆ access()

◆ Get()

◆ InitAccess()

◆ initCursor()

◆ InitWalk()

◆ Remove()

◆ Store()

◆ Walk()