katetextblock.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_TEXTBLOCK_H
#define KATE_TEXTBLOCK_H

#include <QtCore/QVector>
#include <QtCore/QSet>

#include "katepartprivate_export.h"
#include <ktexteditor/cursor.h>
#include "katetextline.h"

namespace Kate {

class TextBuffer;
class TextCursor;
class TextRange;

class KATEPART_TESTS_EXPORT TextBlock {
  public:
    TextBlock (TextBuffer *buffer, int startLine);

    ~TextBlock ();

    int startLine () const { return m_startLine; }

    void setStartLine (int startLine);

    TextLine line (int line) const;

    void appendLine (const QString &textOfLine);
    
    void clearLines ();

    int lines () const { return m_lines.size(); }

    void text (QString &text) const;

    void wrapLine (const KTextEditor::Cursor &position, int fixStartLinesStartIndex);

    void unwrapLine (int line, TextBlock *previousBlock, int fixStartLinesStartIndex);

    void insertText (const KTextEditor::Cursor &position, const QString &text);

    void removeText (const KTextEditor::Range &range, QString &removedText);

    void debugPrint (int blockIndex) const;

    TextBlock *splitBlock (int fromLine);

    void mergeBlock (TextBlock *targetBlock);

    void deleteBlockContent ();

    void clearBlockContent (TextBlock *targetBlock);

    QList<QSet<TextRange*> > rangesForLine (int line) const {
      return QList<QSet<TextRange*> >() << m_uncachedRanges << cachedRangesForLine(line);
    }

    bool containsRange (TextRange* range) const {
      return m_cachedLineForRanges.contains(range) || m_uncachedRanges.contains(range);
    }

    void markModifiedLinesAsSaved ();
    
    void insertCursor (Kate::TextCursor *cursor) { m_cursors.insert (cursor); }
    
    void removeCursor (Kate::TextCursor *cursor) { m_cursors.remove (cursor); }

    void updateRange(TextRange* range);

    void removeRange (TextRange* range);

    QSet<TextRange*> cachedRangesForLine (int line) const {
      line -= m_startLine;
      if(line >= 0 && line < m_cachedRangesForLine.size())
        return m_cachedRangesForLine[line];
      else
        return QSet<TextRange*>();
    }

  private:
    TextBuffer *m_buffer;

    QVector<Kate::TextLine> m_lines;

    int m_startLine;

    QSet<TextCursor *> m_cursors;

    QVector<QSet<TextRange *> > m_cachedRangesForLine;

    QHash<TextRange *, int> m_cachedLineForRanges;

    QSet<TextRange *> m_uncachedRanges;
};

}

#endif