annotate common/options.cpp @ 61:adfc2be5ee30 release-2.0

Added signature for changeset 223487a685b1
author David Demelier <markand@malikania.fr>
date Tue, 01 Mar 2016 08:53:16 +0100
parents 03068f5ed79d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * options.cpp -- parse Unix command line options
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2015 David Demelier <markand@malikania.fr>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include <cassert>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 #include "options.h"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 namespace irccd {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 namespace parser {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 namespace {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 using Iterator = std::vector<std::string>::iterator;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 using Args = std::vector<std::string>;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 inline bool isOption(const std::string &arg) noexcept
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 return arg.size() >= 2 && arg[0] == '-';
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 inline bool isLongOption(const std::string &arg) noexcept
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 assert(isOption(arg));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 return arg.size() >= 3 && arg[1] == '-';
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 inline bool isShortSimple(const std::string &arg) noexcept
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 assert(isOption(arg));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 assert(!isLongOption(arg));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 return arg.size() == 2;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 void parseLongOption(Result &result, Args &args, Iterator &it, Iterator &end, const Options &definition)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 auto arg = *it++;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 auto opt = definition.find(arg);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
57 if (opt == definition.end())
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
58 throw InvalidOption(arg);
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 /* Need argument? */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 if (opt->second) {
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
62 if (it == end || isOption(*it))
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
63 throw MissingValue(arg);
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 result.insert(std::make_pair(arg, *it++));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 it = args.erase(args.begin(), it);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 end = args.end();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 } else {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 result.insert(std::make_pair(arg, ""));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 it = args.erase(args.begin());
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 end = args.end();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
74
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 void parseShortOption(Result &result, Args &args, Iterator &it, Iterator &end, const Options &definition)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 if (isShortSimple(*it)) {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 /*
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 * Here two cases:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 * -v (no option)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 * -c value
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 auto arg = *it++;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 auto opt = definition.find(arg);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
86
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
87 if (opt == definition.end())
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
88 throw InvalidOption(arg);
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
89
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 /* Need argument? */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 if (opt->second) {
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
92 if (it == end || isOption(*it))
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
93 throw MissingValue(arg);
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
94
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 result.insert(std::make_pair(arg, *it++));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 it = args.erase(args.begin(), it);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 end = args.end();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 } else {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 result.insert(std::make_pair(arg, ""));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 it = args.erase(args.begin());
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 end = args.end();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 } else {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 /*
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 * Here multiple scenarios:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 * 1. -abc (-a -b -c if all are simple boolean arguments)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 * 2. -vc foo.conf (-v -c foo.conf if -c is argument dependant)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 * 3. -vcfoo.conf (-v -c foo.conf also)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 auto value = it->substr(1);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 auto len = value.length();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 int toremove = 1;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
114
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 for (decltype(len) i = 0; i < len; ++i) {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 auto arg = std::string{'-'} + value[i];
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 auto opt = definition.find(arg);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
118
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
119 if (opt == definition.end())
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
120 throw InvalidOption(arg);
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
121
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 if (opt->second) {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 if (i == (len - 1)) {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 /* End of string, get the next argument (see 2.) */
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
125 if (++it == end || isOption(*it))
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
126 throw MissingValue(arg);
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
127
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
128 result.insert(std::make_pair(arg, *it));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 toremove += 1;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 } else {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 result.insert(std::make_pair(arg, value.substr(i + 1)));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 i = len;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 } else {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 result.insert(std::make_pair(arg, ""));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
138
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 it = args.erase(args.begin(), args.begin() + toremove);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
140 end = args.end();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
142 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
143
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
144 } // !namespace
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
145
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
146 Result read(std::vector<std::string> &args, const Options &definition)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
147 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
148 Result result;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
149
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
150 auto it = args.begin();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
151 auto end = args.end();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
152
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
153 while (it != end) {
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
154 if (!isOption(*it))
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
155 break;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
156
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
157 if (isLongOption(*it))
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
158 parseLongOption(result, args, it, end, definition);
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
159 else
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
160 parseShortOption(result, args, it, end, definition);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
161 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
162
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
163 return result;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
164 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
165
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
166 Result read(int &argc, char **&argv, const Options &definition)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
167 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
168 std::vector<std::string> args;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
169
23
03068f5ed79d Misc: various style issues, #419
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
170 for (int i = 0; i < argc; ++i)
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
171 args.push_back(argv[i]);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
172
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
173 auto before = args.size();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
174 auto result = read(args, definition);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
175
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
176 argc -= before - args.size();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
177 argv += before - args.size();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
178
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
179 return result;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
180 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
181
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
182 } // !parser
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
183
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
184 } // !irccd