doc/c++utilities/path_8h_source.html

#ifndef IOUTILITIES_PATHHELPER_H

#define IOUTILITIES_PATHHELPER_H


#include "../global.h"


#ifdef PLATFORM_WINDOWS

#include "../conversion/stringconversion.h"

#endif


#include <list>

#include <string>

#include <string_view>

#ifdef CPP_UTILITIES_USE_STANDARD_FILESYSTEM

#include <filesystem>

#endif


#ifdef PLATFORM_WINDOWS

#define PATH_SEP_CHAR '\\'

#define SEARCH_PATH_SEP_CHAR ';'

#define PATH_SEP_STR "\\"

#define SEARCH_PATH_SEP_STR ";"

#else

#define PATH_SEP_CHAR '/'

#define SEARCH_PATH_SEP_CHAR ':'

#define PATH_SEP_STR "/"

#define SEARCH_PATH_SEP_STR ":"

#endif


namespace CppUtilities {


CPP_UTILITIES_EXPORT std::string fileName(const std::string &path);

CPP_UTILITIES_EXPORT std::string directory(const std::string &path);

#ifdef CPP_UTILITIES_PATHHELPER_STRING_VIEW

CPP_UTILITIES_EXPORT std::string_view fileName(std::string_view path);

CPP_UTILITIES_EXPORT std::string_view directory(std::string_view path);

#endif

CPP_UTILITIES_EXPORT void removeInvalidChars(std::string &fileName);


using PathValueType =

#ifdef PLATFORM_WINDOWS

    wchar_t

#else

    char

#endif

    ;

#ifdef CPP_UTILITIES_USE_STANDARD_FILESYSTEM

static_assert(std::is_same_v<typename std::filesystem::path::value_type, PathValueType>);

#endif


using NativePathString = std::basic_string<PathValueType>;

using NativePathStringView = std::basic_string_view<PathValueType>;

using PathString = std::string;

using PathStringView = std::string_view;


inline

#ifdef PLATFORM_WINDOWS

    NativePathString

#else

    NativePathStringView

#endif


    makeNativePath(PathStringView path)

{

#ifdef PLATFORM_WINDOWS

    auto ec = std::error_code();

    return convertMultiByteToWide(ec, path);

#else

    return path;

#endif

}


inline

#ifdef PLATFORM_WINDOWS

    PathString

#else

    PathStringView

#endif


    extractNativePath(NativePathStringView path)

{

#ifdef PLATFORM_WINDOWS

    auto res = convertUtf16LEToUtf8(reinterpret_cast<const char *>(path.data()), path.size() * 2);

    return std::string(res.first.get(), res.second);

#else

    return path;

#endif

}


} // namespace CppUtilities


#endif // IOUTILITIES_PATHHELPER_H

global.h

CPP_UTILITIES_EXPORT
#define CPP_UTILITIES_EXPORT
Marks the symbol to be exported by the c++utilities library.
Definition global.h:14

CppUtilities
Contains all utilities provides by the c++utilities library.
Definition argumentparser.h:18

CppUtilities::extractNativePath
PathStringView extractNativePath(NativePathStringView path)
Returns path as UTF-8 string or string view.
Definition path.h:102

CppUtilities::convertUtf16LEToUtf8
CPP_UTILITIES_EXPORT StringData convertUtf16LEToUtf8(const char *inputBuffer, std::size_t inputBufferSize)
Converts the specified UTF-16 (little-endian) string to UTF-8.
Definition stringconversion.cpp:162

CppUtilities::NativePathString
std::basic_string< PathValueType > NativePathString
The string type used to store paths in the native encoding.
Definition path.h:54

CppUtilities::PathValueType
char PathValueType
The native type used by std::filesystem:path.
Definition path.h:41

CppUtilities::stringToNumber
IntegralType stringToNumber(const StringType &string, BaseType base=10)
Converts the given string to an unsigned/signed number assuming string uses the specified base.
Definition stringconversion.h:593

CppUtilities::PathStringView
std::string_view PathStringView
The string view type used to pass paths UTF-8 encoded.
Definition path.h:63

CppUtilities::NativePathStringView
std::basic_string_view< PathValueType > NativePathStringView
The string view type used to pass paths in the native encoding.
Definition path.h:57

CppUtilities::PathString
std::string PathString
The string type used to store paths UTF-8 encoded.
Definition path.h:60

CppUtilities::removeInvalidChars
CPP_UTILITIES_EXPORT void removeInvalidChars(std::string &fileName)
Removes invalid characters from the specified fileName.
Definition path.cpp:75

CppUtilities::fileName
CPP_UTILITIES_EXPORT std::string fileName(const std::string &path)
Returns the file name and extension of the specified path string.
Definition path.cpp:17

CppUtilities::makeNativePath
NativePathStringView makeNativePath(PathStringView path)
Returns path in the platform's native encoding.
Definition path.h:82

CppUtilities::directory
CPP_UTILITIES_EXPORT std::string directory(const std::string &path)
Returns the directory of the specified path string (including trailing slash).
Definition path.cpp:25

stringconversion.h