cursor.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2003-2005 Hamish Rodda <rodda@kde.org>
   Copyright (C) 2001-2005 Christoph Cullmann <cullmann@kde.org>
   Copyright (C) 2002 Christian Couder <christian@kdevelop.org>
   Copyright (C) 2001 Joseph Wenninger <jowenn@kde.org>
   Copyright (C) 1999 Jochen Wilhelmy <digisnap@cs.tu-berlin.de>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   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 KDELIBS_KTEXTEDITOR_CURSOR_H
#define KDELIBS_KTEXTEDITOR_CURSOR_H

#include <ktexteditor/ktexteditor_export.h>
#include <kdebug.h>

namespace KTextEditor
{
class Document;
class Range;
class SmartCursor;

class KTEXTEDITOR_EXPORT Cursor
{
  friend class Range;

  public:
    Cursor();

    Cursor(int line, int column);

    Cursor(const Cursor& copy);

    //TODO: KDE5 make non-virtual for maximum speed
    virtual ~Cursor();

    virtual bool isValid() const;

    virtual bool isSmartCursor() const;

    virtual SmartCursor* toSmartCursor() const;

    static Cursor invalid();

    static Cursor start();

    virtual void setPosition(const Cursor& position);

    void setPosition(int line, int column);

    virtual int line() const;

    virtual void setLine(int line);

    int column() const;

    virtual void setColumn(int column);

    bool atStartOfLine() const;

    bool atStartOfDocument() const;

    void position (int &line, int &column) const;

    Range* range() const;

    inline Cursor& operator=(const Cursor& cursor)
      { setPosition(cursor); return *this; }

    inline friend Cursor operator+(const Cursor& c1, const Cursor& c2)
      { return Cursor(c1.line() + c2.line(), c1.column() + c2.column()); }

    inline friend Cursor& operator+=(Cursor& c1, const Cursor& c2)
      { c1.setPosition(c1.line() + c2.line(), c1.column() + c2.column()); return c1; }

    inline friend Cursor operator-(const Cursor& c1, const Cursor& c2)
      { return Cursor(c1.line() - c2.line(), c1.column() - c2.column()); }

    inline friend Cursor& operator-=(Cursor& c1, const Cursor& c2)
      { c1.setPosition(c1.line() - c2.line(), c1.column() - c2.column()); return c1; }

    inline friend bool operator==(const Cursor& c1, const Cursor& c2)
      { return c1.line() == c2.line() && c1.column() == c2.column(); }

    inline friend bool operator!=(const Cursor& c1, const Cursor& c2)
      { return !(c1 == c2); }

    inline friend bool operator>(const Cursor& c1, const Cursor& c2)
      { return c1.line() > c2.line() || (c1.line() == c2.line() && c1.m_column > c2.m_column); }

    inline friend bool operator>=(const Cursor& c1, const Cursor& c2)
      { return c1.line() > c2.line() || (c1.line() == c2.line() && c1.m_column >= c2.m_column); }

    inline friend bool operator<(const Cursor& c1, const Cursor& c2)
      { return !(c1 >= c2); }

    inline friend bool operator<=(const Cursor& c1, const Cursor& c2)
      { return !(c1 > c2); }

    inline friend QDebug operator<< (QDebug s, const Cursor& cursor) {
      if (&cursor)
        s.nospace() << "(" << cursor.line() << ", " << cursor.column() << ")";
      else
        s.nospace() << "(null cursor)";
      return s.space();
    }

   protected:
    virtual void setRange(Range* range);

    void cursorChangedDirectly(const Cursor& from);

    int m_line;

    int m_column;

    Range* m_range;
};

}

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;