fixes to the TreeModel and Client
[quassel.git] / src / client / treemodel.cpp
index c113b28..9a01abf 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-08 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 
 #include "treemodel.h"
 
+#include <QDebug>
+#include <QCoreApplication>
+
 /*****************************************
- *  Buffer Items stored in the Tree Model
+ *  Abstract Items of a TreeModel
  *****************************************/
-TreeItem::TreeItem(const QList<QVariant> &data, TreeItem *parent)
+AbstractTreeItem::AbstractTreeItem(AbstractTreeItem *parent)
   : QObject(parent),
-    itemData(data),
-    _parentItem(parent),
     _flags(Qt::ItemIsSelectable | Qt::ItemIsEnabled)
 {
 }
 
-TreeItem::TreeItem(TreeItem *parent)
-  : QObject(parent),
-    itemData(QList<QVariant>()),
-    _parentItem(parent),
-    _flags(Qt::ItemIsSelectable | Qt::ItemIsEnabled)
-{
+AbstractTreeItem::~AbstractTreeItem() {
 }
 
-TreeItem::~TreeItem() {
-  qDeleteAll(_childItems);
+quint64 AbstractTreeItem::id() const {
+  return qHash(this);
 }
 
-quint64 TreeItem::id() const {
-  return (quint64)this;
+bool AbstractTreeItem::newChild(AbstractTreeItem *item) {
+  // check if a child with that ID is already known
+  Q_ASSERT(childById(item->id()) == 0);
+    
+  int newRow = childCount();
+  emit beginAppendChilds(newRow, newRow);
+  _childItems.append(item);
+  emit endAppendChilds();
+  
+  return true;
 }
 
-void TreeItem::appendChild(TreeItem *item) {
-  _childItems.append(item);
-  _childHash[item->id()] = item;
-  connect(item, SIGNAL(destroyed()),
-         this, SLOT(childDestroyed()));
+bool AbstractTreeItem::removeChild(int row) {
+  if(childCount() <= row)
+    return false;
+
+  child(row)->removeAllChilds();
+  emit beginRemoveChilds(row, row);
+  AbstractTreeItem *treeitem = _childItems.takeAt(row);
+  treeitem->deleteLater();
+  emit endRemoveChilds();
+
+  return true;
 }
 
-void TreeItem::removeChild(int row) {
-  if(row >= _childItems.size())
+bool AbstractTreeItem::removeChildById(const quint64 &id) {
+  const int numChilds = childCount();
+  
+  for(int i = 0; i < numChilds; i++) {
+    if(_childItems[i]->id() == id)
+      return removeChild(i);
+  }
+  
+  return false;
+}
+
+void AbstractTreeItem::removeAllChilds() {
+  const int numChilds = childCount();
+  
+  if(numChilds == 0)
     return;
-  TreeItem *treeitem = _childItems.value(row);
-  _childItems.removeAt(row);
-  _childHash.remove(_childHash.key(treeitem));
+  
+  AbstractTreeItem *child;
+
+  QList<AbstractTreeItem *>::iterator childIter;
+
+  childIter = _childItems.begin();
+  while(childIter != _childItems.end()) {
+    child = *childIter;
+    child->removeAllChilds();
+    childIter++;
+  }
+
+  emit beginRemoveChilds(0, numChilds - 1);
+  childIter = _childItems.begin();
+  while(childIter != _childItems.end()) {
+    child = *childIter;
+    childIter = _childItems.erase(childIter);
+    child->deleteLater();
+  }
+  emit endRemoveChilds();
 }
 
-TreeItem *TreeItem::child(int row) const {
-  if(row < _childItems.size())
-    return _childItems.value(row);
-  else
+AbstractTreeItem *AbstractTreeItem::child(int row) const {
+  if(childCount() <= row)
     return 0;
+  else
+    return _childItems[row];
 }
 
-TreeItem *TreeItem::childById(const uint &id) const {
-  if(_childHash.contains(id))
-    return _childHash.value(id);
-  else
-    return 0;
+AbstractTreeItem *AbstractTreeItem::childById(const quint64 &id) const {
+  const int numChilds = childCount();
+  for(int i = 0; i < numChilds; i++) {
+    if(_childItems[i]->id() == id)
+      return _childItems[i];
+  }
+  return 0;
 }
 
-int TreeItem::childCount() const {
+int AbstractTreeItem::childCount() const {
   return _childItems.count();
 }
 
-int TreeItem::row() const {
-  if(_parentItem)
-    return _parentItem->_childItems.indexOf(const_cast<TreeItem*>(this));
+int AbstractTreeItem::row() const {
+  if(!parent())
+    return -1;
   else
-    return 0;
+    return parent()->_childItems.indexOf(const_cast<AbstractTreeItem *>(this));
 }
 
-TreeItem *TreeItem::parent() {
-  return _parentItem;
+AbstractTreeItem *AbstractTreeItem::parent() const {
+  return qobject_cast<AbstractTreeItem *>(QObject::parent());
 }
 
-int TreeItem::columnCount() const {
-  return itemData.count();
+Qt::ItemFlags AbstractTreeItem::flags() const {
+  return _flags;
 }
 
-QVariant TreeItem::data(int column, int role) const {
-  if(role == Qt::DisplayRole && column < itemData.count())
-    return itemData[column];
-  else
+void AbstractTreeItem::setFlags(Qt::ItemFlags flags) {
+  _flags = flags;
+}
+
+void AbstractTreeItem::dumpChildList() {
+  qDebug() << "==== Childlist for Item:" << this << id() << "====";
+  if(childCount() > 0) {
+    AbstractTreeItem *child;
+    QList<AbstractTreeItem *>::const_iterator childIter = _childItems.constBegin();
+    while(childIter != _childItems.constEnd()) {
+      child = *childIter;
+      qDebug() << "Row:" << child->row() << child << child->id() << child->data(0, Qt::DisplayRole);
+      childIter++;
+    }
+  }
+  qDebug() << "==== End Of Childlist ====";  
+}
+
+/*****************************************
+ * SimpleTreeItem
+ *****************************************/
+SimpleTreeItem::SimpleTreeItem(const QList<QVariant> &data, AbstractTreeItem *parent)
+  : AbstractTreeItem(parent),
+    _itemData(data)
+{
+}
+
+SimpleTreeItem::~SimpleTreeItem() {
+}
+
+QVariant SimpleTreeItem::data(int column, int role) const {
+  if(column >= columnCount() || role != Qt::DisplayRole)
     return QVariant();
+  else
+    return _itemData[column];
 }
 
-Qt::ItemFlags TreeItem::flags() const {
-  return _flags;
+bool SimpleTreeItem::setData(int column, const QVariant &value, int role) {
+  if(column > columnCount() || role != Qt::DisplayRole)
+    return false;
+
+  if(column == columnCount())
+    _itemData.append(value);
+  else
+    _itemData[column] = value;
+
+  emit dataChanged(column);
+  return true;
 }
 
-void TreeItem::setFlags(Qt::ItemFlags flags) {
-  _flags = flags;
+int SimpleTreeItem::columnCount() const {
+  return _itemData.count();
+}
+
+/*****************************************
+ * PropertyMapItem
+ *****************************************/
+PropertyMapItem::PropertyMapItem(const QStringList &propertyOrder, AbstractTreeItem *parent)
+  : AbstractTreeItem(parent),
+    _propertyOrder(propertyOrder)
+{
 }
 
-void TreeItem::childDestroyed() {
-  TreeItem *item = static_cast<TreeItem*>(sender());
-  removeChild(item->row());
+PropertyMapItem::PropertyMapItem(AbstractTreeItem *parent)
+  : AbstractTreeItem(parent),
+    _propertyOrder(QStringList())
+{
 }
+
+
+PropertyMapItem::~PropertyMapItem() {
+}
+  
+QVariant PropertyMapItem::data(int column, int role) const {
+  if(column >= columnCount())
+    return QVariant();
+
+  switch(role) {
+  case Qt::ToolTipRole:
+    return toolTip(column);
+  case Qt::DisplayRole:
+    return property(_propertyOrder[column].toAscii());
+  default:
+    return QVariant();
+  }
   
+}
+
+bool PropertyMapItem::setData(int column, const QVariant &value, int role) {
+  if(column >= columnCount() || role != Qt::DisplayRole)
+    return false;
+
+  emit dataChanged(column);
+  return setProperty(_propertyOrder[column].toAscii(), value);
+}
+
+int PropertyMapItem::columnCount() const {
+  return _propertyOrder.count();
+}
+  
+void PropertyMapItem::appendProperty(const QString &property) {
+  _propertyOrder << property;
+}
+
 
 
 /*****************************************
  * TreeModel
  *****************************************/
 TreeModel::TreeModel(const QList<QVariant> &data, QObject *parent)
-  : QAbstractItemModel(parent)
+  : QAbstractItemModel(parent),
+    _childStatus(QModelIndex(), 0, 0, 0),
+    _aboutToRemoveOrInsert(false)
 {
-  rootItem = new TreeItem(data, 0);
+  rootItem = new SimpleTreeItem(data, 0);
+  connectItem(rootItem);
+
+  if(QCoreApplication::instance()->arguments().contains("--debugmodel")) {
+    connect(this, SIGNAL(rowsAboutToBeInserted(const QModelIndex &, int, int)),
+           this, SLOT(debug_rowsAboutToBeInserted(const QModelIndex &, int, int)));
+    connect(this, SIGNAL(rowsAboutToBeRemoved(const QModelIndex &, int, int)),
+           this, SLOT(debug_rowsAboutToBeRemoved(const QModelIndex &, int, int)));
+    connect(this, SIGNAL(rowsInserted(const QModelIndex &, int, int)),
+           this, SLOT(debug_rowsInserted(const QModelIndex &, int, int)));
+    connect(this, SIGNAL(rowsRemoved(const QModelIndex &, int, int)),
+           this, SLOT(debug_rowsRemoved(const QModelIndex &, int, int)));
+  }
 }
 
 TreeModel::~TreeModel() {
@@ -134,42 +274,59 @@ QModelIndex TreeModel::index(int row, int column, const QModelIndex &parent) con
   if(!hasIndex(row, column, parent))
     return QModelIndex();
   
-  TreeItem *parentItem;
+  AbstractTreeItem *parentItem;
   
   if(!parent.isValid())
     parentItem = rootItem;
   else
-    parentItem = static_cast<TreeItem*>(parent.internalPointer());
+    parentItem = static_cast<AbstractTreeItem *>(parent.internalPointer());
   
-  TreeItem *childItem = parentItem->child(row);
+  AbstractTreeItem *childItem = parentItem->child(row);
+
   if(childItem)
     return createIndex(row, column, childItem);
   else
     return QModelIndex();
 }
 
-QModelIndex TreeModel::indexById(uint id, const QModelIndex &parent) const {
-  TreeItem *parentItem; 
+QModelIndex TreeModel::indexById(quint64 id, const QModelIndex &parent) const {
+  AbstractTreeItem *parentItem; 
   
   if(!parent.isValid())
     parentItem = rootItem;
   else
-    parentItem = static_cast<TreeItem *>(parent.internalPointer());
+    parentItem = static_cast<AbstractTreeItem *>(parent.internalPointer());
+  
+  AbstractTreeItem *childItem = parentItem->childById(id);
   
-  TreeItem *childItem = parentItem->childById(id);
   if(childItem)
     return createIndex(childItem->row(), 0, childItem);
   else
     return QModelIndex();
 }
 
-QModelIndex TreeModel::parent(const QModelIndex &index) const {
-  if(!index.isValid())
+QModelIndex TreeModel::indexByItem(AbstractTreeItem *item) const {
+  if(item == 0) {
+    qWarning() << "TreeModel::indexByItem(AbstractTreeItem *item) received NULL-Pointer";
     return QModelIndex();
+  }
   
-  TreeItem *childItem = static_cast<TreeItem*>(index.internalPointer());
-  TreeItem *parentItem = static_cast<TreeItem*>(childItem->parent());
+  if(item == rootItem)
+    return QModelIndex();
+  else
+    return createIndex(item->row(), 0, item);
+}
+
+QModelIndex TreeModel::parent(const QModelIndex &index) const {
+  if(!index.isValid()) {
+    qWarning() << "TreeModel::parent(): has been asked for the rootItems Parent!";
+    return QModelIndex();
+  }
   
+  AbstractTreeItem *childItem = static_cast<AbstractTreeItem *>(index.internalPointer());
+  AbstractTreeItem *parentItem = childItem->parent();
+
+  Q_ASSERT(parentItem);
   if(parentItem == rootItem)
     return QModelIndex();
   
@@ -177,36 +334,57 @@ QModelIndex TreeModel::parent(const QModelIndex &index) const {
 }
 
 int TreeModel::rowCount(const QModelIndex &parent) const {
-  TreeItem *parentItem;
+  AbstractTreeItem *parentItem;
   if(!parent.isValid())
     parentItem = rootItem;
   else
-    parentItem = static_cast<TreeItem*>(parent.internalPointer());
-  
+    parentItem = static_cast<AbstractTreeItem*>(parent.internalPointer());
+
   return parentItem->childCount();
 }
 
 int TreeModel::columnCount(const QModelIndex &parent) const {
-  if(parent.isValid())
-    return static_cast<TreeItem*>(parent.internalPointer())->columnCount();
-  else
-    return rootItem->columnCount();
+  Q_UNUSED(parent)
+  // since there the Qt Views don't draw more columns than the header has columns
+  // we can be lazy and simply return the count of header columns
+  // actually this gives us more freedom cause we don't have to ensure that a rows parent
+  // has equal or more columns than that row
+  
+//   if(parent.isValid()) {
+//     AbstractTreeItem *child;
+//     if(child = static_cast<AbstractTreeItem *>(parent.internalPointer())->child(parent.column(), parent.row()))
+//       return child->columnCount();
+//     else
+//       return static_cast<AbstractTreeItem*>(parent.internalPointer())->columnCount();
+//   } else {
+//     return rootItem->columnCount();
+//   }
+
+  return rootItem->columnCount();
 }
 
 QVariant TreeModel::data(const QModelIndex &index, int role) const {
   if(!index.isValid())
     return QVariant();
 
-  TreeItem *item = static_cast<TreeItem*>(index.internalPointer());
+  AbstractTreeItem *item = static_cast<AbstractTreeItem *>(index.internalPointer());
   return item->data(index.column(), role);
 }
 
+bool TreeModel::setData(const QModelIndex &index, const QVariant &value, int role) {
+  if(!index.isValid())
+    return false;
+
+  AbstractTreeItem *item = static_cast<AbstractTreeItem *>(index.internalPointer());
+  return item->setData(index.column(), value, role);
+}
+
 Qt::ItemFlags TreeModel::flags(const QModelIndex &index) const {
-  TreeItem *item;
+  AbstractTreeItem *item;
   if(!index.isValid())
     item = rootItem;
   else
-    item = static_cast<TreeItem *>(index.internalPointer());
+    item = static_cast<AbstractTreeItem *>(index.internalPointer());
   return item->flags();
 }
 
@@ -217,48 +395,147 @@ QVariant TreeModel::headerData(int section, Qt::Orientation orientation, int rol
     return QVariant();
 }
 
-bool TreeModel::removeRow(int row, const QModelIndex &parent) {
-  if(row > rowCount(parent))
-    return false;
+void TreeModel::itemDataChanged(int column) {
+  AbstractTreeItem *item = qobject_cast<AbstractTreeItem *>(sender());
+  QModelIndex leftIndex, rightIndex;
+
+  if(item == rootItem)
+    return;
+
+  if(column == -1) {
+    leftIndex = createIndex(item->row(), 0, item);
+    rightIndex = createIndex(item->row(), item->columnCount() - 1, item);
+  } else {
+    leftIndex = createIndex(item->row(), column, item);
+    rightIndex = leftIndex;
+  }
+
+  emit dataChanged(leftIndex, rightIndex);
+}
+
+void TreeModel::connectItem(AbstractTreeItem *item) {
+  connect(item, SIGNAL(dataChanged(int)),
+         this, SLOT(itemDataChanged(int)));
   
-  TreeItem *item;
-  if(!parent.isValid())
-    item = rootItem;
-  else
-    item = static_cast<TreeItem*>(parent.internalPointer());
+  connect(item, SIGNAL(beginAppendChilds(int, int)),
+         this, SLOT(beginAppendChilds(int, int)));
+  connect(item, SIGNAL(endAppendChilds()),
+         this, SLOT(endAppendChilds()));
   
-  beginRemoveRows(parent, row, row);
-  item->removeChild(row);
-  endRemoveRows();
-  return true;
+  connect(item, SIGNAL(beginRemoveChilds(int, int)),
+         this, SLOT(beginRemoveChilds(int, int)));
+  connect(item, SIGNAL(endRemoveChilds()),
+         this, SLOT(endRemoveChilds()));
 }
 
-bool TreeModel::removeRows(int row, int count, const QModelIndex &parent) {
-  // check if there is work to be done
-  if(count == 0)
-    return true;
+void TreeModel::beginAppendChilds(int firstRow, int lastRow) {
+  AbstractTreeItem *parentItem = qobject_cast<AbstractTreeItem *>(sender());
+  if(!parentItem) {
+    qWarning() << "TreeModel::beginAppendChilds(): cannot append Childs to unknown parent";
+    return;
+  }
 
-  // out of range check
-  if(row + count - 1 > rowCount(parent) || row < 0 || count < 0) 
-    return false;
-  
-  TreeItem *item;
-  if(!parent.isValid())
-    item = rootItem;
-  else
-    item = static_cast<TreeItem*>(parent.internalPointer());
+  QModelIndex parent = indexByItem(parentItem);
+  Q_ASSERT(!_aboutToRemoveOrInsert);
   
+  _aboutToRemoveOrInsert = true;
+  _childStatus = ChildStatus(parent, rowCount(parent), firstRow, lastRow);
+  beginInsertRows(parent, firstRow, lastRow);
+}
+
+void TreeModel::endAppendChilds() {
+  AbstractTreeItem *parentItem = qobject_cast<AbstractTreeItem *>(sender());
+  if(!parentItem) {
+    qWarning() << "TreeModel::endAppendChilds(): cannot append Childs to unknown parent";
+    return;
+  }
+  Q_ASSERT(_aboutToRemoveOrInsert);
+  ChildStatus cs = _childStatus;
+  QModelIndex parent = indexByItem(parentItem);
+  Q_ASSERT(cs.parent == parent);
+  Q_ASSERT(rowCount(parent) == cs.childCount + cs.end - cs.start + 1);
+
+  _aboutToRemoveOrInsert = false;
+  for(int i = cs.start; i <= cs.end; i++) {
+    connectItem(parentItem->child(i));
+  }
+  endInsertRows();
+}
+
+void TreeModel::beginRemoveChilds(int firstRow, int lastRow) {
+  AbstractTreeItem *parentItem = qobject_cast<AbstractTreeItem *>(sender());
+  if(!parentItem) {
+    qWarning() << "TreeModel::beginRemoveChilds(): cannot append Childs to unknown parent";
+    return;
+  }
+  QModelIndex parent = indexByItem(parentItem);
+  Q_ASSERT(firstRow <= lastRow);
+  Q_ASSERT(parentItem->childCount() > lastRow);
+  Q_ASSERT(!_aboutToRemoveOrInsert);
   
-  beginRemoveRows(parent, row, row + count - 1);
+  _aboutToRemoveOrInsert = true;
+  _childStatus = ChildStatus(parent, rowCount(parent), firstRow, lastRow);
+  beginRemoveRows(parent, firstRow, lastRow);
+}
 
-  for(int i = row + count - 1; i >= 0; i--) {
-    item->removeChild(i);
+void TreeModel::endRemoveChilds() {
+  AbstractTreeItem *parentItem = qobject_cast<AbstractTreeItem *>(sender());
+  if(!parentItem) {
+    qWarning() << "TreeModel::endRemoveChilds(): cannot append Childs to unknown parent";
+    return;
   }
+  Q_ASSERT(_aboutToRemoveOrInsert);
+  ChildStatus cs = _childStatus;
+  QModelIndex parent = indexByItem(parentItem);
+  Q_ASSERT(cs.parent == parent);
+  Q_ASSERT(rowCount(parent) == cs.childCount - cs.end + cs.start - 1);
+  
+  _aboutToRemoveOrInsert = false;
   endRemoveRows();
-  return true;
 }
 
 void TreeModel::clear() {
-  removeRows(0, rowCount());
-  reset();
+  rootItem->removeAllChilds();
+}
+
+void TreeModel::debug_rowsAboutToBeInserted(const QModelIndex &parent, int start, int end) {
+  // qDebug() << "debug_rowsAboutToBeInserted" << parent << parent.internalPointer() << parent.data().toString() << rowCount(parent) << start << end;
+}
+
+void TreeModel::debug_rowsAboutToBeRemoved(const QModelIndex &parent, int start, int end) {
+  AbstractTreeItem *parentItem;
+  parentItem = static_cast<AbstractTreeItem *>(parent.internalPointer());
+  if(!parentItem)
+    parentItem = rootItem;
+  qDebug() << "#" << parent << parentItem << parent.data().toString() << rowCount(parent) << start << end;
+
+  QModelIndex child;
+  AbstractTreeItem *childItem;
+  for(int i = end; i >= start; i--) {
+    child = parent.child(i, 0);
+    childItem = parentItem->child(i);
+    Q_ASSERT(childItem);
+    qDebug() << ">>>" << i << child << childItem->id() << child.data().toString();
+  }
+}
+
+void TreeModel::debug_rowsInserted(const QModelIndex &parent, int start, int end) {
+  AbstractTreeItem *parentItem;
+  parentItem = static_cast<AbstractTreeItem *>(parent.internalPointer());
+  if(!parentItem)
+    parentItem = rootItem;
+  qDebug() << "#" << parent << parentItem << parent.data().toString() << rowCount(parent) << start << end;
+
+  QModelIndex child;
+  AbstractTreeItem *childItem;
+  for(int i = start; i <= end; i++) {
+    child = parent.child(i, 0);
+    childItem = parentItem->child(i);
+    Q_ASSERT(childItem);
+    qDebug() << "<<<" << i << child << childItem->id() << child.data().toString();
+  }
+}
+
+void TreeModel::debug_rowsRemoved(const QModelIndex &parent, int start, int end) {
+  // qDebug() << "debug_rowsRemoved" << parent << parent.internalPointer() << parent.data().toString() << rowCount(parent) << start << end;
 }