GammaRay::SourceLocation Class Reference

Specifies a source code location. More...

#include <sourcelocation.h>

Public Member Functions
	SourceLocation ()
	SourceLocation (const QUrl &url, int line=0, int column=0)
int	column () const
QString	displayString () const
bool	isValid () const
int	line () const
void	setColumn (int column)
void	setLine (int line)
void	setUrl (const QUrl &url)
QUrl	url () const

Friends
QDataStream &	operator<< (QDataStream &out, const SourceLocation &location)
QDataStream &	operator>> (QDataStream &in, SourceLocation &location)

Detailed Description

Specifies a source code location.

A source location consists of a document and cursor position

A Cursor represents a position in a Document through a tuple of two ints, namely the line() and column().

Notes

• Lines and columns start a 0 (=> zero-based numbering)

Constructor & Destructor Documentation

SourceLocation() [1/2]

GammaRay::SourceLocation::SourceLocation

(

)

The default constructor creates a (invalid) cursor at position (-1, -1) with an invalid url

SourceLocation() [2/2]

GammaRay::SourceLocation::SourceLocation ( const QUrl &  url, int  line = 0, int  column = 0  )

explicit

This constructor creates a (valid) cursor at position (0, 0) with url

Member Function Documentation

displayString()

QString GammaRay::SourceLocation::displayString

(

)

const

Returns a human-readable version of this source location

SourceLocation loc(QUrl::fromLocalFile("file.cpp", 0, 0);
qDebug() << loc.displayString();

=> Prints: file.cpp:1:1

Note

This will use one-based numbering (file.cpp:1:1 instead of file.cpp:0:0)