CLI for C++ Project Page CLI for C++ Home Page
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
CLI::Parser

CLI::Parser Class Reference

Abstract base class for CLI command-line parsers. More...

#include <Parser.h>

Inheritance diagram for CLI::Parser:

CLI::BasicParser CLI::PosixParser List of all members.

Public Member Functions

virtual ~Parser ()
CommandLine parse (Options &options, const int argc, const char *argv[])
 Parse the command line represented by the argc and argv parameters.

Protected Member Functions

virtual Tokens flatten (const Options &options, const int argc, const char *argv[])=0

Detailed Description

Abstract base class for CLI command-line parsers.

Author:
John Poplett
Version:
1.0
See also:
CommandLine

Constructor & Destructor Documentation

virtual CLI::Parser::~Parser (   )  [virtual]
 

Member Function Documentation

virtual Tokens CLI::Parser::flatten (  const Options &  options,
const int  argc,
const char *  argv[]
)  [protected, pure virtual]
 

Implemented in CLI::BasicParser, and CLI::PosixParser.

CommandLine CLI::Parser::parse (  Options &  options,
const int  argc,
const char *  argv[]
) 
 

Parse the command line represented by the argc and argv parameters.

Parameters:
options a description of valid options for this program
argc the argument count passed into main
argv the argument vector passed into main
Exceptions:
ParseException 
Returns:
CommandLine the parsed result

The documentation for this class was generated from the following file:
SourceForge Logo hosts this site. Send comments to:
John Poplett