XLZipArchive.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLZIPARCHIVE_HPP
#define OPENXLSX_XLZIPARCHIVE_HPP
 
#ifdef _MSC_VER    // conditionally enable MSVC specific pragmas to avoid other compilers warning about unknown pragmas
#    pragma warning(push)
#    pragma warning(disable : 4251)
#    pragma warning(disable : 4275)
#endif    // _MSC_VER
 
// ===== OpenXLSX Includes ===== //
#include "OpenXLSX-Exports.hpp"
 
#include <memory>
#include <string>
 
namespace OpenXLSX
{
    class OPENXLSX_EXPORT XLZipArchive
    {
    public:
        XLZipArchive();
 
        XLZipArchive(const XLZipArchive& other) = default;
 
        XLZipArchive(XLZipArchive&& other) noexcept = default;
 
        ~XLZipArchive();
 
        XLZipArchive& operator=(const XLZipArchive& other) = default;
 
        XLZipArchive& operator=(XLZipArchive&& other) noexcept = default;
 
        explicit operator bool() const;
 
        [[nodiscard]] bool isValid() const;
 
        [[nodiscard]] bool isOpen() const;
 
        void open(std::string_view fileName);
 
        void close();
 
        void save(std::string_view path = "");
 
        void addEntry(std::string_view name, std::string data);
 
        void addEntryAllocated(std::string_view name, void* data, size_t size);
 
        void addEntryFromFile(std::string_view name, std::string_view filePath);
 
        void deleteEntry(std::string_view entryName);
 
        [[nodiscard]] std::string getEntry(std::string_view name) const;
 
        void* openEntryStream(std::string_view name) const;
 
        int64_t readEntryStream(void* stream, char* buffer, uint64_t size) const;
 
        void closeEntryStream(void* stream) const;
 
        [[nodiscard]] bool hasEntry(std::string_view entryName) const;
 
        [[nodiscard]] std::vector<std::string> entryNames() const;
 
        void setCompressionLevel(int level);
 
        int compressionLevel() const;
 
    private:
        struct LibZipApp;
        std::shared_ptr<LibZipApp> m_archive; 
        int m_compressionLevel{1}; 
    };
}    // namespace OpenXLSX
 
#ifdef _MSC_VER    // conditionally enable MSVC specific pragmas to avoid other compilers warning about unknown pragmas
#    pragma warning(pop)
#endif    // _MSC_VER
 
#endif    // OPENXLSX_XLZIPARCHIVE_HPP