katetexthistory.cpp

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.
 */

#include "katetexthistory.h"
#include "katetextbuffer.h"

namespace Kate {

TextHistory::TextHistory (TextBuffer &buffer)
  : m_buffer (buffer)
  , m_lastSavedRevision (-1)
  , m_firstHistoryEntryRevision (0)
{
  // just call clear to init
  clear ();
}

TextHistory::~TextHistory ()
{
}

qint64 TextHistory::revision () const
{
  // just output last revisions of buffer
  return m_buffer.revision ();
}

void TextHistory::clear ()
{
  // reset last saved revision
  m_lastSavedRevision = -1;

  // remove all history entries and add no-change dummy for first revision
  m_historyEntries.clear ();
  m_historyEntries.push_back (Entry ());

  // first entry will again belong to first revision
  m_firstHistoryEntryRevision = 0;
}

void TextHistory::setLastSavedRevision ()
{
  // current revision was succesful saved
  m_lastSavedRevision = revision ();
}

void TextHistory::wrapLine (const KTextEditor::Cursor &position)
{
  // create and add new entry
  Entry entry;
  entry.type = Entry::WrapLine;
  entry.line = position.line ();
  entry.column = position.column ();
  addEntry (entry);
}

void TextHistory::unwrapLine (int line, int oldLineLength)
{
  // create and add new entry
  Entry entry;
  entry.type = Entry::UnwrapLine;
  entry.line = line;
  entry.column = 0;
  entry.oldLineLength = oldLineLength;
  addEntry (entry);
}

void TextHistory::insertText (const KTextEditor::Cursor &position, int length, int oldLineLength)
{
  // create and add new entry
  Entry entry;
  entry.type = Entry::InsertText;
  entry.line = position.line ();
  entry.column = position.column ();
  entry.length = length;
  entry.oldLineLength = oldLineLength;
  addEntry (entry);
}

void TextHistory::removeText (const KTextEditor::Range &range, int oldLineLength)
{
  // create and add new entry
  Entry entry;
  entry.type = Entry::RemoveText;
  entry.line = range.start().line ();
  entry.column = range.start().column ();
  entry.length = range.end().column() - range.start().column();
  entry.oldLineLength = oldLineLength;
  addEntry (entry);
}

void TextHistory::addEntry (const Entry &entry)
{
  Q_ASSERT (!m_historyEntries.empty ());

  if ((m_historyEntries.size () == 1) && !m_historyEntries.first().referenceCounter) {
    m_firstHistoryEntryRevision = revision () + 1;

    m_historyEntries.first() = entry;

    return;
  }

  m_historyEntries.push_back (entry);
}

void TextHistory::lockRevision (qint64 revision)
{
  Q_ASSERT (!m_historyEntries.empty ());
  Q_ASSERT (revision >= m_firstHistoryEntryRevision);
  Q_ASSERT (revision < (m_firstHistoryEntryRevision + m_historyEntries.size()));

  Entry &entry = m_historyEntries[revision - m_firstHistoryEntryRevision];
  ++entry.referenceCounter;
}

void TextHistory::unlockRevision (qint64 revision)
{
  Q_ASSERT (!m_historyEntries.empty ());
  Q_ASSERT (revision >= m_firstHistoryEntryRevision);
  Q_ASSERT (revision < (m_firstHistoryEntryRevision + m_historyEntries.size()));

  Entry &entry = m_historyEntries[revision - m_firstHistoryEntryRevision];
  Q_ASSERT (entry.referenceCounter);
  --entry.referenceCounter;

  if (!entry.referenceCounter) {
    int unreferencedEdits = 0;
    for (int i = 0; i + 1 < m_historyEntries.size(); ++i) {
      if (m_historyEntries.at(i).referenceCounter)
        break;

      // remember deleted count
      ++unreferencedEdits;
    }

    if (unreferencedEdits > 0) {
      // remove stuff from history
      m_historyEntries.erase (m_historyEntries.begin(), m_historyEntries.begin() + unreferencedEdits);

      // patch first entry revision
      m_firstHistoryEntryRevision += unreferencedEdits;
    }
  }
}

void TextHistory::Entry::transformCursor (int &cursorLine, int &cursorColumn, bool moveOnInsert) const
{
  if (line > cursorLine)
    return;

  switch (type) {
    case WrapLine:
      if (cursorLine == line) {
        if (cursorColumn <= column) {
          if (cursorColumn < column || !moveOnInsert)
            return;
        }

        cursorColumn =  cursorColumn - column;
      }

      cursorLine +=  1;
      return;

    case UnwrapLine:
      if (cursorLine == line)
        cursorColumn +=  oldLineLength;

      cursorLine -= 1;
      return;

    case InsertText:
      if (cursorLine != line)
        return;

      // skip cursors with too small column
      if (cursorColumn <= column)
        if (cursorColumn < column || !moveOnInsert)
          return;

      // patch column of cursor
      if (cursorColumn <= oldLineLength)
        cursorColumn += length;

      // special handling if cursor behind the real line, e.g. non-wrapping cursor in block selection mode
      else if (cursorColumn < oldLineLength + length)
        cursorColumn =  oldLineLength + length;

      return;

    case RemoveText:
      if (cursorLine != line)
        return;

      // skip cursors with too small column
      if (cursorColumn <= column)
          return;

      // patch column of cursor
      if (cursorColumn <= column + length)
        cursorColumn =  column;
      else
        cursorColumn -=  length;

      return;

    default:
      return;
  }
}

void TextHistory::Entry::reverseTransformCursor (int &cursorLine, int &cursorColumn, bool moveOnInsert) const
{   
  switch (type) {
    case WrapLine:
      if (cursorLine <= line)
          return;
        
      if (cursorLine == line + 1) {
        cursorColumn = cursorColumn + column;
      }

      cursorLine -=  1;
      return;

    case UnwrapLine:
      if (cursorLine < line - 1)
          return;
        
      if (cursorLine == line - 1) {
        if (cursorColumn <= oldLineLength) {
            if (cursorColumn < oldLineLength || !moveOnInsert)
                return;
        }
          
        cursorColumn -= oldLineLength;
      }
      
      cursorLine += 1;
      return;

    case InsertText:
      if (cursorLine != line)
        return;

      // skip cursors with too small column
      if (cursorColumn <= column)
        return;

      // patch column of cursor
      if (cursorColumn - length < column)
        cursorColumn = column;
      else
        cursorColumn -= length;

      return;

    case RemoveText:
      if (cursorLine != line)
        return;

      // skip cursors with too small column
      if (cursorColumn <= column)
        if (cursorColumn < column || !moveOnInsert)
          return;

      // patch column of cursor
      if (cursorColumn <= oldLineLength)
        cursorColumn += length;

      // special handling if cursor behind the real line, e.g. non-wrapping cursor in block selection mode
      else if (cursorColumn < oldLineLength + length)
        cursorColumn =  oldLineLength + length;
      return;

    default:
      return;
  }
}

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

