Description:

1. Introduction

This is the root namespace of ALib , a general purpose C++ library. ALib is developed by A-Worx GmbH, Germany, published under Boost Software License.

This namespace is almost empty, apart from:

sub-namespaces of ALib Modules ,
the single unique non-module related sub-namespace alib::lang.
sub-namespace alib::compatibility, which is not even a real C++ namespace! In fact, it is used by various modules to place "documentation" of entities that provide compatibility to types of the standard C++ class library and 3rd-party libraries.
Functions and types related to bootstrapping ALib.

Nevertheless, this namespace is quite bloated with type aliases, which is explained in the next section.

2. Type Aliases In Namespace alib

Once a C++ library becomes more complex, their types get split into different namespaces and sub-namespaces. This is also true for ALib , which is split into various modules. Consequently, the common need to conveniently address all types, is to add several using statements to a compilation unit. With ALib this could for example look like this:

 using namespace alib::threads;
 using namespace alib::strings;
 using namespace alib::expressions;

To avoid the need of the right "permutation" of using statements at the top of a users' compilation unit, ALib "mirrors" all important types into this outer namespace with type definition statements. For example, at the end of header file alib/expressions/compiler.hpp , just before closing outer namespace alib, the following statement is made:

 /// Type alias in namespace \b alib.
 using Compiler=  expressions::Compiler;

With that, a single:

 using namespace alib;

fits for all ALib types and in most cases, this single using statement is all that is needed. This approach does not generate conflicts: If for example the using code would have an own class named "Compiler", it can fall back to the standard schematic, by adding just:

 using namespace alib::threads;
 using namespace alib::strings;

and accessing class Compiler explicitly as alib::expressions::Compiler.

Note

The reason why this all is possible ist due to (a next great) design decision of C++. While the CODE in the following snippet:

   namespace A { namespace B {  CODE } }

"sees" all types in namespace A, with this snippet:

   using namespace A::B;
   CODE

the CODE does not "see" types of namespace A, but only those of B.

3. Domain-Specific Constants and Variables

Similar to the concept of mirroring important interface classes into this namespace alib (which is described in the previous paragraph), it is also agreed to place important global constants here. The impact and benefits are quite the same.
As a sample, see DirectorySeparator or NewLine , which appear in this namespace as soon as header alib/lang/system/directory.hpp , respectively alib/strings/cstring.hpp is included.

4. Documentation

The ALib Programmer's Manual provides extensive documentation, including various separated manuals of ALib Modules , tutorials with sample code, information about configuring and compiling the library and so forth.
For people new to ALib , the ALib Programmer's Manual is the right place to start!

Reference Documentation

Nested Namespaces:
namespace	bitbuffer

namespace	boxing

namespace	characters

namespace	cli

namespace	compatibility

namespace	config

namespace	enums

namespace	expressions

namespace	files

namespace	lang

namespace	lox

namespace	monomem

namespace	singletons

namespace	strings

namespace	threads

namespace	time

Type Index:
struct	CompilationFlagMeaningsEntry

struct	TCompilationFlags

Type Definition Index:
using	ALox = lox::ALox
	Type alias in namespace alib.

using	ALoxReportWriter = lox::ALoxReportWriter
	Type alias in namespace alib.

using	AnsiConsoleLogger = lox::loggers::AnsiConsoleLogger
	Type alias in namespace alib.

using	AnsiLogger = lox::loggers::AnsiLogger
	Type alias in namespace alib.

using	ArrayCompressor = bitbuffer::ac_v1::ArrayCompressor

using	AString = strings::TAString <character>
	Type alias in namespace alib.

using	AutoSizes = strings::util::AutoSizes
	Type alias in namespace alib.

using	BitBuffer = bitbuffer::BitBuffer
	Type alias in namespace alib.

template<uinteger TCapacity>
using	BitBufferLocal = bitbuffer::BitBufferLocal<TCapacity>
	Type alias in namespace alib.

using	BitBufferMA = bitbuffer::BitBufferMA
	Type alias in namespace alib.

using	BitReader = bitbuffer::BitReader
	Type alias in namespace alib.

template<int TEnd, int TBegin = 0, typename TInterface = int>
using	BitSet = lang::TBitSet<int, TEnd, TBegin>
	Type alias in namespace alib.

using	BitWriter = bitbuffer::BitWriter
	Type alias in namespace alib.

using	Box = boxing::Box
	Type alias in namespace alib.

using	Boxes = boxing::Boxes
	Type alias in namespace alib.

using	ByteSize = lang::format::ByteSizeIEC
	Type alias in namespace alib.

using	ByteSizeIEC = lang::format::ByteSizeIEC
	Type alias in namespace alib.

using	ByteSizeSI = lang::format::ByteSizeSI
	Type alias in namespace alib.

using	ByteSizeUnits = lang::format::ByteSizeUnits
	Type alias in namespace alib.

using	Calculus = expressions::plugins::Calculus
	Type alias in namespace alib.

using	CalendarDate = lang::system::CalendarDate
	Type alias in namespace alib.

using	CalendarDateTime = lang::system::CalendarDateTime
	Type alias in namespace alib.

using	CalendarDuration = lang::system::CalendarDuration
	Type alias in namespace alib.

using	character = characters::character
	Type alias in namespace alib.

using	CLIUtil = cli::CLIUtil
	Type alias in namespace alib.

using	CommandLine = cli::CommandLine
	Type alias in namespace alib.

using	Compiler = expressions::Compiler
	Type alias in namespace alib.

using	CompilerPlugin = expressions::CompilerPlugin
	Type alias in namespace alib.

using	ComplementAString = strings::TAString <complementChar>
	Type alias in namespace alib.

using	complementChar = characters::complementChar
	Type alias in namespace alib.

using	ComplementCString = strings::TCString <complementChar>
	Type alias in namespace alib.

using	ComplementFormat = strings::TFormat<complementChar >
	Type alias in namespace alib.

template<integer TCapacity>
using	ComplementLocalString = strings::TLocalString<complementChar, TCapacity>
	Type alias in namespace alib.

using	ComplementMAString = monomem::TMAString<complementChar>
	Type alias in namespace alib.

using	ComplementNumberFormat = strings::TNumberFormat<complementChar>
	Type alias in namespace alib.

using	ComplementString = strings::TString <complementChar>
	Type alias in namespace alib.

using	ComplementStringLengthResetter = strings::TStringLengthResetter<complementChar>
	Type alias in namespace alib.

using	ComplementStringNZT = strings::TStringNZT <complementChar>
	Type alias in namespace alib.

using	ComplementSubstring = strings::TSubstring <complementChar>
	Type alias in namespace alib.

using	Configuration = config::Configuration
	Type alias in namespace alib.

using	Console = lang::system::Console
	Type alias in namespace alib.

using	ConsoleLogger = lox::loggers::ConsoleLogger
	Type alias in namespace alib.

using	CString = strings::TCString <character>
	Type alias in namespace alib.

using	DateTime = time::DateTime
	Type alias in namespace alib.

using	DbgBoxing = boxing::DbgBoxing
	Type alias in namespace alib.

using	Directory = lang::system::Directory
	Type alias in namespace alib.

using	Enum = boxing::Enum
	Type alias in namespace alib.

template<typename TEnum >
using	EnumBitSet

template<typename TEnum , typename TEnableIf = void>
using	EnumIterator = enums::EnumIterator<TEnum, TEnableIf>
	Type alias in namespace alib.

template<typename TEnum >
using	EnumRecords = enums::EnumRecords<TEnum>
	Type alias in namespace alib.

using	EnvironmentVariables = lang::system::EnvironmentVariables
	Type alias in namespace alib.

using	ESC = lox::ESC
	Type alias in namespace alib.

using	Exception = lang::Exception
	Type alias in namespace alib.

using	ExpressionFormatter = expressions::util::ExpressionFormatter
	Type alias in namespace alib.

using	ExpressionScope = expressions::Scope
	Type alias in namespace alib. Renamed to not collide with alib::lox::Scope.

template<typename TChar >
using	FAppend = boxing::FAppend<TChar>
	Type alias in namespace alib.

using	FClone = boxing::FClone
	Type alias in namespace alib.

using	FEquals = boxing::FEquals
	Type alias in namespace alib.

using	FFilter = files::FFilter
	Type alias in namespace alib.

using	FHashcode = boxing::FHashcode
	Type alias in namespace alib.

using	FileExpressions = files::FileExpressions
	Type alias in namespace alib.

using	FInfo = files::FInfo
	Type alias in namespace alib.

using	FIsLess = boxing::FIsLess
	Type alias in namespace alib.

using	FIsNotNull = boxing::FIsNotNull
	Type alias in namespace alib.

using	FIsTrue = boxing::FIsTrue
	Type alias in namespace alib.

template<typename T , std::size_t TSize>
using	FixedCapacityVector = monomem::util::FixedCapacityVector<T, TSize>
	Type alias in namespace alib.

template<typename T , std::size_t TSize, typename TCompare = std::less<T>>
using	FixedSizePriorityQueue = std::priority_queue< T, FixedCapacityVector<T, TSize>, TCompare>

using	Format = strings::TFormat<character>
	Type alias in namespace alib.

using	Formatter = lang::format::Formatter
	Type alias in namespace alib.

using	FormatterJavaStyle = lang::format::FormatterJavaStyle
	Type alias in namespace alib.

using	FormatterPythonStyle = lang::format::FormatterPythonStyle
	Type alias in namespace alib.

using	FTree = files::FTree
	Type alias in namespace alib.

template<typename TKey , typename TMapped , typename THash = std::hash <TKey>, typename TEqual = std::equal_to<TKey>, lang::Caching THashCaching = lang::Caching::Auto, typename TRecycling = monomem::Recycling::Private>
using	HashMap = monomem::HashMap<TKey, TMapped,THash,TEqual, THashCaching, TRecycling >
	Type alias in namespace alib. See type definition alib::monomem::HashMap.

template<typename T , typename THash = std::hash <T>, typename TEqual = std::equal_to<T>, lang::Caching THashCaching = lang::Caching::Auto, typename TRecycling = monomem::Recycling::Private>
using	HashSet = monomem::HashSet<T, THash, TEqual, THashCaching, TRecycling >
	Type alias in namespace alib. See type definition alib::monomem::HashSet.

using	HuffmanDecoder = bitbuffer::ac_v1::HuffmanDecoder

using	HuffmanEncoder = bitbuffer::ac_v1::HuffmanEncoder

using	IniFile = config::IniFile
	Type alias in namespace alib.

using	InMemoryPlugin = config::InMemoryPlugin
	Type alias in namespace alib.

using	integer = lang::integer
	Type alias in namespace alib.

using	intGap_t = lang::intGap_t
	Type alias in namespace alib.

using	ISReadLineN = strings::compatibility::std::TISReadLine<char>
	Type alias in namespace alib.

using	ISReadLineW = strings::compatibility::std::TISReadLine<wchar_t>
	Type alias in namespace alib.

template<typename T , typename TRecycling = monomem::Recycling::Private>
using	List = monomem::List<T, TRecycling>
	Type alias in namespace alib.

template<integer TCapacity>
using	LocalString = strings::TLocalString<character, TCapacity>
	Type alias in namespace alib.

using	Log = lox::Log
	Type alias in namespace alib.

using	Logger = lox::detail::Logger
	Type alias in namespace alib.

using	LogTools = lox::LogTools
	Type alias in namespace alib.

using	Lox = lox::Lox
	Type alias in namespace alib.

using	MAString = monomem::TMAString<character>
	Type alias in namespace alib.

using	MemoryLogger = lox::loggers::MemoryLogger
	Type alias in namespace alib.

using	MonoAllocator = monomem::MonoAllocator
	Type alias in namespace alib.

using	NAString = strings::TAString <nchar>
	Type alias in namespace alib.

using	nchar = characters::nchar
	Type alias in namespace alib.

using	NCString = strings::TCString <nchar>
	Type alias in namespace alib.

