OpenImageIO
|
#include <argparse.h>
Public Member Functions | |
ArgParse (int argc=0, const char **argv=NULL) | |
int | options (const char *intro,...) |
int | parse (int argc, const char **argv) |
std::string | geterror () const |
void | usage () const |
std::string | command_line () const |
Argument Parsing
The parse function takes a list of options and variables or functions for storing option values and return <0 on failure:
The available argument types are:
There are several special format tokens:
Notes:
std::string ArgParse::command_line | ( | ) | const |
Return the entire command-line as one string.
std::string ArgParse::geterror | ( | ) | const |
Return any error messages generated during the course of parse() (and clear any error flags). If no error has occurred since the last time geterror() was called, it will return an empty string.
int ArgParse::options | ( | const char * | intro, |
... | |||
) |
Declare the command line options. After the introductory message, parameters are a set of format strings and variable pointers. Each string contains an option name and a scanf-like format string to enumerate the arguments of that option (eg. "-option %d %f %s"). The format string is followed by a list of pointers to the argument variables, just like scanf. A NULL terminates the list. Multiple calls to options() will append additional options.
int ArgParse::parse | ( | int | argc, |
const char ** | argv | ||
) |
With the options already set up, parse the command line. Return 0 if ok, -1 if it's a malformed command line.
void ArgParse::usage | ( | ) | const |
Print the usage message to stdout. The usage message is generated and formatted automatically based on the command and description arguments passed to parse().