CLI.hpp
12.5 KB
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
#pragma once
#include <string>
#include <regex>
#include <iostream>
#include <functional>
#include <tuple>
#include <exception>
#include <algorithm>
#include <sstream>
#include <type_traits>
// This is unreachable outside this file; you should not use Combiner directly
namespace {
void logit(std::string output) {
std::cout << output << std::endl;
}
template <typename T>
std::string join(const T& v, std::string delim = ",") {
std::ostringstream s;
for (const auto& i : v) {
if (&i != &v[0]) {
s << delim;
}
s << i;
}
return s.str();
}
struct Combiner {
int num;
bool positional;
bool required;
bool defaulted;
/// Can be or-ed together
Combiner operator | (Combiner b) const {
Combiner self;
self.num = num + b.num;
self.positional = positional || b.positional;
self.required = required || b.required;
self.defaulted = defaulted || b.defaulted;
return self;
}
/// Call to give the number of arguments expected on cli
Combiner operator() (int n) const {
return Combiner{n, positional, required, defaulted};
}
Combiner operator, (Combiner b) const {
return *this | b;
}
};
}
namespace CLI {
class BadNameString : public std::runtime_error {
public:
BadNameString(std::string name) : runtime_error("Failed to parse: " + name) {};
};
class CallForHelp : public std::runtime_error {
public:
CallForHelp() : runtime_error("Help option passed") {};
};
class ParseError : public std::runtime_error {
public:
ParseError(std::string info="") : runtime_error(info) {};
};
class OptionAlreadyAdded : public std::runtime_error {
public:
OptionAlreadyAdded(std::string name) : runtime_error("Already added:" + name) {};
};
const std::regex reg_split{R"regex((?:([a-zA-Z0-9]?)(?:,|$)|^)([a-zA-Z0-9][a-zA-Z0-9_\-]*)?)regex"};
const std::regex reg_short{R"regex(-([^-])(.*))regex"};
const std::regex reg_long{R"regex(--([^-^=][^=]*)=?(.*))regex"};
std::tuple<std::string, std::string> split(std::string fullname) throw(BadNameString) {
std::smatch match;
if (std::regex_match(fullname, match, reg_split)) {
std::string sname = match[1];
std::string lname = match[2];
if(sname == "" and lname == "")
throw BadNameString("EMPTY");
return std::tuple<std::string, std::string>(sname, lname);
} else throw BadNameString(fullname);
}
const Combiner NOTHING {0,false,false,false};
const Combiner REQUIRED {0,false,true, false};
const Combiner DEFAULT {0,false,false,true};
const Combiner POSITIONAL{0,true, false,false};
const Combiner ARGS {1,false,false,false};
typedef std::vector<std::vector<std::string>> results_t;
typedef std::function<bool(results_t)> callback_t;
class Option {
public:
protected:
// Config
std::string sname;
std::string lname;
Combiner opts;
std::string discription;
callback_t callback;
// Results
results_t results {};
public:
Option(std::string name, std::string discription = "", Combiner opts=NOTHING, std::function<bool(results_t)> callback=[](results_t){return true;}) throw (BadNameString) :
opts(opts), discription(discription), callback(callback){
std::tie(sname, lname) = split(name);
}
/// Process the callback
bool run_callback() const {
return callback(results);
}
/// Indistinguishible options are equal
bool operator== (const Option& other) const {
if(sname=="" && other.sname=="")
return lname==other.lname;
else if(lname=="" && other.lname=="")
return sname==other.sname;
else
return sname==other.sname || lname==other.lname;
}
std::string getName() const {
if(sname=="")
return "--" + lname;
else if (lname=="")
return "-" + sname;
else
return "-" + sname + ", --" + lname;
}
bool check_sname(const std::string& name) const {
return name == sname;
}
bool check_lname(const std::string& name) const {
return name == lname;
}
std::string get_sname() const {
return sname;
}
std::string get_lname() const {
return lname;
}
int get_num() const {
return opts.num;
}
void add_result(int r, std::string s) {
results.at(r).push_back(s);
}
int get_new() {
results.emplace_back();
return results.size() - 1;
}
int count() {
return results.size();
}
std::string string() const {
std::string val = "Option: " + getName() + "\n"
+ " " + discription + "\n"
+ " [";
for(const auto& item : results) {
if(&item!=&results[0])
val+="],[";
val += join(item);
}
val += "]";
return val;
}
};
/// Creates a command line program, with very few defaults.
/** To use, create a new Program() instance with argc, argv, and a help discription. The templated
* add_option methods make it easy to prepare options. Remember to call `.start` before starting your
* program, so that the options can be evaluated and the help option doesn't accidentally run your program. */
class App {
public:
protected:
std::string desc;
std::vector<Option> options;
std::vector<std::string> missing_options;
std::vector<std::string> positionals;
public:
/// Create a new program. Pass in the same arguments as main(), along with a help string.
App(std::string discription)
: desc(discription) {
}
/// Add an option, will automatically understand the type for common types.
/** To use, create a variable with the expected type, and pass it in after the name.
* After start is called, you can use count to see if the value was passed, and
* the value will be initialized properly.
*
* Program::REQUIRED, Program::DEFAULT, and Program::POSITIONAL are options, and can be `|`
* together. The positional options take an optional number of arguments.
*
* For example,
*
* std::string filename
* program.add_option("filename", filename, "discription of filename");
*/
void add_option(
std::string name, ///< The name, long,short
callback_t callback, ///< The callback
std::string discription="", ///< Discription string
Combiner opts=ARGS ///< The options (REQUIRED, DEFAULT, POSITIONAL, ARGS())
) {
Option myopt{name, discription, opts, callback};
if(std::find(std::begin(options), std::end(options), myopt) == std::end(options))
options.push_back(myopt);
else
throw OptionAlreadyAdded(myopt.getName());
}
/// Add option for string
void add_option(
std::string name, ///< The name, long,short
std::string &variable, ///< The variable to set
std::string discription="", ///< Discription string
Combiner opts=ARGS ///< The options (REQUIRED, DEFAULT, POSITIONAL, ARGS())
) {
CLI::callback_t fun = [&variable](CLI::results_t res){
if(res.size()!=1) {
return false;
}
if(res[0].size()!=1) {
return false;
}
variable = res[0][0];
return true;
};
add_option(name, fun, discription, opts);
}
/// Add option for flag
void add_flag(
std::string name, ///< The name, short,long
std::string discription="" ///< Discription string
) {
CLI::callback_t fun = [](CLI::results_t res){
return true;
};
add_option(name, fun, discription, NOTHING);
}
/// Add option for flag
template<typename T>
typename std::enable_if<std::is_integral<T>::value, void>::type
add_flag(
std::string name, ///< The name, short,long
T &count, ///< A varaible holding the count
std::string discription="" ///< Discription string
) {
count = 0;
CLI::callback_t fun = [&count](CLI::results_t res){
count = res.size();
return true;
};
add_option(name, fun, discription, NOTHING);
}
/// Parses the command line - throws errors
void parse(int argc, char **argv) throw(CallForHelp, ParseError) {
std::vector<std::string> args;
for(int i=1; i<argc; i++)
args.emplace_back(argv[i]);
parse(args);
}
void parse(std::vector<std::string> args) throw(CallForHelp, ParseError) {
std::reverse(args.begin(), args.end());
bool positional_only = false;
while(args.size()>0) {
if(args.back() == "--") {
args.pop_back();
positional_only = true;
} else if(positional_only || (!_parse_long(args) && !_parse_short(args))) {
logit("Positional: "+args.back());
positionals.push_back(args.back());
args.pop_back();
}
}
for(Option& opt : options)
if (opt.count() > 0) {
logit(opt.string());
if(!opt.run_callback())
logit("Failed");
}
//TODO: Check for false callbacks
}
bool _parse_short(std::vector<std::string> &args) {
std::string current = args.back();
std::smatch match;
if(!std::regex_match(current, match, reg_short))
return false;
args.pop_back();
std::string name = match[1];
std::string rest = match[2];
logit("Working on short:");
logit(name);
logit(rest);
auto op = std::find_if(std::begin(options), std::end(options), [name](const Option &v){return v.check_sname(name);});
if(op == std::end(options)) {
missing_options.push_back("-" + op->get_sname());
return true;
}
int vnum = op->get_new();
int num = op->get_num();
if(rest != "" && num > 0) {
num--;
op->add_result(vnum, rest);
rest = "";
}
while(num>0) {
num--;
std::string current = args.back();
logit("Adding: "+current);
args.pop_back();
op->add_result(vnum,current);
if(args.size()==0)
return true;
}
if(rest != "") {
rest = "-" + rest;
args.push_back(rest);
}
return true;
}
bool _parse_long(std::vector<std::string> &args) {
std::string current = args.back();
std::smatch match;
if(!std::regex_match(current, match, reg_long))
return false;
args.pop_back();
std::string name = match[1];
std::string value = match[2];
logit("Working on long:");
logit(name);
logit(value);
auto op = std::find_if(std::begin(options), std::end(options), [name](const Option &v){return v.check_lname(name);});
if(op == std::end(options)) {
missing_options.push_back("--" + op->get_lname());
return true;
}
int vnum = op->get_new();
int num = op->get_num();
if(value != "") {
num--;
op->add_result(vnum, value);
}
while(num>0) {
num--;
std::string current = args.back();
args.pop_back();
op->add_result(vnum,current);
if(args.size()==0)
return true;
}
return true;
}
/// This must be called after the options are in but before the rest of the program.
/** Instead of throwing erros, causes the program to exit
* if -h or an invalid option is passed. */
void start(int argc, char** argv) {
try {
parse(argc, argv);
} catch(const CallForHelp &e) {
std::cout << help() << std::endl;
exit(0);
} catch(const ParseError &e) {
std::cerr << "ERROR:" << std::endl;
std::cerr << e.what() << std::endl;
std::cerr << help() << std::endl;
exit(1);
}
}
/// Counts the number of times the given option was passed.
int count(std::string name) const {
return 0;
}
std::string help() const {return "";}
};
}