zapette.hpp

Go to the documentation of this file.

/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2024 Denis Corbin
//
// 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 2
// of the License, or (at your option) any later version.
//
// 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, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// to contact the author, see the AUTHOR file
/*********************************************************************/
 
 
#ifndef ZAPETTE_HPP
#define ZAPETTE_HPP
 
#include "../my_config.h"
#include "infinint.hpp"
#include "generic_file.hpp"
#include "integers.hpp"
#include "mem_ui.hpp"
#include "contextual.hpp"
 
namespace libdar
{
 
 
 
 
 
    class zapette : public generic_file, public contextual, protected mem_ui
    {
    public:
 
 
        zapette(const std::shared_ptr<user_interaction> & dialog, generic_file *input, generic_file *output, bool by_the_end);
    zapette(const zapette & ref) = default;
    zapette(zapette && ref) noexcept = default;
    zapette & operator = (const zapette & ref) = default;
    zapette & operator = (zapette && ref) noexcept = default;
        ~zapette();
 
            // inherited methods from generic_file
    virtual bool skippable(skippability direction, const infinint & amount) override { return true; };
        virtual bool skip(const infinint &pos) override;
        virtual bool skip_to_eof() override { if(is_terminated()) throw SRC_BUG; position = file_size; return true; };
        virtual bool skip_relative(S_I x) override;
    virtual bool truncatable(const infinint & pos) const override { return false; };
        virtual infinint get_position() const override { if(is_terminated()) throw SRC_BUG; return position; };
 
        // overwritten inherited methods from contextual
        virtual void set_info_status(const std::string & s) override;
    virtual bool is_an_old_start_end_archive() const override;
    virtual const label & get_data_name() const override;
 
    infinint get_first_slice_header_size() const;
 
    infinint get_non_first_slice_header_size() const;
 
    protected:
    virtual void inherited_read_ahead(const infinint & amount) override {}; // optimization will be done when zapette will use the messaging_encode/decode exchange format
        virtual U_I inherited_read(char *a, U_I size) override;
        virtual void inherited_write(const char *a, U_I size) override;
    virtual void inherited_truncate(const infinint & pos) override { throw SRC_BUG; }; // read only object
    virtual void inherited_sync_write() override {};
    virtual void inherited_flush_read() override {};
    virtual void inherited_terminate() override;
 
    private:
        generic_file *in, *out;
        infinint position, file_size;
        char serial_counter;
 
 
 
    void make_transfert(U_16 size, const infinint &offset, char *data, const std::string & info, S_I & lu, infinint & arg) const;
    };
 
 
} // end of namespace
 
#endif