using	NFormat = strings::TFormat<nchar>
	Type alias in namespace alib.

template<integer TCapacity>
using	NLocalString = strings::TLocalString <nchar , TCapacity>
	Type alias in namespace alib.

using	NMAString = monomem::TMAString<nchar>
	Type alias in namespace alib.

using	NNumberFormat = strings::TNumberFormat<nchar>
	Type alias in namespace alib.

using	NString = strings::TString <nchar>
	Type alias in namespace alib.

using	NString128 = NLocalString< 128>
	Type alias name for TLocalString<nchar,128> .

using	NString16 = NLocalString< 16>
	Type alias name for TLocalString<nchar,16> .

using	NString1K = NLocalString<1024>
	Type alias name for TLocalString<nchar,1024> .

using	NString256 = NLocalString< 256>
	Type alias name for TLocalString<nchar,256> .

using	NString2K = NLocalString<2048>
	Type alias name for TLocalString<nchar,2048> .

using	NString32 = NLocalString< 32>
	Type alias name for TLocalString<nchar,32> .

using	NString4K = NLocalString<4096>
	Type alias name for TLocalString<nchar,4096> .

using	NString512 = NLocalString< 512>
	Type alias name for TLocalString<nchar,512> .

using	NString64 = NLocalString< 64>
	Type alias name for TLocalString<nchar,64> .

using	NString8 = NLocalString< 8>
	Type alias name for TLocalString<nchar,8> .

using	NStringLengthResetter = strings::TStringLengthResetter<nchar>
	Type alias in namespace alib.

using	NStringNZT = strings::TStringNZT <nchar>
	Type alias in namespace alib.

using	NSubstring = strings::TSubstring <nchar>
	Type alias in namespace alib.

template<lang::Case TSensitivity>
using	NSubstringSearch = strings::util::TSubstringSearch<nchar>
	Type alias in namespace alib.

using	NumberFormat = strings::TNumberFormat<character>
	Type alias in namespace alib.

using	NumberFormatFlags = strings::NumberFormatFlags
	Type alias in namespace alib.

template<typename TOwnable >
using	Owner = lang::Owner<TOwnable>
	Type alias in namespace alib.

using	OwnerAndGroupResolver = files::OwnerAndGroupResolver
	Type alias in namespace alib.

using	Paragraphs = lang::format::Paragraphs
	Type alias in namespace alib.

using	Priorities = alib::config::Priorities
	Type alias in namespace alib.

using	ProcessInfo = lang::system::ProcessInfo
	Type alias in namespace alib.

using	PropertyFormatter = lang::format::PropertyFormatter
	Type alias in namespace alib.

template<typename TFormattable , typename TOptionEnum >
using	PropertyFormatters = lang::format::PropertyFormatters<TFormattable, TOptionEnum>
	Type alias in namespace alib.

using	Recycling = monomem::Recycling
	Type alias in namespace alib.

using	RegexMatcher = strings::util::RegexMatcher
	Type alias in namespace alib.

template<typename T >
using	ResourcedType = lang::resources::ResourcedType<T>
	Type alias in namespace alib.

using	ResourceInfo = lang::resources::ResourceInfo
	Type alias in namespace alib.

using	ResourcePool = lang::resources::ResourcePool
	Type alias in namespace alib.

using	ResultsPaths = files::ResultsPaths
	Type alias in namespace alib.

using	RTTRAllocator = monomem::util::RTTRAllocator
	Type alias in namespace alib.

using	Runnable = threads::Runnable
	Type alias in namespace alib.

using	ScanParameters = files::ScanParameters
	Type alias in namespace alib.

using	Scope = lox::Scope
	Type alias in namespace alib.

using	ShiftOpRHS = int
	Type alias in namespace alib.

template<typename T >
using	Singleton = singletons::Singleton<T>
	Type alias in namespace alib.

using	Sleeper = threads::Sleeper
	Type alias in namespace alib.

using	SmartLock = threads::SmartLock
	Type alias in namespace alib.

using	Spaces = strings::util::Spaces
	Type alias in namespace alib.

using	SPExpression = expressions::SPExpression
	Type alias in namespace alib.

using	SPFileFilter = files::SPFileFilter
	Type alias in namespace alib.

using	SPFormatter = std::shared_ptr< lang::format::Formatter>

template<typename T >
using	StdContMA = monomem::StdContMA<T>
	Type alias in namespace alib.

template<typename T >
using	StdContMAOptional = monomem::StdContMAOptional<T>
	Type alias in namespace alib.

template<typename T >
using	StdContMARecycling = monomem::StdContMARecycling<T>
	Type alias in namespace alib.

using	StopWatch = time::StopWatch
	Type alias in namespace alib.

using	StrangeAString = strings::TAString <strangeChar>
	Type alias in namespace alib.

using	strangeChar = characters::strangeChar
	Type alias in namespace alib.

using	StrangeCString = strings::TCString <strangeChar>
	Type alias in namespace alib.

using	StrangeFormat = strings::TFormat<strangeChar >
	Type alias in namespace alib.

template<integer TCapacity>
using	StrangeLocalString = strings::TLocalString<strangeChar, TCapacity>
	Type alias in namespace alib.

using	StrangeMAString = monomem::TMAString<strangeChar>
	Type alias in namespace alib.

using	StrangeNumberFormat = strings::TNumberFormat<strangeChar>
	Type alias in namespace alib.

using	StrangeString = strings::TString <strangeChar>
	Type alias in namespace alib.

using	StrangeStringLengthResetter = strings::TStringLengthResetter<strangeChar >
	Type alias in namespace alib.

using	StrangeStringNZT = strings::TStringNZT <strangeChar>
	Type alias in namespace alib.

using	StrangeSubstring = strings::TSubstring <strangeChar>
	Type alias in namespace alib.

using	String = strings::TString <character>
	Type alias in namespace alib.

using	String128 = LocalString< 128>
	Type alias name for TLocalString<character,128> .

using	String16 = LocalString< 16>
	Type alias name for TLocalString<character,16> .

using	String1K = LocalString<1024>
	Type alias name for TLocalString<character,1024> .

using	String256 = LocalString< 256>
	Type alias name for TLocalString<character,256> .

using	String2K = LocalString<2048>
	Type alias name for TLocalString<character,2048> .

using	String32 = LocalString< 32>
	Type alias name for TLocalString<character,32> .

using	String4K = LocalString<4096>
	Type alias name for TLocalString<character,4096> .

using	String512 = LocalString< 512>
	Type alias name for TLocalString<character,512> .

using	String64 = LocalString< 64>
	Type alias name for TLocalString<character,64> .

using	String8 = LocalString< 8>
	Type alias name for TLocalString<character,8> .

using	StringLengthResetter = strings::TStringLengthResetter<character>
	Type alias in namespace alib.

using	StringNZT = strings::TStringNZT <character>
	Type alias in namespace alib.

using	StringReader = strings::compatibility::std::StringReader
	Type alias in namespace alib.

template<typename T , typename TNodeMaintainer = StringTreeNamesDynamic<character>, typename TRecycling = Recycling::Private>
using	StringTree = monomem::StringTree<T, TNodeMaintainer, TRecycling>
	Type alias in namespace alib.

template<typename TChar , integer TLocalCapacity = 32>
using	StringTreeNamesDynamic = monomem::StringTreeNamesDynamic<TChar, TLocalCapacity>
	Type alias in namespace alib.

template<typename TChar >
using	StringTreeNamesMonoAlloc = monomem::StringTreeNamesMonoAlloc<TChar>
	Type alias in namespace alib.

template<typename TChar >
using	StringTreeNamesStatic = monomem::StringTreeNamesStatic<TChar>
	Type alias in namespace alib.

using	StringWriter = strings::compatibility::std::StringWriter
	Type alias in namespace alib.

using	Substring = strings::TSubstring <character>
	Type alias in namespace alib.

template<lang::Case TSensitivity>
using	SubstringSearch = strings::util::TSubstringSearch<character>
	Type alias in namespace alib.

using	SystemErrors = lang::system::SystemErrors
	Type alias in namespace alib.

template<typename TEnum >
using	T_EnumIsArithmetical = enums::T_EnumIsArithmetical<TEnum>
	Type alias in namespace alib.

template<typename TEnum >
using	T_EnumIsBitwise = enums::T_EnumIsBitwise<TEnum>
	Type alias in namespace alib.

template<typename TEnum >
using	T_EnumRecords = enums::T_EnumRecords<TEnum>
	Type alias in namespace alib.

template<typename T >
using	T_Resourced = lang::resources::T_Resourced<T>
	Type alias in namespace alib.

using	TextFileLogger = lox::loggers::TextFileLogger
	Type alias in namespace alib.

using	TextLogger = lox::detail::textlogger::TextLogger
	Type alias in namespace alib.

using	Thread = threads::Thread
	Type alias in namespace alib.

using	ThreadID = threads::ThreadID
	Type to store thread identifiers.

using	ThreadLock = threads::ThreadLock
	Type alias in namespace alib.

using	ThreadLockNR = threads::ThreadLockNR
	Type alias in namespace alib.

using	TickConverter = time::TickConverter
	Type alias in namespace alib.

using	Ticks = time::Ticks
	Type alias in namespace alib.

using	Token = strings::util::Token
	Type alias in namespace alib.

using	Tokenizer = strings::util::TTokenizer<character>
	Type alias in namespace alib.

using	TokenizerN = strings::util::TTokenizer<nchar>
	Type alias in namespace alib.

using	TokenizerW = strings::util::TTokenizer<wchar>
	Type alias in namespace alib.

using	TypeFunctors = compatibility::std::TypeFunctors
	Type alias in namespace alib.

using	uinteger = lang::uinteger
	Type alias in namespace alib.

using	uintGap_t = lang::uintGap_t
	Type alias in namespace alib.

using	Variable = config::Variable
	Type alias in namespace alib.

using	VariableDecl = config::VariableDecl
	Type alias in namespace alib.

using	Verbosity = lox::Verbosity
	Type alias in namespace alib.

using	VStudioLogger = lox::loggers::VStudioLogger
	Type alias in namespace alib.

using	WAString = strings::TAString <wchar>
	Type alias in namespace alib.

using	wchar = characters::wchar
	Type alias in namespace alib.

using	WCString = strings::TCString <wchar>
	Type alias in namespace alib.

using	WFormat = strings::TFormat<wchar>
	Type alias in namespace alib.

using	WildcardMatcher = strings::util::TWildcardMatcher<character>
	Type alias in namespace alib.

using	WildcardMatcherN = strings::util::TWildcardMatcher<nchar>
	Type alias in namespace alib.

using	WildcardMatcherW = strings::util::TWildcardMatcher<wchar>
	Type alias in namespace alib.

using	WindowsConsoleLogger = lox::loggers::WindowsConsoleLogger
	Type alias in namespace alib.

template<integer TCapacity>
using	WLocalString = strings::TLocalString <wchar , TCapacity>
	Type alias in namespace alib.

using	WMAString = monomem::TMAString<wchar>
	Type alias in namespace alib.

using	WNumberFormat = strings::TNumberFormat<wchar>
	Type alias in namespace alib.

using	WString = strings::TString <wchar>
	Type alias in namespace alib.

using	WString128 = WLocalString< 128>
	Type alias name for TLocalString<wchar,128> .

using	WString16 = WLocalString< 16>
	Type alias name for TLocalString<wchar,16> .

using	WString1K = WLocalString<1024>
	Type alias name for TLocalString<wchar,1024> .

using	WString256 = WLocalString< 256>
	Type alias name for TLocalString<wchar,256> .

using	WString2K = WLocalString<2048>
	Type alias name for TLocalString<wchar,2048> .

using	WString32 = WLocalString< 32>
	Type alias name for TLocalString<wchar,32> .

using	WString4K = WLocalString<4096>
	Type alias name for TLocalString<wchar,4096> .

using	WString512 = WLocalString< 512>
	Type alias name for TLocalString<wchar,512> .

using	WString64 = WLocalString< 64>
	Type alias name for TLocalString<wchar,64> .

