forked from funkey/util
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ProgramOptions.cpp
517 lines (378 loc) · 14.1 KB
/
ProgramOptions.cpp
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
#include <iostream>
#include <fstream>
#include <sstream>
#include <string>
#include <vector>
#include <algorithm>
#include <sys/ioctl.h> // to get environment variables
#include <boost/program_options.hpp>
#include <boost/tuple/tuple.hpp>
#include <util/foreach.h>
#include <config.h>
#include "ProgramOptions.h"
namespace util {
std::set<program_option_impl*, is_less>* ProgramOptions::Options = 0;
std::set<std::string>* ProgramOptions::KnownLongParams = 0;
std::map<const program_option_impl*, std::string> ProgramOptions::Values;
boost::program_options::options_description* ProgramOptions::CommandLineOptions = 0;
boost::program_options::positional_options_description* ProgramOptions::Positional = 0;
boost::program_options::options_description* ProgramOptions::ConfigFileOptions = 0;
std::string ProgramOptions::BinaryName = "";
ProgramOption help(
_long_name = "help",
_short_name = "h",
_description_text = "Prints this help.");
ProgramOption optionConfigFile(
_long_name = "config",
_short_name = "c",
_description_text = "Path to a configuration file to use instead of the default [name_of_binary].conf.",
_argument_sketch = "file");
bool
is_less::operator()(program_option_impl* left, program_option_impl* right) {
if (left->getModuleName() == right->getModuleName())
return left->getLongParam() < right->getLongParam();
else
return left->getModuleName() < right->getModuleName();
}
void
ProgramOptions::init(int argc, char** argv) {
BinaryName = argv[0];
if (Options == 0)
Options = new std::set<program_option_impl*, is_less>();
if (KnownLongParams == 0)
KnownLongParams = new std::set<std::string>();
// get all options
boost::program_options::variables_map values;
boost::program_options::store(boost::program_options::command_line_parser(argc, argv).options(*CommandLineOptions).positional(*Positional).run(), values);
boost::program_options::notify(values);
// set initial program option values
foreach(program_option_impl* option, *Options) {
if (values.count(option->getLongParam()))
Values[option] = values[option->getLongParam()].as<std::string>();
if (option->getModuleName() != "")
if (values.count(option->getModuleName() + "." + option->getLongParam()))
Values[option] = values[option->getModuleName() + "." + option->getLongParam()].as<std::string>();
}
if (help) {
printUsage();
exit(0);
}
// add the include option
ConfigFileOptions->add_options()
("include",
boost::program_options::value<std::vector<std::string> >()->composing(),
"Include another config file.");
// if config file is set, read from it as well
if (optionConfigFile) {
boost::filesystem::path configFile(optionConfigFile.as<std::string>());
if (boost::filesystem::exists(configFile))
readFromFile(configFile, values);
else
std::cerr << "ERROR: configuration file " << configFile << " does not exist" << std::endl;
// otherwise, try to read from [binary_name].conf
} else {
boost::filesystem::path defaultConfigFile(BinaryName + ".conf");
if (boost::filesystem::exists(defaultConfigFile)) {
readFromFile(defaultConfigFile, values);
}
#if defined(SYSTEM_LINUX) || defined(SYSTEM_FREEBSD)
else {
// if this does not exist, look in the home directory
char const* home = getenv("HOME");
boost::filesystem::path homeConfigFile(std::string(home) + "/.config/" + BinaryName + "/config");
if (boost::filesystem::exists(homeConfigFile))
readFromFile(homeConfigFile, values);
}
#endif
}
}
void
ProgramOptions::readFromFile(boost::filesystem::path configFile, boost::program_options::variables_map& values) {
unsigned int beginNewInclude;
if (values.count("include"))
beginNewInclude = values["include"].as<std::vector<std::string> >().size();
else
beginNewInclude = 0;
std::ifstream config(configFile.string().c_str());
if (!config.good()) {
std::cerr << "ERROR: can't open config file: " << configFile << std::endl;
return;
}
// read from the config file
boost::program_options::store(boost::program_options::parse_config_file(config, *ConfigFileOptions), values);
boost::program_options::notify(values);
// update program option values
foreach(program_option_impl* option, *Options) {
std::string module = (option->getModuleName() != "" ? option->getModuleName() + "." : "");
// set without module part? (shortcut, only for command line arguments)
if (values.count(option->getLongParam())) {
Values[option] = values[option->getLongParam()].as<std::string>();
// set with module part?
} else if (values.count(module + option->getLongParam())) {
Values[option] = values[module + option->getLongParam()].as<std::string>();
}
}
unsigned int endNewInclude = beginNewInclude;
if(values.count("include"))
endNewInclude = values["include"].as<std::vector<std::string> >().size();
// are there new includes?
if (endNewInclude > beginNewInclude) {
// include other config file back to front, such that the last one
// specified has precedence
for (int i = (int)endNewInclude - 1; i >= (int)beginNewInclude; i--) {
std::string includeFileName = values["include"].as<std::vector<std::string> >()[i];
// append include file name to current config file's directory
boost::filesystem::path includeFile = configFile.parent_path() / includeFileName;
if (!boost::filesystem::exists(includeFile)) {
std::cerr << "ERROR: include file " << includeFile << " does not exist" << std::endl;
continue;
}
readFromFile(includeFile, values);
}
}
}
bool
ProgramOptions::isOptionSet(const program_option_impl& option) {
return Values.find(&option) != Values.end();
}
std::string
ProgramOptions::getOptionValue(const program_option_impl& option) {
if (Values.count(&option))
return Values[&option];
else
return option.getDefaultValue();
}
void
ProgramOptions::addProgramOption(program_option_impl* option) {
if (Options == 0)
Options = new std::set<program_option_impl*, is_less>();
if (KnownLongParams == 0)
KnownLongParams = new std::set<std::string>();
if (CommandLineOptions == 0)
CommandLineOptions = new boost::program_options::options_description("command line options");
if (Positional == 0)
Positional = new boost::program_options::positional_options_description();
if (ConfigFileOptions == 0)
ConfigFileOptions = new boost::program_options::options_description("config file options");
std::string moduleName = (option->getModuleName() != "" ? option->getModuleName() + "." : "");
std::string argument = option->getLongParam() + (option->getShortParam() != "" ? "," + option->getShortParam() : "");
// add the option to the boost options descriptions
// to the command line options (--Module.longParam and -shortParam)
CommandLineOptions->add_options()
((moduleName + argument).c_str(),
boost::program_options::value<std::string>()->implicit_value("true"),
"");
// to the config file options ([Module] longParam)
ConfigFileOptions->add_options()
((moduleName + option->getLongParam()).c_str(),
boost::program_options::value<std::string>()->implicit_value("true"),
"");
// try adding the option without the module name (--longParam)
// (this might be ambiguous)
if (moduleName != "" &&
KnownLongParams->count(option->getLongParam()) == 0)
CommandLineOptions->add_options()
(option->getLongParam().c_str(),
boost::program_options::value<std::string>()->implicit_value("true"),
"");
// set it as the positional program option, if desired
if (option->isPositional())
Positional->add((moduleName + option->getLongParam()).c_str(), -1);
Options->insert(option);
KnownLongParams->insert(option->getLongParam());
}
std::string
extractLine(
std::string& str, size_t lineWidth,
std::string breakBefore = " \t",
std::string breakAfter = "-") {
// set break position behind last character initially
size_t breakPosition = str.length();
bool doBreakAfter = false;
// try to find a break position that fits a line
while ((doBreakAfter ? breakPosition - 1 : breakPosition) > lineWidth) {
int nextPossibleBreakBeforePosition =
str.find_last_of(breakBefore, breakPosition - 1);
int nextPossibleBreakAfterPosition =
str.find_last_of(breakAfter, breakPosition - 1);
size_t nextPossibleBreakPosition;
bool doPossibleBreakAfter;
if (nextPossibleBreakAfterPosition > nextPossibleBreakBeforePosition) {
doPossibleBreakAfter = true;
nextPossibleBreakPosition = nextPossibleBreakAfterPosition;
} else {
doPossibleBreakAfter = false;
nextPossibleBreakPosition = nextPossibleBreakBeforePosition;
}
if (nextPossibleBreakPosition == std::string::npos) {
break;
} else {
breakPosition = nextPossibleBreakPosition;
doBreakAfter = doPossibleBreakAfter;
}
}
if (doBreakAfter)
breakPosition++;
std::string line = str.substr(0, breakPosition);
// remove line from str and delete trailing spaces from remainer
size_t startSubString = str.find_first_not_of(' ', breakPosition);
if (startSubString == std::string::npos)
startSubString = breakPosition;
str = str.substr(startSubString, str.length());
return line;
}
std::string
stretchLine(std::string line, unsigned width) {
int difference = width - line.length();
if (difference <= 0)
return line;
// split line by spaces:
std::vector<std::string> words;
while (true) {
size_t spacePos = line.find_first_of(' ');
if (spacePos == std::string::npos) {
// no more spaces found
words.push_back(line);
break;
}
words.push_back(line.substr(0, spacePos));
line = line.substr(spacePos + 1);
}
int numSpaces = words.size() - 1;
// number of spaces need to be added to every space in the line
int equallyAugmentSpaces = (numSpaces != 0 ? difference / numSpaces : 0);
// number of spaces that have to be augmented by a single space additionally
int additionalAugmentSpaces = (numSpaces != 0 ? difference % numSpaces : 0);
std::string stretchedLine = "";
std::vector<std::string>::iterator i;
for (i = words.begin(); i != words.end(); i++) {
if (i != words.begin()) {
stretchedLine += std::string(equallyAugmentSpaces + 1, ' ');
if (additionalAugmentSpaces > 0) {
stretchedLine += ' ';
additionalAugmentSpaces--;
}
}
stretchedLine += (*i);
}
return stretchedLine;
}
void
printBlock(std::string text, unsigned int indentation, unsigned int lineWidth, std::ostream& os) {
while (text.length() > 0) {
std::string line = extractLine(text, lineWidth);
size_t pos_new = line.find_first_of("\n");
// handle lines containing newlines separatly
if (pos_new != std::string::npos) {
std::string shortline = line.substr(0, pos_new + 1);
os << shortline;
// add remainer to text again
// and restart loop
text = line.substr(pos_new + 1, line.length()) + " " + text;
os << std::string(indentation, ' ');
continue;
}
// stretch every line except last one
if (text.length() > 0 || pos_new != std::string::npos)
os << stretchLine(line, lineWidth) << std::endl;
else
os << line << std::endl;
os << std::string(indentation, ' ');
}
}
void
ProgramOptions::printUsage() {
std::string moduleName = "";
std::cout << std::endl
<< "Usage: " << BinaryName
<< " --[\e[4moption\e[0m [\e[4mvalue\e[0m]] ..."
<< std::endl << std::endl;
std::string optionsText;
optionsText +=
"Options can be given on the command line or via a configuration file "
"(default: " + BinaryName + ".conf):\n" +
"\n" +
" " + BinaryName + " --Module.option value\n" +
"\n" +
"is equivalent to giving a configuration file containing\n" +
"\n" +
" [Module]\n" +
" option=value\n" +
"\n" +
"Command line arguments overwrite config file settings. The module part " +
"of an option may be omitted on the command line. In this case, all options " +
"with that name in all modules are set. Short versions of options are " +
"available for the command line as shown below.\n" +
"\n";
// get tty width:
winsize wsize;
ioctl(0, TIOCGWINSZ, &wsize);
int numColumns = std::min(wsize.ws_col - 5, 100);
printBlock(optionsText, 0, numColumns, std::cout);
std::cout << "General options:" << std::endl << std::endl;
std::set<program_option_impl*>::iterator i;
for (i = Options->begin(); i != Options->end(); i++) {
if (moduleName != (*i)->getModuleName()) {
moduleName = (*i)->getModuleName();
std::cout << std::endl << "Module '" << moduleName << "':" << std::endl << std::endl;
}
std::cout << *(*i) << std::endl;
}
}
std::string
program_option_impl::getModuleName() const {
return _moduleName;
}
std::string
program_option_impl::getLongParam() const {
return _longParam;
}
std::string
program_option_impl::getShortParam() const {
return _shortParam;
}
std::string
program_option_impl::getDescription() const {
return _description;
}
std::string
program_option_impl::getArgumentSketch() const {
return _argumentSketch;
}
std::string
program_option_impl::getDefaultValue() const {
return _defaultValue;
}
bool
program_option_impl::isPositional() const {
return _isPositional;
}
std::ostream&
operator<<(std::ostream& os, program_option_impl& option) {
int sizeLongParam = option.getLongParam().length();
int sizeShortParam = (option.getShortParam() != "" ? option.getShortParam().length() + 1 : 0);
int sizeArgumentSketch = option.getArgumentSketch().length();
// get tty width:
winsize wsize;
ioctl(0, TIOCGWINSZ, &wsize);
int numColumns = std::min(wsize.ws_col - 5, 100);
int spaceIndentation = 2;
int spaceLongParam = 25;
int spaceShortParam = 5;
int spaceDescription =
numColumns
- spaceIndentation
- spaceLongParam
- spaceShortParam;
os << std::string(spaceIndentation, ' ');
if (option.getShortParam() != "")
os << "-" << option.getShortParam();
os << std::string(std::max(0, spaceShortParam - sizeShortParam), ' ');
os << option.getLongParam() << " \e[4m" << option.getArgumentSketch() << "\e[0m";
os << std::string(std::max(0, spaceLongParam - (sizeLongParam + 1 + sizeArgumentSketch)), ' ');
std::string description = option.getDescription();
printBlock(description, spaceIndentation + spaceLongParam + spaceShortParam, spaceDescription, os);
return os;
}
} // namespace util
// End of file