1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/* Copyright © 2005-2007 Roger Leigh <rleigh@codelibre.net>
*
* schroot 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 3 of the License, or
* (at your option) any later version.
*
* schroot 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, see
* <http://www.gnu.org/licenses/>.
*
*********************************************************************/
#ifndef SCHROOT_BASE_MAIN_H
#define SCHROOT_BASE_MAIN_H
#include <schroot-base/schroot-base-options.h>
#include <string>
/**
* schroot generic program components.
*
* Common infrastructure used by all programs. This includes options
* parsing and common options, top-level error handling and a generic
* method for program instantiation.
*/
namespace schroot_base
{
/**
* Frontend base for schroot programs. This class is used to "run"
* schroot programs. It contains functionality common to all
* programs, such as help and version output.
*/
class main
{
public:
/**
* The constructor.
*
* @param program_name the program name.
* @param program_usage the program usage message.
* @param program_options the command-line options to use.
* @param use_syslog whether to open a connection to the system
* logger.
*/
main (std::string const& program_name,
std::string const& program_usage,
options::ptr const& program_options,
bool use_syslog);
/// The destructor.
virtual ~main ();
/**
* Run the program.
*
* @param argc the number of arguments
* @param argv argument vector
* @returns 0 on success, 1 on failure or the exit status of the
* chroot command.
*/
int
run (int argc,
char *argv[]);
/**
* Print help information.
*
* @param stream the stream to output to.
*/
virtual void
action_help (std::ostream& stream);
/**
* Print version information.
*
* @param stream the stream to output to.
*/
virtual void
action_version (std::ostream& stream);
protected:
/**
* Run the program. This is the program-specific run method which
* must be implemented in a derived class.
*
* @returns 0 on success, 1 on failure or the exit status of the
* chroot command.
*/
virtual int
run_impl () = 0;
/// The name of the program.
std::string program_name;
/// The usage text of the program.
std::string program_usage;
/// The program options.
options::ptr program_options;
/// Use syslog for message logging>
bool use_syslog;
};
}
#endif /* SCHROOT_BASE_MAIN_H */
/*
* Local Variables:
* mode:C++
* End:
*/
|