using	WString8 = WLocalString< 8>
	Type alias name for TLocalString<wchar,8> .

using	WStringLengthResetter = strings::TStringLengthResetter<wchar>
	Type alias in namespace alib.

using	WStringNZT = strings::TStringNZT <wchar>
	Type alias in namespace alib.

using	WSubstring = strings::TSubstring <wchar>
	Type alias in namespace alib.

template<lang::Case TSensitivity>
using	WSubstringSearch = strings::util::TSubstringSearch<wchar>
	Type alias in namespace alib.

using	XAString = strings::TAString <xchar>
	Type alias in namespace alib.

using	xchar = characters::xchar
	Type alias in namespace alib.

using	XCString = strings::TCString <xchar>
	Type alias in namespace alib.

using	XFormat = strings::TFormat<xchar>
	Type alias in namespace alib.

template<integer TCapacity>
using	XLocalString = strings::TLocalString <xchar , TCapacity>
	Type alias in namespace alib.

using	XMAString = monomem::TMAString<xchar>
	Type alias in namespace alib.

using	XNumberFormat = strings::TNumberFormat<xchar>
	Type alias in namespace alib.

using	XString = strings::TString <xchar>
	Type alias in namespace alib.

using	XStringLengthResetter = strings::TStringLengthResetter<xchar>
	Type alias in namespace alib.

using	XStringNZT = strings::TStringNZT <xchar>
	Type alias in namespace alib.

using	XSubstring = strings::TSubstring <xchar>
	Type alias in namespace alib.

Enumeration Index:
enum class	BootstrapPhases { PrepareResources = 1 , PrepareConfig = 2 , Final = 3 }

enum class	ShutdownPhases { Announce = 1 , Destruct = 2 }

Function Index:
ALIB_WARNINGS_ALLOW_UNSAFE_BUFFER_USAGE void	AssertALibVersionAndFlags (int alibVersion, int alibRevision, TCompilationFlags compilationFlags)

void	Bootstrap (BootstrapPhases targetPhase, Camp *targetCamp, int alibVersion, int alibRevision, TCompilationFlags compilationFlags)

ALIB_WARNINGS_RESTORE void	Bootstrap (int alibVersion, int alibRevision, TCompilationFlags compilationFlags)

void	BootstrapAddDefaultCamps ()

constexpr ComplementCString	ComplementDefaultWhitespaces ()

constexpr ComplementCString	ComplementNewLine ()

void	DbgCheckSingleThreaded ()

constexpr CString	DefaultWhitespaces ()

constexpr ComplementCString	EmptyComplementString ()

constexpr NCString	EmptyNString ()

constexpr StrangeCString	EmptyStrangeString ()

constexpr CString	EmptyString ()

constexpr WCString	EmptyWString ()

constexpr XCString	EmptyXString ()

constexpr NCString	NDefaultWhitespaces ()

constexpr CString	NewLine ()

constexpr NCString	NNewLine ()

constexpr ComplementString	NullComplementString ()

constexpr NString	NullNString ()

constexpr StrangeString	NullStrangeString ()

constexpr String	NullString ()

constexpr WString	NullWString ()

constexpr XString	NullXString ()

template<typename TInterface , TInterface TEnd, TInterface TBegin>
constexpr alib::lang::TBitSet< TInterface, TEnd, TBegin >	operator& (const alib::lang::TBitSet< TInterface, TEnd, TBegin > &lhs, const alib::lang::TBitSet< TInterface, TEnd, TBegin > &rhs) noexcept

template<typename TInterface , TInterface TEnd, TInterface TBegin>
constexpr alib::lang::TBitSet< TInterface, TEnd, TBegin >	operator^ (const alib::lang::TBitSet< TInterface, TEnd, TBegin > &lhs, const alib::lang::TBitSet< TInterface, TEnd, TBegin > &rhs) noexcept

template<typename TInterface , TInterface TEnd, TInterface TBegin>
constexpr alib::lang::TBitSet< TInterface, TEnd, TBegin >	operator\| (const alib::lang::TBitSet< TInterface, TEnd, TBegin > &lhs, const alib::lang::TBitSet< TInterface, TEnd, TBegin > &rhs) noexcept

void	Shutdown ()

void	Shutdown (ShutdownPhases targetPhase, Camp *targetCamp)

constexpr StrangeCString	StrangeDefaultWhitespaces ()

constexpr StrangeCString	StrangeNewLine ()

constexpr WCString	WDefaultWhitespaces ()

constexpr WCString	WNewLine ()

constexpr XCString	XDefaultWhitespaces ()

constexpr XCString	XNewLine ()

Variable Index:
lox::ALox	ALOX

int	ArgC = 0

const char **	ArgVN = nullptr

const wchar_t **	ArgVW = nullptr

lang::basecamp::BaseCamp	BASECAMP

ALIB_API List< lang::Camp * >	Camps

cli::Cli	CLI

CompilationFlagMeaningsEntry	CompilationFlagMeanings [30]

ALIB_WARNINGS_ALLOW_UNSAFE_BUFFER_USAGE TCompilationFlags	CompilationFlags = {ALIB_COMPILATION_FLAGS}

config::Config	CONFIG

constexpr nchar	DirectorySeparator

ALIB_API ComplementCString	EMPTY_COMPLEMENT_STRING = A_CCHAR ("")
	A global instance of a nulled zero-terminated string of complementary character size.

ALIB_API NCString	EMPTY_N_STRING = A_NCHAR ("")
	A global instance of a nulled zero-terminated string of wide character size.

ALIB_API StrangeCString	EMPTY_STRANGE_STRING = A_SCHAR ("")
	A global instance of a nulled zero-terminated string of strange character size.

ALIB_API CString	EMPTY_STRING = A_CHAR ("")
	A global instance of a nulled zero-terminated string of standard character size.

ALIB_API WCString	EMPTY_W_STRING = A_WCHAR ("")
	A global instance of a nulled zero-terminated string of wide character size.

ALIB_API XString	EMPTY_X_STRING = A_XCHAR ("")
	A global instance of a nulled zero-terminated string of strange character size.

expressions::Expressions	EXPRESSIONS

files::Files	FILES

bool	NonCampModulesInitialized = false

ComplementString	NULL_COMPLEMENT_STRING = nullptr
	A global instance of a nulled string of complementary character size.

NString	NULL_N_STRING = nullptr
	A global instance of a nulled string of wide character size.

StrangeString	NULL_STRANGE_STRING = nullptr
	A global instance of a nulled string of strange character size.

String	NULL_STRING = nullptr
	A global instance of a nulled string of standard character size.

WString	NULL_W_STRING = nullptr
	A global instance of a nulled string of wide character size.

XString	NULL_X_STRING = nullptr
	A global instance of a nulled string of strange character size.

unsigned char	Revision = ALIB_REVISION

int	Version = ALIB_VERSION

Type Definition Details:

◆ ALox

using ALox = lox::ALox

Type alias in namespace alib.

Definition at line 217 of file aloxmodule.hpp.

◆ ALoxReportWriter

using ALoxReportWriter = lox::ALoxReportWriter

Type alias in namespace alib.

Definition at line 70 of file reportwriter.hpp.

◆ AnsiConsoleLogger

using AnsiConsoleLogger = lox::loggers::AnsiConsoleLogger

Type alias in namespace alib.

Definition at line 268 of file ansilogger.hpp.

◆ AnsiLogger

using AnsiLogger = lox::loggers::AnsiLogger

Type alias in namespace alib.

Definition at line 265 of file ansilogger.hpp.

◆ ArrayCompressor

using ArrayCompressor = bitbuffer::ac_v1::ArrayCompressor

Type alias in namespace alib, referencing the sub-namespace within alib::bitbuffer which provides the current version of array compression.

See also: Namespace alib::bitbuffer::ac_v1 for more information.

Definition at line 21 of file arraycompressor.hpp.

◆ AString

using AString = strings::TAString <character>

Type alias in namespace alib.

Definition at line 128 of file strings/fwds.hpp.

◆ AutoSizes

using AutoSizes = strings::util::AutoSizes

Type alias in namespace alib.

Definition at line 213 of file autosizes.hpp.

◆ BitBuffer

using BitBuffer = bitbuffer::BitBuffer

Type alias in namespace alib.

Definition at line 1442 of file bitbuffer.hpp.

◆ BitBufferLocal

template<uinteger TCapacity>

using BitBufferLocal = bitbuffer::BitBufferLocal<TCapacity>

Type alias in namespace alib.

Definition at line 1449 of file bitbuffer.hpp.

◆ BitBufferMA

using BitBufferMA = bitbuffer::BitBufferMA

Type alias in namespace alib.

Definition at line 1445 of file bitbuffer.hpp.

◆ BitReader

using BitReader = bitbuffer::BitReader

Type alias in namespace alib.

Definition at line 1455 of file bitbuffer.hpp.

◆ BitSet

template<int TEnd, int TBegin = 0, typename TInterface = int>

using BitSet = lang::TBitSet<int, TEnd, TBegin>

Type alias in namespace alib.

Definition at line 904 of file bitset.hpp.

◆ BitWriter

using BitWriter = bitbuffer::BitWriter

Type alias in namespace alib.

Definition at line 1452 of file bitbuffer.hpp.

◆ Box

using Box = boxing::Box

Type alias in namespace alib.

Definition at line 40 of file boxing/fwds.hpp.

◆ Boxes

using Boxes = boxing::Boxes

Type alias in namespace alib.

Definition at line 43 of file boxing/fwds.hpp.

◆ ByteSize

using ByteSize = lang::format::ByteSizeIEC

Type alias in namespace alib.

Definition at line 252 of file bytesize.hpp.

◆ ByteSizeIEC

using ByteSizeIEC = lang::format::ByteSizeIEC

Type alias in namespace alib.

Definition at line 255 of file bytesize.hpp.

◆ ByteSizeSI

using ByteSizeSI = lang::format::ByteSizeSI

Type alias in namespace alib.

Definition at line 258 of file bytesize.hpp.

◆ ByteSizeUnits

using ByteSizeUnits = lang::format::ByteSizeUnits

Type alias in namespace alib.

Definition at line 249 of file bytesize.hpp.

◆ Calculus

using Calculus = expressions::plugins::Calculus

Type alias in namespace alib.

Definition at line 903 of file calculus.hpp.

◆ CalendarDate

using CalendarDate = lang::system::CalendarDate

Type alias in namespace alib.

Definition at line 759 of file calendar.hpp.

◆ CalendarDateTime

using CalendarDateTime = lang::system::CalendarDateTime

Type alias in namespace alib.

Definition at line 753 of file calendar.hpp.

◆ CalendarDuration

using CalendarDuration = lang::system::CalendarDuration

Type alias in namespace alib.

Definition at line 756 of file calendar.hpp.

◆ character

using character = characters::character

Type alias in namespace alib.

Definition at line 665 of file characters.hpp.

◆ CLIUtil

using CLIUtil = cli::CLIUtil

Type alias in namespace alib.

Definition at line 240 of file cliutil.hpp.

◆ CommandLine

using CommandLine = cli::CommandLine

Type alias in namespace alib.

Definition at line 616 of file commandline.hpp.

◆ Compiler

using Compiler = expressions::Compiler

Type alias in namespace alib.

Definition at line 596 of file compiler.hpp.

◆ CompilerPlugin

using CompilerPlugin = expressions::CompilerPlugin

Type alias in namespace alib.

Definition at line 665 of file compilerplugin.hpp.

◆ ComplementAString

using ComplementAString = strings::TAString <complementChar>

Type alias in namespace alib.

Definition at line 131 of file strings/fwds.hpp.

◆ complementChar

using complementChar = characters::complementChar

Type alias in namespace alib.

Definition at line 668 of file characters.hpp.

◆ ComplementCString

using ComplementCString = strings::TCString <complementChar>

Type alias in namespace alib.

Definition at line 113 of file strings/fwds.hpp.

◆ ComplementFormat

