plugins/duchainviewer/duchainmodel.h

   1 /*
   2  * KDevelop DUChain viewer
   3  *
   4  * Copyright 2006 Hamish Rodda <rodda@kde.org>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU Library General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public
  17  * License along with this program; if not, write to the
  18  * Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  */
  21
  22 #ifndef DUCHAINMODEL_H
  23 #define DUCHAINMODEL_H
  24
  25 #include <QtCore/QAbstractItemModel>
  26 #include <QtCore/QHash>
  27
  28 #include <ktexteditor/cursor.h>
  29 #include <kurl.h>
  30
  31 #include <language/duchain/duchainbase.h>
  32 #include <language/duchain/duchainobserver.h>
  33
  34 class DUChainViewPlugin;
  35
  36 namespace KDevelop {
  37  class TopDUContext;
  38  class IDocument;
  39  class ParseJob;
  40 }
  41
  42 class ProxyObject : public KDevelop::DUChainBase
  43 {
  44 public:
  45   ProxyObject(KDevelop::DUChainBase* _parent, KDevelop::DUChainBase* _object);
  46
  47   virtual void preDelete() {};
  48
  49   KDevelop::DUChainBase* parent;
  50   KDevelop::DUChainBase* object;
  51 };
  52
  53 class DUChainModel : public QAbstractItemModel
  54 {
  55   Q_OBJECT
  56
  57 public:
  58   DUChainModel(DUChainViewPlugin* parent);
  59   virtual ~DUChainModel();
  60
  61   void setTopContext(KDevelop::TopDUContextPointer context);
  62
  63   KDevelop::DUChainBasePointer* objectForIndex(const QModelIndex& index) const;
  64
  65 public Q_SLOTS:
  66   void documentActivated(KDevelop::IDocument* document);
  67   void parseJobFinished(KDevelop::ParseJob* job);
  68
  69 public:
  70   virtual int columnCount(const QModelIndex & parent = QModelIndex()) const;
  71   virtual QModelIndex index(int row, int column, const QModelIndex & parent = QModelIndex()) const;
  72   virtual QModelIndex parent(const QModelIndex & index) const;
  73   virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const;
  74   virtual int rowCount(const QModelIndex & parent = QModelIndex()) const;
  75   //virtual bool hasChildren(const QModelIndex & parent = QModelIndex()) const;
  76
  77 private slots:
  78   void doubleClicked ( const QModelIndex & index );
  79
  80   // Watch definition use chain changes
  81   void branchAdded(KDevelop::DUContextPointer context);
  82
  83 private:
  84   DUChainViewPlugin* plugin() const;
  85
  86   int findInsertIndex(QList<KDevelop::DUChainBasePointer*>& list, KDevelop::DUChainBase* object) const;
  87
  88   QModelIndex createParentIndex(KDevelop::DUChainBasePointer* type) const;
  89
  90   template <typename T>
  91   KTextEditor::Cursor nextItem(QVectorIterator<T*>& it, bool initialise) const
  92   {
  93     if (initialise)
  94       if (it.hasNext())
  95         it.next();
  96
  97     if (it.hasPrevious())
  98       return it.peekPrevious()->range().textRange().start();
  99
 100     return KTextEditor::Cursor::invalid();
 101   }
 102
 103   template <typename T>
 104   KDevelop::DUChainBase* item(QVectorIterator<T*>& it) const
 105   {
 106     Q_ASSERT(it.hasPrevious());
 107     KDevelop::DUChainBase* item = it.peekPrevious();
 108     if (it.hasNext())
 109       it.next();
 110     else
 111       // Make hasPrevious return false
 112       it.toFront();
 113
 114     return item;
 115   }
 116
 117   template <typename T>
 118   KDevelop::DUChainBase* proxyItem(KDevelop::DUChainBase* parent, QVectorIterator<T*>& it) const
 119   {
 120     KDevelop::DUChainBase* target = item(it);
 121     KDevelop::DUChainBase* proxy = new ProxyObject(parent, target);
 122     m_proxyObjects.insert(target, createPointerForObject(proxy));
 123     return proxy;
 124   }
 125
 126   QList<KDevelop::DUChainBasePointer*>* childItems(KDevelop::DUChainBasePointer* parent) const;
 127   KDevelop::DUChainBasePointer* pointerForObject(KDevelop::DUChainBase* object) const;
 128   KDevelop::DUChainBasePointer* createPointerForObject(KDevelop::DUChainBase* object) const;
 129
 130   KDevelop::TopDUContextPointer m_chain;
 131   KUrl m_document;
 132   mutable QHash<KDevelop::DUChainBase*, KDevelop::DUChainBasePointer*> m_knownObjects;
 133   mutable QHash<KDevelop::DUChainBasePointer*, QList<KDevelop::DUChainBasePointer*>* > m_objectLists;
 134   mutable QHash<KDevelop::DUChainBasePointer*, int > m_modelRow;
 135   mutable QHash<KDevelop::DUChainBase*, KDevelop::DUChainBasePointer*> m_proxyObjects;
 136 };
 137
 138 #endif
 139
 140 // kate: space-indent on; indent-width 2; tab-width 4; replace-tabs on; auto-insert-doxygen on