zip.hpp

Go to the documentation of this file.

#ifndef CORAL_UTIL_ZIP_HPP
#define CORAL_UTIL_ZIP_HPP

#include <chrono>
#include <cstdint>
#include <stdexcept>
#include <string>

#include "boost/filesystem/path.hpp"
#include "boost/optional.hpp"

#include "coral/config.h"


// Forward declarations to avoid dependency on zip.h
struct zip;
struct zip_file;


namespace coral
{
namespace util
{

namespace zip
{

typedef std::uint64_t EntryIndex;


const EntryIndex INVALID_ENTRY_INDEX = 0xFFFFFFFFFFFFFFFFull;


class Archive
{
public:
    Archive() CORAL_NOEXCEPT;

    Archive(const boost::filesystem::path& path);

    // Disable copying.
    Archive(const Archive&) = delete;
    Archive& operator=(const Archive&) = delete;

    Archive(Archive&&) CORAL_NOEXCEPT;
    Archive& operator=(Archive&&) CORAL_NOEXCEPT;

    ~Archive() CORAL_NOEXCEPT;

    void Open(const boost::filesystem::path& path);

    void Discard() CORAL_NOEXCEPT;

    bool IsOpen() const CORAL_NOEXCEPT;

    std::uint64_t EntryCount() const;

    EntryIndex FindEntry(const std::string& name) const;

    std::string EntryName(EntryIndex index) const;

    bool IsDirEntry(EntryIndex index) const;

    void ExtractAll(
        const boost::filesystem::path& targetDir) const;

    boost::filesystem::path ExtractFileTo(
        EntryIndex index,
        const boost::filesystem::path& targetDir) const;

private:
    ::zip* m_archive;
};


class Exception : public std::runtime_error
{
public:
    // Creates an exception with the given message
    Exception(const std::string& msg) CORAL_NOEXCEPT;

    // Creates an exception for the last error for the given archive
    Exception(::zip* archive) CORAL_NOEXCEPT;

    // Creates an exception for the last error for the given file
    Exception(zip_file* file) CORAL_NOEXCEPT;
};


}}} // namespace
#endif // header guard