cmdoptns.h(3cc)

Compounds

class CommandOption
CommandOption is the base class for all command line options. class CommandOptionArg
Class for options with an argument e.g. class CommandOptionCollect
It only makes sense to have a single one of these set and it is also exclusive with CommandOptionRest. CommandOption to collect parameters that are not options. class CommandOptionNoArg
CommandOption type for flags. class CommandOptionParse
This is the CommandOptionParse interface class. class CommandOptionRest
It only makes sense to have a single one of these set and it is exclusive with CommandOptionCollect. CommandOption to take the rest of the command line. class CommandOptionWithArg
Derived class of CommandOption for options that have a value associated with them.

Functions

CommandOptionParse * makeCommandOptionParse (int argc, char **argv, char *comment, CommandOption *options=defaultCommandOptionList)
makeCommandOptionParse will create an implementation of a CommandOptionParse object.

Variables

CommandOption * defaultCommandOptionList
This defines a linked list head pointer for all the command line options that use the default list.

CommandOptionParse* makeCommandOptionParse (int argc, char ** argv, char * comment, CommandOption * options = defaultCommandOptionList)

makeCommandOptionParse will create an implementation of a CommandOptionParse object.

This particular implementation is a wrapper around getopt_long(3). That interface unfortunatly does not provide enough information to give the best error messages with malformed input. If the implementation changes there is a good chance that the binary interface will remain the same.

CommandOption* defaultCommandOptionList

This defines a linked list head pointer for all the command line options that use the default list.

It will most likely be used in most cases without being explicitly referenced in application code. It is a default value of various method's parameters.