katetextfolding.h

Go to the documentation of this file.

/*  This file is part of the Kate project.
 *
 *  Copyright (C) 2013 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_TEXTFOLDING_H
#define KATE_TEXTFOLDING_H

#include "katepartprivate_export.h"

#include "ktexteditor/range.h"

#include <QObject>
#include <QFlags>
 
namespace Kate {

class TextBuffer;
class TextCursor;

class KATEPART_TESTS_EXPORT TextFolding : public QObject {
  Q_OBJECT
  
  public: 
    TextFolding (TextBuffer &buffer);
    
    ~TextFolding ();

    enum FoldingRangeFlag {
      Persistent = 0x1,
      
      Folded = 0x2
    };
    Q_DECLARE_FLAGS(FoldingRangeFlags, FoldingRangeFlag)
    
    
    qint64 newFoldingRange (const KTextEditor::Range &range, FoldingRangeFlags flags = FoldingRangeFlags());

    KTextEditor::Range foldingRange(qint64 id) const;

    bool foldRange (qint64 id);
    
    bool unfoldRange (qint64 id, bool remove = false);
    
    bool isLineVisible (int line, qint64 *foldedRangeId = 0) const;
    
    void ensureLineIsVisible (int line);
    
    int visibleLines () const;
    
    int lineToVisibleLine (int line) const;
    
    int visibleLineToLine (int visibleLine) const;
    
    QVector<QPair<qint64, FoldingRangeFlags> > foldingRangesStartingOnLine (int line) const;
    
    QVariantList exportFoldingRanges () const;
    
    void importFoldingRanges (const QVariantList &folds);
    
    QString debugDump () const;
    
    void debugPrint (const QString &title) const;
  
  public Q_SLOTS:
    void clear ();
    
  Q_SIGNALS:
    void foldingRangesChanged ();
      
  private:
    class FoldingRange {
      public:
        FoldingRange (TextBuffer &buffer, const KTextEditor::Range &range, FoldingRangeFlags flags);
        
        ~FoldingRange ();
        
        typedef QVector<FoldingRange*> Vector;
        
        Kate::TextCursor *start;
        
        Kate::TextCursor *end;
        
        FoldingRange *parent;
        
        FoldingRange::Vector nestedRanges;
        
        FoldingRangeFlags flags;
        
        qint64 id;
    };
    
    static void exportFoldingRanges (const TextFolding::FoldingRange::Vector &ranges, QVariantList &folds);
    
    static QString debugDump (const TextFolding::FoldingRange::Vector &ranges, bool recurse);
    
    bool insertNewFoldingRange (FoldingRange *parent, TextFolding::FoldingRange::Vector &existingRanges, TextFolding::FoldingRange *newRange);
    
    bool updateFoldedRangesForNewRange (TextFolding::FoldingRange *newRange);
    
    bool updateFoldedRangesForRemovedRange (TextFolding::FoldingRange *oldRange);
    
    void appendFoldedRanges (TextFolding::FoldingRange::Vector &newFoldedFoldingRanges, const TextFolding::FoldingRange::Vector &ranges) const;
  
    static bool compareRangeByStart (FoldingRange *a, FoldingRange *b);

    static bool compareRangeByEnd (FoldingRange *a, FoldingRange *b);
    
    static bool compareRangeByStartWithLine (int line, FoldingRange *range);
    
    static bool compareRangeByLineWithStart (FoldingRange *range, int line);
    
    void foldingRangesStartingOnLine (QVector<QPair<qint64, FoldingRangeFlags> > &results, const TextFolding::FoldingRange::Vector &ranges, int line) const;
    
  private:
    TextBuffer &m_buffer;
    
    FoldingRange::Vector m_foldingRanges;

    FoldingRange::Vector m_foldedFoldingRanges;
    
    qint64 m_idCounter;
    
    QHash<qint64, FoldingRange *> m_idToFoldingRange;
};

}

Q_DECLARE_OPERATORS_FOR_FLAGS(Kate::TextFolding::FoldingRangeFlags)

#endif