cat_entree.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 CAT_ENTREE_HPP
#define CAT_ENTREE_HPP
 
#include "../my_config.h"
 
extern "C"
{
} // end extern "C"
 
#include "infinint.hpp"
#include "user_interaction.hpp"
#include "pile.hpp"
#include "escape.hpp"
#include "archive_version.hpp"
#include "proto_compressor.hpp"
#include "pile_descriptor.hpp"
#include "smart_pointer.hpp"
#include "entree_stats.hpp"
#include "list_entry.hpp"
#include "slice_layout.hpp"
 
#include <memory>
 
namespace libdar
{
    class cat_etoile;
 
 
 
 
    class cat_entree
    {
    public :
 
        static cat_entree *read(const std::shared_ptr<user_interaction> & dialog,
                const smart_pointer<pile_descriptor> & f,
                const archive_version & reading_ver,
                entree_stats & stats,
                std::map <infinint, cat_etoile *> & corres,
                compression default_algo,
                bool lax,
                bool only_detruit,
                bool small);
 
    cat_entree(saved_status val): xsaved(val) {};
 
 
    cat_entree(const smart_pointer<pile_descriptor> & pdesc, bool small, saved_status val);
 
        // copy constructor is fine as we only copy the address of pointers
    cat_entree(const cat_entree & ref) = default;
 
        // move constructor
    cat_entree(cat_entree && ref) noexcept = default;
 
        // assignment operator is fine too for the same reason
    cat_entree & operator = (const cat_entree & ref) = default;
 
        // move assignment operator
    cat_entree & operator = (cat_entree && ref) = default;
 
        virtual ~cat_entree() noexcept(false) {};
 
    virtual bool operator == (const cat_entree & ref) const = 0;
    bool operator != (const cat_entree & ref) const { return ! (*this == ref); };
 
 
    bool same_as(const cat_entree & ref) const { return true; };
 
 
        void dump(const pile_descriptor & pdesc, bool small) const;
 
 
    void specific_dump(const pile_descriptor & pdesc, bool small) const { inherited_dump(pdesc, small); };
 
 
    virtual void post_constructor(const pile_descriptor & pdesc) {};
 
        virtual unsigned char signature() const = 0;
 
    virtual std::string get_description() const = 0;
 
        virtual cat_entree *clone() const = 0;
 
 
    virtual void change_location(const smart_pointer<pile_descriptor> & pdesc);
 
    saved_status get_saved_status() const { return xsaved; };
 
        void set_saved_status(saved_status x) { xsaved = x; };
 
 
    void set_list_entry(const slice_layout *sly,
                bool fetch_ea,
                list_entry & ent) const;
 
    protected:
    virtual void inherited_dump(const pile_descriptor & pdesc, bool small) const;
 
 
    pile *get_pile() const { return pdesc.is_null() ? nullptr : pdesc->stack; };
 
 
    proto_compressor *get_compressor_layer() const { return pdesc.is_null() ? nullptr : pdesc->compr; };
 
 
    escape *get_escape_layer() const { return pdesc.is_null() ? nullptr : pdesc->esc; };
 
    generic_file *get_read_cat_layer(bool small) const;
 
    private:
    static const U_I ENTREE_CRC_SIZE;
 
    saved_status xsaved;     
    smart_pointer<pile_descriptor> pdesc;
    };
 
    extern const char *cat_entree_signature2string(unsigned char sign);
 
 
} // end of namespace
 
#endif