using ComplementFormat = strings::TFormat<complementChar >

Type alias in namespace alib.

Definition at line 301 of file strings/fwds.hpp.

◆ ComplementLocalString

template<integer TCapacity>

using ComplementLocalString = strings::TLocalString<complementChar, TCapacity>

Type alias in namespace alib.

Definition at line 169 of file strings/fwds.hpp.

◆ ComplementMAString

using ComplementMAString = monomem::TMAString<complementChar>

Type alias in namespace alib.

Definition at line 108 of file mastring.hpp.

◆ ComplementNumberFormat

using ComplementNumberFormat = strings::TNumberFormat<complementChar>

Type alias in namespace alib.

Definition at line 282 of file strings/fwds.hpp.

◆ ComplementString

using ComplementString = strings::TString <complementChar>

Type alias in namespace alib.

Definition at line 77 of file strings/fwds.hpp.

◆ ComplementStringLengthResetter

using ComplementStringLengthResetter = strings::TStringLengthResetter<complementChar>

Type alias in namespace alib.

Definition at line 319 of file strings/fwds.hpp.

◆ ComplementStringNZT

using ComplementStringNZT = strings::TStringNZT <complementChar>

Type alias in namespace alib.

Definition at line 149 of file strings/fwds.hpp.

◆ ComplementSubstring

using ComplementSubstring = strings::TSubstring <complementChar>

Type alias in namespace alib.

Definition at line 95 of file strings/fwds.hpp.

◆ Configuration

using Configuration = config::Configuration

Type alias in namespace alib.

Definition at line 483 of file configuration.hpp.

◆ Console

using Console = lang::system::Console

Type alias in namespace alib.

Definition at line 48 of file console.hpp.

◆ ConsoleLogger

using ConsoleLogger = lox::loggers::ConsoleLogger

Type alias in namespace alib.

Definition at line 98 of file consolelogger.hpp.

◆ CString

using CString = strings::TCString <character>

Type alias in namespace alib.

Definition at line 110 of file strings/fwds.hpp.

◆ DateTime

using DateTime = time::DateTime

Type alias in namespace alib.

Definition at line 226 of file datetime.hpp.

◆ DbgBoxing

using DbgBoxing = boxing::DbgBoxing

Type alias in namespace alib.

Definition at line 539 of file dbgboxing.hpp.

◆ Directory

using Directory = lang::system::Directory

Type alias in namespace alib.

Definition at line 242 of file directory.hpp.

◆ Enum

typedef boxing::Enum Enum = boxing::Enum

Type alias in namespace alib.

Definition at line 353 of file enum.hpp.

◆ EnumBitSet

template<typename TEnum >

using EnumBitSet

Initial value:

lang::TBitSet<TEnum, enums::T_EnumIsIterable<TEnum>::End,

enums::T_EnumIsIterable<TEnum>::Begin>

Type alias in namespace alib.

See also: For more information, consult type definition EnumBitSet .

Definition at line 56 of file iterablebitset.hpp.

◆ EnumIterator

template<typename TEnum , typename TEnableIf = void>

using EnumIterator = enums::EnumIterator<TEnum, TEnableIf>

Type alias in namespace alib.

Definition at line 483 of file iterable.hpp.

◆ EnumRecords

template<typename TEnum >

using EnumRecords = enums::EnumRecords<TEnum>

Type alias in namespace alib.

Definition at line 745 of file records.hpp.

◆ EnvironmentVariables

using EnvironmentVariables = lang::system::EnvironmentVariables

Type alias in namespace alib.

Definition at line 59 of file environment.hpp.

◆ ESC

using ESC = lox::ESC

Type alias in namespace alib.

Definition at line 237 of file alox/alox.hpp.

◆ Exception

using Exception = lang::Exception

Type alias in namespace alib.

Definition at line 532 of file exception.hpp.

◆ ExpressionFormatter

using ExpressionFormatter = expressions::util::ExpressionFormatter

Type alias in namespace alib.

Definition at line 129 of file expressionformatter.hpp.

◆ ExpressionScope

using ExpressionScope = expressions::Scope

Type alias in namespace alib. Renamed to not collide with alib::lox::Scope.

Definition at line 195 of file scope.hpp.

◆ FAppend

template<typename TChar >

using FAppend = boxing::FAppend<TChar>

Type alias in namespace alib.

Definition at line 69 of file boxing/fwds.hpp.

◆ FClone

using FClone = boxing::FClone

Type alias in namespace alib.

Definition at line 52 of file boxing/fwds.hpp.

◆ FEquals

using FEquals = boxing::FEquals

Type alias in namespace alib.

Definition at line 55 of file boxing/fwds.hpp.

◆ FFilter

using FFilter = files::FFilter

Type alias in namespace alib.

Definition at line 60 of file ffilter.hpp.

◆ FHashcode

using FHashcode = boxing::FHashcode

Type alias in namespace alib.

Definition at line 49 of file boxing/fwds.hpp.

◆ FileExpressions

using FileExpressions = files::FileExpressions

Type alias in namespace alib.

The outer class is our friend.

Definition at line 214 of file fileexpressions.hpp.

◆ FInfo

using FInfo = files::FInfo

Type alias in namespace alib.

Definition at line 551 of file finfo.hpp.

◆ FIsLess

using FIsLess = boxing::FIsLess

Type alias in namespace alib.

Definition at line 61 of file boxing/fwds.hpp.

◆ FIsNotNull

using FIsNotNull = boxing::FIsNotNull

Type alias in namespace alib.

Definition at line 58 of file boxing/fwds.hpp.

◆ FIsTrue

using FIsTrue = boxing::FIsTrue

Type alias in namespace alib.

Definition at line 64 of file boxing/fwds.hpp.

◆ FixedCapacityVector

template<typename T , std::size_t TSize>

using FixedCapacityVector = monomem::util::FixedCapacityVector<T, TSize>

Type alias in namespace alib.

Definition at line 111 of file fixedcapacityvector.hpp.

◆ FixedSizePriorityQueue

template<typename T , std::size_t TSize, typename TCompare = std::less<T>>

using FixedSizePriorityQueue = std::priority_queue< T, FixedCapacityVector<T, TSize>, TCompare>

Type alias in namespace alib, which denotes a std::priority_queue using a FixedCapacityVector as its underlying container type.

Definition at line 117 of file fixedcapacityvector.hpp.

◆ Format

using Format = strings::TFormat<character>

Type alias in namespace alib.

Definition at line 298 of file strings/fwds.hpp.

◆ Formatter

using Formatter = lang::format::Formatter

Type alias in namespace alib.

Definition at line 68 of file lang/format/fwds.hpp.

◆ FormatterJavaStyle

using FormatterJavaStyle = lang::format::FormatterJavaStyle

Type alias in namespace alib.

Definition at line 74 of file lang/format/fwds.hpp.

◆ FormatterPythonStyle

using FormatterPythonStyle = lang::format::FormatterPythonStyle

Type alias in namespace alib.

Definition at line 71 of file lang/format/fwds.hpp.

◆ FTree

using FTree = files::FTree

Type alias in namespace alib.

Definition at line 284 of file ftree.hpp.

◆ HashMap

template<typename TKey , typename TMapped , typename THash = std::hash <TKey>, typename TEqual = std::equal_to<TKey>, lang::Caching THashCaching = lang::Caching::Auto, typename TRecycling = monomem::Recycling::Private>

using HashMap = monomem::HashMap<TKey, TMapped,THash,TEqual, THashCaching, TRecycling >

Type alias in namespace alib. See type definition alib::monomem::HashMap.

Definition at line 104 of file hashmap.hpp.

◆ HashSet

template<typename T , typename THash = std::hash <T>, typename TEqual = std::equal_to<T>, lang::Caching THashCaching = lang::Caching::Auto, typename TRecycling = monomem::Recycling::Private>

using HashSet = monomem::HashSet<T, THash, TEqual, THashCaching, TRecycling >

Type alias in namespace alib. See type definition alib::monomem::HashSet.

Definition at line 94 of file hashset.hpp.

◆ HuffmanDecoder

using HuffmanDecoder = bitbuffer::ac_v1::HuffmanDecoder

Type alias in namespace alib, referencing the sub-namespace within alib::bitbuffer which provides the current version of array compression.

See also: Namespace alib::bitbuffer::ac_v1 for more information.

Definition at line 31 of file arraycompressor.hpp.

◆ HuffmanEncoder

using HuffmanEncoder = bitbuffer::ac_v1::HuffmanEncoder

Type alias in namespace alib, referencing the sub-namespace within alib::bitbuffer which provides the current version of array compression.

See also: Namespace alib::bitbuffer::ac_v1 for more information.

Definition at line 26 of file arraycompressor.hpp.

◆ IniFile

using IniFile = config::IniFile

Type alias in namespace alib.

Definition at line 318 of file inifile.hpp.

◆ InMemoryPlugin

using InMemoryPlugin = config::InMemoryPlugin

Type alias in namespace alib.

Definition at line 525 of file inmemoryplugin.hpp.

◆ integer

using integer = lang::integer

Type alias in namespace alib.

Definition at line 286 of file integers.hpp.

◆ intGap_t

using intGap_t = lang::intGap_t

Type alias in namespace alib.

Definition at line 292 of file integers.hpp.

◆ ISReadLineN

using ISReadLineN = strings::compatibility::std::TISReadLine<char>

Type alias in namespace alib.

Definition at line 391 of file std_strings_iostream.hpp.

◆ ISReadLineW

using ISReadLineW = strings::compatibility::std::TISReadLine<wchar_t>

Type alias in namespace alib.

Definition at line 394 of file std_strings_iostream.hpp.

◆ List

template<typename T , typename TRecycling = monomem::Recycling::Private>

using List = monomem::List<T, TRecycling>

Type alias in namespace alib.

Definition at line 829 of file list.hpp.

◆ LocalString

template<integer TCapacity>

using LocalString = strings::TLocalString<character, TCapacity>

Type alias in namespace alib.

Definition at line 165 of file strings/fwds.hpp.

◆ Log

using Log = lox::Log

Type alias in namespace alib.

Definition at line 158 of file log.inl.

◆ Logger

using Logger = lox::detail::Logger

Type alias in namespace alib.

Definition at line 199 of file logger.hpp.

◆ LogTools

using LogTools = lox::LogTools

Type alias in namespace alib.

Definition at line 78 of file logtools.hpp.

◆ Lox

using Lox = lox::Lox

Type alias in namespace alib.

Definition at line 1492 of file lox.inl.

◆ MAString

using MAString = monomem::TMAString<character>

Type alias in namespace alib.

Definition at line 105 of file mastring.hpp.

◆ MemoryLogger

using MemoryLogger = lox::loggers::MemoryLogger

Type alias in namespace alib.

Definition at line 121 of file memorylogger.hpp.

◆ MonoAllocator

using MonoAllocator = monomem::MonoAllocator

Type alias in namespace alib.

Definition at line 754 of file monoallocator.hpp.

◆ NAString

using NAString = strings::TAString <nchar>

Type alias in namespace alib.

Definition at line 137 of file strings/fwds.hpp.

◆ nchar

using nchar = characters::nchar

Type alias in namespace alib.

Definition at line 656 of file characters.hpp.

◆ NCString

using NCString = strings::TCString <nchar>

Type alias in namespace alib.

Definition at line 119 of file strings/fwds.hpp.

◆ NFormat

using NFormat = strings::TFormat<nchar>

Type alias in namespace alib.

Definition at line 307 of file strings/fwds.hpp.

◆ NLocalString

template<integer TCapacity>

using NLocalString = strings::TLocalString <nchar , TCapacity>

Type alias in namespace alib.

Definition at line 177 of file strings/fwds.hpp.

◆ NMAString

using NMAString = monomem::TMAString<nchar>

Type alias in namespace alib.

Definition at line 114 of file mastring.hpp.

◆ NNumberFormat

using NNumberFormat = strings::TNumberFormat<nchar>

Type alias in namespace alib.

