libdar.hpp

Go to the documentation of this file.

/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2052 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//
// to contact the author : http://dar.linux.free.fr/email.html
/*********************************************************************/

    // NOTE : The following comments are used by doxygen to generate the documentation of reference










#ifndef LIBDAR_HPP
#define LIBDAR_HPP

#include "../my_config.h"

extern "C"
{
#if MUTEX_WORKS
#if HAVE_PTHREAD_H
#include <pthread.h>
#endif
#endif
}


#include <string>
#include "compressor.hpp"
#include "path.hpp"
#include "mask.hpp"
#include "integers.hpp"
#include "infinint.hpp"
#include "statistics.hpp"
#include "user_interaction.hpp"
#include "deci.hpp"
#include "archive.hpp"
#include "crypto.hpp"
#include "thread_cancellation.hpp"
#include "compile_time_features.hpp"


#define LIBDAR_XXXXXXXX

#define LIBDAR_NOEXCEPT 0

#define LIBDAR_EMEMORY 1

#define LIBDAR_EBUG 2

#define LIBDAR_EINFININT 3

#define LIBDAR_ELIMITINT 4

#define LIBDAR_ERANGE 5

#define LIBDAR_EDECI 6

#define LIBDAR_EFEATURE 7

#define LIBDAR_EHARDWARE 8

#define LIBDAR_EUSER_ABORT 9

#define LIBDAR_EDATA 10

#define LIBDAR_ESCRIPT 11

#define LIBDAR_ELIBCALL 12

#define LIBDAR_UNKNOWN 13

#define LIBDAR_ECOMPILATION 14

#define LIBDAR_THREAD_CANCEL 15


namespace libdar
{


    const U_I LIBDAR_COMPILE_TIME_MAJOR = 5;
    const U_I LIBDAR_COMPILE_TIME_MEDIUM = 5;
    const U_I LIBDAR_COMPILE_TIME_MINOR = 0;

        // LIBDAR INITIALIZATION METHODS                                      //
        //                                                                    //
        //      A FUNCTION OF THE get_version*() FAMILY *MUST* BE CALLED      //
        //            BEFORE ANY OTHER FUNCTION OF THIS LIBRARY               //
        //                                                                    //
        // CLIENT PROGRAM MUST CHECK THAT THE MAJOR NUMBER RETURNED           //
        // BY THIS CALL IS NOT GREATER THAN THE VERSION USED AT COMPILATION   //
        // TIME. IF SO, THE PROGRAM MUST ABORT AND RETURN A WARNING TO THE    //
        // USER TELLING THE DYNAMICALLY LINKED VERSION IS TOO RECENT AND NOT  //
        // COMPATIBLE WITH THIS SOFTWARE. THE MESSAGE MUST INVITE THE USER    //
        // TO UPGRADE HIS SOFTWARE WITH A MORE RECENT VERSION COMPATIBLE WITH //
        // THIS LIBDAR RELEASE.                                               //


    extern void get_version(U_I & major, U_I & medium, U_I & minor, bool init_libgcrypt = true);


    extern void get_version_noexcept(U_I & major, U_I & medium, U_I & minor, U_16 & exception, std::string & except_msg, bool init_libgcrypt = true);


        // CLOSING/CLEANING LIBDAR                   //

        // while libdar has only a single boolean as global variable
        // that defines whether the library is initialized or not
        // it must proceed to mutex, and dependent libraries initializations
        // (liblzo, libgcrypt, etc.), which is done during the get_version() call
        // Some library also need to clear some data so the following call
        // is provided in that aim and must be called when libdar will no more
        // be used by the application.

    extern void close_and_clean();


        // WRAPPER FUNCTIONS AROUND archive class methods to trap exceptions and convert them in error code and message
        // these are intended for C program/programmers not enough confident with C++.
        //
        // FOR LIBDAR C++ APPLICATIONS, YOU WOULD RATHER USE THE archive C++ CLASS THAN THESE FOLLOWING WRAPPERS
        //



    extern archive* open_archive_noexcept(user_interaction & dialog,
                                          const path & chem, const std::string & basename,
                                          const std::string & extension,
                                          const archive_options_read & options,
                                          U_16 & exception,
                                          std::string & except_msg);



    extern archive *create_archive_noexcept(user_interaction & dialog,
                                            const path & fs_root,
                                            const path & sauv_path,
                                            const std::string & filename,
                                            const std::string & extension,
                                            const archive_options_create & options,
                                            statistics * progressive_report,
                                            U_16 & exception,
                                            std::string & except_msg);




    extern archive *isolate_archive_noexcept(user_interaction & dialog,
                                             const path &sauv_path,
                                             archive *ref_arch,
                                             const std::string & filename,
                                             const std::string & extension,
                                             const archive_options_isolate & options,
                                             U_16 & exception,
                                             std::string & except_msg);


    extern archive *merge_archive_noexcept(user_interaction & dialog,
                                           const path & sauv_path,
                                           archive *ref_arch1,
                                           const std::string & filename,
                                           const std::string & extension,
                                           const archive_options_merge & options,
                                           statistics * progressive_report,
                                           U_16 & exception,
                                           std::string & except_msg);



    extern void close_archive_noexcept(archive *ptr,
                                       U_16 & exception,
                                       std::string & except_msg);



    extern statistics op_extract_noexcept(user_interaction & dialog,
                                          archive *ptr,
                                          const path &fs_root,
                                          const archive_options_extract & options,
                                          statistics * progressive_report,
                                          U_16 & exception,
                                          std::string & except_msg);



    extern void op_listing_noexcept(user_interaction & dialog,
                                    archive *ptr,
                                    const archive_options_listing & options,
                                    U_16 & exception,
                                    std::string & except_msg);



    extern statistics op_diff_noexcept(user_interaction & dialog,
                                       archive *ptr,
                                       const path & fs_root,
                                       const archive_options_diff & options,
                                       statistics * progressive_report,
                                       U_16 & exception,
                                       std::string & except_msg);



    extern statistics op_test_noexcept(user_interaction & dialog,
                                       archive *ptr,
                                       const archive_options_test & options,
                                       statistics * progressive_report,
                                       U_16 & exception,
                                       std::string & except_msg);



    extern bool get_children_of_noexcept(user_interaction & dialog,
                                         archive *ptr,
                                         const std::string & dir,
                                         U_16 & exception,
                                         std::string & except_msg);



        // TOOLS ROUTINES                            //



    extern char *libdar_str2charptr_noexcept(const std::string & x, U_16 & exception, std::string & except_msg);

        // THREAD CANCELLATION ROUTINES              //

#if MUTEX_WORKS


    inline extern void cancel_thread(pthread_t tid, bool immediate = true, U_64 flag = 0) { thread_cancellation::cancel(tid, immediate, flag); }


    inline extern bool cancel_status(pthread_t tid) { return thread_cancellation::cancel_status(tid); }


    inline extern bool cancel_clear(pthread_t tid) { return thread_cancellation::clear_pending_request(tid); }
#endif



} // end of namespace

#endif