ZIP.h

Go to the documentation of this file.

// ReSharper disable CppRedundantQualifier
 
#pragma once
 
#include "../PackFile.h"
 
namespace vpkpp {
 
constexpr std::string_view BEE_EXTENSION  = ".bee_pack";
constexpr std::string_view BMZ_EXTENSION  = ".bmz";
constexpr std::string_view FPK_EXTENSION  = ".fpk";
constexpr std::string_view PK3_EXTENSION  = ".pk3";
constexpr std::string_view PK4_EXTENSION  = ".pk4";
constexpr std::string_view PKZ_EXTENSION  = ".pkz";
constexpr std::string_view ZIP_EXTENSION  = ".zip";
 
class ZIP : public PackFile {
public:
    ~ZIP() override;

    static std::unique_ptr<PackFile> create(const std::string& path);

    [[nodiscard]] static std::unique_ptr<PackFile> open(const std::string& path, const EntryCallback& callback = nullptr);
 
    static constexpr std::string_view GUID = "3F3FDBC4F5D44B1F8A8E3AF5611B561B";
 
    [[nodiscard]] constexpr std::string_view getGUID() const override {
        return ZIP::GUID;
    }
 
    [[nodiscard]] constexpr bool hasEntryChecksums() const override {
        return true;
    }
 
    [[nodiscard]] std::vector<std::string> verifyEntryChecksums() const override;
 
    [[nodiscard]] constexpr bool isCaseSensitive() const override {
        return true;
    }
 
    [[nodiscard]] std::optional<std::vector<std::byte>> readEntry(const std::string& path_) const override;
 
    [[nodiscard]] bool isReadOnly() const noexcept override;
 
    bool bake(const std::string& outputDir_ /*= ""*/, BakeOptions options /*= {}*/, const EntryCallback& callback /*= nullptr*/) override;
 
    [[nodiscard]] Attribute getSupportedEntryAttributes() const override;
 
    [[nodiscard]] EntryCompressionType getEntryCompressionType(const std::string& path_) const;
 
    void setEntryCompressionType(const std::string& path_, EntryCompressionType type);
 
    [[nodiscard]] int16_t getEntryCompressionStrength(const std::string& path_) const;
 
    void setEntryCompressionStrength(const std::string& path_, int16_t strength);
 
protected:
    explicit ZIP(const std::string& fullFilePath_);
 
    void addEntryInternal(Entry& entry, const std::string& path, std::vector<std::byte>& buffer, EntryOptions options) override;
 
    bool bakeTempZip(const std::string& writeZipPath, BakeOptions options, const EntryCallback& callback) const; // NOLINT(*-use-nodiscard)
 
    bool openZIP(std::string_view path);
 
    void closeZIP();
 
    const std::string tempZIPPath;
 
    void* streamHandle = nullptr;
    bool streamOpen = false;
 
    void* zipHandle = nullptr;
    bool zipOpen = false;
 
private:
    VPKPP_REGISTER_PACKFILE_OPEN(BEE_EXTENSION, &ZIP::open);
    VPKPP_REGISTER_PACKFILE_OPEN(BMZ_EXTENSION, &ZIP::open);
    VPKPP_REGISTER_PACKFILE_OPEN(FPK_EXTENSION, &ZIP::open);
    VPKPP_REGISTER_PACKFILE_OPEN(PK3_EXTENSION, &ZIP::open);
    VPKPP_REGISTER_PACKFILE_OPEN(PK4_EXTENSION, &ZIP::open);
    VPKPP_REGISTER_PACKFILE_OPEN(PKZ_EXTENSION, &ZIP::open);
    VPKPP_REGISTER_PACKFILE_OPEN(ZIP_EXTENSION, &ZIP::open);
};
 
} // namespace vpkpp