Definition at line 288 of file strings/fwds.hpp.

◆ NString

using NString = strings::TString <nchar>

Type alias in namespace alib.

Definition at line 83 of file strings/fwds.hpp.

◆ NString128

using NString128 = NLocalString< 128>

Type alias name for TLocalString<nchar,128> .

Definition at line 230 of file strings/fwds.hpp.

◆ NString16

using NString16 = NLocalString< 16>

Type alias name for TLocalString<nchar,16> .

Definition at line 221 of file strings/fwds.hpp.

◆ NString1K

using NString1K = NLocalString<1024>

Type alias name for TLocalString<nchar,1024> .

Definition at line 239 of file strings/fwds.hpp.

◆ NString256

using NString256 = NLocalString< 256>

Type alias name for TLocalString<nchar,256> .

Definition at line 233 of file strings/fwds.hpp.

◆ NString2K

using NString2K = NLocalString<2048>

Type alias name for TLocalString<nchar,2048> .

Definition at line 242 of file strings/fwds.hpp.

◆ NString32

using NString32 = NLocalString< 32>

Type alias name for TLocalString<nchar,32> .

Definition at line 224 of file strings/fwds.hpp.

◆ NString4K

using NString4K = NLocalString<4096>

Type alias name for TLocalString<nchar,4096> .

Definition at line 245 of file strings/fwds.hpp.

◆ NString512

using NString512 = NLocalString< 512>

Type alias name for TLocalString<nchar,512> .

Definition at line 236 of file strings/fwds.hpp.

◆ NString64

using NString64 = NLocalString< 64>

Type alias name for TLocalString<nchar,64> .

Definition at line 227 of file strings/fwds.hpp.

◆ NString8

using NString8 = NLocalString< 8>

Type alias name for TLocalString<nchar,8> .

Definition at line 188 of file strings/fwds.hpp.

◆ NStringLengthResetter

using NStringLengthResetter = strings::TStringLengthResetter<nchar>

Type alias in namespace alib.

Definition at line 325 of file strings/fwds.hpp.

◆ NStringNZT

using NStringNZT = strings::TStringNZT <nchar>

Type alias in namespace alib.

Definition at line 155 of file strings/fwds.hpp.

◆ NSubstring

typedef strings::TSubstring< nchar > NSubstring = strings::TSubstring <nchar>

Type alias in namespace alib.

Definition at line 101 of file strings/fwds.hpp.

◆ NSubstringSearch

template<lang::Case TSensitivity>

using NSubstringSearch = strings::util::TSubstringSearch<nchar>

Type alias in namespace alib.

Definition at line 108 of file subsearch.hpp.

◆ NumberFormat

using NumberFormat = strings::TNumberFormat<character>

Type alias in namespace alib.

Definition at line 279 of file strings/fwds.hpp.

◆ NumberFormatFlags

using NumberFormatFlags = strings::NumberFormatFlags

Type alias in namespace alib.

Definition at line 552 of file numberformat.hpp.

◆ Owner

template<typename TOwnable >

using Owner = lang::Owner<TOwnable>

Type alias in namespace alib.

Definition at line 101 of file owner.hpp.

◆ OwnerAndGroupResolver

using OwnerAndGroupResolver = files::OwnerAndGroupResolver

Type alias in namespace alib.

Definition at line 52 of file ftools.hpp.

◆ Paragraphs

using Paragraphs = lang::format::Paragraphs

Type alias in namespace alib.

Definition at line 77 of file lang/format/fwds.hpp.

◆ Priorities

using Priorities = alib::config::Priorities

Type alias in namespace alib.

Definition at line 107 of file priorities.hpp.

◆ ProcessInfo

using ProcessInfo = lang::system::ProcessInfo

Type alias in namespace alib.

Definition at line 169 of file processinfo.hpp.

◆ PropertyFormatter

using PropertyFormatter = lang::format::PropertyFormatter

Type alias in namespace alib.

Definition at line 287 of file propertyformatter.hpp.

◆ PropertyFormatters

template<typename TFormattable , typename TOptionEnum >

using PropertyFormatters = lang::format::PropertyFormatters<TFormattable, TOptionEnum>

Type alias in namespace alib.

Definition at line 352 of file propertyformatters.hpp.

◆ Recycling

using Recycling = monomem::Recycling

Type alias in namespace alib.

Definition at line 64 of file monomem/fwds.hpp.

◆ RegexMatcher

using RegexMatcher = strings::util::RegexMatcher

Type alias in namespace alib.

Definition at line 95 of file regexmatcher.hpp.

◆ ResourcedType

template<typename T >

using ResourcedType = lang::resources::ResourcedType<T>

Type alias in namespace alib.

Definition at line 624 of file resources.hpp.

◆ ResourceInfo

using ResourceInfo = lang::resources::ResourceInfo

Type alias in namespace alib.

Definition at line 627 of file resources.hpp.

◆ ResourcePool

using ResourcePool = lang::resources::ResourcePool

Type alias in namespace alib.

Definition at line 616 of file resources.hpp.

◆ ResultsPaths

using ResultsPaths = files::ResultsPaths

Type alias in namespace alib.

Definition at line 257 of file fscanner.hpp.

◆ RTTRAllocator

using RTTRAllocator = monomem::util::RTTRAllocator

Type alias in namespace alib.

Definition at line 394 of file rttrallocator.hpp.

◆ Runnable

using Runnable = threads::Runnable

Type alias in namespace alib.

Definition at line 387 of file thread.hpp.

◆ ScanParameters

using ScanParameters = files::ScanParameters

Type alias in namespace alib.

Definition at line 254 of file fscanner.hpp.

◆ Scope

using Scope = lox::Scope

Type alias in namespace alib.

Definition at line 234 of file alox/alox.hpp.

◆ ShiftOpRHS

using ShiftOpRHS = int

Type alias in namespace alib.

Definition at line 1458 of file bitbuffer.hpp.

◆ Singleton

template<typename T >

using Singleton = singletons::Singleton<T>

Type alias in namespace alib.

Definition at line 129 of file singleton.hpp.

◆ Sleeper

using Sleeper = threads::Sleeper

Type alias in namespace alib.

Definition at line 311 of file sleeper.hpp.

◆ SmartLock

using SmartLock = threads::SmartLock

Type alias in namespace alib.

Definition at line 182 of file smartlock.hpp.

◆ Spaces

using Spaces = strings::util::Spaces

Type alias in namespace alib.

Definition at line 100 of file spaces.hpp.

◆ SPExpression

using SPExpression = expressions::SPExpression

Type alias in namespace alib.

Definition at line 240 of file expression.hpp.

◆ SPFileFilter

using SPFileFilter = files::SPFileFilter

Type alias in namespace alib.

Definition at line 63 of file ffilter.hpp.

◆ SPFormatter

using SPFormatter = std::shared_ptr< lang::format::Formatter>

Shared pointer to instances of standard formatters .

See also: Method Formatter::GetDefault .

Definition at line 84 of file lang/format/fwds.hpp.

◆ StdContMA

template<typename T >

using StdContMA = monomem::StdContMA<T>

Type alias in namespace alib.

Definition at line 510 of file stdcontainerma.hpp.

◆ StdContMAOptional

template<typename T >

using StdContMAOptional = monomem::StdContMAOptional<T>

Type alias in namespace alib.

Definition at line 514 of file stdcontainerma.hpp.

◆ StdContMARecycling

template<typename T >

using StdContMARecycling = monomem::StdContMARecycling<T>

Type alias in namespace alib.

Definition at line 518 of file stdcontainerma.hpp.

◆ StopWatch

using StopWatch = time::StopWatch

Type alias in namespace alib.

Definition at line 168 of file stopwatch.hpp.

◆ StrangeAString

using StrangeAString = strings::TAString <strangeChar>

Type alias in namespace alib.

Definition at line 134 of file strings/fwds.hpp.

◆ strangeChar

using strangeChar = characters::strangeChar

Type alias in namespace alib.

Definition at line 671 of file characters.hpp.

◆ StrangeCString

using StrangeCString = strings::TCString <strangeChar>

Type alias in namespace alib.

Definition at line 116 of file strings/fwds.hpp.

◆ StrangeFormat

using StrangeFormat = strings::TFormat<strangeChar >

Type alias in namespace alib.

Definition at line 304 of file strings/fwds.hpp.

◆ StrangeLocalString

template<integer TCapacity>

using StrangeLocalString = strings::TLocalString<strangeChar, TCapacity>

Type alias in namespace alib.

Definition at line 173 of file strings/fwds.hpp.

◆ StrangeMAString

using StrangeMAString = monomem::TMAString<strangeChar>

Type alias in namespace alib.

Definition at line 111 of file mastring.hpp.

◆ StrangeNumberFormat

using StrangeNumberFormat = strings::TNumberFormat<strangeChar>

Type alias in namespace alib.

Definition at line 285 of file strings/fwds.hpp.

◆ StrangeString

using StrangeString = strings::TString <strangeChar>

Type alias in namespace alib.

Definition at line 80 of file strings/fwds.hpp.

◆ StrangeStringLengthResetter

using StrangeStringLengthResetter = strings::TStringLengthResetter<strangeChar >

Type alias in namespace alib.

Definition at line 322 of file strings/fwds.hpp.

◆ StrangeStringNZT

using StrangeStringNZT = strings::TStringNZT <strangeChar>

Type alias in namespace alib.

Definition at line 152 of file strings/fwds.hpp.

◆ StrangeSubstring

using StrangeSubstring = strings::TSubstring <strangeChar>

Type alias in namespace alib.

Definition at line 98 of file strings/fwds.hpp.

◆ String

using String = strings::TString <character>

Type alias in namespace alib.

Definition at line 74 of file strings/fwds.hpp.

◆ String128

using String128 = LocalString< 128>

Type alias name for TLocalString<character,128> .

Definition at line 203 of file strings/fwds.hpp.

◆ String16

using String16 = LocalString< 16>

Type alias name for TLocalString<character,16> .

Definition at line 194 of file strings/fwds.hpp.

◆ String1K

using String1K = LocalString<1024>

Type alias name for TLocalString<character,1024> .

Definition at line 212 of file strings/fwds.hpp.

◆ String256

using String256 = LocalString< 256>

Type alias name for TLocalString<character,256> .

Definition at line 206 of file strings/fwds.hpp.

◆ String2K

using String2K = LocalString<2048>

Type alias name for TLocalString<character,2048> .

Definition at line 215 of file strings/fwds.hpp.

◆ String32

using String32 = LocalString< 32>

Type alias name for TLocalString<character,32> .

Definition at line 197 of file strings/fwds.hpp.

◆ String4K

using String4K = LocalString<4096>

Type alias name for TLocalString<character,4096> .

Definition at line 218 of file strings/fwds.hpp.

◆ String512

using String512 = LocalString< 512>

Type alias name for TLocalString<character,512> .

Definition at line 209 of file strings/fwds.hpp.

◆ String64

using String64 = LocalString< 64>

Type alias name for TLocalString<character,64> .

Definition at line 200 of file strings/fwds.hpp.

◆ String8

using String8 = LocalString< 8>

Type alias name for TLocalString<character,8> .

Definition at line 191 of file strings/fwds.hpp.

◆ StringLengthResetter

using StringLengthResetter = strings::TStringLengthResetter<character>

Type alias in namespace alib.

Definition at line 316 of file strings/fwds.hpp.

◆ StringNZT

using StringNZT = strings::TStringNZT <character>

Type alias in namespace alib.

Definition at line 146 of file strings/fwds.hpp.

◆ StringReader

using StringReader = strings::compatibility::std::StringReader

Type alias in namespace alib.

Definition at line 400 of file std_strings_iostream.hpp.

◆ StringTree

template<typename T , typename TNodeMaintainer = StringTreeNamesDynamic<character>, typename TRecycling = Recycling::Private>

using StringTree = monomem::StringTree<T, TNodeMaintainer, TRecycling>

Type alias in namespace alib.

Definition at line 2642 of file stringtree.hpp.

