25#define CLI11_ERROR_DEF(parent, name) \
27 name(std::string ename, std::string msg, int exit_code) : parent(std::move(ename), std::move(msg), exit_code) {} \
28 name(std::string ename, std::string msg, ExitCodes exit_code) \
29 : parent(std::move(ename), std::move(msg), exit_code) {} \
32 name(std::string msg, ExitCodes exit_code) : parent(#name, std::move(msg), exit_code) {} \
33 name(std::string msg, int exit_code) : parent(#name, std::move(msg), exit_code) {}
36#define CLI11_ERROR_SIMPLE(name) \
37 explicit name(std::string msg) : name(#name, msg, ExitCodes::name) {}
70class Error :
public std::runtime_error {
72 std::string error_name{
"Error"};
77 std::string
get_name()
const {
return error_name; }
80 : runtime_error(msg), actual_exit_code(exit_code), error_name(std::move(name)) {}
82 Error(std::string name, std::string msg,
ExitCodes exit_code) :
Error(name, msg, static_cast<int>(exit_code)) {}
110 name +
": You can't change expected arguments after you've changed the multi option policy!");
116 return IncorrectConstruction(name +
": multi_option_policy only works for flags and exact value options");
127 return BadNameString(
"Must have a name, not just dashes: " + name);
129 static BadNameString MultiPositionalNames(std::string name) {
130 return BadNameString(
"Only one positional name allowed, remove: " + name);
192 static FileError Missing(std::string name) {
return FileError(name +
" was not readable (missing?)"); }
200 :
ConversionError(
"The value " + member +
" is not an allowed value for " + name) {}
223 if(min_subcom == 1) {
226 return RequiredError(
"Requires at least " + std::to_string(min_subcom) +
" subcommands",
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 RequiredError(
"Exactly 1 option from [" + option_list +
"] is required and " + std::to_string(used) +
238 if((min_option == 1) && (used == 0))
239 return RequiredError(
"At least 1 option from [" + option_list +
"]");
240 if(used < min_option) {
241 return RequiredError(
"Requires at least " + std::to_string(min_option) +
" options used and only " +
242 std::to_string(used) +
"were given from [" + option_list +
"]",
246 return RequiredError(
"Requires at most 1 options be given from [" + option_list +
"]",
249 return RequiredError(
"Requires at most " + std::to_string(max_option) +
" options be used and " +
250 std::to_string(used) +
"were given from [" + option_list +
"]",
260 :
ArgumentMismatch(expected > 0 ? (
"Expected exactly " + std::to_string(expected) +
" arguments to " + name +
261 ", got " + std::to_string(received))
262 : (
"Expected at least " + std::to_string(-expected) +
" arguments to " + name +
263 ", got " + std::to_string(received)),
266 static ArgumentMismatch AtLeast(std::string name,
int num, std::size_t received) {
267 return ArgumentMismatch(name +
": At least " + std::to_string(num) +
" required but received " +
268 std::to_string(received));
270 static ArgumentMismatch AtMost(std::string name,
int num, std::size_t received) {
271 return ArgumentMismatch(name +
": At Most " + std::to_string(num) +
" required but received " +
272 std::to_string(received));
274 static ArgumentMismatch TypedAtLeast(std::string name,
int num, std::string type) {
275 return ArgumentMismatch(name +
": " + std::to_string(num) +
" required " + type +
" missing");
280 static ArgumentMismatch PartialType(std::string name,
int num, std::string type) {
281 return ArgumentMismatch(name +
": " + type +
" only partially specified: " + std::to_string(num) +
282 " required for each element");
303 explicit ExtrasError(std::vector<std::string> args)
304 :
ExtrasError((args.size() > 1 ?
"The following arguments were not expected: "
305 :
"The following argument was not expected: ") +
308 ExtrasError(
const std::string &name, std::vector<std::string> args)
310 (args.size() > 1 ?
"The following arguments were not expected: "
311 :
"The following argument was not expected: ") +
321 static ConfigError NotConfigurable(std::string item) {
322 return ConfigError(item +
": This option is not allowed in a configuration file");
349#undef CLI11_ERROR_DEF
350#undef CLI11_ERROR_SIMPLE
#define CLI11_ERROR_SIMPLE(name)
Definition Error.hpp:36
#define CLI11_ERROR_DEF(parent, name)
Definition Error.hpp:25
Thrown when the wrong number of arguments has been received.
Definition Error.hpp:256
Thrown on construction of a bad name.
Definition Error.hpp:121
Usually something like –help-all on command line.
Definition Error.hpp:169
-h or –help on command line
Definition Error.hpp:163
-v or –version on command line
Definition Error.hpp:176
Thrown when extra values are found in an INI file.
Definition Error.hpp:317
Construction errors (not in parsing)
Definition Error.hpp:88
Thrown when conversion call back fails, such as when an int fails to coerce to a string.
Definition Error.hpp:196
All errors derive from this one.
Definition Error.hpp:70
int get_exit_code() const
Definition Error.hpp:75
Error(std::string name, std::string msg, ExitCodes exit_code)
Definition Error.hpp:82
std::string get_name() const
Definition Error.hpp:77
Error(std::string name, std::string msg, int exit_code=static_cast< int >(ExitCodes::BaseClass))
Definition Error.hpp:79
Thrown when an excludes option is present.
Definition Error.hpp:294
Thrown when parsing an INI file and it is missing.
Definition Error.hpp:189
Thrown when an option is set to conflicting values (non-vector and multi args, for example)
Definition Error.hpp:93
Thrown when validation fails before parsing.
Definition Error.hpp:327
Thrown when an option already exists.
Definition Error.hpp:135
Thrown when counting a non-existent option.
Definition Error.hpp:344
Definition Option.hpp:238
Anything that can error in Parse.
Definition Error.hpp:150
Thrown when a required option is missing.
Definition Error.hpp:219
Thrown when a requires option is missing.
Definition Error.hpp:287
Does not output a diagnostic in CLI11_PARSE, but allows main() to return with a specific error code.
Definition Error.hpp:183
This is a successful completion on parsing, supposed to exit.
Definition Error.hpp:157
Thrown when validation of results fails.
Definition Error.hpp:212
std::string join(const T &v, std::string delim=",")
Simple function to join a string.
Definition StringTools.hpp:63
std::string rjoin(const T &v, std::string delim=",")
Join a string in reverse order.
Definition StringTools.hpp:96
ExitCodes
Definition Error.hpp:41
MultiOptionPolicy
Enumeration of the multiOption Policy selection.
Definition Option.hpp:38