documentcursor.h

Go to the documentation of this file.

/* This file is part of the KDE project
 * 
 *  Copyright (C) 2010 Christoph Cullmann <cullmann@kde.org>
 *  Copyright (C) 2012 Dominik Haumann <dhaumann@kde.org>
 *
 *  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 KTEXTEDITOR_DOCUMENT_CURSOR_H
#define KTEXTEDITOR_DOCUMENT_CURSOR_H

#include <ktexteditor/cursor.h>
#include <ktexteditor/document.h>

#include "katepartprivate_export.h"

namespace KTextEditor {

class KATEPART_TESTS_EXPORT DocumentCursor
{
  //
  // sub types
  //
  public:
    enum WrapBehavior {
      Wrap = 0x0,  
      NoWrap = 0x1 
    };

  //
  // Constructor
  //
  public:
    DocumentCursor(KTextEditor::Document* document);

    DocumentCursor(KTextEditor::Document* document, const KTextEditor::Cursor& position);

    DocumentCursor(KTextEditor::Document* document, int line, int column);

    DocumentCursor (const DocumentCursor &other);

  //
  // stuff that needs to be implemented by editor part cusors
  //
  public:

    Document *document () const;

    void setPosition (const KTextEditor::Cursor& position);

    int line() const;

    int column() const;

    ~DocumentCursor ();

  //
  // forbidden stuff
  //
  private:
    DocumentCursor ();

  //
  // convenience API
  //
  public:

    inline bool isValid() const {
      return line() >= 0 && column() >= 0;
    }

    // TODO KDE5: use KTE::Document::isValidTextPosition()
    inline bool isValidTextPosition() const {
      return isValid() && line() < document()->lines() && column() <= document()->lineLength(line());
    }

    void makeValid();

    void setPosition (int line, int column);

    void setLine(int line);

    void setColumn(int column);

    bool atStartOfLine() const;

    bool atEndOfLine() const;

    bool atStartOfDocument() const;

    bool atEndOfDocument() const;

    bool gotoNextLine();

    bool gotoPreviousLine();

    bool move(int chars, WrapBehavior wrapBehavior = Wrap);

    const Cursor& toCursor () const;

    operator const Cursor& () const;

  //
  // operators for: DocumentCursor <-> DocumentCursor
  //
    DocumentCursor &operator= (const DocumentCursor &other);

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

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

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

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

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

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

    inline friend QDebug operator<< (QDebug s, const DocumentCursor *cursor) {
      if (cursor)
        s.nospace() << "(" << cursor->document() << ": " << cursor->line() << ", " << cursor->column() << ")";
      else
        s.nospace() << "(null document cursor)";
      return s.space();
    }

    inline friend QDebug operator<< (QDebug s, const DocumentCursor &cursor) {
      return s << &cursor;
    }

  private:
    KTextEditor::Document* m_document;
    KTextEditor::Cursor m_cursor;
};

}

#endif

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