path.hpp File Reference

Description:

This header file is part of sub-namespace alib::lang::system of module ALib BaseCamp of the ALib C++ Library.

© 2013-2024 A-Worx GmbH, Germany. Published under Boost Software License.

Definition in file path.hpp.

#include "alib/lang/system/systemerrors.hpp"
#include "alib/strings/stringnzt.hpp"
#include "alib/monomem/poolallocator.hpp"
#include <filesystem>

Include dependency graph for path.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Path

Namespaces
namespace	alib
namespace	alib::lang
namespace	alib::lang::system
	This is the reference documentation of sub-namespace system of module ALib BaseCamp.

Macros
ALib Module BaseCamp Feature Selection
#define	ALIB_PATH_CHARACTERS_WIDE   1
ALib Module BaseCamp
The macros in this section are introduced by inner namespace alib::lang::resources of camp ALib BaseCamp.
#define	A_PATH(literal)
#define	ALIB_PATH_TO_NARROW( src, dest, bufSize)
#define	ALIB_PATH_TO_NARROW_ARG( src, bufSize)
#define	ALIB_PATH_TO_STRING( src, dest, bufSize)
#define	ALIB_PATH_TO_STRING_ARG( src, bufSize)
#define	ALIB_STRING_TO_PATH( src, dest, bufSize)
#define	ALIB_STRING_TO_PATH_ARG( src, bufSize)

Typedefs
using	CPathString = strings::TCString<PathCharType>
	The string-type used with this ALib Module.
using	Path = lang::system::Path
	Type alias in namespace alib.
using	PathCharType = std::filesystem::path::value_type
using	PathString = strings::TString<PathCharType>
	The string-type used with this ALib Module.
using	PathStringMA = strings::TAString<PathCharType, PoolAllocator >
	A mono-allocated string representing a path.
using	PathStringPA = strings::TAString<PathCharType, PoolAllocator >
	A pool-allocated string representing a path.
using	PathSubstring = strings::TSubstring<PathCharType>
	The string-type used with this ALib Module.
using	SystemFolders = lang::system::SystemFolders
	Type alias in namespace alib.

Enumerations
enum class	SystemFolders {   Root , Current , Home , HomeConfig ,   Module , Temp , VarTemp }

Variables
static constexpr PathCharType	DIRECTORY_SEPARATOR = '/'
	The standard path separator character. Defaults to '\' on Windows OS, '/' else.
static constexpr PathString	EMPTY_PATH
	An empty path string.
static constexpr PathString	NULL_PATH
	A nulled path string.