◆ StringTreeNamesDynamic

template<typename TChar , integer TLocalCapacity = 32>

using StringTreeNamesDynamic = monomem::StringTreeNamesDynamic<TChar, TLocalCapacity>

Type alias in namespace alib.

Definition at line 2628 of file stringtree.hpp.

◆ StringTreeNamesMonoAlloc

template<typename TChar >

using StringTreeNamesMonoAlloc = monomem::StringTreeNamesMonoAlloc<TChar>

Type alias in namespace alib.

Definition at line 2636 of file stringtree.hpp.

◆ StringTreeNamesStatic

template<typename TChar >

using StringTreeNamesStatic = monomem::StringTreeNamesStatic<TChar>

Type alias in namespace alib.

Definition at line 2632 of file stringtree.hpp.

◆ StringWriter

using StringWriter = strings::compatibility::std::StringWriter

Type alias in namespace alib.

Definition at line 397 of file std_strings_iostream.hpp.

◆ Substring

typedef strings::TSubstring< character > Substring = strings::TSubstring <character>

Type alias in namespace alib.

Definition at line 92 of file strings/fwds.hpp.

◆ SubstringSearch

template<lang::Case TSensitivity>

using SubstringSearch = strings::util::TSubstringSearch<character>

Type alias in namespace alib.

Definition at line 116 of file subsearch.hpp.

◆ SystemErrors

using SystemErrors = lang::system::SystemErrors

Type alias in namespace alib.

Definition at line 310 of file systemerrors.hpp.

◆ T_EnumIsArithmetical

template<typename TEnum >

using T_EnumIsArithmetical = enums::T_EnumIsArithmetical<TEnum>

Type alias in namespace alib.

Definition at line 81 of file arithmetical.hpp.

◆ T_EnumIsBitwise

template<typename TEnum >

using T_EnumIsBitwise = enums::T_EnumIsBitwise<TEnum>

Type alias in namespace alib.

Definition at line 112 of file bitwise.hpp.

◆ T_EnumRecords

template<typename TEnum >

using T_EnumRecords = enums::T_EnumRecords<TEnum>

Type alias in namespace alib.

Definition at line 741 of file records.hpp.

◆ T_Resourced

template<typename T >

using T_Resourced = lang::resources::T_Resourced<T>

Type alias in namespace alib.

Definition at line 620 of file resources.hpp.

◆ TextFileLogger

using TextFileLogger = lox::loggers::TextFileLogger

Type alias in namespace alib.

Definition at line 139 of file textfilelogger.hpp.

◆ TextLogger

using TextLogger = lox::detail::textlogger::TextLogger

Type alias in namespace alib.

Definition at line 736 of file textlogger.hpp.

◆ Thread

using Thread = threads::Thread

Type alias in namespace alib.

Definition at line 390 of file thread.hpp.

◆ ThreadID

using ThreadID = threads::ThreadID

Type to store thread identifiers.

Definition at line 393 of file thread.hpp.

◆ ThreadLock

using ThreadLock = threads::ThreadLock

Type alias in namespace alib.

Definition at line 248 of file threadlock.hpp.

◆ ThreadLockNR

using ThreadLockNR = threads::ThreadLockNR

Type alias in namespace alib.

Definition at line 202 of file threadlocknr.hpp.

◆ TickConverter

using TickConverter = time::TickConverter

Type alias in namespace alib.

Definition at line 124 of file tickconverter.hpp.

◆ Ticks

using Ticks = time::Ticks

Type alias in namespace alib.

Definition at line 114 of file ticks.hpp.

◆ Token

using Token = strings::util::Token

Type alias in namespace alib.

Definition at line 537 of file token.hpp.

◆ Tokenizer

using Tokenizer = strings::util::TTokenizer<character>

Type alias in namespace alib.

Definition at line 213 of file tokenizer.hpp.

◆ TokenizerN

using TokenizerN = strings::util::TTokenizer<nchar>

Type alias in namespace alib.

Definition at line 216 of file tokenizer.hpp.

◆ TokenizerW

using TokenizerW = strings::util::TTokenizer<wchar>

Type alias in namespace alib.

Definition at line 219 of file tokenizer.hpp.

◆ TypeFunctors

using TypeFunctors = compatibility::std::TypeFunctors

Type alias in namespace alib.

Definition at line 124 of file std_typeinfo.hpp.

◆ uinteger

using uinteger = lang::uinteger

Type alias in namespace alib.

Definition at line 289 of file integers.hpp.

◆ uintGap_t

using uintGap_t = lang::uintGap_t

Type alias in namespace alib.

Definition at line 295 of file integers.hpp.

◆ Variable

using Variable = config::Variable

Type alias in namespace alib.

Definition at line 839 of file variable.hpp.

◆ VariableDecl

using VariableDecl = config::VariableDecl

Type alias in namespace alib.

Definition at line 232 of file variabledecl.hpp.

◆ Verbosity

using Verbosity = lox::Verbosity

Type alias in namespace alib.

Definition at line 231 of file alox/alox.hpp.

◆ VStudioLogger

using VStudioLogger = lox::loggers::VStudioLogger

Type alias in namespace alib.

Definition at line 104 of file vstudiologger.hpp.

◆ WAString

using WAString = strings::TAString <wchar>

Type alias in namespace alib.

Definition at line 140 of file strings/fwds.hpp.

◆ wchar

using wchar = characters::wchar

Type alias in namespace alib.

Definition at line 659 of file characters.hpp.

◆ WCString

using WCString = strings::TCString <wchar>

Type alias in namespace alib.

Definition at line 122 of file strings/fwds.hpp.

◆ WFormat

using WFormat = strings::TFormat<wchar>

Type alias in namespace alib.

Definition at line 310 of file strings/fwds.hpp.

◆ WildcardMatcher

using WildcardMatcher = strings::util::TWildcardMatcher<character>

Type alias in namespace alib.

Definition at line 88 of file wildcardmatcher.hpp.

◆ WildcardMatcherN

using WildcardMatcherN = strings::util::TWildcardMatcher<nchar>

Type alias in namespace alib.

Definition at line 91 of file wildcardmatcher.hpp.

◆ WildcardMatcherW

using WildcardMatcherW = strings::util::TWildcardMatcher<wchar>

Type alias in namespace alib.

Definition at line 94 of file wildcardmatcher.hpp.

◆ WindowsConsoleLogger

using WindowsConsoleLogger = lox::loggers::WindowsConsoleLogger

Type alias in namespace alib.

Definition at line 146 of file windowsconsolelogger.hpp.

◆ WLocalString

template<integer TCapacity>

using WLocalString = strings::TLocalString <wchar , TCapacity>

Type alias in namespace alib.

Definition at line 181 of file strings/fwds.hpp.

◆ WMAString

using WMAString = monomem::TMAString<wchar>

Type alias in namespace alib.

Definition at line 117 of file mastring.hpp.

◆ WNumberFormat

using WNumberFormat = strings::TNumberFormat<wchar>

Type alias in namespace alib.

Definition at line 291 of file strings/fwds.hpp.

◆ WString

using WString = strings::TString <wchar>

Type alias in namespace alib.

Definition at line 86 of file strings/fwds.hpp.

◆ WString128

using WString128 = WLocalString< 128>

Type alias name for TLocalString<wchar,128> .

Definition at line 260 of file strings/fwds.hpp.

◆ WString16

using WString16 = WLocalString< 16>

Type alias name for TLocalString<wchar,16> .

Definition at line 251 of file strings/fwds.hpp.

◆ WString1K

using WString1K = WLocalString<1024>

Type alias name for TLocalString<wchar,1024> .

Definition at line 269 of file strings/fwds.hpp.

◆ WString256

using WString256 = WLocalString< 256>

Type alias name for TLocalString<wchar,256> .

Definition at line 263 of file strings/fwds.hpp.

◆ WString2K

using WString2K = WLocalString<2048>

Type alias name for TLocalString<wchar,2048> .

Definition at line 272 of file strings/fwds.hpp.

◆ WString32

using WString32 = WLocalString< 32>

Type alias name for TLocalString<wchar,32> .

Definition at line 254 of file strings/fwds.hpp.

◆ WString4K

using WString4K = WLocalString<4096>

Type alias name for TLocalString<wchar,4096> .

Definition at line 275 of file strings/fwds.hpp.

◆ WString512

using WString512 = WLocalString< 512>

Type alias name for TLocalString<wchar,512> .

Definition at line 266 of file strings/fwds.hpp.

◆ WString64

using WString64 = WLocalString< 64>

Type alias name for TLocalString<wchar,64> .

Definition at line 257 of file strings/fwds.hpp.

◆ WString8

using WString8 = WLocalString< 8>

Type alias name for TLocalString<wchar,8> .

Definition at line 248 of file strings/fwds.hpp.

◆ WStringLengthResetter

using WStringLengthResetter = strings::TStringLengthResetter<wchar>

Type alias in namespace alib.

Definition at line 328 of file strings/fwds.hpp.

◆ WStringNZT

using WStringNZT = strings::TStringNZT <wchar>

Type alias in namespace alib.

Definition at line 158 of file strings/fwds.hpp.

◆ WSubstring

typedef strings::TSubstring< wchar > WSubstring = strings::TSubstring <wchar>

Type alias in namespace alib.

Definition at line 104 of file strings/fwds.hpp.

◆ WSubstringSearch

template<lang::Case TSensitivity>

using WSubstringSearch = strings::util::TSubstringSearch<wchar>

Type alias in namespace alib.

Definition at line 112 of file subsearch.hpp.

◆ XAString

using XAString = strings::TAString <xchar>

Type alias in namespace alib.

Definition at line 143 of file strings/fwds.hpp.

◆ xchar

using xchar = characters::xchar

Type alias in namespace alib.

Definition at line 662 of file characters.hpp.

◆ XCString

using XCString = strings::TCString <xchar>

Type alias in namespace alib.

Definition at line 125 of file strings/fwds.hpp.

◆ XFormat

using XFormat = strings::TFormat<xchar>

Type alias in namespace alib.

Definition at line 313 of file strings/fwds.hpp.

◆ XLocalString

template<integer TCapacity>

using XLocalString = strings::TLocalString <xchar , TCapacity>

Type alias in namespace alib.

Definition at line 185 of file strings/fwds.hpp.

◆ XMAString

using XMAString = monomem::TMAString<xchar>

Type alias in namespace alib.

Definition at line 120 of file mastring.hpp.

◆ XNumberFormat

using XNumberFormat = strings::TNumberFormat<xchar>

Type alias in namespace alib.

Definition at line 294 of file strings/fwds.hpp.

◆ XString

using XString = strings::TString <xchar>

Type alias in namespace alib.

Definition at line 89 of file strings/fwds.hpp.

◆ XStringLengthResetter

using XStringLengthResetter = strings::TStringLengthResetter<xchar>

Type alias in namespace alib.

Definition at line 331 of file strings/fwds.hpp.

◆ XStringNZT

using XStringNZT = strings::TStringNZT <xchar>

Type alias in namespace alib.

Definition at line 161 of file strings/fwds.hpp.

◆ XSubstring

typedef strings::TSubstring< xchar > XSubstring = strings::TSubstring <xchar>

Type alias in namespace alib.

Definition at line 107 of file strings/fwds.hpp.

Enumeration Details:

◆ BootstrapPhases

enum class BootstrapPhases

strong

Initialization levels usable with Bootstrapping ALib Camps.

Enumerator
PrepareResources	Creates field Camp::resourcePool and loads its camp-specific default values.
PrepareConfig	Initializes up to the creation of a field config .
Final	The final initialization phase.

Definition at line 25 of file camp.hpp.

◆ ShutdownPhases

enum class ShutdownPhases

strong

Termination levels usable with Bootstrapping ALib Camps.

Enumerator
Announce	Signals termination. Keeps resources, config, etc. intact. Usable to write configuration data, stop background threads, etc.
Destruct	The main phase of termination that destructs everything.

Definition at line 34 of file camp.hpp.

