katetexthistory.h

Go to the documentation of this file.

/*  This file is part of the Kate project.
 *
 *  Copyright (C) 2010 Christoph Cullmann <cullmann@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_TEXTHISTORY_H
#define KATE_TEXTHISTORY_H

#include <QtCore/QList>

#include <ktexteditor/range.h>

#include "katepartprivate_export.h"
#include "katetextcursor.h"
#include "katetextrange.h"

namespace Kate {

class TextBuffer;

class KATEPART_TESTS_EXPORT TextHistory {
  friend class TextBuffer;
  friend class TextBlock;

  public:
    qint64 revision () const;

    qint64 lastSavedRevision () const { return m_lastSavedRevision; }

    void lockRevision (qint64 revision);

    void unlockRevision (qint64 revision);

    void transformCursor (int& line, int& column, KTextEditor::MovingCursor::InsertBehavior insertBehavior, qint64 fromRevision, qint64 toRevision = -1);

    void transformRange (KTextEditor::Range &range, KTextEditor::MovingRange::InsertBehaviors insertBehaviors, KTextEditor::MovingRange::EmptyBehavior emptyBehavior, qint64 fromRevision, qint64 toRevision = -1);

  private:
    class Entry {
      public:
        void transformCursor (int &line, int &column, bool moveOnInsert) const;
        
        void reverseTransformCursor (int &line, int &column, bool moveOnInsert) const;

        enum Type {
          NoChange
          , WrapLine
          , UnwrapLine
          , InsertText
          , RemoveText
        };

        Entry ()
         : referenceCounter (0), type (NoChange), line (-1), column (-1), length (-1), oldLineLength (-1)
        {
        }

        unsigned int referenceCounter;

        Type type;

        int line;

        int column;

        int length;

        int oldLineLength;
    };

    TextHistory (TextBuffer &buffer);

    ~TextHistory ();

    void clear ();

    void setLastSavedRevision ();

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

    void unwrapLine (int line, int oldLineLength);

    void insertText (const KTextEditor::Cursor &position, int length, int oldLineLength);

    void removeText (const KTextEditor::Range &range, int oldLineLength);

    void addEntry (const Entry &entry);

  private:
    TextBuffer &m_buffer;

    qint64 m_lastSavedRevision;

    QList<Entry> m_historyEntries;

    qint64 m_firstHistoryEntryRevision;
};

}

#endif