Bayonne2 / Common C++ 2 Framework
Data Structures | Functions | Variables
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...
 
  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...
 
  It only makes sense to have a single one of these set and it is exclusive with CommandOptionCollect. More...
 
  It only makes sense to have a single one of these set and it is also exclusive with CommandOptionRest. More...
 
  CommandOption type for flags. More...
 
  This is the CommandOptionParse interface class. More...
 

Functions

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

Variables

  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,
)

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.


Generated on Dec 21, 2017 for commoncpp2-1.8.1, ccrtp-1.7.2, libzrtpcpp-2.3.4, ccscript3-1.1.7, ccaudio2-1.0.0 and bayonne2-2.3.2 (after installation in /usr/local/) by   doxygen 1.8.6

AltStyle によって変換されたページ (->オリジナル) /