#include <user_interaction.hpp>
Inherited by libdar::user_interaction_callback.
Public Member Functions | |
user_interaction () | |
class constructor. | |
virtual | ~user_interaction () |
virtual void | pause (const std::string &message) |
method used to ask a boolean question to the user. | |
virtual bool | pause2 (const std::string &message) |
alternative method to the pause() method | |
void | warning (const std::string &message) |
method used to display a warning or a message to the user. | |
virtual std::string | get_string (const std::string &message, bool echo)=0 |
method used to ask a question that needs an arbitrary answer. | |
virtual void | listing (const std::string &flag, const std::string &perm, const std::string &uid, const std::string &gid, const std::string &size, const std::string &date, const std::string &filename, bool is_dir, bool has_children) |
virtual void | dar_manager_show_files (const std::string &filename, bool available_data, bool available_ea) |
virtual void | dar_manager_contents (U_I number, const std::string &chemin, const std::string &archive_name) |
virtual void | dar_manager_statistics (U_I number, const infinint &data_count, const infinint &total_data, const infinint &ea_count, const infinint &total_ea) |
virtual void | dar_manager_show_version (U_I number, const std::string &data_date, const std::string &ea_date) |
void | printf (const char *format,...) |
libdar uses this call to format output before send to warning() method. | |
bool | get_use_listing () const |
this is not a virtual method, it has not to be overwritten in inherited classes. | |
bool | get_use_dar_manager_show_files () const |
this is not a virtual method, it has not to be overwritten in inherited classes. | |
bool | get_use_dar_manager_contents () const |
this is not a virtual method, it has not to be overwritten in inherited classes. | |
bool | get_use_dar_manager_statistics () const |
this is not a virtual method, it has not to be overwritten in inherited classes. | |
bool | get_use_dar_manager_show_version () const |
this is not a virtual method, it has not to be overwritten in inherited classes. | |
virtual user_interaction * | clone () const =0 |
make a newly allocated object which has the same properties as "this". | |
void | warning_with_more (U_I num) |
make a pause each N line of output when calling the warning method | |
Protected Member Functions | |
void | set_use_listing (bool val) |
method to be called with true as argument if you have defined a listing() method. | |
void | set_use_dar_manager_show_files (bool val) |
method to be called with true as argument if you have defined a dar_manager_show_files() method. | |
void | set_use_dar_manager_contents (bool val) |
method to be called with true as argument if you have defined a dar_manager_contents() method. | |
void | set_use_dar_manager_statistics (bool val) |
method to be called with true as argument if you have defined a dar_manager_statistics() method. | |
void | set_use_dar_manager_show_version (bool val) |
method to be called with true as argument if you have defined a dar_manager_show_version() method. | |
virtual void | inherited_warning (const std::string &message)=0 |
need to be overwritten in place of the warning() method since API 3.1.x |
You can base your own class on it using C++ inheritance or use the class user_interaction_callback which implements the interaction based on callback functions. The user_interaction class is used by libdar in the following circumpstances:
Definition at line 91 of file user_interaction.hpp.
virtual void libdar::user_interaction::pause | ( | const std::string & | message | ) | [inline, virtual] |
method used to ask a boolean question to the user.
[in] | message | is the message to be displayed, that is the question. |
Euser_abort | If the user answer "false" or "no" to the question the method must throw an exception of type "Euser_abort". |
Reimplemented in libdar::user_interaction_callback.
Definition at line 104 of file user_interaction.hpp.
References pause2().
virtual bool libdar::user_interaction::pause2 | ( | const std::string & | message | ) | [inline, virtual] |
alternative method to the pause() method
[in] | message | The boolean question to ask to the user |
Definition at line 118 of file user_interaction.hpp.
Referenced by pause().
void libdar::user_interaction::warning | ( | const std::string & | message | ) |
method used to display a warning or a message to the user.
[in] | message | is the message to display. |
virtual std::string libdar::user_interaction::get_string | ( | const std::string & | message, | |
bool | echo | |||
) | [pure virtual] |
method used to ask a question that needs an arbitrary answer.
[in] | message | is the question to display to the user. |
[in] | echo | is set to false is the answer must not be shown while the user answers. |
Implemented in libdar::user_interaction_callback.
virtual void libdar::user_interaction::listing | ( | const std::string & | flag, | |
const std::string & | perm, | |||
const std::string & | uid, | |||
const std::string & | gid, | |||
const std::string & | size, | |||
const std::string & | date, | |||
const std::string & | filename, | |||
bool | is_dir, | |||
bool | has_children | |||
) | [virtual] |
optional method to use if you want file listing splitted in several fields. If want to use this feature, you have then to supply an implementation for this method, in your inherited class which will be called by libdar in place of the warning method You will also have to call the set_use_listing() method has been called with true as parameter from the constructor of your inherited class to tell libdar that the listing() method is to be used in place of the warning() method for archive listing.
[in] | flag | is the given information about the EA, compression, presence of saved data. |
[in] | perm | is the access permission of the file. |
[in] | uid | User ID of the file. |
[in] | gid | Group ID of the file. |
[in] | size | file size. |
[in] | date | file modification date. |
[in] | filename | file name. |
[in] | is_dir | true if file is a directory. |
[in] | has_children | true if file is a directory which is not empty. |
Reimplemented in libdar::user_interaction_callback.
virtual void libdar::user_interaction::dar_manager_show_files | ( | const std::string & | filename, | |
bool | available_data, | |||
bool | available_ea | |||
) | [virtual] |
optional method to use if you want dar_manager database contents listing split in several fields. if you want to use this feature, you have then to supply an implementation for this method in your inherited class, method that will be called by libdar in place of the warning method. You will also have to call the set_use_dar_manager_show_files() protected method with true as argument from the constructor of your inherited class to tell libdar to use the dar_manager_show_files() method in place of the warning() method.
[in] | filename | name of the file |
[in] | available_data | whether the backup has data associated with the file |
[in] | available_ea | whether the backup has Extended Attributes associated with the file |
Reimplemented in libdar::user_interaction_callback.
virtual void libdar::user_interaction::dar_manager_contents | ( | U_I | number, | |
const std::string & | chemin, | |||
const std::string & | archive_name | |||
) | [virtual] |
optional method to use if you want dar_manager database archive listing split in several fields if you want to use this feature, you have then to supply an implementation for this method in your inherited class, method that will be called by libdar in place of the warning method. You will also have to call the set_use_dar_manager_contents() protected method with true as argument from the constructor of your inherited class to tell libdar to use the dar_manager_contents() method in place of the warning() method.
[in] | number | is the number of the archive in the database |
[in] | chemin | recorded path where to find this archive |
[in] | archive_name | basename of this archive |
Reimplemented in libdar::user_interaction_callback.
virtual void libdar::user_interaction::dar_manager_statistics | ( | U_I | number, | |
const infinint & | data_count, | |||
const infinint & | total_data, | |||
const infinint & | ea_count, | |||
const infinint & | total_ea | |||
) | [virtual] |
optional method to use if you want dar_manager statistics listing split in several fields if you want to use this feature, you have then to supply an implementation for this method in your inherited class, method that will be called by libdar in place of the warning method. You will also have to call the set_use_dar_manager_statistics() protected method with true as argument from the constructor of your inherited class to tell libdar to use the dar_manager_statistics() method in place of the warning() method.
[in] | number | archive number |
[in] | data_count | amount of file which last version is located in this archive |
[in] | total_data | total number of file covered in this database |
[in] | ea_count | amount of EA which last version is located in this archive |
[in] | total_ea | total number of file that have EA covered by this database |
Reimplemented in libdar::user_interaction_callback.
virtual void libdar::user_interaction::dar_manager_show_version | ( | U_I | number, | |
const std::string & | data_date, | |||
const std::string & | ea_date | |||
) | [virtual] |
optional method to use if you want dar_manager statistics listing split in several fields if you want to use this feature, you have then to supply an implementation for this method in your inherited class, method that will be called by libdar in place of the warning method. You will also have to call the set_use_dar_manager_show_version() protected method with true as argument from the constructor of your inherited class to tell libdar to use the dar_manager_show_version() method in place of the warning() method.
[in] | number | archive number |
[in] | data_date | is the last modification date of the requested file in thie archive whose number is "number" |
[in] | ea_date | is the date of the EA for the requested file in the archive whose number is "number" |
Reimplemented in libdar::user_interaction_callback.
void libdar::user_interaction::printf | ( | const char * | format, | |
... | ||||
) |
bool libdar::user_interaction::get_use_listing | ( | ) | const [inline] |
this is not a virtual method, it has not to be overwritten in inherited classes.
for libdar to know if it is interesting to use listing(), dar_manager_show_files(), dar_manager_contents(), dar_manager_statistics() or to keep reporting listing thanks to the warning() method,
Definition at line 247 of file user_interaction.hpp.
virtual user_interaction* libdar::user_interaction::clone | ( | ) | const [pure virtual] |
make a newly allocated object which has the same properties as "this".
This *is* a virtual method, it *must* be overwritten in any inherited class copy constructor and = operator may have to be overwrittent too if necessary Warning ! clone() must throw exception if necessary (Ememory), but never return a NULL pointer !
Implemented in libdar::user_interaction_callback.
Referenced by libdar::filesystem_hard_link_read::filesystem_hard_link_read(), libdar::filesystem_hard_link_write::filesystem_hard_link_write(), and libdar::generic_file::generic_file().
void libdar::user_interaction::warning_with_more | ( | U_I | num | ) | [inline] |
make a pause each N line of output when calling the warning method
[in] | num | is the number of line to display at once, zero for unlimited display |
Definition at line 273 of file user_interaction.hpp.
void libdar::user_interaction::set_use_listing | ( | bool | val | ) | [inline, protected] |
method to be called with true as argument if you have defined a listing() method.
in the constructor of any inherited class that define a listing() method it is advisable to call set_use_listing() with true as argument for libdar knows that the listing() call has to be used in place of the warning() call for file listing.
Definition at line 283 of file user_interaction.hpp.
Referenced by libdar::user_interaction_callback::set_listing_callback().
virtual void libdar::user_interaction::inherited_warning | ( | const std::string & | message | ) | [protected, pure virtual] |
need to be overwritten in place of the warning() method since API 3.1.x
[in] | message | message to display |
Implemented in libdar::user_interaction_callback.