carb/extras/Options.h

↰ Parent directory: carb/extras/

Provides a set of helper functions to manage the processing of command line arguments.

Source: carb/extras/Options.h

Namespaces

• carb: The main Carbonite namespace.

• carb::options: Namespace for the options processing helper functions.

Classes

• carb::options::Option: Information about a single option and its parser.

• carb::options::Options: Receives the results of parsing an options string.

• carb::options::Value: A multi-value type.

Enums

• carb::options::ParseResult: The possible result codes of parsing a single option.

• carb::options::ValueType: Type names for values passed to the parser functions.

Functions

• carb::options::getArgString: Retrieves a single argument value from the next argument.

• carb::options::parseOptions: Parses a set of options from an argument vector.

• carb::options::printOptionUsage: Prints out the documentation for an option table.

• carb::options::stringToNumber: Converts a string to a number.

• carb::options::stringToNumber: Converts a string to a number.

• carb::options::stringToNumber: Converts a string to a number.

• carb::options::stringToNumber: Converts a string to a number.

Typedefs

• carb::options::ArgParserFunc: Prototype of a parser function to handle a single option.

Variables

• carb::options::kArgFailExpectedArgument: Special failure value for carb::options::getArgString indicating that an expected argument was missing.

• carb::options::kArgFailExpectedQuote: Special failure value for carb::options::getArgString indicating that an argument’s value started with a single or double quotation mark but did not end with the matching quotation or the ending quotation mark was missing.