CLI11
1.9.0
|
Namespaces | |
detail | |
enums | |
FailureMessage | |
Classes | |
class | App |
Creates a command line program, with very few defaults. More... | |
class | ArgumentMismatch |
Thrown when the wrong number of arguments has been received. More... | |
class | AsNumberWithUnit |
class | AsSizeValue |
class | AutoTimer |
This class prints out the time upon destruction. More... | |
class | BadNameString |
Thrown on construction of a bad name. More... | |
class | Bound |
Produce a bounded range (factory). Min and max are inclusive. More... | |
class | CallForAllHelp |
Usually something like –help-all on command line. More... | |
class | CallForHelp |
-h or –help on command line More... | |
class | CheckedTransformer |
translate named items to other or a value set More... | |
class | Config |
This class provides a converter for configuration files. More... | |
class | ConfigBase |
This converter works with INI/TOML files; to write proper TOML files use ConfigTOML. More... | |
class | ConfigError |
Thrown when extra values are found in an INI file. More... | |
struct | ConfigItem |
Holds values to load into Options. More... | |
class | ConfigTOML |
ConfigTOML generates a TOML compliant output. More... | |
class | ConstructionError |
Construction errors (not in parsing) More... | |
class | ConversionError |
Thrown when conversion call back fails, such as when an int fails to coerce to a string. More... | |
class | CustomValidator |
Class wrapping some of the accessors of Validator. More... | |
class | Error |
All errors derive from this one. More... | |
class | ExcludesError |
Thrown when an excludes option is present. More... | |
class | ExtrasError |
Thrown when too many positionals or options are found. More... | |
class | FileError |
Thrown when parsing an INI file and it is missing. More... | |
class | Formatter |
class | FormatterBase |
class | FormatterLambda |
This is a specialty override for lambda functions. More... | |
class | HorribleError |
class | IncorrectConstruction |
Thrown when an option is set to conflicting values (non-vector and multi args, for example) More... | |
class | InvalidError |
Thrown when validation fails before parsing. More... | |
struct | is_bool |
Check to see if something is bool (fail check by default) More... | |
struct | is_bool< bool > |
Check to see if something is bool (true if actually a bool) More... | |
struct | is_copyable_ptr |
Check to see if something is copyable pointer. More... | |
struct | is_shared_ptr |
Check to see if something is a shared pointer. More... | |
struct | is_shared_ptr< const std::shared_ptr< T > > |
Check to see if something is a shared pointer (True if really a shared pointer) More... | |
struct | is_shared_ptr< std::shared_ptr< T > > |
Check to see if something is a shared pointer (True if really a shared pointer) More... | |
struct | is_vector |
Check to see if something is a vector (fail check by default) More... | |
struct | is_vector< const std::vector< T, A > > |
Check to see if something is a vector (true if actually a const vector) More... | |
struct | is_vector< std::vector< T, A > > |
Check to see if something is a vector (true if actually a vector) More... | |
class | IsMember |
Verify items are in a set. More... | |
struct | IsMemberType |
This can be specialized to override the type deduction for IsMember. More... | |
struct | IsMemberType< const char * > |
The main custom type needed here is const char * should be a string. More... | |
struct | make_void |
A copy of std::void_t from C++17 (helper for C++11 and C++14) More... | |
class | Option |
class | Option_group |
Extension of App to better manage groups of options. More... | |
class | OptionAlreadyAdded |
Thrown when an option already exists. More... | |
class | OptionBase |
class | OptionDefaults |
class | OptionNotFound |
Thrown when counting a non-existent option. More... | |
class | ParseError |
Anything that can error in Parse. More... | |
class | Range |
Produce a range (factory). Min and max are inclusive. More... | |
class | RequiredError |
Thrown when a required option is missing. More... | |
class | RequiresError |
Thrown when a requires option is missing. More... | |
class | RuntimeError |
Does not output a diagnostic in CLI11_PARSE, but allows to return from main() with a specific error code. More... | |
class | Success |
This is a successful completion on parsing, supposed to exit. More... | |
class | Timer |
This is a simple timer with pretty printing. Creating the timer starts counting. More... | |
class | Transformer |
Translate named items to other or a value set. More... | |
class | ValidationError |
Thrown when validation of results fails. More... | |
class | Validator |
Some validators that are provided. More... | |
Typedefs | |
using | App_p = std::shared_ptr< App > |
using | ConfigINI = ConfigBase |
the default Config is the INI file format More... | |
using | results_t = std::vector< std::string > |
using | callback_t = std::function< bool(const results_t &)> |
callback function definition More... | |
using | Option_p = std::unique_ptr< Option > |
template<bool B, class T = void> | |
using | enable_if_t = typename std::enable_if< B, T >::type |
template<typename... Ts> | |
using | void_t = typename make_void< Ts... >::type |
A copy of std::void_t from C++17 - same reasoning as enable_if_t, it does not hurt to redefine. More... | |
template<bool B, class T , class F > | |
using | conditional_t = typename std::conditional< B, T, F >::type |
A copy of std::conditional_t from C++14 - same reasoning as enable_if_t, it does not hurt to redefine. More... | |
Enumerations | |
enum | config_extras_mode : char { config_extras_mode::error = 0, config_extras_mode::ignore, config_extras_mode::capture } |
enumeration of modes of how to deal with extras in config files More... | |
enum | ExitCodes { ExitCodes::Success = 0, ExitCodes::IncorrectConstruction = 100, ExitCodes::BadNameString, ExitCodes::OptionAlreadyAdded, ExitCodes::FileError, ExitCodes::ConversionError, ExitCodes::ValidationError, ExitCodes::RequiredError, ExitCodes::RequiresError, ExitCodes::ExcludesError, ExitCodes::ExtrasError, ExitCodes::ConfigError, ExitCodes::InvalidError, ExitCodes::HorribleError, ExitCodes::OptionNotFound, ExitCodes::ArgumentMismatch, ExitCodes::BaseClass = 127 } |
enum | AppFormatMode { AppFormatMode::Normal, AppFormatMode::All, AppFormatMode::Sub } |
enum | MultiOptionPolicy : char { MultiOptionPolicy::Throw, MultiOptionPolicy::TakeLast, MultiOptionPolicy::TakeFirst, MultiOptionPolicy::Join, MultiOptionPolicy::TakeAll } |
Enumeration of the multiOption Policy selection. More... | |
Functions | |
void | TriggerOn (App *trigger_app, App *app_to_enable) |
Helper function to enable one option group/subcommand when another is used. More... | |
void | TriggerOn (App *trigger_app, std::vector< App * > apps_to_enable) |
Helper function to enable one option group/subcommand when another is used. More... | |
void | TriggerOff (App *trigger_app, App *app_to_enable) |
Helper function to disable one option group/subcommand when another is used. More... | |
void | TriggerOff (App *trigger_app, std::vector< App * > apps_to_enable) |
Helper function to disable one option group/subcommand when another is used. More... | |
void | deprecate_option (Option *opt, const std::string &replacement="") |
Helper function to mark an option as deprecated. More... | |
void | deprecate_option (App *app, const std::string &option_name, const std::string &replacement="") |
Helper function to mark an option as deprecated. More... | |
void | deprecate_option (App &app, const std::string &option_name, const std::string &replacement="") |
Helper function to mark an option as deprecated. More... | |
void | retire_option (App *app, Option *opt) |
Helper function to mark an option as retired. More... | |
void | retire_option (App &app, Option *opt) |
Helper function to mark an option as retired. More... | |
void | retire_option (App *app, const std::string &option_name) |
Helper function to mark an option as retired. More... | |
void | retire_option (App &app, const std::string &option_name) |
Helper function to mark an option as retired. More... | |
template<typename T > | |
using | TransformPairs = std::vector< std::pair< std::string, T > > |
definition of the default transformation object More... | |
const detail::ExistingFileValidator | ExistingFile |
Check for existing file (returns error message if check fails) More... | |
const detail::ExistingDirectoryValidator | ExistingDirectory |
Check for an existing directory (returns error message if check fails) More... | |
const detail::ExistingPathValidator | ExistingPath |
Check for an existing path. More... | |
const detail::NonexistentPathValidator | NonexistentPath |
Check for an non-existing path. More... | |
const detail::IPV4Validator | ValidIPV4 |
Check for an IP4 address. More... | |
const detail::PositiveNumber | PositiveNumber |
Check for a positive number. More... | |
const detail::NonNegativeNumber | NonNegativeNumber |
Check for a non-negative number. More... | |
const detail::Number | Number |
Check for a number. More... | |
std::string | ignore_case (std::string item) |
Helper function to allow ignore_case to be passed to IsMember or Transform. More... | |
std::string | ignore_underscore (std::string item) |
Helper function to allow ignore_underscore to be passed to IsMember or Transform. More... | |
std::string | ignore_space (std::string item) |
Helper function to allow checks to ignore spaces to be passed to IsMember or Transform. More... | |
using CLI::App_p = typedef std::shared_ptr<App> |
using CLI::callback_t = typedef std::function<bool(const results_t &)> |
callback function definition
using CLI::conditional_t = typedef typename std::conditional<B, T, F>::type |
A copy of std::conditional_t from C++14 - same reasoning as enable_if_t, it does not hurt to redefine.
using CLI::ConfigINI = typedef ConfigBase |
the default Config is the INI file format
using CLI::enable_if_t = typedef typename std::enable_if<B, T>::type |
A copy of enable_if_t from C++14, compatible with C++11.
We could check to see if C++14 is being used, but it does not hurt to redefine this (even Google does this: https://github.com/google/skia/blob/master/include/private/SkTLogic.h) It is not in the std namespace anyway, so no harm done.
using CLI::Option_p = typedef std::unique_ptr<Option> |
using CLI::results_t = typedef std::vector<std::string> |
using CLI::TransformPairs = typedef std::vector<std::pair<std::string, T> > |
definition of the default transformation object
using CLI::void_t = typedef typename make_void<Ts...>::type |
A copy of std::void_t from C++17 - same reasoning as enable_if_t, it does not hurt to redefine.
|
strong |
This enum signifies the type of help requested
This is passed in by App; all user classes must accept this as the second argument.
Enumerator | |
---|---|
Normal | |
All | |
Sub |
|
strong |
|
strong |
These codes are part of every error in CLI. They can be obtained from e using e.exit_code or as a quick shortcut, int values from e.get_error_code().
|
strong |
Enumeration of the multiOption Policy selection.
|
inline |
Helper function to mark an option as deprecated.
|
inline |
Helper function to mark an option as deprecated.
|
inline |
Helper function to mark an option as deprecated.
|
inline |
Helper function to allow ignore_case to be passed to IsMember or Transform.
|
inline |
Helper function to allow checks to ignore spaces to be passed to IsMember or Transform.
|
inline |
Helper function to allow ignore_underscore to be passed to IsMember or Transform.
|
inline |
Helper function to mark an option as retired.
Helper function to mark an option as retired.
|
inline |
Helper function to mark an option as retired.
Helper function to mark an option as retired.
Helper function to disable one option group/subcommand when another is used.
Helper function to disable one option group/subcommand when another is used.
Helper function to enable one option group/subcommand when another is used.
Helper function to enable one option group/subcommand when another is used.
const detail::ExistingDirectoryValidator CLI::ExistingDirectory |
Check for an existing directory (returns error message if check fails)
const detail::ExistingFileValidator CLI::ExistingFile |
Check for existing file (returns error message if check fails)
const detail::ExistingPathValidator CLI::ExistingPath |
Check for an existing path.
const detail::NonexistentPathValidator CLI::NonexistentPath |
Check for an non-existing path.
const detail::NonNegativeNumber CLI::NonNegativeNumber |
Check for a non-negative number.
const detail::Number CLI::Number |
Check for a number.
const detail::PositiveNumber CLI::PositiveNumber |
Check for a positive number.
const detail::IPV4Validator CLI::ValidIPV4 |
Check for an IP4 address.