ROSE  0.9.9.168
Public Types | Static Public Member Functions | Protected Member Functions | List of all members
Sawyer::CommandLine::StringSetParser Class Reference

Description

Parses any one of a set of strings.

Recognizes any of the strings register via with method and returns a ParsedValue of type std::string for the string that was matched. Longer matches are preferred over shorter matches; if the input contains "bandana" and the parser knows about "ban", "band", and "bandana", it will match "bandana". The return value is a ParsedValue whose value is an std::string.

See also
Command line parser factories

Definition at line 1186 of file CommandLine.h.

#include <CommandLine.h>

Inheritance diagram for Sawyer::CommandLine::StringSetParser:
Inheritance graph
[legend]
Collaboration diagram for Sawyer::CommandLine::StringSetParser:
Collaboration graph
[legend]

Public Types

typedef SharedPointer< StringSetParserPtr
 Reference counting pointer for this class. More...
 
- Public Types inherited from Sawyer::CommandLine::ValueParser
typedef SharedPointer< ValueParserPtr
 Reference counting pointer for this class. More...
 

Public Member Functions

Ptr with (const std::string &s)
 Adds string members. More...
 
Ptr with (const std::vector< std::string > sv)
 Adds string members. More...
 
template<class InputIterator >
Ptr with (InputIterator begin, InputIterator end)
 Adds string members. More...
 
- Public Member Functions inherited from Sawyer::CommandLine::ValueParser
ParsedValue matchString (const std::string &)
 Parse the entire string and return a value. More...
 
ParsedValue match (Cursor &)
 Parse a value from the beginning of the specified string. More...
 
Ptr valueSaver (const ValueSaver::Ptr &f)
 Property: functor responsible for saving a parsed value in user storage. More...
 
const ValueSaver::Ptr valueSaver () const
 Property: functor responsible for saving a parsed value in user storage. More...
 
- Public Member Functions inherited from Sawyer::SharedObject
 SharedObject ()
 Default constructor. More...
 
 SharedObject (const SharedObject &)
 Copy constructor. More...
 
virtual ~SharedObject ()
 Virtual destructor. More...
 
SharedObjectoperator= (const SharedObject &)
 Assignment. More...
 
- Public Member Functions inherited from Sawyer::SharedFromThis< ValueParser >
SharedPointer< ValueParser > sharedFromThis ()
 Create a shared pointer from this. More...
 
SharedPointer< const ValueParser > sharedFromThis () const
 Create a shared pointer from this. More...
 

Static Public Member Functions

static Ptr instance ()
 Allocating constructor. More...
 
static Ptr instance (const ValueSaver::Ptr &valueSaver)
 Allocating constructor. More...
 

Protected Member Functions

 StringSetParser ()
 Constructor for derived classes. More...
 
 StringSetParser (const ValueSaver::Ptr &valueSaver)
 Constructor for derived classes. More...
 
- Protected Member Functions inherited from Sawyer::CommandLine::ValueParser
 ValueParser ()
 Constructor for derived classes. More...
 
 ValueParser (const ValueSaver::Ptr &valueSaver)
 Constructor for derived classes. More...
 

Member Typedef Documentation

Reference counting pointer for this class.

Definition at line 1198 of file CommandLine.h.

Constructor & Destructor Documentation

Sawyer::CommandLine::StringSetParser::StringSetParser ( )
inlineprotected

Constructor for derived classes.

Non-subclass users should use instance instead.

Definition at line 1192 of file CommandLine.h.

Sawyer::CommandLine::StringSetParser::StringSetParser ( const ValueSaver::Ptr valueSaver)
inlineprotected

Constructor for derived classes.

Non-subclass users should use instance instead.

Definition at line 1195 of file CommandLine.h.

Member Function Documentation

static Ptr Sawyer::CommandLine::StringSetParser::instance ( )
inlinestatic

Allocating constructor.

Returns a pointer to a new StringSetParser object. Uses will most likely want to use the stringSetParser factory instead, which requires less typing.

See also
Command line parser factories

Definition at line 1203 of file CommandLine.h.

static Ptr Sawyer::CommandLine::StringSetParser::instance ( const ValueSaver::Ptr valueSaver)
inlinestatic

Allocating constructor.

Returns a pointer to a new StringSetParser object. Uses will most likely want to use the stringSetParser factory instead, which takes the same arguments, but requires less typing.

See also
Command line parser factories

Definition at line 1208 of file CommandLine.h.

Ptr Sawyer::CommandLine::StringSetParser::with ( const std::string &  s)
inline

Adds string members.

Inserts an additional string to be recognized in the input.

Definition at line 1212 of file CommandLine.h.

References with().

Referenced by with().

Ptr Sawyer::CommandLine::StringSetParser::with ( const std::vector< std::string >  sv)
inline

Adds string members.

Inserts an additional string to be recognized in the input.

Definition at line 1213 of file CommandLine.h.

References with().

Referenced by with().

template<class InputIterator >
Ptr Sawyer::CommandLine::StringSetParser::with ( InputIterator  begin,
InputIterator  end 
)
inline

Adds string members.

Inserts an additional string to be recognized in the input.

Definition at line 1215 of file CommandLine.h.

References Sawyer::SharedPointer< T >::dynamicCast().


The documentation for this class was generated from the following file: