C++ Utilities
4.6.1
Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities
|
Go to the source code of this file.
Classes | |
struct | ApplicationUtilities::ArgumentOccurrence |
The ArgumentOccurrence struct holds argument values for an occurrence of an argument. More... | |
class | ApplicationUtilities::Argument |
The Argument class is a wrapper for command line argument information. More... | |
class | ApplicationUtilities::ArgumentParser |
The ArgumentParser class provides a means for handling command line arguments. More... | |
class | ApplicationUtilities::HelpArgument |
The HelpArgument class prints help information for an argument parser when present (–help, -h). More... | |
class | ApplicationUtilities::OperationArgument |
The OperationArgument class is an Argument where denotesOperation() is true by default. More... | |
class | ApplicationUtilities::ConfigValueArgument |
The ConfigValueArgument class is an Argument where setCombinable() is true by default. More... | |
Namespaces | |
ApplicationUtilities | |
Contains currently only ArgumentParser and related classes. | |
Macros | |
#define | SET_APPLICATION_INFO |
SET_APPLICATION_INFO More... | |
Typedefs | |
typedef std::initializer_list< Argument * > | ApplicationUtilities::ArgumentInitializerList |
typedef std::vector< Argument * > | ApplicationUtilities::ArgumentVector |
typedef std::function< bool(Argument *)> | ApplicationUtilities::ArgumentPredicate |
Enumerations | |
enum | ApplicationUtilities::UnknownArgumentBehavior { ApplicationUtilities::UnknownArgumentBehavior::Ignore, ApplicationUtilities::UnknownArgumentBehavior::Warn, ApplicationUtilities::UnknownArgumentBehavior::Fail } |
The UnknownArgumentBehavior enum specifies the behavior of the argument parser when an unknown argument is detected. More... | |
enum | ApplicationUtilities::ValueCompletionBehavior : unsigned char { ApplicationUtilities::ValueCompletionBehavior::None = 0, ApplicationUtilities::ValueCompletionBehavior::PreDefinedValues = 2, ApplicationUtilities::ValueCompletionBehavior::Files = 4, ApplicationUtilities::ValueCompletionBehavior::Directories = 8, ApplicationUtilities::ValueCompletionBehavior::FileSystemIfNoPreDefinedValues = 16, ApplicationUtilities::ValueCompletionBehavior::AppendEquationSign = 32 } |
The ValueCompletionBehavior enum specifies the items to be considered when generating completion for an argument value. More... | |
Functions | |
Argument CPP_UTILITIES_EXPORT * | ApplicationUtilities::firstPresentUncombinableArg (const ArgumentVector &args, const Argument *except) |
This function return the first present and uncombinable argument of the given list of arguments. More... | |
Variables | |
CPP_UTILITIES_EXPORT const char * | ApplicationUtilities::applicationName = nullptr |
Specifies the name of the application (used by ArgumentParser::printHelp()). More... | |
CPP_UTILITIES_EXPORT const char * | ApplicationUtilities::applicationAuthor = nullptr |
Specifies the author of the application (used by ArgumentParser::printHelp()). More... | |
CPP_UTILITIES_EXPORT const char * | ApplicationUtilities::applicationVersion = nullptr |
Specifies the version of the application (used by ArgumentParser::printHelp()). More... | |
CPP_UTILITIES_EXPORT const char * | ApplicationUtilities::applicationUrl = nullptr |
Specifies the URL to the application website (used by ArgumentParser::printHelp()). More... | |
CPP_UTILITIES_EXPORT void(* | ApplicationUtilities::exitFunction )(int) = &exit |
Specifies a function quit the application. More... | |
#define SET_APPLICATION_INFO |
SET_APPLICATION_INFO
Sets application meta data used by ArgumentParser::printHelp().
Definition at line 27 of file argumentparser.h.