header.hpp

Go to the documentation of this file.

/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2025 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 HEADER_HPP
#define HEADER_HPP
 
#include "../my_config.h"
 
#include "infinint.hpp"
#include "generic_file.hpp"
#include "user_interaction.hpp"
#include "tlv_list.hpp"
#include "label.hpp"
 
namespace libdar
{
 
 
    const U_32 SAUV_MAGIC_NUMBER = 123; // Why "SAUV_..." because SAUV was the name of DAR much before its first release :-)
 
    using magic_number = U_32;
 
    enum flag_type
    {
    flag_type_terminal = 'T',
    flag_type_non_terminal = 'N',
    flag_type_located_at_end_of_slice = 'E' // since archive format version 8
    };
 
 
 
 
    class header
    {
    public:
        // constructors & Co.
 
        header();
        header(const header & ref) { copy_from(ref); };
    header(header && ref) noexcept { nullifyptr(); move_from(std::move(ref)); };
        header & operator = (const header & ref) { free_pointers(); copy_from(ref); return *this; };
    header & operator = (header && ref) noexcept { move_from(std::move(ref)); return *this; };
    ~header() { free_pointers(); };
 
        // global methods
 
        void read(user_interaction & ui, generic_file & f, bool lax = false );
        void write(user_interaction &, generic_file & f) const;
 
 
        static U_I min_size() { return sizeof(magic_number) + label::common_size() + 2*sizeof(char); };
 
 
        // fields access methods
 
    magic_number & get_set_magic() { return magic; };
    label & get_set_internal_name() { return internal_name; };
    char & get_set_flag() { return flag; };
    label & get_set_data_name() { return data_name; };
 
    bool get_first_slice_size(infinint & size) const;
    void set_first_slice_size(const infinint & size);
    void unset_first_slice_size() { if(first_size != nullptr) { delete first_size; first_size = nullptr; } };
 
    bool get_slice_size(infinint & size) const;
    void set_slice_size(const infinint & size);
    void unset_slice_size() { if(slice_size != nullptr) { delete slice_size; slice_size = nullptr; } };
 
    bool is_old_header() const { return old_header; };
    void set_format_07_compatibility() { old_header = true; };
 
    private:
        magic_number magic;    
        label internal_name;   
    label data_name;       
        char flag;             
        infinint *first_size;  
    infinint *slice_size;  
    bool old_header;       
 
    void nullifyptr() noexcept { first_size = slice_size = nullptr; };
        void copy_from(const header & ref);
    void move_from(header && ref) noexcept;
    void free_pointers();
    void fill_from(user_interaction & ui, const tlv_list & list);
    tlv_list build_tlv_list(user_interaction & ui) const;
    };
 
 
} // end of namespace
 
#endif