CLI11  2.3.2
Error.hpp
Go to the documentation of this file.
1 // Copyright (c) 2017-2023, University of Cincinnati, developed by Henry Schreiner
2 // under NSF AWARD 1414736 and by the respective contributors.
3 // All rights reserved.
4 //
5 // SPDX-License-Identifier: BSD-3-Clause
6 
7 #pragma once
8 
9 // [CLI11:public_includes:set]
10 #include <exception>
11 #include <stdexcept>
12 #include <string>
13 #include <utility>
14 #include <vector>
15 // [CLI11:public_includes:end]
16 
17 // CLI library includes
18 #include "Macros.hpp"
19 #include "StringTools.hpp"
20 
21 namespace CLI {
22 // [CLI11:error_hpp:verbatim]
23 
24 // Use one of these on all error classes.
25 // These are temporary and are undef'd at the end of this file.
26 #define CLI11_ERROR_DEF(parent, name) \
27  protected: \
28  name(std::string ename, std::string msg, int exit_code) : parent(std::move(ename), std::move(msg), exit_code) {} \
29  name(std::string ename, std::string msg, ExitCodes exit_code) \
30  : parent(std::move(ename), std::move(msg), exit_code) {} \
31  \
32  public: \
33  name(std::string msg, ExitCodes exit_code) : parent(#name, std::move(msg), exit_code) {} \
34  name(std::string msg, int exit_code) : parent(#name, std::move(msg), exit_code) {}
35 
36 // This is added after the one above if a class is used directly and builds its own message
37 #define CLI11_ERROR_SIMPLE(name) \
38  explicit name(std::string msg) : name(#name, msg, ExitCodes::name) {}
39 
42 enum class ExitCodes {
43  Success = 0,
47  FileError,
59  BaseClass = 127
60 };
61 
62 // Error definitions
63 
69 
71 class Error : public std::runtime_error {
72  int actual_exit_code;
73  std::string error_name{"Error"};
74 
75  public:
76  CLI11_NODISCARD int get_exit_code() const { return actual_exit_code; }
77 
78  CLI11_NODISCARD std::string get_name() const { return error_name; }
79 
80  Error(std::string name, std::string msg, int exit_code = static_cast<int>(ExitCodes::BaseClass))
81  : runtime_error(msg), actual_exit_code(exit_code), error_name(std::move(name)) {}
82 
83  Error(std::string name, std::string msg, ExitCodes exit_code) : Error(name, msg, static_cast<int>(exit_code)) {}
84 };
85 
86 // Note: Using Error::Error constructors does not work on GCC 4.7
87 
89 class ConstructionError : public Error {
91 };
92 
97  static IncorrectConstruction PositionalFlag(std::string name) {
98  return IncorrectConstruction(name + ": Flags cannot be positional");
99  }
100  static IncorrectConstruction Set0Opt(std::string name) {
101  return IncorrectConstruction(name + ": Cannot set 0 expected, use a flag instead");
102  }
103  static IncorrectConstruction SetFlag(std::string name) {
104  return IncorrectConstruction(name + ": Cannot set an expected number for flags");
105  }
106  static IncorrectConstruction ChangeNotVector(std::string name) {
107  return IncorrectConstruction(name + ": You can only change the expected arguments for vectors");
108  }
109  static IncorrectConstruction AfterMultiOpt(std::string name) {
110  return IncorrectConstruction(
111  name + ": You can't change expected arguments after you've changed the multi option policy!");
112  }
113  static IncorrectConstruction MissingOption(std::string name) {
114  return IncorrectConstruction("Option " + name + " is not defined");
115  }
116  static IncorrectConstruction MultiOptionPolicy(std::string name) {
117  return IncorrectConstruction(name + ": multi_option_policy only works for flags and exact value options");
118  }
119 };
120 
125  static BadNameString OneCharName(std::string name) { return BadNameString("Invalid one char name: " + name); }
126  static BadNameString BadLongName(std::string name) { return BadNameString("Bad long name: " + name); }
127  static BadNameString DashesOnly(std::string name) {
128  return BadNameString("Must have a name, not just dashes: " + name);
129  }
130  static BadNameString MultiPositionalNames(std::string name) {
131  return BadNameString("Only one positional name allowed, remove: " + name);
132  }
133 };
134 
138  explicit OptionAlreadyAdded(std::string name)
139  : OptionAlreadyAdded(name + " is already added", ExitCodes::OptionAlreadyAdded) {}
140  static OptionAlreadyAdded Requires(std::string name, std::string other) {
141  return {name + " requires " + other, ExitCodes::OptionAlreadyAdded};
142  }
143  static OptionAlreadyAdded Excludes(std::string name, std::string other) {
144  return {name + " excludes " + other, ExitCodes::OptionAlreadyAdded};
145  }
146 };
147 
148 // Parsing errors
149 
151 class ParseError : public Error {
153 };
154 
155 // Not really "errors"
156 
158 class Success : public ParseError {
160  Success() : Success("Successfully completed, should be caught and quit", ExitCodes::Success) {}
161 };
162 
164 class CallForHelp : public Success {
166  CallForHelp() : CallForHelp("This should be caught in your main function, see examples", ExitCodes::Success) {}
167 };
168 
170 class CallForAllHelp : public Success {
173  : CallForAllHelp("This should be caught in your main function, see examples", ExitCodes::Success) {}
174 };
175 
177 class CallForVersion : public Success {
180  : CallForVersion("This should be caught in your main function, see examples", ExitCodes::Success) {}
181 };
182 
184 class RuntimeError : public ParseError {
186  explicit RuntimeError(int exit_code = 1) : RuntimeError("Runtime error", exit_code) {}
187 };
188 
190 class FileError : public ParseError {
193  static FileError Missing(std::string name) { return FileError(name + " was not readable (missing?)"); }
194 };
195 
197 class ConversionError : public ParseError {
200  ConversionError(std::string member, std::string name)
201  : ConversionError("The value " + member + " is not an allowed value for " + name) {}
202  ConversionError(std::string name, std::vector<std::string> results)
203  : ConversionError("Could not convert: " + name + " = " + detail::join(results)) {}
204  static ConversionError TooManyInputsFlag(std::string name) {
205  return ConversionError(name + ": too many inputs for a flag");
206  }
207  static ConversionError TrueFalse(std::string name) {
208  return ConversionError(name + ": Should be true/false or a number");
209  }
210 };
211 
213 class ValidationError : public ParseError {
216  explicit ValidationError(std::string name, std::string msg) : ValidationError(name + ": " + msg) {}
217 };
218 
220 class RequiredError : public ParseError {
222  explicit RequiredError(std::string name) : RequiredError(name + " is required", ExitCodes::RequiredError) {}
223  static RequiredError Subcommand(std::size_t min_subcom) {
224  if(min_subcom == 1) {
225  return RequiredError("A subcommand");
226  }
227  return {"Requires at least " + std::to_string(min_subcom) + " subcommands", ExitCodes::RequiredError};
228  }
229  static RequiredError
230  Option(std::size_t min_option, std::size_t max_option, std::size_t used, const std::string &option_list) {
231  if((min_option == 1) && (max_option == 1) && (used == 0))
232  return RequiredError("Exactly 1 option from [" + option_list + "]");
233  if((min_option == 1) && (max_option == 1) && (used > 1)) {
234  return {"Exactly 1 option from [" + option_list + "] is required and " + std::to_string(used) +
235  " were given",
237  }
238  if((min_option == 1) && (used == 0))
239  return RequiredError("At least 1 option from [" + option_list + "]");
240  if(used < min_option) {
241  return {"Requires at least " + std::to_string(min_option) + " options used and only " +
242  std::to_string(used) + "were given from [" + option_list + "]",
244  }
245  if(max_option == 1)
246  return {"Requires at most 1 options be given from [" + option_list + "]", ExitCodes::RequiredError};
247 
248  return {"Requires at most " + std::to_string(max_option) + " options be used and " + std::to_string(used) +
249  "were given from [" + option_list + "]",
251  }
252 };
253 
255 class ArgumentMismatch : public ParseError {
258  ArgumentMismatch(std::string name, int expected, std::size_t received)
259  : ArgumentMismatch(expected > 0 ? ("Expected exactly " + std::to_string(expected) + " arguments to " + name +
260  ", got " + std::to_string(received))
261  : ("Expected at least " + std::to_string(-expected) + " arguments to " + name +
262  ", got " + std::to_string(received)),
264 
265  static ArgumentMismatch AtLeast(std::string name, int num, std::size_t received) {
266  return ArgumentMismatch(name + ": At least " + std::to_string(num) + " required but received " +
267  std::to_string(received));
268  }
269  static ArgumentMismatch AtMost(std::string name, int num, std::size_t received) {
270  return ArgumentMismatch(name + ": At Most " + std::to_string(num) + " required but received " +
271  std::to_string(received));
272  }
273  static ArgumentMismatch TypedAtLeast(std::string name, int num, std::string type) {
274  return ArgumentMismatch(name + ": " + std::to_string(num) + " required " + type + " missing");
275  }
276  static ArgumentMismatch FlagOverride(std::string name) {
277  return ArgumentMismatch(name + " was given a disallowed flag override");
278  }
279  static ArgumentMismatch PartialType(std::string name, int num, std::string type) {
280  return ArgumentMismatch(name + ": " + type + " only partially specified: " + std::to_string(num) +
281  " required for each element");
282  }
283 };
284 
286 class RequiresError : public ParseError {
288  RequiresError(std::string curname, std::string subname)
289  : RequiresError(curname + " requires " + subname, ExitCodes::RequiresError) {}
290 };
291 
293 class ExcludesError : public ParseError {
295  ExcludesError(std::string curname, std::string subname)
296  : ExcludesError(curname + " excludes " + subname, ExitCodes::ExcludesError) {}
297 };
298 
300 class ExtrasError : public ParseError {
302  explicit ExtrasError(std::vector<std::string> args)
303  : ExtrasError((args.size() > 1 ? "The following arguments were not expected: "
304  : "The following argument was not expected: ") +
305  detail::rjoin(args, " "),
307  ExtrasError(const std::string &name, std::vector<std::string> args)
308  : ExtrasError(name,
309  (args.size() > 1 ? "The following arguments were not expected: "
310  : "The following argument was not expected: ") +
311  detail::rjoin(args, " "),
313 };
314 
316 class ConfigError : public ParseError {
319  static ConfigError Extras(std::string item) { return ConfigError("INI was not able to parse " + item); }
320  static ConfigError NotConfigurable(std::string item) {
321  return ConfigError(item + ": This option is not allowed in a configuration file");
322  }
323 };
324 
326 class InvalidError : public ParseError {
328  explicit InvalidError(std::string name)
329  : InvalidError(name + ": Too many positional arguments with unlimited expected args", ExitCodes::InvalidError) {
330  }
331 };
332 
335 class HorribleError : public ParseError {
338 };
339 
340 // After parsing
341 
343 class OptionNotFound : public Error {
345  explicit OptionNotFound(std::string name) : OptionNotFound(name + " not found", ExitCodes::OptionNotFound) {}
346 };
347 
348 #undef CLI11_ERROR_DEF
349 #undef CLI11_ERROR_SIMPLE
350 
352 
353 // [CLI11:error_hpp:end]
354 } // namespace CLI
Error(std::string name, std::string msg, ExitCodes exit_code)
Definition: Error.hpp:83
#define CLI11_ERROR_SIMPLE(name)
Definition: Error.hpp:37
Thrown when an option already exists.
Definition: Error.hpp:136
Definition: App.hpp:34
Definition: Error.hpp:335
Anything that can error in Parse.
Definition: Error.hpp:151
Thrown when too many positionals or options are found.
Definition: Error.hpp:300
Does not output a diagnostic in CLI11_PARSE, but allows main() to return with a specific error code...
Definition: Error.hpp:184
ExitCodes
Definition: Error.hpp:42
CLI11_NODISCARD std::string get_name() const
Definition: Error.hpp:78
Error(std::string name, std::string msg, int exit_code=static_cast< int >(ExitCodes::BaseClass))
Definition: Error.hpp:80
Definition: Option.hpp:228
STL namespace.
CLI11_NODISCARD int get_exit_code() const
Definition: Error.hpp:76
std::string rjoin(const T &v, std::string delim=",")
Join a string in reverse order.
Definition: StringTools.hpp:84
MultiOptionPolicy
Enumeration of the multiOption Policy selection.
Definition: Option.hpp:38
auto to_string(T &&value) -> decltype(std::forward< T >(value))
Convert an object to a string (directly forward if this can become a string)
Definition: TypeTools.hpp:281
Thrown when a required option is missing.
Definition: Error.hpp:220
Thrown when parsing an INI file and it is missing.
Definition: Error.hpp:190
std::string join(const T &v, std::string delim=",")
Simple function to join a string.
Definition: StringTools.hpp:51
Thrown when conversion call back fails, such as when an int fails to coerce to a string.
Definition: Error.hpp:197
Usually something like –help-all on command line.
Definition: Error.hpp:170
Thrown when a requires option is missing.
Definition: Error.hpp:286
Construction errors (not in parsing)
Definition: Error.hpp:89
All errors derive from this one.
Definition: Error.hpp:71
Thrown when validation of results fails.
Definition: Error.hpp:213
Thrown when the wrong number of arguments has been received.
Definition: Error.hpp:255
#define CLI11_ERROR_DEF(parent, name)
Definition: Error.hpp:26
#define CLI11_NODISCARD
Definition: Macros.hpp:47
This is a successful completion on parsing, supposed to exit.
Definition: Error.hpp:158
Thrown when an option is set to conflicting values (non-vector and multi args, for example) ...
Definition: Error.hpp:94
Thrown when an excludes option is present.
Definition: Error.hpp:293
-v or –version on command line
Definition: Error.hpp:177
Thrown when validation fails before parsing.
Definition: Error.hpp:326
Thrown on construction of a bad name.
Definition: Error.hpp:122
Thrown when extra values are found in an INI file.
Definition: Error.hpp:316
-h or –help on command line
Definition: Error.hpp:164
Thrown when counting a non-existent option.
Definition: Error.hpp:343