| Disk ARchive 2.8.1 Full featured and portable backup and archiving tool

Loading...
Searching...
No Matches
user_interaction.hpp
Go to the documentation of this file.
1/*********************************************************************/
2// dar - disk archive - a backup/restoration program
3// Copyright (C) 2002-2025 Denis Corbin
4//
5// This program is free software; you can redistribute it and/or
6// modify it under the terms of the GNU General Public License
7// as published by the Free Software Foundation; either version 2
8// of the License, or (at your option) any later version.
9//
10// This program is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with this program; if not, write to the Free Software
17// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18//
19// to contact the author, see the AUTHOR file
20/*********************************************************************/
21
25
26#ifndef USER_INTERACTION_HPP
27#define USER_INTERACTION_HPP
28
29#include "../my_config.h"
30
31extern "C"
32{
33#if MUTEX_WORKS
34#if HAVE_PTHREAD_H
35#include <pthread.h>
36#endif
37#endif
38}
39
40#include <string>
41#include <list>
42#include "secu_string.hpp"
43#include "infinint.hpp"
44#include "thread_cancellation.hpp"
45
46namespace libdar
47{
48
51
53
57 class user_interaction
58 {
59 public:
60 user_interaction() {};
61 user_interaction(const user_interaction & ref) = default;
62 user_interaction(user_interaction && ref) noexcept = default;
63 user_interaction & operator = (const user_interaction & ref) = default;
64 user_interaction & operator = (user_interaction && ref) noexcept = default;
65 virtual ~user_interaction() = default;
66
67 // the following methode are used by libdar and rely in their inherited_* versions
68 // than must be defined in the inherited classes
69
70 void message(const std::string & message);
71 void pause(const std::string & message);
72 std::string get_string(const std::string & message, bool echo);
73 secu_string get_secu_string(const std::string & message, bool echo);
74
76
84 virtual void printf(const char *format, ...);
85
87
88 bool cancellation_requested() const;
89
91
104
105 void add_thread_to_monitor(pthread_t tid);
106
108
109 void remove_thread_from_monitor(pthread_t tid);
110
111
112 protected:
118 virtual void inherited_message(const std::string & message) = 0;
119
121
126 virtual bool inherited_pause(const std::string & message) = 0;
127
128
130
136 virtual std::string inherited_get_string(const std::string & message, bool echo) = 0;
137
139
145 virtual secu_string inherited_get_secu_string(const std::string & message, bool echo) = 0;
146
147 private:
148
149#if MUTEX_WORKS
150#if HAVE_PTHREAD_H
151 thread_cancellation thcancel;
152
153 std::list<pthread_t> monitoring;
154#endif
155#endif
156
157 };
158
160
161} // end of namespace
162
163#endif
libdar::secu_string
class secu_string
Definition secu_string.hpp:54
libdar::thread_cancellation
class to be used as parent to provide checkpoints to inherited classes
Definition thread_cancellation.hpp:69
libdar::user_interaction
This is a pure virtual class that is used by libdar when interaction with the user is required.
Definition user_interaction.hpp:58
libdar::user_interaction::inherited_pause
virtual bool inherited_pause(const std::string &message)=0
method used to ask a boolean question to the user.
libdar::user_interaction::inherited_message
virtual void inherited_message(const std::string &message)=0
libdar::user_interaction::inherited_get_string
virtual std::string inherited_get_string(const std::string &message, bool echo)=0
method used to ask a question that needs an arbitrary answer.
libdar::user_interaction::add_thread_to_monitor
void add_thread_to_monitor(pthread_t tid)
add a thread to monitor
libdar::user_interaction::printf
virtual void printf(const char *format,...)
libdar uses this call to format output before sending to the message() method.
libdar::user_interaction::inherited_get_secu_string
virtual secu_string inherited_get_secu_string(const std::string &message, bool echo)=0
same a get_string() but uses libdar::secu_string instead of std::string
libdar::user_interaction::remove_thread_from_monitor
void remove_thread_from_monitor(pthread_t tid)
remove a thread from monitoring
libdar::user_interaction::cancellation_requested
bool cancellation_requested() const
known whether cancellation was requested for the current thread or an added thread
infinint.hpp
switch module to limitint (32 ou 64 bits integers) or infinint
my_config.h
include macro defined by the configure script and some specific additional ones
libdar
libdar namespace encapsulate all libdar symbols
Definition archive.hpp:47
secu_string.hpp
this file contains the definition of secu_string class, a std::string like class but allocated in sec...
thread_cancellation.hpp
to be able to cancel libdar operation while running in a given thread.