Parsnip
parsing library
Loading...
Searching...
No Matches
Public Member Functions
Parsnip::ArgvCursor Class Reference

An iterator for argument vectors. More...

#include <parsnip_argv.h>

Public Member Functions

 ArgvCursor (const ArgumentVector *the_argv)
 
 ArgvCursor (const ArgvCursor &from)=default
 
 ArgvCursor (ArgvCursor &&from)=default
 
ArgvCursoroperator= (const ArgvCursor &from)=default
 
ArgvCursoroperator= (ArgvCursor &&from)=default
 
bool isStart () const
 Check if the cursor is at the start of the command line.
 
bool isEnd () const
 Check if the cursor is at the end of the command line.
 
ArgvCursoroperator++ ()
 
ArgvCursor operator++ (int)
 
ArgvCursor operator+ (int value) const
 
ArgvCursor operator- (int value) const
 
const ArgumentVector::StringType & value () const
 Return the current token.
 
const ArgumentVector::StringType remainingString () const
 Return the raw, unsplit remainder of the command line.
 
std::vector< ArgumentVector::StringType > remainingTokens () const
 

Detailed Description

An iterator for argument vectors.

Member Function Documentation

◆ isEnd()

bool Parsnip::ArgvCursor::isEnd ( ) const
inline

Check if the cursor is at the end of the command line.

Returns
True if the cursor is at the end. it does not point to a valid token.

◆ isStart()

bool Parsnip::ArgvCursor::isStart ( ) const
inline

Check if the cursor is at the start of the command line.

Returns
True if it is at the beginning.

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