|
486
|
1 /* |
|
|
2 * options.h -- parse Unix command line options |
|
|
3 * |
|
|
4 * Copyright (c) 2015 David Demelier <markand@malikania.fr> |
|
|
5 * |
|
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
|
|
7 * purpose with or without fee is hereby granted, provided that the above |
|
|
8 * copyright notice and this permission notice appear in all copies. |
|
|
9 * |
|
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
|
17 */ |
|
|
18 |
|
|
19 #ifndef _OPTIONS_H_ |
|
|
20 #define _OPTIONS_H_ |
|
|
21 |
|
|
22 #include <exception> |
|
|
23 #include <map> |
|
|
24 #include <string> |
|
|
25 #include <utility> |
|
|
26 #include <vector> |
|
|
27 |
|
|
28 /** |
|
|
29 * Namespace for options parsing. |
|
|
30 */ |
|
|
31 namespace option { |
|
|
32 |
|
|
33 /** |
|
|
34 * @class InvalidOption |
|
|
35 * @brief This exception is thrown when an invalid option has been found. |
|
|
36 */ |
|
|
37 class InvalidOption : public std::exception { |
|
|
38 private: |
|
|
39 std::string message; |
|
|
40 |
|
|
41 public: |
|
|
42 /** |
|
|
43 * The invalid option given. |
|
|
44 */ |
|
|
45 std::string argument; |
|
|
46 |
|
|
47 /** |
|
|
48 * Construct the exception. |
|
|
49 * |
|
|
50 * @param arg the argument missing |
|
|
51 */ |
|
|
52 inline InvalidOption(std::string arg) |
|
|
53 : argument{std::move(arg)} |
|
|
54 { |
|
|
55 message = std::string{"invalid option: "} + argument; |
|
|
56 } |
|
|
57 |
|
|
58 /** |
|
|
59 * Get the error message. |
|
|
60 * |
|
|
61 * @return the error message |
|
|
62 */ |
|
|
63 const char *what() const noexcept override |
|
|
64 { |
|
|
65 return message.c_str(); |
|
|
66 } |
|
|
67 }; |
|
|
68 |
|
|
69 /** |
|
|
70 * @class MissingValue |
|
|
71 * @brief This exception is thrown when an option requires a value and no value has been given |
|
|
72 */ |
|
|
73 class MissingValue : public std::exception { |
|
|
74 private: |
|
|
75 std::string message; |
|
|
76 |
|
|
77 public: |
|
|
78 /** |
|
|
79 * The argument that requires a value. |
|
|
80 */ |
|
|
81 std::string argument; |
|
|
82 |
|
|
83 /** |
|
|
84 * Construct the exception. |
|
|
85 * |
|
|
86 * @param arg the argument that requires a value |
|
|
87 */ |
|
|
88 inline MissingValue(std::string arg) |
|
|
89 : argument{std::move(arg)} |
|
|
90 { |
|
|
91 message = std::string{"missing argument for: "} + argument; |
|
|
92 } |
|
|
93 |
|
|
94 /** |
|
|
95 * Get the error message. |
|
|
96 * |
|
|
97 * @return the error message |
|
|
98 */ |
|
|
99 const char *what() const noexcept override |
|
|
100 { |
|
|
101 return message.c_str(); |
|
|
102 } |
|
|
103 }; |
|
|
104 |
|
|
105 /** |
|
|
106 * Packed multimap of options. |
|
|
107 */ |
|
|
108 using Result = std::multimap<std::string, std::string>; |
|
|
109 |
|
|
110 /** |
|
|
111 * Define the allowed options. |
|
|
112 */ |
|
|
113 using Options = std::map<std::string, bool>; |
|
|
114 |
|
|
115 /** |
|
|
116 * Extract the command line options and return a result. |
|
|
117 * |
|
|
118 * @param args the arguments |
|
|
119 * @param definition |
|
|
120 * @warning the arguments vector is modified in place to remove parsed options |
|
|
121 * @throw MissingValue |
|
|
122 * @throw InvalidOption |
|
|
123 */ |
|
|
124 Result read(std::vector<std::string> &args, const Options &definition); |
|
|
125 |
|
|
126 /** |
|
|
127 * Overloaded function for usage with main() arguments. |
|
|
128 * |
|
|
129 * @param argc the number of arguments |
|
|
130 * @param argv the argument vector |
|
|
131 * @param definition |
|
|
132 * @note don't forget to remove the first argv[0] argument |
|
|
133 * @warning the argc and argv are modified in place to remove parsed options |
|
|
134 * @throw MissingValue |
|
|
135 * @throw InvalidOption |
|
|
136 */ |
|
|
137 Result read(int &argc, char **&argv, const Options &definition); |
|
|
138 |
|
|
139 } // !option |
|
|
140 |
|
|
141 #endif // !_OPTIONS_H_ |
