Path.h

Go to the documentation of this file.

#pragma once
 
#include "Utility/TSpan.h"
 
#include <Common/Utility/string_utils.h>
#include <Common/compiler.h>
 
#include <cstddef>
#include <string>
#include <utility>
#include <filesystem>
 
namespace ph
{
 
class Path final
{
public:
    Path();
    
    explicit Path(std::string path);
 
    explicit Path(std::string_view path);
 
    explicit Path(TSpanView<char> path);
 
    explicit Path(const char* path);
 
    explicit Path(std::filesystem::path path);
 
    bool isRelative() const;
    bool isAbsolute() const;
    bool isEmpty() const;
    void clear();
    
    Path append(const Path& other) const;
 
    Path append(std::string_view pathStr) const;
 
    Path toAbsolute() const;
 
    std::string toString() const;
 
    std::string toAbsoluteString() const;
 
    std::string toNativeString() const;
 
    std::size_t toNativeString(
        TSpan<char> out_buffer, 
        std::size_t* out_numTotalChars = nullptr,
        bool isNullTerminated = true) const;
 
    std::filesystem::path toStdPath() const;
 
    Path removeLeadingSeparator() const;
 
    Path removeTrailingSeparator() const;
 
    std::string getFilename() const;
 
    std::string getExtension() const;
 
    Path getLeadingElement() const;
 
    Path getTrailingElement(bool ignoreTrailingSeparator = true) const;
 
    Path getParent() const;
 
    // TODO: replace/remove filename
 
    Path replaceExtension(std::string_view replacement) const;
 
    Path removeExtension() const;
 
    Path operator / (const Path& other) const;
    Path operator / (std::string_view pathStr) const;
    bool operator == (const Path& other) const;
 
private:
    static wchar_t charToWchar(const char ch);
 
    std::filesystem::path m_path;
};
 
inline bool Path::isRelative() const
{
    return m_path.is_relative();
}
 
inline bool Path::isAbsolute() const
{
    return m_path.is_absolute();
}
 
inline bool Path::isEmpty() const
{
    return m_path.empty();
}
 
inline void Path::clear()
{
    m_path.clear();
}
 
inline std::filesystem::path Path::toStdPath() const
{
    return m_path;
}
 
}// end namespace ph
 
PH_DEFINE_INLINE_TO_STRING_FORMATTER(ph::Path);