Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

cmdoptns.h File Reference

Go to the source code of this file.

Compounds

class  CommandOption
 CommandOption is the base class for all command line options. More...

class  CommandOptionArg
 Class for options with an argument e.g. More...

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. More...

class  CommandOptionNoArg
 CommandOption type for flags. More...

class  CommandOptionParse
 This is the CommandOptionParse interface class. More...

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. More...

class  CommandOptionWithArg
 Derived class of CommandOption for options that have a value associated with them. More...


Functions

CommandOptionParseMakeCommandOptionParse (int argc, char **argv, char *comment, CommandOption *options=DefaultCommandOptionList)
 MakeCommandOptionParse will create an implementation of a CommandOptionParse object. More...


Variables

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


Function Documentation

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.


Variable Documentation

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.


Generated at Wed Sep 5 11:25:19 2001 for CommonC++ by doxygen1.2.5 written by Dimitri van Heesch, © 1997-2001