1. Introduction

This namespace documented here, namely

aworx

is the outer namespace for C++ software published by A-Worx GmbH, Germany.

While the Java language strongly proposes to use the complete 'reverse domain' name and therefore Java code published by A-Worx GmbH resides in namespace

com.aworx,

for C# the prefix 'com.' is changed to 'cs.'. This way, the C# version of this namespace is

cs.aworx

This distinction is needed to avoid ambiguities within the documentation system (Doxygen ) which is used in scenarios of mixed documentation of similar code written in different languages.

Besides nested namespaces, there are no functions or types defined in this namespace. The C++ language, has one important exception to this rule, as described in the next paragraph.

2. Type Aliases In Namespace aworx

ALib C++ Library and other software of A-Worx GmbH, "mirror" important types into namespace aworx with using statements. For example, by having

 using  Compiler=   aworx::lib::expressions::Compiler;

stated within namespace aworx (but in the header file of class aworx::lib::expressions::Compiler!), this class is made available with just adding

 using namespace aworx;

to a source file. This is convenient when ALib is used in 3rd party code outside of the aworx namespace, but also for the classes of ALib itself, which are organized in "modules", which are located in 'sibling-namespaces' beyond aworx::lib. All classes of these modules may refer to all classes in other modules just due to the "mirroring" of the type in this joint parent namespace aworx. This way, only seldom an explicit namespace has to be given within the ALib sources.

So, while code that is located inside a sub-namespace 'sees' all types defined in parent namespaces, with code that is located elsewhere and is just "using" a sub-namespace of ALib, this is different. Types in parent namespaces here are not automatically 'seen' when a sub-namespace is "used".

This is an important difference and a great design decision of the C++ language! As a conclusion, a user of libraries (types) residing in sub-namespaces of aworx, has different choices on selecting namespaces with using statement:

using namespace aworx; // see all types as 'mirror' types
using namespace aworx::abc::xyz; // see only types of distinct namespace
or: do not 'use' any namespace but select A-Worx types by full qualified name.

To summarize, the effect of mirroring the main interface classes is as follows:

Inside header files of sub-namespaces (and their sub-namespaces) of aworx, e.g. aworx::lib and aworx::lib::lox, these names are visible and used.
Inside external header files, they are not visible but might be quite shortly accessed using namespace prefix "aworx::" (addressing the mirrored type alias).
Inside external cpp-files, if no collision with other libraries or local classes exist, all types of all A-Worx libraries included by header files, can be made visible with one single using statement for namespace aworx. Should collisions occur, then still selected classes of A-Worx libraries that do not collide can be made visible by choosing the complete namespace name for the using statement.
Of-course, the mirrored class names appear only in this namespace aworx, if the corresponding header file of the original class is included in a compilation unit.

3. Domain-Specific Constants and Variables

Similar to the concept of mirroring important interface classes into this namespace aworx (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/system/directory.hpp, respectively alib/strings/cstring.hpp is included.

4. This Documentation

You are reading the documentation of this namespace generated with the documentation of ALib C++ Library. For this reason, all "mirrored" types of ALib will be presented below. Note that for the reasons explained above, with other library/software documentation, other types will appear in the documentation of this namespace.

Reference Documentation

Nested namespaces
	lib

Typedefs
using	Alignment = lib::Alignment

using	ALox = lib::lox::ALox
	Type alias in namespace aworx.

using	ALoxReportWriter = lib::lox::ALoxReportWriter
	Type alias in namespace aworx.

using	AnsiConsoleLogger = lib::lox::loggers::AnsiConsoleLogger
	Type alias in namespace aworx.

using	AnsiLogger = lib::lox::loggers::AnsiLogger
	Type alias in namespace aworx.

using	ArrayCompressor = lib::bitbuffer::ac_v1::ArrayCompressor

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

using	AutoSizes = lib::strings::util::AutoSizes
	Type alias in namespace aworx.

using	BitBuffer = lib::bitbuffer::BitBuffer
	Type alias in namespace aworx.

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

using	BitBufferMA = lib::bitbuffer::BitBufferMA
	Type alias in namespace aworx.

using	BitReader = lib::bitbuffer::BitReader
	Type alias in namespace aworx.

using	BitWriter = lib::bitbuffer::BitWriter
	Type alias in namespace aworx.

using	Bool = lib::Bool

using	BootstrapPhases = lib::Module::BootstrapPhases
	Type alias in namespace aworx.

using	Box = lib::boxing::Box
	Type alias in namespace aworx.

using	Boxes = lib::boxing::Boxes
	Type alias in namespace aworx.

using	Caching = lib::Caching

using	Calculus = lib::expressions::plugins::Calculus
	Type alias in namespace aworx.

using	CalendarDate = lib::system::CalendarDate
	Type alias in namespace aworx.

using	CalendarDateTime = lib::system::CalendarDateTime
	Type alias in namespace aworx.

using	CalendarDuration = lib::system::CalendarDuration
	Type alias in namespace aworx.

using	Case = lib::Case

using	character = lib::characters::character
	Type alias in namespace aworx.

using	CLIUtil = lib::cli::CLIUtil
	Type alias in namespace aworx.

using	CommandLine = lib::cli::CommandLine
	Type alias in namespace aworx.

using	Compiler = lib::expressions::Compiler
	Type alias in namespace aworx.

using	CompilerPlugin = lib::expressions::CompilerPlugin
	Type alias in namespace aworx.

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

using	complementChar = lib::characters::complementChar
	Type alias in namespace aworx.

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

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

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

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

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

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

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

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

using	Configuration = lib::config::Configuration
	Type alias in namespace aworx.

using	Console = lib::system::Console
	Type alias in namespace aworx.

using	ConsoleLogger = lib::lox::loggers::ConsoleLogger
	Type alias in namespace aworx.

using	ContainerOp = lib::ContainerOp

using	CreateDefaults = lib::CreateDefaults

using	CreateIfNotExists = lib::CreateIfNotExists

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

using	CurrentData = lib::CurrentData

using	DateTime = lib::time::DateTime
	Type alias in namespace aworx.

using	DbgBoxing = lib::boxing::DbgBoxing
	Type alias in namespace aworx.

using	Directory = lib::system::Directory
	Type alias in namespace aworx.

using	Enum = lib::boxing::Enum
	Type alias in namespace aworx.

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

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

using	EnvironmentVariables = lib::system::EnvironmentVariables
	Type alias in namespace aworx.

using	ESC = lib::lox::ESC
	Type alias in namespace aworx.

using	Exception = lib::results::Exception
	Type alias in namespace aworx.

using	ExpressionFormatter = lib::expressions::util::ExpressionFormatter
	Type alias in namespace aworx.

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

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

using	FClone = lib::boxing::FClone
	Type alias in namespace aworx.

using	FEquals = lib::boxing::FEquals
	Type alias in namespace aworx.

using	FHashcode = lib::boxing::FHashcode
	Type alias in namespace aworx.

using	FIsLess = lib::boxing::FIsLess
	Type alias in namespace aworx.

using	FIsNotNull = lib::boxing::FIsNotNull
	Type alias in namespace aworx.

using	FIsTrue = lib::boxing::FIsTrue
	Type alias in namespace aworx.

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

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

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

using	Formatter = lib::text::Formatter
	Type alias in namespace aworx.

using	FormatterJavaStyle = lib::text::FormatterJavaStyle
	Type alias in namespace aworx.

using	FormatterPythonStyle = lib::text::FormatterPythonStyle
	Type alias in namespace aworx.

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

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

using	HuffmanDecoder = lib::bitbuffer::ac_v1::HuffmanDecoder

using	HuffmanEncoder = lib::bitbuffer::ac_v1::HuffmanEncoder

using	Inclusion = lib::Inclusion

using	IniFile = lib::config::IniFile
	Type alias in namespace aworx.

using	Initialization = lib::Initialization

using	InMemoryPlugin = lib::config::InMemoryPlugin
	Type alias in namespace aworx.

using	integer = lib::integer
	Type alias in namespace aworx.

using	intGap_t = lib::intGap_t
	Type alias in namespace aworx.

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

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

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

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

using	Log = lib::lox::Log
	Type alias in namespace aworx.

using	Logger = lib::lox::detail::Logger
	Type alias in namespace aworx.

using	LogTools = lib::lox::LogTools
	Type alias in namespace aworx.

using	Lox = lib::lox::Lox
	Type alias in namespace aworx.

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

using	MemoryLogger = lib::lox::loggers::MemoryLogger
	Type alias in namespace aworx.

using	MonoAllocator = lib::monomem::MonoAllocator
	Type alias in namespace aworx.

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

using	nchar = lib::characters::nchar
	Type alias in namespace aworx.

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

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

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

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

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

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

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	NStringNZT = lib::strings::TStringNZT< nchar >
	Type alias in namespace aworx.

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

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

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

using	Paragraphs = lib::text::Paragraphs
	Type alias in namespace aworx.

using	Phase = lib::Phase

using	Priorities = aworx::lib::config::Priorities
	Type alias in namespace aworx.

using	ProcessInfo = lib::system::ProcessInfo
	Type alias in namespace aworx.

using	Propagation = lib::Propagation

using	PropertyFormatter = lib::text::PropertyFormatter
	Type alias in namespace aworx.

template<typename TFormattable , typename TOptionEnum >
using	PropertyFormatters = lib::text::PropertyFormatters< TFormattable, TOptionEnum >
	Type alias in namespace aworx.

using	Reach = lib::Reach

using	Recycling = lib::monomem::Recycling
	Type alias in namespace aworx.

using	RegexMatcher = lib::strings::util::RegexMatcher
	Type alias in namespace aworx.

template<typename T >
using	ResourcedType = lib::resources::ResourcedType< T >
	Type alias in namespace aworx.

using	ResourceInfo = lib::resources::ResourceInfo
	Type alias in namespace aworx.

using	ResourcePool = lib::resources::ResourcePool
	Type alias in namespace aworx.

using	Responsibility = lib::Responsibility

using	RTTRAllocator = lib::monomem::util::RTTRAllocator
	Type alias in namespace aworx.

using	Runnable = lib::threads::Runnable
	Type alias in namespace aworx.

using	Safeness = lib::Safeness

using	Scope = lib::lox::Scope
	Type alias in namespace aworx.

using	ShiftOpRHS = int
	Type alias in namespace aworx.

using	ShutdownPhases = lib::Module::ShutdownPhases
	Type alias in namespace aworx.

using	Side = lib::Side

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

using	Sleeper = lib::threads::Sleeper
	Type alias in namespace aworx.

using	SmartLock = lib::threads::SmartLock
	Type alias in namespace aworx.

using	SortOrder = lib::SortOrder

using	SourceData = lib::SourceData

using	Spaces = lib::strings::util::Spaces
	Type alias in namespace aworx.

using	SPExpression = lib::expressions::SPExpression
	Type alias in namespace aworx.

using	SPFormatter = std::shared_ptr< lib::text::Formatter >

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

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

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

using	StopWatch = lib::time::StopWatch
	Type alias in namespace aworx.

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

using	strangeChar = lib::characters::strangeChar
	Type alias in namespace aworx.

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

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

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

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

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

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

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

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

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

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	StringNZT = lib::strings::TStringNZT< character >
	Type alias in namespace aworx.

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

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

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

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

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

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

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

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

using	Switch = lib::Switch

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

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

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

template<typename T >
using	T_Resourced = lib::resources::T_Resourced< T >
	Type alias in namespace aworx.

using	TextFileLogger = lib::lox::loggers::TextFileLogger
	Type alias in namespace aworx.

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

using	Thread = lib::threads::Thread
	Type alias in namespace aworx.

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

using	ThreadLock = lib::threads::ThreadLock
	Type alias in namespace aworx.

using	ThreadLockNR = lib::threads::ThreadLockNR
	Type alias in namespace aworx.

using	TickConverter = lib::time::TickConverter
	Type alias in namespace aworx.

using	Ticks = lib::time::Ticks
	Type alias in namespace aworx.

using	Timezone = lib::Timezone

using	Timing = lib::Timing

using	Token = lib::strings::util::Token
	Type alias in namespace aworx.

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

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

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

using	TypeFunctors = aworx::lib::compatibility::std::TypeFunctors
	Type alias in namespace aworx.

using	uinteger = lib::uinteger
	Type alias in namespace aworx.

using	uintGap_t = lib::uintGap_t
	Type alias in namespace aworx.

using	Variable = lib::config::Variable
	Type alias in namespace aworx.

using	VariableDecl = lib::config::VariableDecl
	Type alias in namespace aworx.

using	Verbosity = lib::lox::Verbosity
	Type alias in namespace aworx.

using	VStudioLogger = lib::lox::loggers::VStudioLogger
	Type alias in namespace aworx.

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

using	wchar = lib::characters::wchar
	Type alias in namespace aworx.

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

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

using	Whitespaces = lib::Whitespaces

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

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

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

using	WindowsConsoleLogger = lib::lox::loggers::WindowsConsoleLogger
	Type alias in namespace aworx.

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

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

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

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

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	WStringNZT = lib::strings::TStringNZT< wchar >
	Type alias in namespace aworx.

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

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

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

using	xchar = lib::characters::xchar
	Type alias in namespace aworx.

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

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

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

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

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

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

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

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

Variables
lib::ALibDistribution	ALIB

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.

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.

Functions
ALIB_CPP14_CONSTEXPR ComplementCString	ComplementDefaultWhitespaces ()

ALIB_CPP14_CONSTEXPR ComplementCString	ComplementNewLine ()

ALIB_CPP14_CONSTEXPR CString	DefaultWhitespaces ()

ALIB_CPP14_CONSTEXPR ComplementCString	EmptyComplementString ()

ALIB_CPP14_CONSTEXPR NCString	EmptyNString ()

ALIB_CPP14_CONSTEXPR StrangeCString	EmptyStrangeString ()

ALIB_CPP14_CONSTEXPR CString	EmptyString ()

ALIB_CPP14_CONSTEXPR WCString	EmptyWString ()

ALIB_CPP14_CONSTEXPR XCString	EmptyXString ()

ALIB_CPP14_CONSTEXPR NCString	NDefaultWhitespaces ()

ALIB_CPP14_CONSTEXPR CString	NewLine ()

ALIB_CPP14_CONSTEXPR NCString	NNewLine ()

constexpr ComplementString	NullComplementString ()

constexpr NString	NullNString ()

constexpr StrangeString	NullStrangeString ()

constexpr String	NullString ()

constexpr WString	NullWString ()

constexpr XString	NullXString ()

ALIB_CPP14_CONSTEXPR StrangeCString	StrangeDefaultWhitespaces ()

ALIB_CPP14_CONSTEXPR StrangeCString	StrangeNewLine ()

ALIB_CPP14_CONSTEXPR WCString	WDefaultWhitespaces ()

ALIB_CPP14_CONSTEXPR WCString	WNewLine ()

ALIB_CPP14_CONSTEXPR XCString	XDefaultWhitespaces ()

ALIB_CPP14_CONSTEXPR XCString	XNewLine ()

Typedef Documentation

◆ Alignment

using Alignment = lib::Alignment

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 40 of file commonenumdefs_aliased.hpp.

◆ ArrayCompressor

using ArrayCompressor = lib::bitbuffer::ac_v1::ArrayCompressor

Type alias in namespace aworx pointing to the sub-namespace within aworx::lib::bitbuffer which provides the current version of array compression.

See also: Namespace aworx::lib::bitbuffer::ac_v1 for more information.

Definition at line 21 of file arraycompressor.hpp.

◆ Bool

using Bool = lib::Bool

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 28 of file commonenumdefs_aliased.hpp.

◆ Caching

using Caching = lib::Caching

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 112 of file commonenumdefs_aliased.hpp.

◆ Case

using Case = lib::Case

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 36 of file commonenumdefs_aliased.hpp.

◆ ContainerOp

using ContainerOp = lib::ContainerOp

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 100 of file commonenumdefs_aliased.hpp.

◆ CreateDefaults

using CreateDefaults = lib::CreateDefaults

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 88 of file commonenumdefs_aliased.hpp.

◆ CreateIfNotExists

using CreateIfNotExists = lib::CreateIfNotExists

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 84 of file commonenumdefs_aliased.hpp.

◆ CurrentData

using CurrentData = lib::CurrentData

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 56 of file commonenumdefs_aliased.hpp.

◆ FixedSizePriorityQueue

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

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

Definition at line 121 of file fixedcapacityvector.hpp.

◆ HuffmanDecoder

using HuffmanDecoder = lib::bitbuffer::ac_v1::HuffmanDecoder

Type alias in namespace aworx pointing to the sub-namespace within aworx::lib::bitbuffer which provides the current version of array compression.

See also: Namespace aworx::lib::bitbuffer::ac_v1 for more information.

Definition at line 31 of file arraycompressor.hpp.

◆ HuffmanEncoder

using HuffmanEncoder = lib::bitbuffer::ac_v1::HuffmanEncoder

Type alias in namespace aworx pointing to the sub-namespace within aworx::lib::bitbuffer which provides the current version of array compression.

See also: Namespace aworx::lib::bitbuffer::ac_v1 for more information.

Definition at line 26 of file arraycompressor.hpp.

◆ Inclusion

using Inclusion = lib::Inclusion

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 48 of file commonenumdefs_aliased.hpp.

◆ Initialization

using Initialization = lib::Initialization

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 104 of file commonenumdefs_aliased.hpp.

◆ Phase

using Phase = lib::Phase

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 96 of file commonenumdefs_aliased.hpp.

◆ Propagation

using Propagation = lib::Propagation

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 92 of file commonenumdefs_aliased.hpp.

◆ Reach

using Reach = lib::Reach

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 52 of file commonenumdefs_aliased.hpp.

◆ Responsibility

using Responsibility = lib::Responsibility

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 68 of file commonenumdefs_aliased.hpp.

◆ Safeness

using Safeness = lib::Safeness

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 64 of file commonenumdefs_aliased.hpp.

◆ Side

using Side = lib::Side

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 76 of file commonenumdefs_aliased.hpp.

◆ SortOrder

using SortOrder = lib::SortOrder

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 44 of file commonenumdefs_aliased.hpp.

◆ SourceData

using SourceData = lib::SourceData

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 60 of file commonenumdefs_aliased.hpp.

◆ SPFormatter

using SPFormatter = std::shared_ptr<lib::text::Formatter>

Shared pointer to instances of standard formatters.

See also: Method Formatter::GetDefault.

Definition at line 81 of file text/fwds.hpp.

◆ Switch

using Switch = lib::Switch

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 32 of file commonenumdefs_aliased.hpp.

◆ Timezone

using Timezone = lib::Timezone

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 72 of file commonenumdefs_aliased.hpp.

◆ Timing

using Timing = lib::Timing

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 108 of file commonenumdefs_aliased.hpp.

◆ Whitespaces

using Whitespaces = lib::Whitespaces

Type alias in namespace aworx. Available only with inclusion of alib/lib/fs_commonenums/commonenumdefs_aliased.hpp

Definition at line 80 of file commonenumdefs_aliased.hpp.

Function Documentation

◆ ComplementDefaultWhitespaces()

ALIB_CPP14_CONSTEXPR ComplementCString aworx::ComplementDefaultWhitespaces ( )

inline

Inline shortcut to method TT_StringConstants<complementChar>::DefaultWhitespaces.

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

Definition at line 563 of file cstring.hpp.

Here is the call graph for this function:

◆ ComplementNewLine()

ALIB_CPP14_CONSTEXPR ComplementCString aworx::ComplementNewLine ( )

inline

Inline shortcut to method TT_StringConstants<complementChar>::NewLine.

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

Definition at line 537 of file cstring.hpp.

Here is the call graph for this function:

◆ DefaultWhitespaces()

ALIB_CPP14_CONSTEXPR CString aworx::DefaultWhitespaces ( )

inline

Inline shortcut to method TT_StringConstants<character>::DefaultWhitespaces.

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

Definition at line 559 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyComplementString()

ALIB_CPP14_CONSTEXPR ComplementCString aworx::EmptyComplementString ( )

inline

Inline shortcut to method TT_StringConstants<complementChar>::EmptyString.

Returns: A zero-terminated, empty string.

Definition at line 511 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyNString()

ALIB_CPP14_CONSTEXPR NCString aworx::EmptyNString ( )

inline

Inline shortcut to method TT_StringConstants<nchar>::EmptyString.

Returns: A zero-terminated, empty string.

Definition at line 519 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyStrangeString()

ALIB_CPP14_CONSTEXPR StrangeCString aworx::EmptyStrangeString ( )

inline

Inline shortcut to method TT_StringConstants<strangeChar>::EmptyString.

Returns: A zero-terminated, empty string.

Definition at line 515 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyString()

ALIB_CPP14_CONSTEXPR CString aworx::EmptyString ( )

inline

Inline shortcut to method TT_StringConstants<character>::EmptyString.

Returns: A zero-terminated, empty string.

Definition at line 507 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyWString()

ALIB_CPP14_CONSTEXPR WCString aworx::EmptyWString ( )

inline

Inline shortcut to method TT_StringConstants<wchar>::EmptyString.

Returns: A zero-terminated, empty string.

Definition at line 523 of file cstring.hpp.

Here is the call graph for this function:

◆ EmptyXString()

ALIB_CPP14_CONSTEXPR XCString aworx::EmptyXString ( )

inline

Inline shortcut to method TT_StringConstants<xchar>::DefaultWhitespaces.

Returns: A zero-terminated, empty string.

Definition at line 527 of file cstring.hpp.

Here is the call graph for this function:

◆ NDefaultWhitespaces()

ALIB_CPP14_CONSTEXPR NCString aworx::NDefaultWhitespaces ( )

inline

Inline shortcut to method TT_StringConstants<nchar>::DefaultWhitespaces.

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

Definition at line 571 of file cstring.hpp.

Here is the call graph for this function:

◆ NewLine()

ALIB_CPP14_CONSTEXPR CString aworx::NewLine ( )

inline

Inline shortcut to method TT_StringConstants<character>::NewLine.

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

Definition at line 533 of file cstring.hpp.

Here is the call graph for this function:

◆ NNewLine()

ALIB_CPP14_CONSTEXPR NCString aworx::NNewLine ( )

inline

Inline shortcut to method TT_StringConstants<nchar>::NewLine.

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

Definition at line 545 of file cstring.hpp.

Here is the call graph for this function:

◆ NullComplementString()

constexpr ComplementString aworx::NullComplementString ( )

inlineconstexpr

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

Returns: A nulled string.

Definition at line 2467 of file string.hpp.

◆ NullNString()

constexpr NString aworx::NullNString ( )

inlineconstexpr

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

Returns: A nulled string.

Definition at line 2475 of file string.hpp.

◆ NullStrangeString()

constexpr StrangeString aworx::NullStrangeString ( )

inlineconstexpr

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

Returns: A nulled string.

Definition at line 2471 of file string.hpp.

◆ NullString()

constexpr String aworx::NullString ( )

inlineconstexpr

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

Returns: A nulled string.

Definition at line 2463 of file string.hpp.

◆ NullWString()

constexpr WString aworx::NullWString ( )

inlineconstexpr

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

Returns: A nulled string.

Definition at line 2479 of file string.hpp.

◆ NullXString()

constexpr XString aworx::NullXString ( )

inlineconstexpr

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

Returns: A nulled string.

Definition at line 2483 of file string.hpp.

◆ StrangeDefaultWhitespaces()

ALIB_CPP14_CONSTEXPR StrangeCString aworx::StrangeDefaultWhitespaces ( )

inline

Inline shortcut to method TT_StringConstants<strangeChar>::DefaultWhitespaces.

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

Definition at line 567 of file cstring.hpp.

Here is the call graph for this function:

◆ StrangeNewLine()

ALIB_CPP14_CONSTEXPR StrangeCString aworx::StrangeNewLine ( )

inline

Inline shortcut to method TT_StringConstants<strangeChar>::NewLine.

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

Definition at line 541 of file cstring.hpp.

Here is the call graph for this function:

◆ WDefaultWhitespaces()

ALIB_CPP14_CONSTEXPR WCString aworx::WDefaultWhitespaces ( )

inline

Inline shortcut to method TT_StringConstants<wchar>::DefaultWhitespaces.

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

Definition at line 575 of file cstring.hpp.

Here is the call graph for this function:

◆ WNewLine()

ALIB_CPP14_CONSTEXPR WCString aworx::WNewLine ( )

inline

Inline shortcut to method TT_StringConstants<wchar>::NewLine.

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

Definition at line 549 of file cstring.hpp.

Here is the call graph for this function:

◆ XDefaultWhitespaces()

ALIB_CPP14_CONSTEXPR XCString aworx::XDefaultWhitespaces ( )

inline

Inline shortcut to method TT_StringConstants<xchar>::DefaultWhitespaces.

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

Definition at line 579 of file cstring.hpp.

Here is the call graph for this function:

◆ XNewLine()

ALIB_CPP14_CONSTEXPR XCString aworx::XNewLine ( )

inline

Inline shortcut to method TT_StringConstants<xchar>::NewLine.

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

Definition at line 553 of file cstring.hpp.

Here is the call graph for this function:

Variable Documentation

◆ ALIB

ALIB_API lib::ALibDistribution ALIB

The singleton of module-class ALibDistribution.

Definition at line 125 of file distribution.cpp.

◆ DirectorySeparator

constexpr nchar DirectorySeparator

constexpr

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

Definition at line 255 of file directory.hpp.

1. Introduction

2. Type Aliases In Namespace aworx

3. Domain-Specific Constants and Variables

4. This Documentation

Reference Documentation

Nested namespaces

Typedefs

Variables

Functions

Typedef Documentation

◆ Alignment

◆ ArrayCompressor

◆ Bool

◆ Caching

◆ Case

◆ ContainerOp

◆ CreateDefaults

◆ CreateIfNotExists

◆ CurrentData

◆ FixedSizePriorityQueue

◆ HuffmanDecoder

◆ HuffmanEncoder

◆ Inclusion

◆ Initialization

◆ Phase

◆ Propagation

◆ Reach

◆ Responsibility

◆ Safeness

◆ Side

◆ SortOrder

◆ SourceData

◆ SPFormatter

◆ Switch

◆ Timezone

◆ Timing

◆ Whitespaces

Function Documentation

◆ ComplementDefaultWhitespaces()

◆ ComplementNewLine()

◆ DefaultWhitespaces()

◆ EmptyComplementString()

◆ EmptyNString()

◆ EmptyStrangeString()

◆ EmptyString()

◆ EmptyWString()

◆ EmptyXString()

◆ NDefaultWhitespaces()

◆ NewLine()

◆ NNewLine()

◆ NullComplementString()

◆ NullNString()

◆ NullStrangeString()

◆ NullString()

◆ NullWString()

◆ NullXString()

◆ StrangeDefaultWhitespaces()

◆ StrangeNewLine()

◆ WDefaultWhitespaces()

◆ WNewLine()

◆ XDefaultWhitespaces()

◆ XNewLine()

Variable Documentation

◆ ALIB

◆ DirectorySeparator