Disk ARchive  2.5.2
Full featured and portable backup and archiving tool
Namespaces | Macros | Functions | Variables
libdar.hpp File Reference

the main file of the libdar API definitions More...

#include "../my_config.h"
#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"
#include "capabilities.hpp"

Go to the source code of this file.

Namespaces

 libdar
 libdar namespace encapsulate all libdar symbols
 

Macros

#define LIBDAR_XXXXXXXX
 The following macro are used in the "exception" argument of the *_noexcept() functions.
 
#define LIBDAR_NOEXCEPT   0
 normal return no exception has been thrown
 
#define LIBDAR_EMEMORY   1
 memory has been exhausted
 
#define LIBDAR_EBUG   2
 internal bug error.
 
#define LIBDAR_EINFININT   3
 division by zero or other arithmetic error
 
#define LIBDAR_ELIMITINT   4
 limitint overflow
 
#define LIBDAR_ERANGE   5
 range error
 
#define LIBDAR_EDECI   6
 decimal representation error
 
#define LIBDAR_EFEATURE   7
 feature not (yet) implemented
 
#define LIBDAR_EHARDWARE   8
 hardware failure
 
#define LIBDAR_EUSER_ABORT   9
 user has aborted the operation
 
#define LIBDAR_EDATA   10
 data inconsistency, error concerning the treated data
 
#define LIBDAR_ESCRIPT   11
 inter slice script failure
 
#define LIBDAR_ELIBCALL   12
 libdar invalid call (wrong argument given to call, etc.)
 
#define LIBDAR_UNKNOWN   13
 unknown error
 
#define LIBDAR_ECOMPILATION   14
 feature not activated at compilation time
 
#define LIBDAR_THREAD_CANCEL   15
 thread cancellation has been requested
 

Functions

void libdar::get_version (U_I &major, U_I &medium, U_I &minor, bool init_libgcrypt=true)
 return the libdar version, and make libdar initialization (may throw Exceptions) More...
 
void libdar::get_version_noexcept (U_I &major, U_I &medium, U_I &minor, U_16 &exception, std::string &except_msg, bool init_libgcrypt=true)
 return the libdar version, and make libdar initialization (does not throw exceptions) More...
 
void libdar::close_and_clean ()
 
archive * libdar::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)
 this is a wrapper around the archive constructor known as the "read" constructor More...
 
archive * libdar::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)
 this is a wrapper around the archive constructor known as the "create" constructor More...
 
archive * libdar::isolate_archive_noexcept (user_interaction &dialog, archive *ptr, const path &sauv_path, const std::string &filename, const std::string &extension, const archive_options_isolate &options, U_16 &exception, std::string &except_msg)
 this is a wrapper around the archive constructor known as the "isolate" constructor More...
 
archive * libdar::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)
 this is a wrapper around the archive constructor known as the "merging" constructor More...
 
void libdar::close_archive_noexcept (archive *ptr, U_16 &exception, std::string &except_msg)
 this is wrapper around the archive destructor More...
 
statistics libdar::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)
 this is wrapper around the op_extract method More...
 
void libdar::op_listing_noexcept (user_interaction &dialog, archive *ptr, const archive_options_listing &options, U_16 &exception, std::string &except_msg)
 this is wrapper around the op_listing method More...
 
statistics libdar::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)
 this is wrapper around the op_diff method More...
 
statistics libdar::op_test_noexcept (user_interaction &dialog, archive *ptr, const archive_options_test &options, statistics *progressive_report, U_16 &exception, std::string &except_msg)
 this is wrapper around the op_test method More...
 
bool libdar::get_children_of_noexcept (user_interaction &dialog, archive *ptr, const std::string &dir, U_16 &exception, std::string &except_msg)
 this is wrapper around the get_children_of method More...
 
char * libdar::libdar_str2charptr_noexcept (const std::string &x, U_16 &exception, std::string &except_msg)
 routine provided to convert std::string to char * More...
 

Variables

const U_I libdar::LIBDAR_COMPILE_TIME_MAJOR = 5
 libdar Major version defined at compilation time
 
const U_I libdar::LIBDAR_COMPILE_TIME_MEDIUM = 7
 libdar Medium version defined at compilation time
 
const U_I libdar::LIBDAR_COMPILE_TIME_MINOR = 2
 libdar Minor version defined at compilation time
 

Detailed Description

the main file of the libdar API definitions

Definition in file libdar.hpp.