FileHandle.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/Platform/Forward.hpp"
 
#include "FileWatcher.hpp"
 
#include "CeresEngine/DataTypes.hpp"
#include "CeresEngine/Macros.hpp"
 
#include "CeresEngine/Foundation/Flags.hpp"
#include "CeresEngine/Foundation/Poly.hpp"
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
#include "CeresEngine/Foundation/IO/Stream.hpp"
 
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
namespace CeresEngine {
 
    class FileHandle final {
    public:
        using ImplementationType = Poly<IFileHandle, sizeof(void*) * 4>;
        using VisitFunc = std::function<bool(const FileHandle&)>;
 
    private:
        mutable ImplementationType mImplementation = nullptr;
 
    public:
        FileHandle() noexcept;
 
        explicit FileHandle(const FilePath& path);
 
        CE_EXPLICIT(false) FileHandle(ImplementationType&& backend);
 
        FileHandle(const FileHandle& other);
 
        FileHandle& operator=(const FileHandle& other);
 
        FileHandle(FileHandle&& other) noexcept;
 
        FileHandle& operator=(FileHandle&& fileHandle) noexcept;
 
        ~FileHandle() noexcept;
 
    public:
        [[nodiscard]] IFileSystem* getFileSystem() const;
 
        [[nodiscard]] StringView getPath() const;
 
        [[nodiscard]] StringView getFileName() const;
 
        void updateFileInfo() const;
 
        [[nodiscard]] bool exists() const;
 
        [[nodiscard]] bool isFile() const;
 
        [[nodiscard]] bool isDirectory() const;
 
        [[nodiscard]] bool isSymbolicLink() const;
 
        [[nodiscard]] Vector<String> listFiles() const;
 
        void traverse(VisitFunc funcFileEntry) const;
 
        void traverse(VisitFunc funcFile, VisitFunc funcDirectory) const;
 
        void traverse(FileVisitor& visitor) const;
 
#if 0
        [[nodiscard]] Tree readTree(StringView path = "") const;
#endif
 
        [[nodiscard]] FileIterator begin() const;
 
        [[nodiscard]] FileIterator end() const;
 
        [[nodiscard]] UInt64 getSize() const;
 
        [[nodiscard]] Int64 getAccessTime() const;
 
        [[nodiscard]] Int64 getModificationTime() const;
 
        [[nodiscard]] FileHandle getParentDirectory() const;
 
        [[nodiscard]] FileHandle open(StringView path) const;
 
        [[nodiscard]] bool createDirectory() const;
 
        enum class RemoveDirectoryFlag {
            FollowSymlinks = (1u << 0u),
 
            Recursive = (1u << 1u),
 
            None = 0,
            Default = None,
        };
 
        using RemoveDirectoryFlags = Flags<RemoveDirectoryFlag>;
 
        [[nodiscard]] bool removeDirectory(const RemoveDirectoryFlags& flags = RemoveDirectoryFlag::Default) const;
 
        void copyDirectory(const FileHandle& dstDir) const;
 
        [[nodiscard]] bool copy(const FileHandle& dest) const;
 
        [[nodiscard]] bool move(const FileHandle& dest) const;
 
        [[nodiscard]] bool createLink(const FileHandle& dest) const;
 
        [[nodiscard]] bool createSymbolicLink(const FileHandle& dest) const;
 
        [[nodiscard]] bool rename(StringView filename) const;
 
        [[nodiscard]] bool remove() const;
 
        [[nodiscard]] FileWatcher watch(ExecutionContext& executionContext, const FileEvents& events = FileEvent::Default, bool recursive = true) const;
 
        [[nodiscard]] InputStream createInputStream(std::ios_base::openmode mode = std::ios_base::in) const;
 
        [[nodiscard]] OutputStream createOutputStream(std::ios_base::openmode mode = std::ios_base::out) const;
 
        [[nodiscard]] Optional<String> readFile() const;
 
        [[nodiscard]] bool writeFile(StringView content) const;
 
    public:
        [[nodiscard]] explicit operator bool() const noexcept { return mImplementation != nullptr; }
        [[nodiscard]] bool operator==(const FileHandle& other) const noexcept;
        [[nodiscard]] bool operator!=(const FileHandle& other) const noexcept;
 
    private:
        [[nodiscard]] bool genericCopy(const FileHandle& dest) const;
 
        [[nodiscard]] bool genericMove(const FileHandle& dest) const;
    };
 
    CE_FLAGS_OPERATORS(FileHandle::RemoveDirectoryFlag);
 
    class IFileHandle {
    public:
        IFileHandle() = default;
        virtual ~IFileHandle() = default;
 
