Sawyer::CommandLine::Location Struct Reference

Description

Position within a command-line.

A command line consists of an ordered set of strings of various lengths, and this object is an index to a particular character of a particular string.

See also

Cursor::location

Definition at line 216 of file Sawyer/CommandLine.h.

#include <Sawyer/CommandLine.h>

Public Member Functions
	Location ()
	Constructs the location of the first character of the first string.
	Location (size_t idx, size_t offset)
	Constructs a location that points to a particular character of a particular string.
bool	operator== (const Location &other) const
	Equality.
bool	operator!= (const Location &other) const
	Inequality.
bool	operator< (const Location &other) const
	Less than.
bool	operator<= (const Location &other) const
	Less than or equal.

Public Attributes
size_t	idx
	Index into some vector of program argument strings.
size_t	offset
	Character offset within a program argument string.

Constructor & Destructor Documentation

Location() [1/2]

Sawyer::CommandLine::Location::Location ( )

inline

Constructs the location of the first character of the first string.

For empty command-lines, this is also the end location.

Definition at line 222 of file Sawyer/CommandLine.h.

Location() [2/2]

Sawyer::CommandLine::Location::Location ( size_t  idx, size_t  offset  )

inline

Constructs a location that points to a particular character of a particular string.

Definition at line 225 of file Sawyer/CommandLine.h.

Member Function Documentation

operator==()

bool Sawyer::CommandLine::Location::operator== ( const Location &  other ) const

inline

Equality.

Returns true only when this location is equal to other. Two locations are equal only when their idx and offset members are equal.

Definition at line 229 of file Sawyer/CommandLine.h.

References idx, and offset.

operator!=()

bool Sawyer::CommandLine::Location::operator!= ( const Location &  other ) const

inline

Inequality.

Returns true only when this location is not equal to other. Two locations are not equal if either their idx or offset members are not equal.

Definition at line 233 of file Sawyer/CommandLine.h.

operator<()

bool Sawyer::CommandLine::Location::operator< ( const Location &  other ) const

inline

Less than.

Returns true only when this location is less than other. If both locations are referring to the same command-line, then this method returns true if this location points to an earlier character than other.

Definition at line 237 of file Sawyer/CommandLine.h.

References idx, and offset.

operator<=()

bool Sawyer::CommandLine::Location::operator<= ( const Location &  other ) const

inline

Less than or equal.

Returns true only when this location is less than or equal to other as determined by the < or == operators.

Definition at line 241 of file Sawyer/CommandLine.h.

Member Data Documentation

idx

size_t Sawyer::CommandLine::Location::idx

Index into some vector of program argument strings.

Definition at line 217 of file Sawyer/CommandLine.h.

Referenced by Sawyer::CommandLine::Cursor::atArgBegin(), Sawyer::CommandLine::Cursor::atArgEnd(), Sawyer::CommandLine::Cursor::atEnd(), Sawyer::CommandLine::Cursor::consumeArgs(), operator<(), and operator==().

offset

size_t Sawyer::CommandLine::Location::offset

Character offset within a program argument string.

Definition at line 218 of file Sawyer/CommandLine.h.

Referenced by Sawyer::CommandLine::Cursor::atArgBegin(), Sawyer::CommandLine::Cursor::atArgEnd(), Sawyer::CommandLine::Cursor::consumeArgs(), operator<(), and operator==().

---

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

• Sawyer/CommandLine.h