katetextcursor.h

Go to the documentation of this file.

/*  This file is part of the Kate project.
 *
 *  Copyright (C) 2010 Christoph Cullmann <cullmann@kde.org>
 *
 *  Based on code of the SmartCursor/Range by:
 *  Copyright (C) 2003-2005 Hamish Rodda <rodda@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 KATE_TEXTCURSOR_H
#define KATE_TEXTCURSOR_H

#include <ktexteditor/movingcursor.h>

#include "katepartprivate_export.h"
#include "katetextblock.h"

namespace Kate {

class TextBuffer;
class TextBlock;
class TextRange;

class KATEPART_TESTS_EXPORT TextCursor : public KTextEditor::MovingCursor {
  // range wants direct access to some internals
  friend class TextRange;

  // this is a friend, because this is needed to efficiently transfer cursors from on to an other block
  friend class TextBlock;

  private:
    TextCursor (TextBuffer &buffer, TextRange *range, const KTextEditor::Cursor &position, InsertBehavior insertBehavior);

  public:
    TextCursor (TextBuffer &buffer, const KTextEditor::Cursor &position, InsertBehavior insertBehavior);

    ~TextCursor ();

    void setInsertBehavior (InsertBehavior insertBehavior) { m_moveOnInsert = insertBehavior == MoveOnInsert; }

    InsertBehavior insertBehavior () const { return m_moveOnInsert ? MoveOnInsert : StayOnInsert; }

    KTextEditor::Document *document () const;

    void setPosition (const TextCursor& position);

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

    void setPosition (int line, int column) { KTextEditor::MovingCursor::setPosition (line, column); }

    int line() const;

    int lineInternal() const
    {
      // invalid cursor have no block
      if (!m_block)
        return -1;

      // else, calculate real line
      return m_block->startLine () + m_line;
    }

    int column() const { return m_column; }

    int columnInternal() const { return m_column; }

    KTextEditor::MovingRange *range () const;

    Kate::TextRange *kateRange () const { return m_range; }

    TextBlock *block () const { return m_block; }

    int lineInBlock () const { if (m_block) return m_line; return -1; }

  private:
    TextCursor (const TextCursor &);

    TextCursor &operator= (const TextCursor &);

    void setPosition (const KTextEditor::Cursor& position, bool init);

  private:
    TextBuffer &m_buffer;

    TextRange * const m_range;

    TextBlock *m_block;

    int m_line;

    int m_column;

    bool m_moveOnInsert;
};

}

#endif