Function Details:

◆ AssertALibVersionAndFlags()

ALIB_API void AssertALibVersionAndFlags	(	int	alibVersion = ALIB_VERSION,
		int	alibRevision = ALIB_REVISION,
		TCompilationFlags	compilationFlags = TCompilationFlags{ALIB_COMPILATION_FLAGS} )

Compares a given set of compilation flags with the ones set in the ALib library. If a mismatch is found, the configuration mismatch is written to std::cerr and exit(255) is performed.

This function called in all variants of function alib::Bootstrap. If a using application wants to act different on such a mismatch, an own check of fields alib::Version, alib::Revision and alib::CompilationFlags against preprocessor symbols ALIB_VERSION, ALIB_REVISION and ALIB_COMPILATION_FLAGS has to be performed prior to calling Bootstrap.

Attention: A mismatch in ALib library version and compilation flags, may lead to very dubious misbehavior which is almost impossible to debug. This is true for any C/C++ software/library mismatch.

Parameters

alibVersion	The ALib version required. Defaults to ALIB_VERSION and must not be passed when invoking this function.
alibRevision	The ALib sub-version required. Defaults to ALIB_REVISION and must not be passed when invoking this function.
compilationFlags	The flags as defined in invoking compilation unit. Defaults to `ALIB_COMPILATION_FLAGS` and must not be given.

Definition at line 140 of file alib.cpp.

◆ Bootstrap() [1/2]

ALIB_API void Bootstrap	(	BootstrapPhases	targetPhase,
		lang::Camp *	targetCamp = nullptr,
		int	alibVersion = ALIB_VERSION,
		int	alibRevision = ALIB_REVISION,
		TCompilationFlags	compilationFlags = TCompilationFlags{ALIB_COMPILATION_FLAGS} )

This function is usually invoked automatically and rightfully with the standard, parameterless version alib::Bootstrap(). For details on when and how to invoke this method explicitly, see the detailed explanations in chapter 4. Bootstrapping And Shutting Down ALib of the ALib Programmer's Manual.

Parameters

targetPhase	The initialization level to perform.
targetCamp	The "highest" ALib Camp in list Camps to bootstrap. Defaults to `nullptr`, which chooses the end of the list.
alibVersion	The ALib version required. Defaults to ALIB_VERSION and must not be passed when invoking this function.
alibRevision	The ALib sub-version required. Defaults to ALIB_REVISION and must not be passed when invoking this function.
compilationFlags	The flags as defined in invoking compilation unit. Defaults to ALIB_COMPILATION_FLAGS and must not be passed when invoking this function.

Definition at line 95 of file bootstrap.cpp.

Here is the call graph for this function:

◆ Bootstrap() [2/2]

ALIB_API void Bootstrap	(	int	alibVersion = ALIB_VERSION,
		int	alibRevision = ALIB_REVISION,
		TCompilationFlags	compilationFlags = TCompilationFlags{ALIB_COMPILATION_FLAGS} )

Performs standard bootstrapping of ALib . All details are explained in chapter 4. Bootstrapping And Shutting Down ALib of the ALib Programmer's Manual.

Note: In addition, function alib::AssertALibVersionAndFlags is invoked. For this, the parameters of this function must not be given, but left to their default values, which are read from corresponding preprocessor symbols.
For more information on this topic, see chapter 4.7 Assuring Compilation Compatibility of the ALib Programmer's Manual.

Parameters

alibVersion	The ALib version required. Defaults to ALIB_VERSION and must not be passed.
alibRevision	The ALib sub-version required. Defaults to ALIB_REVISION and must not be passed.
compilationFlags	The flags as defined in invoking compilation unit. Defaults to ALIB_COMPILATION_FLAGS and must not be passed.

Definition at line 72 of file alib.cpp.

Here is the call graph for this function:

◆ BootstrapAddDefaultCamps()

ALIB_API void BootstrapAddDefaultCamps ( )

Fills list alib::Camps, taking the permutation of modules contained in the ALib Distribution into account.
This function is usually invoked automatically.

For details on when and how to explicitly invoke this function, see the detailed explanations in chapter 4. Bootstrapping And Shutting Down ALib of the ALib Programmer's Manual.

Definition at line 83 of file bootstrap.cpp.

◆ ComplementDefaultWhitespaces()

constexpr ComplementCString ComplementDefaultWhitespaces ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::DefaultWhitespaces .

Returns: A zero-terminated string of default whitespace characters.

Definition at line 558 of file cstring.hpp.

Here is the call graph for this function:

◆ ComplementNewLine()

constexpr ComplementCString ComplementNewLine ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::NewLine .

Returns: A zero-terminated string containing the new-line character sequence.

Definition at line 532 of file cstring.hpp.

Here is the call graph for this function:

◆ DbgCheckSingleThreaded()

void DbgCheckSingleThreaded ( )

inline

This method stores the first thread that invokes it, and if in the future the method is visited by a different thread, it asserts.

In release compilations, this function is inlined and empty and therefore has not necessarily be removed by preprocessor macro ALIB_DBG or otherwise.

In debug-compilations, this is not empty, if:

Module ALib Threads is not included in the ALib Distribution (what disables thread-safeness throughout the library), and
Compiler symbol ALIB_EXT_LIB_THREADS_AVAILABLE was passed on library compilation, which allows to use the C++ thread library without causing linker failures.

If given, this function is called by macros ALIB_LOCK and ALIB_LOCK_WITH, which otherwise are defined by module ALib Threads . These macros will still be defined in the absence of that module. This exclamatory approach was made with ALib to motivate to write code that compiles with or without multi-threading support.

In addition to the invocation by these "remaining macro stubs", some other prominent entities, like lox::Lox , Formatter or monomem::AcquireGlobalAllocator invoke this method with acquisition.

Definition at line 226 of file alib.cpp.

◆ DefaultWhitespaces()

constexpr CString DefaultWhitespaces ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::DefaultWhitespaces .

Returns: A zero-terminated string of default whitespace characters.

Definition at line 554 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyComplementString()

constexpr ComplementCString EmptyComplementString ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::EmptyString .

Returns: A zero-terminated, empty string.

Definition at line 506 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyNString()

constexpr NCString EmptyNString ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::EmptyString .

Returns: A zero-terminated, empty string.

Definition at line 514 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyStrangeString()

constexpr StrangeCString EmptyStrangeString ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::EmptyString .

Returns: A zero-terminated, empty string.

Definition at line 510 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyString()

constexpr CString EmptyString ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::EmptyString .

Returns: A zero-terminated, empty string.

Definition at line 502 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyWString()

constexpr WCString EmptyWString ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::EmptyString .

Returns: A zero-terminated, empty string.

Definition at line 518 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyXString()

constexpr XCString EmptyXString ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::DefaultWhitespaces .

Returns: A zero-terminated, empty string.

Definition at line 522 of file cstring.hpp.

Here is the call graph for this function:

◆ NDefaultWhitespaces()

constexpr NCString NDefaultWhitespaces ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::DefaultWhitespaces .

Returns: A zero-terminated string of default whitespace characters.

Definition at line 566 of file cstring.hpp.

Here is the call graph for this function:

◆ NewLine()

constexpr CString NewLine ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::NewLine .

Returns: A zero-terminated string containing the new-line character sequence.

Definition at line 528 of file cstring.hpp.

Here is the call graph for this function:

◆ NNewLine()

constexpr NCString NNewLine ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::NewLine .

Returns: A zero-terminated string containing the new-line character sequence.

Definition at line 540 of file cstring.hpp.

Here is the call graph for this function:

◆ NullComplementString()

constexpr ComplementString NullComplementString ( )

inlineconstexpr

Inline shortcut method to create a constexpr nulled string of complementary character size.

Returns: A nulled string.

Definition at line 2502 of file string.hpp.

◆ NullNString()

constexpr NString NullNString ( )

inlineconstexpr

Inline shortcut method to create a constexpr nulled string of narrow character size.

Returns: A nulled string.

Definition at line 2510 of file string.hpp.

◆ NullStrangeString()

constexpr StrangeString NullStrangeString ( )

inlineconstexpr

Inline shortcut method to create a constexpr nulled string of strange character size.

Returns: A nulled string.

Definition at line 2506 of file string.hpp.

◆ NullString()

constexpr String NullString ( )

inlineconstexpr

Inline shortcut method to create a constexpr nulled string of standard character size.

Returns: A nulled string.

Definition at line 2498 of file string.hpp.

◆ NullWString()

constexpr WString NullWString ( )

inlineconstexpr

Inline shortcut method to create a constexpr nulled string of wide character size.

Returns: A nulled string.

Definition at line 2514 of file string.hpp.

◆ NullXString()

constexpr XString NullXString ( )

inlineconstexpr

Inline shortcut method to create a constexpr nulled string of strange character size.

Returns: A nulled string.

Definition at line 2518 of file string.hpp.

◆ operator&()

template<typename TInterface , TInterface TEnd, TInterface TBegin>

constexpr alib::lang::TBitSet< TInterface, TEnd, TBegin > operator&	(	const alib::lang::TBitSet< TInterface, TEnd, TBegin > &	lhs,
		const alib::lang::TBitSet< TInterface, TEnd, TBegin > &	rhs )

constexprnoexcept

Performs binary AND operation two TBitSet objects (of equal size), lhs and rhs .

Note: This operator function is located in the global namespace. The documentation shows namespace alib, which is done for the purposes of organizing the manual index better.

Parameters

lhs	The left hand side operand.
rhs	The right hand side operand.

Template Parameters

TEnd	Template parameter of class TBitSet. Deduced by the compiler.
TBegin	Template parameter of class TBitSet. Deduced by the compiler.
TInterface	Template parameter of class TBitSet. Deduced by the compiler.

Returns: A temporary TBitSet containing the result of the operation.

Definition at line 927 of file bitset.hpp.

Here is the call graph for this function:

◆ operator^()

template<typename TInterface , TInterface TEnd, TInterface TBegin>

constexpr alib::lang::TBitSet< TInterface, TEnd, TBegin > operator^	(	const alib::lang::TBitSet< TInterface, TEnd, TBegin > &	lhs,
		const alib::lang::TBitSet< TInterface, TEnd, TBegin > &	rhs )

constexprnoexcept

Performs binary XOR operation two TBitSet objects (of equal size), lhs and rhs .

Note: This operator function is located in the global namespace. The documentation shows namespace alib, which is done for the purposes of organizing the manual index better.

Parameters

lhs	The left hand side operand.
rhs	The right hand side operand.

Template Parameters

TEnd	Template parameter of class TBitSet. Deduced by the compiler.
TBegin	Template parameter of class TBitSet. Deduced by the compiler.
TInterface	Template parameter of class TBitSet. Deduced by the compiler.

Returns: A temporary TBitSet containing the result of the operation.

Definition at line 981 of file bitset.hpp.

Here is the call graph for this function:

◆ operator|()

template<typename TInterface , TInterface TEnd, TInterface TBegin>

constexpr alib::lang::TBitSet< TInterface, TEnd, TBegin > operator\|	(	const alib::lang::TBitSet< TInterface, TEnd, TBegin > &	lhs,
		const alib::lang::TBitSet< TInterface, TEnd, TBegin > &	rhs )

constexprnoexcept

Performs binary OR operation two TBitSet objects (of equal size), lhs and rhs .

Note: This operator function is located in the global namespace. The documentation shows namespace alib, which is done for the purposes of organizing the manual index better.

Parameters

lhs	The left hand side operand.
rhs	The right hand side operand.

Template Parameters

TEnd	Template parameter of class TBitSet. Deduced by the compiler.
TBegin	Template parameter of class TBitSet. Deduced by the compiler.
TInterface	Template parameter of class TBitSet. Deduced by the compiler.

Returns: A temporary TBitSet containing the result of the operation.

Definition at line 954 of file bitset.hpp.

Here is the call graph for this function:

◆ Shutdown() [1/2]

ALIB_API void Shutdown ( )

