BaseCamp Class Reference

Description:

---

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

See also

For detailed descriptions, please consult

• Chapter 3. ALib Camps and special Module BootCamp, as well as
• this camps' Programmer's Manual.

Friends

class CalendarDateTime

Definition at line 103 of file basecamp.hpp.

#include <basecamp.hpp>

Inheritance diagram for BaseCamp:

Collaboration diagram for BaseCamp:

Public Field Index:
bool	HasConsoleWindow
String	LocaleFound
bool	WaitForKeyPressOnTermination =false
Public Field Index: inherited from Camp
NCString	ResourceCategory

Public Method Index:
ALIB_API	BaseCamp ()
ALIB_API bool	IsDebuggerPresent ()
Public Method Index: inherited from Camp
	Camp (Camp &&)=delete
	Camp (const Camp &)=delete
	Camp (const NCString &resourceCategory)
virtual	~Camp ()
void	BootstrapResource (const NString &name, const String &data)
void	BootstrapSetConfig (config::Configuration *pConfig)
void	BootstrapSetResourcePool (lang::resources::ResourcePool *pool)
config::Configuration &	GetConfig ()
const String &	GetResource (const NString &name)
resources::ResourcePool &	GetResourcePool ()
bool	IsBootstrapped ()
void	operator= (Camp &&)=delete
void	operator= (const Camp &)=delete
const String &	TryResource (const NString &name)

Field Details:

HasConsoleWindow

bool 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 run-time (after method Bootstrap was invoked).

Note

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

Definition at line 139 of file basecamp.hpp.

LocaleFound

String 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 147 of file basecamp.hpp.

WaitForKeyPressOnTermination

bool 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 run-time (after method Bootstrap was invoked).

Definition at line 120 of file basecamp.hpp.

Constructor(s) / Destructor Details::

BaseCamp()

BaseCamp

(

)

---

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

Definition at line 232 of file basecamp.cpp.

Method Details:

bootstrap()

void bootstrap ( BootstrapPhases phase )

overrideprotectedvirtual

---

Implementation of Camp::bootstrap .

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 NumberFormat::SetFromLocale on static singleton NumberFormat::Global .

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

Parameters

phase

The initialization phase to perform.

Implements Camp.

Definition at line 240 of file basecamp.cpp.

Here is the call graph for this function:

IsDebuggerPresent()

bool 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 1065 of file basecamp.cpp.

Here is the call graph for this function:

shutdown()

void shutdown ( ShutdownPhases phase )

overrideprotectedvirtual

---

Terminates this module. (Nothing to do.)

Parameters

phase

The shutdown phase to perform.

Implements Camp.

Definition at line 1010 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