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

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

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

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

Member Function Documentation

◆ operator==()

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

Equality.

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

◆ operator!=()

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

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.

◆ operator<()

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

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.

◆ operator<=()

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

Less than or equal.

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

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.

◆ offset

size_t Sawyer::CommandLine::Location::offset

Character offset within a program argument string.

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

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

Sawyer/CommandLine.h