alib::camp::Basecamp Class Reference

Description:

This is a strict singleton class representing module ALib Camp. The only instance is found with the namespace variable alib::BASECAMP.

See also

For detailed descriptions, please consult the chapter 3. The Basecamp of the Programmer's Manual of the module ALib Camp.

Definition at line 47 of file basecamp.hpp.

#include <basecamp.hpp>

Inheritance diagram for alib::camp::Basecamp:

Collaboration diagram for alib::camp::Basecamp:

Public Field Index:
bool	HasConsoleWindow
String	LocaleFound
bool	WaitForKeyPressOnTermination =false
Public Field Index: inherited from alib::resources::ResourceHolder
NCString	ResourceCategory

Public Method Index:
	Basecamp ()
virtual void	Bootstrap () override
bool	IsDebuggerPresent ()
virtual void	Shutdown (ShutdownPhases phase) override
Public Method Index: inherited from alib::camp::Camp
void	BootstrapSetConfig (const SharedConfiguration &pConfig)
void	BootstrapSetPhase (BootstrapPhases phase)
void	BootstrapSetResourcePool (const SPResourcePool &pResourcePool)
BootstrapPhases	GetBootstrapState ()
SharedConfiguration &	GetConfig ()
bool	IsBootstrapped ()
Public Method Index: inherited from alib::resources::ResourceHolder
	ResourceHolder (const NCString &resourceCategory=nullptr)
	ResourceHolder (SPResourcePool &pool, const NCString &resourceCategory)
void	BootstrapResource (const NString &name, const String &data)
const String &	GetResource (const NString &name)
ResourcePool &	GetResourcePool ()
SPResourcePool &	GetResourcePoolSP ()
bool	HasPool ()
void	Set (SPResourcePool &pool, const NCString &resourceCategory=nullptr)
const String &	TryResource (const NString &name)

Additional Inherited Members
Public Type Index: inherited from alib::resources::ResourceHolder
using	SPResourcePool = SharedPtr<resources::ResourcePool, MonoAllocator>
Protected Field Index: inherited from alib::camp::Camp
int	bootstrapState = 0
SharedConfiguration	config
Protected Field Index: inherited from alib::resources::ResourceHolder
SPResourcePool	resourcePool
	Shared pointer to the resource pool.
Protected Method Index: inherited from alib::camp::Camp
	Camp (Camp &&)=delete
	Deleted move constructor.
	Camp (const Camp &)=delete
	Deleted copy constructor.
	Camp (const NCString &resourceCategory)
virtual	~Camp ()
	Virtual destructor to satisfy C++ abstract type rules.
void	operator= (Camp &&)=delete
	Deleted move assignment.
void	operator= (const Camp &)=delete
	Deleted copy assignment.

Field Details:

HasConsoleWindow

bool alib::camp::Basecamp::HasConsoleWindow

This flag indicates if the current process has console output window attached. While this is not detectable in Unix like systems (or just with huge efforts), in windows it is. The determination is performed in Bootstrap and done as follows

• If configuration variable ALIB_HAS_CONSOLE_WINDOW is set, its value is returned.
• Otherwise, on Unix like OStrue is returned.
• On Windows OS it is determined if a console window is attached to the process using system call GetConsoleWindow() and compare its result to NULL.

In addition, this public flag may be modified at runtime (after method Bootstrap was invoked).

Note

The evaluation of configuration variable ALIB_HAS_CONSOLE_WINDOW is done only if module ALib Variables is included in the ALib Build.

Definition at line 74 of file basecamp.hpp.

LocaleFound

String alib::camp::Basecamp::LocaleFound

This string is set during bootstrapping in the case that a locale information was found (via standard environment variables or ALib variable LOCALE) and successfully set.
Otherwise this string is nulled.

Definition at line 80 of file basecamp.hpp.

WaitForKeyPressOnTermination

bool alib::camp::Basecamp::WaitForKeyPressOnTermination =false

If true, within Shutdown, it is waited for a key press in the console window.
By default, this flag is enabled when debugging a console application under Visual Studio.
This default behavior can be overruled by setting configuration variable ALIB/WAIT_FOR_KEY_PRESS.
In addition, this public flag may be modified at runtime (after method Bootstrap was invoked).

Definition at line 57 of file basecamp.hpp.

Constructor(s) / Destructor Details:

Basecamp()

alib::camp::Basecamp::Basecamp

(

)

Constructor.
While this is public, it must not be invoked as this is a strict singleton type. (See notes in 2. Class Camp).

Definition at line 172 of file basecamp.cpp.

Here is the call graph for this function:

Method Details:

Bootstrap()

void alib::camp::Basecamp::Bootstrap ( )

overridevirtual

Implementation of virtual void Bootstrap() =0.

In phase BootstrapPhases::Final performs:

• In glibc versions of ALib (GNU/unix) probably invoke glibc method setlocale(), depending on the setting of the environment variables LANG and LANGUAGE and depending on ALib configuration variable ALIB/LOCALE.

  In addition, invokes SetFromLocale on static singleton NumberFormat::Global.

• Config variable WAIT_FOR_KEY_PRESS is read and the field WaitForKeyPressOnTermination set accordingly.

Implements alib::camp::Camp.

Definition at line 181 of file basecamp.cpp.

Here is the call graph for this function:

IsDebuggerPresent()

bool alib::camp::Basecamp::IsDebuggerPresent

(

)

If true, the current process is under the hood of a debugger.

Returns

true if the application is run in a debugger.

Definition at line 374 of file basecamp.cpp.

Here is the call graph for this function:

Shutdown()

void alib::camp::Basecamp::Shutdown ( ShutdownPhases phase )

overridevirtual

Terminates this camp.

Parameters

phase

The shutdown phase to perform.

Implements alib::camp::Camp.

Definition at line 343 of file basecamp.cpp.

Here is the call graph for this function:

---

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

• basecamp.hpp
• basecamp.cpp