Source/Common/FileSystem.h - master - Mr.Stalin/FOnline-Engine

Source/Common/FileSystem.h
207 строк8 KB
cvet
Effekseer integration (#185)
22 июл 2026, 19:35
22 июл 2026, 19:35fa98b3d
//      __________        ___               ______            _
//     / ____/ __ \____  / (_)___  ___     / ____/___  ____ _(_)___  ___
//    / /_  / / / / __ \/ / / __ \/ _ \   / __/ / __ \/ __ `/ / __ \/ _ `
//   / __/ / /_/ / / / / / / / / /  __/  / /___/ / / / /_/ / / / / /  __/
//  /_/    \____/_/ /_/_/_/_/ /_/\___/  /_____/_/ /_/\__, /_/_/ /_/\___/
//                                                  /____/
// FOnline Engine
// https://fonline.ru
// https://github.com/cvet/fonline
//
// MIT License
//
// Copyright (c) 2006 - 2026, Anton Tsvetinskiy aka cvet <cvet@tut.by>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//

#pragma once

#include "Common.h"

#include "DataSource.h"

FO_BEGIN_NAMESPACE

FO_DECLARE_EXCEPTION(FileSystemExeption);

class FileHeader
{
public:
    FileHeader() noexcept = default;
    explicit FileHeader(string_view path, size_t size, uint64_t write_time, ptr<const DataSource> ds);
    FileHeader(const FileHeader&) = delete;
    FileHeader(FileHeader&&) noexcept = default;
    auto operator=(const FileHeader&) = delete;
    auto operator=(FileHeader&&) noexcept -> FileHeader& = default;
    explicit operator bool() const noexcept { return _isLoaded; }
    ~FileHeader() = default;

    [[nodiscard]] auto GetNameNoExt() const -> string_view;
    [[nodiscard]] auto GetPath() const -> string_view;
    [[nodiscard]] auto GetDiskPath() const -> string;
    [[nodiscard]] auto GetSize() const -> size_t;
    [[nodiscard]] auto GetWriteTime() const -> uint64_t;
    [[nodiscard]] auto GetDataSource() const -> ptr<const DataSource>;
    [[nodiscard]] auto Copy() const -> FileHeader;

protected:
    bool _isLoaded {};
    string _filePath {};
    size_t _fileSize {};
    uint64_t _writeTime {};
    nptr<const DataSource> _dataSource {};
};

class FileReader final
{
public:
    explicit FileReader(const_span<uint8_t> buf);
    FileReader(const FileReader&) = delete;
    FileReader(FileReader&&) noexcept = default;
    auto operator=(const FileReader&) = delete;
    auto operator=(FileReader&&) noexcept -> FileReader& = default;
    ~FileReader() = default;

    [[nodiscard]] auto GetStr() const -> string;
    [[nodiscard]] auto GetData() const -> vector<uint8_t>;
    [[nodiscard]] auto GetDataSpan() const -> const_span<uint8_t>;
    [[nodiscard]] auto GetSize() const -> size_t;
    [[nodiscard]] auto GetCurDataSpan(size_t size) const -> const_span<uint8_t>;
    [[nodiscard]] auto GetCurPos() const -> size_t;
    // ReSharper disable CppInconsistentNaming
    [[nodiscard]] auto GetStrNT() -> string; // Null terminated
    [[nodiscard]] auto GetUInt8() -> uint8_t;
    [[nodiscard]] auto GetInt8() -> int8_t { return std::bit_cast<int8_t>(GetUInt8()); }
    [[nodiscard]] auto GetBEUInt16() -> uint16_t;
    [[nodiscard]] auto GetBEInt16() -> int16_t { return std::bit_cast<int16_t>(GetBEUInt16()); }
    [[nodiscard]] auto GetLEUInt16() -> uint16_t;
    [[nodiscard]] auto GetLEInt16() -> int16_t { return std::bit_cast<int16_t>(GetLEUInt16()); }
    [[nodiscard]] auto GetBEUInt32() -> uint32_t;
    [[nodiscard]] auto GetBEInt32() -> int32_t { return std::bit_cast<int32_t>(GetBEUInt32()); }
    [[nodiscard]] auto GetLEUInt32() -> uint32_t;
    [[nodiscard]] auto GetLEInt32() -> int32_t { return std::bit_cast<int32_t>(GetLEUInt32()); }
    // ReSharper restore CppInconsistentNaming

    auto SeekFragment(string_view fragment) -> bool;
    void CopyData(span<uint8_t> buf);
    void ReadBytes(span<uint8_t> out);
    void SetCurPos(size_t pos);
    void GoForward(size_t offs);
    void GoBack(size_t offs);

    template<typename T>
        requires(std::is_standard_layout_v<T> && std::is_trivially_copyable_v<T>)
    void ReadObject(T& out)
    {
        CopyData(make_span(&out, sizeof(T)));
    }
    template<typename T>
        requires(std::is_standard_layout_v<T> && std::is_trivially_copyable_v<T>)
    void ReadObjectArray(span<T> out)
    {
        if (!out.empty()) {
            CopyData(make_span(out.data(), out.size() * sizeof(T)));
        }
    }

private:
    const_span<uint8_t> _buf;
    size_t _curPos {};
};

class File final : public FileHeader
{
public:
    File() noexcept = default;
    explicit File(string_view path, size_t size, uint64_t write_time, ptr<const DataSource> ds, unique_del_ptr<const uint8_t>&& buf);
    File(const File&) = delete;
    File(File&&) noexcept = default;
    auto operator=(const File&) = delete;
    auto operator=(File&&) noexcept -> File& = default;
    ~File() = default;

    [[nodiscard]] auto GetStr() const -> string;
    [[nodiscard]] auto GetData() const -> vector<uint8_t>;
    [[nodiscard]] auto GetDataSpan() const -> const_span<uint8_t>;
    [[nodiscard]] auto GetReader() const -> FileReader;

    static auto Load(const FileHeader& fh) -> File;

protected:
    unique_del_nptr<const uint8_t> _fileBuf {};
};

class FileCollection final
{
public:
    explicit FileCollection(initializer_list<FileHeader> files);
    explicit FileCollection(vector<FileHeader> files);
    FileCollection(const FileCollection&) = delete;
    FileCollection(FileCollection&&) noexcept = default;
    auto operator=(const FileCollection&) = delete;
    auto operator=(FileCollection&&) noexcept -> FileCollection& = default;
    ~FileCollection() = default;

    [[nodiscard]] auto GetFilesCount() const -> size_t;
    [[nodiscard]] auto GetFileByIndex(size_t index) const -> const FileHeader&;
    [[nodiscard]] auto FindFileByName(string_view name_no_ext) const -> File;
    [[nodiscard]] auto FindFileByPath(string_view path) const -> File;

    [[nodiscard]] auto begin() { return _files.begin(); }
    [[nodiscard]] auto end() { return _files.end(); }
    [[nodiscard]] auto begin() const { return _files.begin(); }
    [[nodiscard]] auto end() const { return _files.end(); }

private:
    vector<FileHeader> _files {};
    unordered_map<string, size_t> _nameToIndex {};
    unordered_map<string, size_t> _pathToIndex {};
};

class FileSystem final
{
public:
    FileSystem() noexcept = default;
    FileSystem(const FileSystem&) = delete;
    FileSystem(FileSystem&&) noexcept = default;
    auto operator=(const FileSystem&) = delete;
    auto operator=(FileSystem&&) noexcept = delete;
    ~FileSystem() = default;

    [[nodiscard]] auto GetAllFiles() const -> FileCollection;
    [[nodiscard]] auto FilterFiles(string_view ext, string_view dir = "", bool recursive = true) const -> FileCollection;
    [[nodiscard]] auto FilterFiles(const_span<string> include_patterns, const_span<string> exclude_patterns) const -> FileCollection;
    [[nodiscard]] auto IsFileExists(string_view path) const -> bool;
    [[nodiscard]] auto ReadFile(string_view path) const -> File;
    [[nodiscard]] auto ReadFileText(string_view path) const -> string;
    [[nodiscard]] auto ReadFileHeader(string_view path) const -> FileHeader;

    void AddDirSource(string_view dir, bool recursive = false, bool non_cached = false, bool maybe_not_available = false);
    void AddPackSource(string_view dir, string_view pack, bool maybe_not_available = false);
    void AddPacksSource(string_view dir, const vector<string>& packs);
    void AddCustomSource(unique_ptr<DataSource> data_source);
    auto ReindexDataSources() -> bool;
    void CleanDataSources();

private:
    vector<unique_ptr<DataSource>> _dataSources {};
};

FO_END_NAMESPACE