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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
// -*-C++-*-
// Copyright © 2011, 2012, 2014-18 Richard Kettlewell.
//
// 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 3 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, see <http://www.gnu.org/licenses/>.
#ifndef COMMANDLINE_H
#define COMMANDLINE_H
/** @file Command.h
* @brief Command-line parsing
*/
#include <string>
#include <vector>
#include <cstdio>
#include "Defaults.h"
#include "Selection.h"
struct option;
/** @brief Represents the parsed command line */
class Command {
public:
Command() = default;
Command(const Command &) = delete;
Command &operator=(const Command &) = delete;
~Command();
/** @brief Verbosity of log summary in report */
enum LogVerbosity {
All,
Errors,
Recent,
Latest,
Failed,
};
/** @brief Parse command line arguments */
void parse(int argc, const char *const *argv);
/** @brief @c --backup action
*
* The default is @c false.
*/
bool backup = false;
/** @brief @c --prune action
*
* The default is @c false.
*/
bool prune = false;
/** @brief @c --prune-incomplete action
*
* The default is @c false.
*/
bool pruneIncomplete = false;
/** @brief @c --retire action
*
* The default is @c false.
*/
bool retire = false;
/** @brief @c --retire-device action
*
* The default is @c false.
*/
bool retireDevice = false;
/** @brief @c --dump-config action
*
* The default is @c false.
*/
bool dumpConfig = false;
/** @brief Output file for HTML report or null pointer */
std::string *html = nullptr;
/** @brief Output file for text report or null pointer */
std::string *text = nullptr;
/** @brief Address for email report or null pointer */
std::string *email = nullptr;
/** @brief Explicitly specified stores */
std::vector<std::string> stores;
/** @brief Explicitly specified stores
*
* These ones don't have to be mount points.
*/
std::vector<std::string> unmountedStores;
/** @brief Wait if lock cannot be held
*
* The default is @c false.
*/
bool wait = false;
/** @brief Actually do something
*
* i.e. opposite of @c --no-act
*
* The default is @c true.
*/
bool act = true;
/** @brief Force retirement
*
* The default is @c false.
*/
bool force = false;
/** @brief Database-only retirement
*
* The default is @c false.
*/
bool forgetOnly = false;
/** @brief Log summary verbosity */
LogVerbosity logVerbosity = Failed;
/** @brief Devices selected for retirement */
std::vector<std::string> devices;
/** @brief Selections */
VolumeSelections selections;
/** @brief Convert verbosity from string
* @param v Verbosity string from command line
* @return Enumeration value
*/
static LogVerbosity getVerbosity(const std::string &v);
/** @brief Return the help string */
static const char *helpString();
/** @brief Option table
* Used by getopt_long(3).
*/
static const struct option options[];
private:
/** @brief Display help message and terminate */
[[noreturn]] void help();
/** @brief Display version string and terminate */
[[noreturn]] void version();
};
/** @brief Program command line */
extern Command command;
/** @brief Path to config file
*
* This defaults to @ref DEFAULT_CONFIG.
*/
extern std::string configPath;
/** @brief Database path */
extern std::string database;
#endif /* COMMANDLINE_H */
|
