PCK.h

Go to the documentation of this file.

// ReSharper disable CppRedundantQualifier
 
#pragma once
 
#include <sourcepp/parser/Binary.h>
 
#include "../PackFile.h"
 
namespace vpkpp {
 
constexpr auto PCK_SIGNATURE = sourcepp::parser::binary::makeFourCC("GDPC");
constexpr std::string_view PCK_PATH_PREFIX = "res://";
constexpr std::string_view PCK_EXTENSION = ".pck";
 
class PCK : public PackFile {
protected:
    enum FlagsDirV2 : uint32_t {
        FLAG_DIR_NONE               = 0,
        FLAG_DIR_ENCRYPTED          = 1 << 0,
        FLAG_DIR_RELATIVE_FILE_DATA = 1 << 1,
    };
 
    enum FlagsFileV2 : uint32_t {
        FLAG_FILE_NONE      = 0,
        FLAG_FILE_ENCRYPTED = 1 << 0,
        FLAG_FILE_REMOVED   = 1 << 1,
    };
 
    struct Header {
        uint32_t packVersion;
        uint32_t godotVersionMajor;
        uint32_t godotVersionMinor;
        uint32_t godotVersionPatch;
        FlagsDirV2 flags; // packVersion >= 2
    };
 
public:
    static std::unique_ptr<PackFile> create(const std::string& path, uint32_t version = 2, uint32_t godotMajorVersion = 0, uint32_t godotMinorVersion = 0, uint32_t godotPatchVersion = 0);

    [[nodiscard]] static std::unique_ptr<PackFile> open(const std::string& path, const EntryCallback& callback = nullptr);
 
    static constexpr std::string_view GUID = "28F4A6FF40EB46E38D47EEC6EFB47C4F";
 
    [[nodiscard]] constexpr std::string_view getGUID() const override {
        return PCK::GUID;
    }
 
    [[nodiscard]] constexpr bool isCaseSensitive() const override {
        return true;
    }
 
    [[nodiscard]] std::optional<std::vector<std::byte>> readEntry(const std::string& path_) const override;
 
    bool bake(const std::string& outputDir_ /*= ""*/, BakeOptions options /*= {}*/, const EntryCallback& callback /*= nullptr*/) override;
 
    [[nodiscard]] Attribute getSupportedEntryAttributes() const override;
 
    [[nodiscard]] explicit operator std::string() const override;

    [[nodiscard]] uint32_t getVersion() const;

    void setVersion(uint32_t version);
 
    [[nodiscard]] std::tuple<uint32_t, uint32_t, uint32_t> getGodotVersion() const;
 
    void setGodotVersion(uint32_t major, uint32_t minor = 0, uint32_t patch = 0);
 
protected:
    using PackFile::PackFile;
 
    void addEntryInternal(Entry& entry, const std::string& path, std::vector<std::byte>& buffer, EntryOptions options) override;
 
    Header header{};
 
    std::size_t startOffset = 0;
    std::size_t dataOffset = 0;
 
private:
    VPKPP_REGISTER_PACKFILE_OPEN(PCK_EXTENSION, &PCK::open);
    VPKPP_REGISTER_PACKFILE_OPEN_EXECUTABLE(&PCK::open);
};
 
} // namespace vpkpp