cmdoptns.h File Reference

Command line option parsing interface. More...

#include <cc++/string.h>

Include dependency graph for cmdoptns.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

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

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

Detailed Description

Command line option parsing interface.

Definition in file cmdoptns.h.

Function Documentation

__EXPORT CommandOptionParse* makeCommandOptionParse	(	int	argc,
		char **	argv,
		const 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

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