Terminates ALib . All details are explained in chapter 4. Bootstrapping And Shutting Down ALib of the ALib Programmer's Manual.

Definition at line 94 of file alib.cpp.

Here is the call graph for this function:

◆ Shutdown() [2/2]

ALIB_API void Shutdown	(	ShutdownPhases	targetPhase,
		lang::Camp *	targetCamp = nullptr )

This function is usually invoked automatically and rightfully with the standard, parameterless version alib::Shutdown().

For details on when and how to invoke this method explicitly, see the detailed explanations in chapter 4. Bootstrapping And Shutting Down ALib of the ALib Programmer's Manual.

Parameters

targetPhase	The termination level to perform.
targetCamp	The "lowest" ALib Camp in list Camps to shut down. Defaults to `nullptr`, which chooses the start of the list.

Definition at line 277 of file bootstrap.cpp.

Here is the call graph for this function:

◆ StrangeDefaultWhitespaces()

constexpr StrangeCString StrangeDefaultWhitespaces ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::DefaultWhitespaces .

Returns: A zero-terminated string of default whitespace characters.

Definition at line 562 of file cstring.hpp.

Here is the call graph for this function:

◆ StrangeNewLine()

constexpr StrangeCString StrangeNewLine ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::NewLine .

Returns: A zero-terminated string containing the new-line character sequence.

Definition at line 536 of file cstring.hpp.

Here is the call graph for this function:

◆ WDefaultWhitespaces()

constexpr WCString WDefaultWhitespaces ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::DefaultWhitespaces .

Returns: A zero-terminated string of default whitespace characters.

Definition at line 570 of file cstring.hpp.

Here is the call graph for this function:

◆ WNewLine()

constexpr WCString WNewLine ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::NewLine .

Returns: A zero-terminated string containing the new-line character sequence.

Definition at line 544 of file cstring.hpp.

Here is the call graph for this function:

◆ XDefaultWhitespaces()

constexpr XCString XDefaultWhitespaces ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::DefaultWhitespaces .

Returns: A zero-terminated string of default whitespace characters.

Definition at line 574 of file cstring.hpp.

Here is the call graph for this function:

◆ XNewLine()

constexpr XCString XNewLine ( )

inlineconstexpr

Inline shortcut to method TT_StringConstants::NewLine .

Returns: A zero-terminated string containing the new-line character sequence.

Definition at line 548 of file cstring.hpp.

Here is the call graph for this function:

Variable Details:

◆ ALOX

ALIB_API lox::ALox ALOX

The singleton instance of ALib Camp class ALox .

Definition at line 52 of file aloxmodule.cpp.

◆ ArgC

ALIB_API int ArgC = 0

The number of command line arguments. Defaults to 0.

Note: An application is responsible for setting this global variable in its main() function, in case the value is needed somewhere.

Definition at line 59 of file alib.cpp.

◆ ArgVN

ALIB_API const char ** ArgVN = nullptr

List of command line arguments if given as single byte character strings.

Note: An application is responsible for setting this global variable in its main() function, in case the value is needed somewhere.

Definition at line 60 of file alib.cpp.

◆ ArgVW

ALIB_API const wchar_t ** ArgVW = nullptr

List of command line arguments if given as multi-byte character strings.

Note: An application is responsible for setting this global variable in its main() function, in case the value is needed somewhere.

Definition at line 61 of file alib.cpp.

◆ BASECAMP

ALIB_API lang::basecamp::BaseCamp BASECAMP

The singleton instance of ALib Camp class BaseCamp .

Definition at line 136 of file basecamp.cpp.

◆ Camps

ALIB_API List<lang::Camp*> Camps

extern

Lists all ALib Camps in the order of bootstrapping. Shutdown is performed in reverse order. This list is used by overloaded functions

For details on when and how to manipulate this list explicitly, see the detailed explanations in chapter 4. Bootstrapping And Shutting Down ALib of the ALib Programmer's Manual.

◆ CLI

ALIB_API cli::Cli CLI

The singleton instance of ALib Camp class Cli .

Definition at line 30 of file cli.cpp.

◆ CompilationFlagMeanings

ALIB_API CompilationFlagMeaningsEntry CompilationFlagMeanings

Initial value:

=
          { {  0, "DEBUG"                            },
            {  1, "MONOMEM"                          },
            {  2, "SINGLETONS"                       },
            {  3, "CHARACTERS"                       },
            {  4, "ENUMS"                            },
            {  5, "TIME"                             },
            {  6, "BOXING"                           },
            {  7, "STRINGS"                          },
            {  8, "BITBUFFER"                        },
            {  9, "THREADS"                          },
            { 10, "CAMP"                              },
            { 11, "ALOX"                             },
            { 12, "CLI"                              },
            { 13, "CONFIGURATION"                    },
            { 14, "EXPRESSIONS"                      },
            { 15, "FILES"                            },
            { 16, "FEAT_SINGLETON_MAPPED"            },
            { 17, "CHARACTERS_WIDE"                  },
            { 18, "CHARACTERS_WCHAR_IS_4"            },
            { 19, "FEAT_BOXING_BIJECTIVE_INTEGRALS"  },
            { 20, "FEAT_BOXING_BIJECTIVE_CHARACTERS" },
            { 21, "FEAT_BOXING_BIJECTIVE_FLOATS"     },
            { 22, "DEBUG_BOXING"                     },
            { 23, "DEBUG_STRINGS"                    },
            { 24, "DEBUG_MONOMEM"                    },
            { 25, "DEBUG_RESOURCES"                  },
            { 26, "DBG_LOG"                          },
            { 27, "DBG_LOG_CI"                       },
            { 28, "REL_LOG"                          },
            { 29, "REL_LOG_CI"                       },
          }

This is for the creation of output on information about the bits found in field CompilationFlags. Declared public to allow exposure, e.g. in verbose logging.

See also: Method AssertALibVersionAndFlags for more information.

Definition at line 105 of file alib.cpp.

◆ CompilationFlags

ALIB_API TCompilationFlags CompilationFlags = {ALIB_COMPILATION_FLAGS}

These flags are used internally to detect incompatibilities when linking ALib to binaries that use different compilation flags. Declared public to allow exposure, e.g. in verbose logging.

See also: Function AssertALibVersionAndFlags, which is invoked by overloaded functions Bootstrap.

Definition at line 68 of file alib.cpp.

◆ CONFIG

ALIB_API config::Config CONFIG

The singleton instance of ALib Camp class Config .

Definition at line 40 of file config.cpp.

◆ DirectorySeparator

constexpr nchar DirectorySeparator

constexpr

The standard path separator character. Defaults to '\' on Windows OS, '/' else. Note: Available with including "alib/lang/system/directory.hpp"

Definition at line 248 of file directory.hpp.

◆ EMPTY_COMPLEMENT_STRING

ComplementCString EMPTY_COMPLEMENT_STRING = A_CCHAR ("")

A global instance of a nulled zero-terminated string of complementary character size.

Definition at line 477 of file string.cpp.

◆ EMPTY_N_STRING

NCString EMPTY_N_STRING = A_NCHAR ("")

A global instance of a nulled zero-terminated string of wide character size.

Definition at line 479 of file string.cpp.

◆ EMPTY_STRANGE_STRING

StrangeCString EMPTY_STRANGE_STRING = A_SCHAR ("")

A global instance of a nulled zero-terminated string of strange character size.

Definition at line 478 of file string.cpp.

◆ EMPTY_STRING

CString EMPTY_STRING = A_CHAR ("")

A global instance of a nulled zero-terminated string of standard character size.

Definition at line 476 of file string.cpp.

◆ EMPTY_W_STRING

WCString EMPTY_W_STRING = A_WCHAR ("")

A global instance of a nulled zero-terminated string of wide character size.

Definition at line 480 of file string.cpp.

◆ EMPTY_X_STRING

XString EMPTY_X_STRING = A_XCHAR ("")

A global instance of a nulled zero-terminated string of strange character size.

Definition at line 481 of file string.cpp.

◆ EXPRESSIONS

ALIB_API expressions::Expressions EXPRESSIONS

The singleton instance of ALib Camp class Expressions .

Definition at line 41 of file expressions.cpp.

◆ FILES

ALIB_API files::Files FILES

The singleton instance of ALib Camp class Files .

Definition at line 30 of file filescamp.cpp.

◆ NonCampModulesInitialized

bool NonCampModulesInitialized = false

State of initialization of the ALib Modules that do not dispose over a lang::Camp . instance.

Definition at line 63 of file alib.cpp.

◆ NULL_COMPLEMENT_STRING

ALIB_API ComplementString NULL_COMPLEMENT_STRING = nullptr

A global instance of a nulled string of complementary character size.

Definition at line 471 of file string.cpp.

◆ NULL_N_STRING

ALIB_API NString NULL_N_STRING = nullptr

A global instance of a nulled string of wide character size.

Definition at line 473 of file string.cpp.

◆ NULL_STRANGE_STRING

ALIB_API StrangeString NULL_STRANGE_STRING = nullptr

A global instance of a nulled string of strange character size.

Definition at line 472 of file string.cpp.

◆ NULL_STRING

ALIB_API String NULL_STRING = nullptr

A global instance of a nulled string of standard character size.

Definition at line 470 of file string.cpp.

◆ NULL_W_STRING

ALIB_API WString NULL_W_STRING = nullptr

A global instance of a nulled string of wide character size.

Definition at line 474 of file string.cpp.

◆ NULL_X_STRING

ALIB_API XString NULL_X_STRING = nullptr

A global instance of a nulled string of strange character size.

Definition at line 475 of file string.cpp.

◆ Revision

ALIB_API unsigned char Revision = ALIB_REVISION

The revision number of this release. Usually a module is initially released as revision 0. Pure bug-fix releases that do not change the interface of ALib are holding the same Version but an increased number in this field.

Definition at line 66 of file alib.cpp.

◆ Version

ALIB_API int Version = ALIB_VERSION

The module version. Standard ALib versioning scheme is YYMM (as integer number) of the module release date. Besides this version number, field Revision indicates if this is a revised version of a former release.

Definition at line 65 of file alib.cpp.

Description:

1. Introduction

2. Type Aliases In Namespace alib

3. Domain-Specific Constants and Variables

4. Documentation

Reference Documentation

Nested Namespaces:

Type Index:

Type Definition Index:

Enumeration Index:

Function Index:

Variable Index:

Type Definition Details:

◆ ALox

◆ ALoxReportWriter

◆ AnsiConsoleLogger

◆ AnsiLogger

◆ ArrayCompressor

◆ AString

◆ AutoSizes

◆ BitBuffer

◆ BitBufferLocal

◆ BitBufferMA

◆ BitReader

◆ BitSet

◆ BitWriter

◆ Box

◆ Boxes

◆ ByteSize

◆ ByteSizeIEC

◆ ByteSizeSI

◆ ByteSizeUnits

◆ Calculus

◆ CalendarDate

◆ CalendarDateTime

◆ CalendarDuration

◆ character

◆ CLIUtil

◆ CommandLine

◆ Compiler

◆ CompilerPlugin

◆ ComplementAString

◆ complementChar

◆ ComplementCString

◆ ComplementFormat

◆ ComplementLocalString

◆ ComplementMAString

◆ ComplementNumberFormat

◆ ComplementString

◆ ComplementStringLengthResetter

◆ ComplementStringNZT

◆ ComplementSubstring

◆ Configuration

◆ Console

◆ ConsoleLogger

◆ CString

◆ DateTime

◆ DbgBoxing

◆ Directory

◆ Enum

◆ EnumBitSet

◆ EnumIterator

◆ EnumRecords

◆ EnvironmentVariables

◆ ESC

◆ Exception

◆ ExpressionFormatter

◆ ExpressionScope

◆ FAppend

◆ FClone

◆ FEquals

◆ FFilter

◆ FHashcode

◆ FileExpressions

◆ FInfo

◆ FIsLess

◆ FIsNotNull

◆ FIsTrue

◆ FixedCapacityVector

◆ FixedSizePriorityQueue