ZipSource.hpp

Go to the documentation of this file.

/*
 *
 * ---
 *
 *  Copyright (C) 2020 Anselm Schmidt (ans[ät]ohai.su)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version in addition to the terms of any
 *  licences already herein identified.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program. If not, see <https://www.gnu.org/licenses/>.
 *
 * ---
 *
 * ZipSource.hpp
 *
 * Wrapper for pointer to a libzip source.
 *  Does NOT have ownership of the pointer, but takes care of its deletion!
 *
 *  Created on: Jan 4, 2021
 *      Author: ans
 */

#ifndef WRAPPER_ZIPSOURCE_HPP_
#define WRAPPER_ZIPSOURCE_HPP_

#include <zip.h>

namespace crawlservpp::Wrapper {

    /*
     * DECLARATION
     */


    class ZipSource {
    public:

        ZipSource();
        ZipSource(const void * data, zip_uint64_t size);
        virtual ~ZipSource();


        [[nodiscard]] zip_source_t * get() noexcept;
        [[nodiscard]] const zip_source_t * getc() const noexcept;
        [[nodiscard]] bool valid() const noexcept;
        [[nodiscard]] zip_error_t getError() const;


        void clear() noexcept;



        ZipSource(ZipSource&) = delete;

        ZipSource& operator=(ZipSource&) = delete;

        ZipSource(ZipSource&& other) noexcept;
        ZipSource& operator=(ZipSource&& other) noexcept;


    private:
        // underlying pointer to ZIP source
        zip_source_t * ptr{nullptr};

        // last occured error
        zip_error_t error{};
    };

    /*
     * IMPLEMENTATION
     */

    inline ZipSource::ZipSource() {
        this->ptr = zip_source_buffer_create(nullptr, 0, 0, &(this->error));
    }


    inline ZipSource::ZipSource(const void * data, zip_uint64_t size) {
        this->ptr = zip_source_buffer_create(data, size, 0, &(this->error));
    }

    inline ZipSource::~ZipSource() {
        this->clear();
    }


    inline zip_source_t * ZipSource::get() noexcept {
        return this->ptr;
    }


    inline const zip_source_t * ZipSource::getc() const noexcept {
        return this->ptr;
    }


    inline bool ZipSource::valid() const noexcept {
        return this->ptr != nullptr;
    }


    inline zip_error_t ZipSource::getError() const {
        return this->error;
    }


    inline void ZipSource::clear() noexcept {
        if(this->ptr != nullptr) {
            zip_source_free(this->ptr);

            this->ptr = nullptr;
        }

        zip_error_fini(&(this->error));
    }


    inline ZipSource::ZipSource(ZipSource&& other) noexcept : ptr(other.ptr) {
        other.ptr = nullptr;
    }


    inline ZipSource& ZipSource::operator=(ZipSource&& other) noexcept {
        if(&other != this) {
            this->clear();

            this->ptr = other.ptr;

            other.ptr = nullptr;
        }

        return *this;
    }

} /* namespace crawlservpp::Wrapper */

#endif /* WRAPPER_ZIPSOURCE_HPP_ */