mirror of
https://bitbucket.org/smil3y/kde-extraapps.git
synced 2025-02-26 11:52:54 +00:00
114 lines
3.9 KiB
C++
114 lines
3.9 KiB
C++
/* This file is part of KDevelop
|
|
Copyright 2010 David Nolden <david.nolden.kdevelop@art-master.de>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License version 2 as published by the Free Software Foundation.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
#ifndef KDEVPLATFORM_CURSORINREVISION_H
|
|
#define KDEVPLATFORM_CURSORINREVISION_H
|
|
|
|
#include "../languageexport.h"
|
|
#include "simplecursor.h"
|
|
|
|
namespace KDevelop {
|
|
|
|
/**
|
|
* Represents a cursor (line-number and column-number) within a text document.
|
|
*
|
|
* In KDevelop, this object is used when referencing a cursor that does _not_ point into the
|
|
* most most current document revision. Therefore, before applying such a cursor in the text
|
|
* documents, it has to be translated into the current document revision explicitly, thereby replaying
|
|
* eventual changes (see DUChainBase::translate...)
|
|
*/
|
|
|
|
class KDEVPLATFORMLANGUAGE_EXPORT CursorInRevision {
|
|
public:
|
|
|
|
int line, column;
|
|
|
|
CursorInRevision() : line(0), column(0) {
|
|
}
|
|
|
|
CursorInRevision(int _line, int _column) : line(_line), column(_column) {
|
|
}
|
|
|
|
static CursorInRevision invalid() {
|
|
return CursorInRevision(-1, -1);
|
|
}
|
|
|
|
bool isValid() const {
|
|
return line != -1 || column != -1;
|
|
}
|
|
|
|
bool operator<(const CursorInRevision& rhs) const {
|
|
return line < rhs.line || (line == rhs.line && column < rhs.column);
|
|
}
|
|
|
|
bool operator<=(const CursorInRevision& rhs) const {
|
|
return line < rhs.line || (line == rhs.line && column <= rhs.column);
|
|
}
|
|
|
|
bool operator>(const CursorInRevision& rhs) const {
|
|
return line > rhs.line || (line == rhs.line && column > rhs.column);
|
|
}
|
|
|
|
bool operator>=(const CursorInRevision& rhs) const {
|
|
return line > rhs.line || (line == rhs.line && column >= rhs.column);
|
|
}
|
|
|
|
bool operator ==(const CursorInRevision& rhs) const {
|
|
return line == rhs.line && column == rhs.column;
|
|
}
|
|
|
|
bool operator !=(const CursorInRevision& rhs) const {
|
|
return !(*this == rhs);
|
|
}
|
|
|
|
CursorInRevision operator +(const CursorInRevision& rhs) const {
|
|
return CursorInRevision(line + rhs.line, column + rhs.column);
|
|
}
|
|
|
|
/// @warning Using this is wrong in most cases! If you want
|
|
/// to transform this cursor to the current revision, you should do a proper
|
|
/// mapping instead through @ref KDevelop::DUChainBase or @ref KDevelop::RevisionReference
|
|
/// or @ref KDevelop::DocumentChangeTracker
|
|
SimpleCursor castToSimpleCursor() const {
|
|
return SimpleCursor(line, column);
|
|
}
|
|
|
|
/// @warning Using this is wrong in most cases! If you want
|
|
/// to transform this cursor to the current revision, you should do a proper
|
|
/// mapping instead through @ref KDevelop::DUChainBase or @ref KDevelop::RevisionReference
|
|
/// or @ref KDevelop::DocumentChangeTracker
|
|
static CursorInRevision castFromSimpleCursor(const SimpleCursor& cursor) {
|
|
return CursorInRevision(cursor.line, cursor.column);
|
|
}
|
|
|
|
/// kDebug() stream operator. Writes this cursor to the debug output in a nicely formatted way.
|
|
inline friend QDebug operator<< (QDebug s, const CursorInRevision& cursor) {
|
|
s.nospace() << "(" << cursor.line << ", " << cursor.column << ")";
|
|
return s.space();
|
|
}
|
|
};
|
|
|
|
inline uint qHash(const KDevelop::CursorInRevision& cursor) {
|
|
return cursor.line * 53 + cursor.column * 47;
|
|
}
|
|
|
|
} // namespace KDevelop
|
|
|
|
Q_DECLARE_TYPEINFO(KDevelop::CursorInRevision, Q_MOVABLE_TYPE);
|
|
Q_DECLARE_METATYPE(KDevelop::CursorInRevision)
|
|
|
|
#endif
|