  if (fromRevision == toRevision)
    return;

  Q_ASSERT (!m_historyEntries.empty ());
  Q_ASSERT (fromRevision != toRevision);
  Q_ASSERT (fromRevision >= m_firstHistoryEntryRevision);
  Q_ASSERT (fromRevision < (m_firstHistoryEntryRevision + m_historyEntries.size()));
  Q_ASSERT (toRevision >= m_firstHistoryEntryRevision);
  Q_ASSERT (toRevision < (m_firstHistoryEntryRevision + m_historyEntries.size()));

  bool moveOnInsert = insertBehavior == KTextEditor::MovingCursor::MoveOnInsert;
  
  if (toRevision > fromRevision) {
    for (int rev = fromRevision - m_firstHistoryEntryRevision + 1; rev <= (toRevision - m_firstHistoryEntryRevision); ++rev) {
        const Entry &entry = m_historyEntries.at(rev);
        entry.transformCursor (line, column, moveOnInsert);
    }
  } else {
    for (int rev = fromRevision - m_firstHistoryEntryRevision; rev >= (toRevision - m_firstHistoryEntryRevision + 1); --rev) {
        const Entry &entry = m_historyEntries.at(rev);
        entry.reverseTransformCursor (line, column, moveOnInsert);
    }
  }
}

void TextHistory::transformRange (KTextEditor::Range &range, KTextEditor::MovingRange::InsertBehaviors insertBehaviors, KTextEditor::MovingRange::EmptyBehavior emptyBehavior, qint64 fromRevision, qint64 toRevision)
{
  bool invalidateIfEmpty = emptyBehavior == KTextEditor::MovingRange::InvalidateIfEmpty;
  if (invalidateIfEmpty && range.end() <= range.start()) {
    range = KTextEditor::Range::invalid();
    return;
  }

  if (fromRevision == -1)
    fromRevision = revision ();

  if (toRevision == -1)
    toRevision = revision ();

  if (fromRevision == toRevision)
    return;

  Q_ASSERT (!m_historyEntries.empty ());
  Q_ASSERT (fromRevision != toRevision);
  Q_ASSERT (fromRevision >= m_firstHistoryEntryRevision);
  Q_ASSERT (fromRevision < (m_firstHistoryEntryRevision + m_historyEntries.size()));
  Q_ASSERT (toRevision >= m_firstHistoryEntryRevision);
  Q_ASSERT (toRevision < (m_firstHistoryEntryRevision + m_historyEntries.size()));
  
  // first: copy cursors, without range association
  int startLine = range.start().line(), startColumn = range.start().column(), endLine = range.end().line(), endColumn = range.end().column();
  
  bool moveOnInsertStart = !(insertBehaviors & KTextEditor::MovingRange::ExpandLeft);
  bool moveOnInsertEnd = (insertBehaviors & KTextEditor::MovingRange::ExpandRight);
  
  if (toRevision > fromRevision) {
    for (int rev = fromRevision - m_firstHistoryEntryRevision + 1; rev <= (toRevision - m_firstHistoryEntryRevision); ++rev) {
        const Entry &entry = m_historyEntries.at(rev);
        
        entry.transformCursor (startLine, startColumn, moveOnInsertStart);
        
        entry.transformCursor (endLine, endColumn, moveOnInsertEnd);

        // got empty?
        if(endLine < startLine || (endLine == startLine && endColumn <= startColumn))
        {
            if (invalidateIfEmpty) {
                range = KTextEditor::Range::invalid();
                return;
            }
            else{
                // else normalize them
                endLine = startLine;
                endColumn = startColumn;
            }
        }
    }
  } else {
    for (int rev = fromRevision - m_firstHistoryEntryRevision ; rev >= (toRevision - m_firstHistoryEntryRevision + 1); --rev) {
        const Entry &entry = m_historyEntries.at(rev);
        
        entry.reverseTransformCursor (startLine, startColumn, moveOnInsertStart);
        
        entry.reverseTransformCursor (endLine, endColumn, moveOnInsertEnd);

        // got empty?
        if(endLine < startLine || (endLine == startLine && endColumn <= startColumn))
        {
            if (invalidateIfEmpty) {
                range = KTextEditor::Range::invalid();
                return;
            }
            else{
                // else normalize them
                endLine = startLine;
                endColumn = startColumn;
            }
        }
    }
  }

  // now, copy cursors back
  range.start().setLine(startLine);
  range.start().setColumn(startColumn);
  range.end().setLine(endLine);
  range.end().setColumn(endColumn);
  
}

}