    public:
        [[nodiscard]] virtual IFileSystem* getFileSystem() const = 0;
 
        virtual void updateFileInfo() = 0;
 
        [[nodiscard]] virtual StringView getPath() const = 0;
 
        [[nodiscard]] virtual bool exists() const = 0;
 
        [[nodiscard]] virtual bool isFile() const = 0;
 
        [[nodiscard]] virtual bool isDirectory() const = 0;
 
        [[nodiscard]] virtual bool isSymbolicLink() const = 0;
 
        [[nodiscard]] virtual FileIterator begin() const = 0;
 
        [[nodiscard]] virtual UInt64 getSize() const = 0;
 
        [[nodiscard]] virtual Int64 getAccessTime() const = 0;
 
        [[nodiscard]] virtual Int64 getModificationTime() const = 0;
 
        [[nodiscard]] virtual bool createDirectory() = 0;
 
        [[nodiscard]] virtual bool removeDirectory() = 0;
 
        [[nodiscard]] virtual bool copy(IFileHandle& dest) = 0;
 
        [[nodiscard]] virtual bool move(IFileHandle& dest) = 0;
 
        [[nodiscard]] virtual bool createLink(IFileHandle& dest) = 0;
 
        [[nodiscard]] virtual bool createSymbolicLink(IFileHandle& dest) = 0;
 
        [[nodiscard]] virtual bool rename(StringView filename) = 0;
 
        [[nodiscard]] virtual bool remove() = 0;
 
        [[nodiscard]] virtual InputStream createInputStream(std::ios_base::openmode mode) const = 0;
 
        [[nodiscard]] virtual OutputStream createOutputStream(std::ios_base::openmode mode) = 0;
    };
 
    class FileVisitor {
        friend class FileHandle;
 
    public:
        FileVisitor();
        virtual ~FileVisitor();
 
    protected:
        [[nodiscard]] virtual bool onFileEntry(const FileHandle& handle);
 
        virtual void onFile(const FileHandle& handle);
 
        [[nodiscard]] virtual bool onDirectory(const FileHandle& handle);
    };
 
    class FunctionalFileVisitor final : public FileVisitor {
    public:
        using VisitFunc = std::function<bool(const FileHandle&)>;
        using FileVistFunc = std::function<bool(const FileHandle&)>;
        using DirectoryVisitFunc = std::function<bool(const FileHandle&)>;
 
    private:
        VisitFunc mFileEntryFunc;
        FileVistFunc mFileFunc;
        DirectoryVisitFunc mDirectoryFunc;
 
    public:
        CE_EXPLICIT(false) FunctionalFileVisitor(VisitFunc&& funcFileEntry);
 
        FunctionalFileVisitor(FileVistFunc&& funcFile, DirectoryVisitFunc&& funcDirectory);
 
        ~FunctionalFileVisitor() final;
 
    protected:
        [[nodiscard]] bool onFileEntry(const FileHandle& handle) final;
 
        void onFile(const FileHandle& handle) final;
 
        [[nodiscard]] bool onDirectory(const FileHandle& handle) final;
    };
 
    class FileIterator final {
    public:
        using ImplementationType = Poly<IFileIterator, sizeof(void*) * 4, false>;
 
    private:
        ImplementationType mImplementation = nullptr;
 
    public:
        FileIterator();
 
        FileIterator(ImplementationType&& backend);
 
        FileIterator(FileIterator&& other) noexcept;
        FileIterator& operator=(FileIterator&& other) noexcept;
 
        FileIterator(const FileIterator& other) = delete;
        FileIterator& operator=(const FileIterator& other) = delete;
 
        ~FileIterator() noexcept;
 
    public:
        [[nodiscard]] FileHandle operator*() const;
 
        void operator++();
 
        [[nodiscard]] bool operator==(const FileIterator& other) const;
 
        [[nodiscard]] bool operator!=(const FileIterator& it) const;
 
        [[nodiscard]] IFileSystem* getFileSystem() const;
    };
 
    class IFileIterator {
    public:
        IFileIterator() = default;
        virtual ~IFileIterator() = default;
 
    public:
        [[nodiscard]] virtual IFileSystem* getFileSystem() const = 0;
 
        [[nodiscard]] virtual bool isValid() const = 0;
 
        [[nodiscard]] virtual const FileHandle& getParent() const = 0;
 
        [[nodiscard]] virtual Int32 getIndex() const = 0;
 
        [[nodiscard]] virtual FileHandle getFileHandle() const = 0;
 
        virtual void next() = 0;
    };
 
} // namespace CeresEngine