FilePath.hpp

Go to the documentation of this file.

 
//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2023 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/DataTypes.hpp"
#include "CeresEngine/Macros.hpp"
 
#include "CeresEngine/Foundation/String.hpp"
 
#include <string>
#include <filesystem>
 
namespace CeresEngine {
 
    class FilePath {
    private:
        String mPath;
 
    public:
        FilePath();
 
        FilePath(StringView path);
 
        FilePath(String&& path);
 
        FilePath(const char* path);
 
        FilePath(const FilePath&) = default;
        FilePath(FilePath&&) = default;
        FilePath& operator=(const FilePath&) = default;
        FilePath& operator=(FilePath&&) = default;
 
        virtual ~FilePath();
 
    public:
        [[nodiscard]] StringView getPath() const { return mPath; }
 
        [[nodiscard]] String toNative() const;
 
        [[nodiscard]] bool isEmpty() const;
 
        [[nodiscard]] StringView getFullPath() const;
 
        [[nodiscard]] StringView getFileName() const;
 
        [[nodiscard]] StringView getBaseName() const;
 
        [[nodiscard]] StringView getExtension() const;
 
        [[nodiscard]] StringView getParent() const;
 
        [[nodiscard]] FilePath getParentPath() const { return {getParent()}; }
 
        [[nodiscard]] StringView getDriveLetter() const;
 
        [[nodiscard]] bool isAbsolute() const;
 
        [[nodiscard]] bool isRelative() const;
 
        [[nodiscard]] FilePath resolve(const FilePath& path) const;
 
        [[nodiscard]] FilePath normalize() const;
 
        [[nodiscard]] FilePath relativize(const FilePath& base) const;
 
        FilePath& makeRelative();
 
        [[nodiscard]] FilePath toRelative() const& { return FilePath(*this).makeRelative(); }
 
        [[nodiscard]] FilePath&& toRelative() && { return std::move(makeRelative()); }
 
        FilePath& makeAbsolute();
 
        [[nodiscard]] FilePath toAbsolute() const& { return FilePath(*this).makeAbsolute(); }
 
        [[nodiscard]] FilePath&& toAbsolute() && { return std::move(makeAbsolute()); }
 
    public: // Operators
        FilePath operator/(const FilePath& other) const;
        FilePath& operator/=(const FilePath& other);
 
    public:
        const String& toString() const { return mPath; }
 
        std::filesystem::path toStdPath() const;
 
        operator std::filesystem::path() const { return toStdPath(); }
 
    protected:
        void setPath(StringView path);
 
        void setPath(String&& path);
    };
 
} // namespace CeresEngine