fichier_global.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 FICHIER_GLOBAL_HPP
#define FICHIER_GLOBAL_HPP


#include "../my_config.h"

extern "C"
{
#if HAVE_UNISTD_H
#include <unistd.h>
#endif
} // end extern "C"

#include "integers.hpp"
#include "generic_file.hpp"
#include "thread_cancellation.hpp"
#include "user_interaction.hpp"
#include "mem_ui.hpp"

#include <string>

namespace libdar
{



    class fichier_global : public generic_file, public thread_cancellation, public mem_ui
    {
    public :
    enum advise
    {
        advise_normal,     
        advise_sequential, 
        advise_random,     
        advise_noreuse,    
        advise_willneed,   
        advise_dontneed    
    };


        fichier_global(const std::shared_ptr<user_interaction> & dialog,
               gf_mode mode): generic_file(mode),
                      mem_ui(dialog),
                      disk_full(false) {};

    fichier_global(const fichier_global & ref) = default;

    fichier_global(fichier_global && ref) noexcept = default;

    fichier_global & operator = (const fichier_global & ref) = default;

    fichier_global & operator = (fichier_global && ref) noexcept = default;

        // destructor
    ~fichier_global() = default;

    virtual void change_ownership(const std::string & user, const std::string & group) = 0;

    virtual void change_permission(U_I perm) = 0;

        virtual infinint get_size() const = 0;

    virtual void fadvise(advise adv) const = 0;

    protected :

    virtual U_I fichier_global_inherited_write(const char *a, U_I size) = 0;



    virtual bool fichier_global_inherited_read(char *a, U_I size, U_I & read, std::string & message) = 0;

    private:
    bool disk_full; 

        // inherited from generic_file class and relocated as private methods
    virtual void inherited_write(const char *a, U_I size) override;
    virtual U_I inherited_read(char *a, U_I size) override;
    };



} // end of namespace

#endif