Rework of the TreeModel. This should finaliy *knock on wood* inconsitency issues.
[quassel.git] / src / client / treemodel.cpp
index 3ae2bc3..dd06446 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  *
  *****************************************/
 AbstractTreeItem::AbstractTreeItem(AbstractTreeItem *parent)
   : QObject(parent),
-    _parentItem(parent),
     _flags(Qt::ItemIsSelectable | Qt::ItemIsEnabled)
 {
 }
 
 AbstractTreeItem::~AbstractTreeItem() {
-  foreach(int key, _childItems.keys()) {
-    qDeleteAll(_childItems[key]);
-  }
 }
 
 quint64 AbstractTreeItem::id() const {
@@ -45,46 +41,87 @@ quint64 AbstractTreeItem::id() const {
 int AbstractTreeItem::defaultColumn() const {
   // invalid QModelIndexes aka rootNodes get their Childs stuffed into column -1
   // all others to 0
-  if(_parentItem == 0)
+  if(parent() == 0)
     return -1;
   else
     return 0;
 }
 
-void AbstractTreeItem::appendChild(int column, AbstractTreeItem *item) {
+bool AbstractTreeItem::newChild(int column, AbstractTreeItem *item) {
+  if(column >= columnCount()) {
+    qWarning() << "AbstractTreeItem::newChild() cannot append Child to not existing column!" << this << column;
+    return false;
+  }
+  
   if(!_childItems.contains(column)) {
     _childItems[column] = QList<AbstractTreeItem *>();
-    _childHash[column] = QHash<quint64, AbstractTreeItem *>();
   }
-  
-  _childItems[column].append(item);
-  _childHash[column][item->id()] = item;
 
-  connect(item, SIGNAL(destroyed()), this, SLOT(childDestroyed()));
+  int newRow = _childItems[column].count();
+  emit beginAppendChilds(column, newRow, newRow);
+  _childItems[column].append(item);
+  emit endAppendChilds();
+  
+  return true;
 }
 
-void AbstractTreeItem::appendChild(AbstractTreeItem *child) {
-  appendChild(defaultColumn(), child);
+bool AbstractTreeItem::newChild(AbstractTreeItem *item) {
+  return newChild(defaultColumn(), item);
 }
 
-void AbstractTreeItem::removeChild(int column, int row) {
-  if(!_childItems.contains(column)
-     || _childItems[column].size() <= row)
-    return;
-  
-  AbstractTreeItem *treeitem = _childItems[column].value(row);
-  _childItems[column].removeAt(row);
-  _childHash[column].remove(_childHash[column].key(treeitem));
+bool AbstractTreeItem::removeChild(int column, int row) {
+  if(!_childItems.contains(column) || row >= childCount(column))
+    return false;
+
+  emit beginRemoveChilds(column, row, row);
+  AbstractTreeItem *treeitem = _childItems[column].takeAt(row);
   treeitem->deleteLater();
+  emit endRemoveChilds();
+
+  return true;
 }
 
-void AbstractTreeItem::removeChild(int row) {
-  removeChild(defaultColumn(), row);
+bool AbstractTreeItem::removeChild(int row) {
+  return removeChild(defaultColumn(), row);
+}
+
+bool AbstractTreeItem::removeChildById(int column, const quint64 &id) {
+  if(!_childItems.contains(column))
+    return false;
+
+  for(int i = 0; i < _childItems[column].count(); i++) {
+    if(_childItems[column][i]->id() == id)
+      return removeChild(column, i);
+  }
+  return false;
+}
+
+bool AbstractTreeItem::removeChildById(const quint64 &id) {
+  return removeChildById(defaultColumn(), id);
+}
+
+void AbstractTreeItem::removeAllChilds() {
+  AbstractTreeItem *child;
+
+  QHash<int, QList<AbstractTreeItem *> >::iterator columnIter = _childItems.begin();
+  while(columnIter != _childItems.end()) {
+    if(columnIter->count() > 0) {
+      emit beginRemoveChilds(columnIter.key(), 0, columnIter->count() - 1);
+      QList<AbstractTreeItem *>::iterator childIter = columnIter->begin();
+      while(childIter != columnIter->end()) {
+       child = *childIter;
+       // child->removeAllChilds();
+       childIter = columnIter->erase(childIter);
+       child->deleteLater();
+      }
+      emit endRemoveChilds();
+    }
+    columnIter++;
+  }
 }
 
 AbstractTreeItem *AbstractTreeItem::child(int column, int row) const {
-  if(!_childItems.contains(column)
-     || _childItems[column].size() <= row)
+  if(!_childItems.contains(column) || _childItems[column].size() <= row)
     return 0;
   else
     return _childItems[column].value(row);
@@ -94,15 +131,18 @@ AbstractTreeItem *AbstractTreeItem::child(int row) const {
   return child(defaultColumn(), row);
 }
 
-AbstractTreeItem *AbstractTreeItem::childById(int column, const uint &id) const {
-  if(!_childHash.contains(column)
-     || !_childHash[column].contains(id))
+AbstractTreeItem *AbstractTreeItem::childById(int column, const quint64 &id) const {
+  if(!_childItems.contains(column))
     return 0;
-  else
-    return _childHash[column].value(id);
+
+  for(int i = 0; i < _childItems[column].count(); i++) {
+    if(_childItems[column][i]->id() == id)
+      return _childItems[column][i];
+  }
+  return 0;
 }
 
-AbstractTreeItem *AbstractTreeItem::childById(const uint &id) const {
+AbstractTreeItem *AbstractTreeItem::childById(const quint64 &id) const {
   return childById(defaultColumn(), id);
 }
 
@@ -118,31 +158,29 @@ int AbstractTreeItem::childCount() const {
 }
 
 int AbstractTreeItem::column() const {
-  if(!_parentItem)
+  if(!parent())
     return -1;
 
-  QHash<int, QList<AbstractTreeItem*> >::const_iterator iter = _parentItem->_childItems.constBegin();
-  int pos;
-  while(iter != _parentItem->_childItems.constEnd()) {
-    pos = iter.value().indexOf(const_cast<AbstractTreeItem *>(this));
-    if(pos != -1)
+  QHash<int, QList<AbstractTreeItem*> >::const_iterator iter = parent()->_childItems.constBegin();
+  while(iter != parent()->_childItems.constEnd()) {
+    if(iter->contains(const_cast<AbstractTreeItem *>(this)))
       return iter.key();
     iter++;
   }
 
-  // unable to find us o_O
-  return _parentItem->defaultColumn();
+  qWarning() << "AbstractTreeItem::column(): unable to determine the Column of" << this;
+  return parent()->defaultColumn();
 }
 
 int AbstractTreeItem::row() const {
-  if(!_parentItem)
+  if(!parent())
     return -1;
   else
-    return _parentItem->_childItems[column()].indexOf(const_cast<AbstractTreeItem*>(this));
+    return parent()->_childItems[column()].indexOf(const_cast<AbstractTreeItem *>(this));
 }
 
-AbstractTreeItem *AbstractTreeItem::parent() {
-  return _parentItem;
+AbstractTreeItem *AbstractTreeItem::parent() const {
+  return qobject_cast<AbstractTreeItem *>(QObject::parent());
 }
 
 Qt::ItemFlags AbstractTreeItem::flags() const {
@@ -153,11 +191,6 @@ void AbstractTreeItem::setFlags(Qt::ItemFlags flags) {
   _flags = flags;
 }
 
-void AbstractTreeItem::childDestroyed() {
-  AbstractTreeItem *item = static_cast<AbstractTreeItem*>(sender());
-  removeChild(item->column(), item->row());
-}
-  
 /*****************************************
  * SimpleTreeItem
  *****************************************/
@@ -171,10 +204,23 @@ SimpleTreeItem::~SimpleTreeItem() {
 }
 
 QVariant SimpleTreeItem::data(int column, int role) const {
-  if(role == Qt::DisplayRole && column < _itemData.count())
+  if(column >= columnCount() || role != Qt::DisplayRole)
+    return QVariant();
+  else
     return _itemData[column];
+}
+
+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
-    return QVariant();
+    _itemData[column] = value;
+
+  emit dataChanged(column);
+  return true;
 }
 
 int SimpleTreeItem::columnCount() const {
@@ -201,15 +247,20 @@ PropertyMapItem::~PropertyMapItem() {
 }
   
 QVariant PropertyMapItem::data(int column, int role) const {
-  if(column >= columnCount())
-    return QVariant();
-
-  if(role != Qt::DisplayRole)
+  if(column >= columnCount() || role != Qt::DisplayRole)
     return QVariant();
 
   return property(_propertyOrder[column].toAscii());
 }
 
+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();
 }
@@ -224,9 +275,12 @@ void PropertyMapItem::appendProperty(const QString &property) {
  * TreeModel
  *****************************************/
 TreeModel::TreeModel(const QList<QVariant> &data, QObject *parent)
-  : QAbstractItemModel(parent)
+  : QAbstractItemModel(parent),
+    _childStatus(QModelIndex(), 0, 0, 0),
+    _aboutToRemoveOrInsert(false)
 {
   rootItem = new SimpleTreeItem(data, 0);
+  connectItem(rootItem);
 }
 
 TreeModel::~TreeModel() {
@@ -252,7 +306,7 @@ QModelIndex TreeModel::index(int row, int column, const QModelIndex &parent) con
     return QModelIndex();
 }
 
-QModelIndex TreeModel::indexById(uint id, const QModelIndex &parent) const {
+QModelIndex TreeModel::indexById(quint64 id, const QModelIndex &parent) const {
   AbstractTreeItem *parentItem; 
   
   if(!parent.isValid())
@@ -268,7 +322,7 @@ QModelIndex TreeModel::indexById(uint id, const QModelIndex &parent) const {
     return QModelIndex();
 }
 
-QModelIndex TreeModel::indexByItem(AbstractTreeItem *item) const {
+QModelIndex TreeModel::indexByItem(AbstractTreeItem *item, int column) const {
   if(item == 0) {
     qWarning() << "TreeModel::indexByItem(AbstractTreeItem *item) received NULL-Pointer";
     return QModelIndex();
@@ -277,7 +331,7 @@ QModelIndex TreeModel::indexByItem(AbstractTreeItem *item) const {
   if(item == rootItem)
     return QModelIndex();
   else
-    return createIndex(item->row(), 0, item);
+    return createIndex(item->row(), column, item);
 
 }
 
@@ -291,7 +345,7 @@ QModelIndex TreeModel::parent(const QModelIndex &index) const {
   if(parentItem == rootItem)
     return QModelIndex();
   
-  return createIndex(parentItem->row(), 0, parentItem);
+  return createIndex(parentItem->row(), childItem->column(), parentItem);
 }
 
 int TreeModel::rowCount(const QModelIndex &parent) const {
@@ -305,20 +359,41 @@ int TreeModel::rowCount(const QModelIndex &parent) const {
 }
 
 int TreeModel::columnCount(const QModelIndex &parent) const {
-  if(parent.isValid())
-    return static_cast<AbstractTreeItem*>(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();
 
-  AbstractTreeItem *item = static_cast<AbstractTreeItem*>(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 {
   AbstractTreeItem *item;
   if(!index.isValid())
@@ -337,74 +412,102 @@ QVariant TreeModel::headerData(int section, Qt::Orientation orientation, int rol
 
 void TreeModel::itemDataChanged(int column) {
   AbstractTreeItem *item = qobject_cast<AbstractTreeItem *>(sender());
-  QModelIndex itemIndex;
+  QModelIndex leftIndex, rightIndex;
 
-  if(item == rootItem) 
-    itemIndex = QModelIndex();
-  else
-    itemIndex = createIndex(item->row(), column, item);
-
-  emit dataChanged(itemIndex, itemIndex);
-}
-
-void TreeModel::appendChild(AbstractTreeItem *parent, AbstractTreeItem *child) {
-  if(parent == 0 or child == 0) {
-    qWarning() << "TreeModel::apendChild(parent, child) parent and child have to be valid pointers!" << parent << child;
+  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;
   }
 
-  int nextRow = parent->childCount();
-  beginInsertRows(indexByItem(parent), nextRow, nextRow);
-  parent->appendChild(child);
-  endInsertRows();
+  emit dataChanged(leftIndex, rightIndex);
+}
 
-  connect(child, SIGNAL(dataChanged(int)),
+void TreeModel::connectItem(AbstractTreeItem *item) {
+  connect(item, SIGNAL(dataChanged(int)),
          this, SLOT(itemDataChanged(int)));
+  
+  connect(item, SIGNAL(beginAppendChilds(int, int, int)),
+         this, SLOT(beginAppendChilds(int, int, int)));
+  connect(item, SIGNAL(endAppendChilds()),
+         this, SLOT(endAppendChilds()));
+  
+  connect(item, SIGNAL(beginRemoveChilds(int, int, int)),
+         this, SLOT(beginRemoveChilds(int, int, int)));
+  connect(item, SIGNAL(endRemoveChilds()),
+         this, SLOT(endRemoveChilds()));
 }
 
-
-bool TreeModel::removeRow(int row, const QModelIndex &parent) {
-  if(row > rowCount(parent))
-    return false;
-  
-  AbstractTreeItem *item;
-  if(!parent.isValid())
-    item = rootItem;
-  else
-    item = static_cast<AbstractTreeItem*>(parent.internalPointer());
+void TreeModel::beginAppendChilds(int column, int firstRow, int lastRow) {
+  AbstractTreeItem *parentItem = qobject_cast<AbstractTreeItem *>(sender());
+  if(!parentItem) {
+    qWarning() << "TreeModel::beginAppendChilds(): cannot append Childs to unknown parent";
+    return;
+  }
+  QModelIndex parent = indexByItem(parentItem, column);
+  Q_ASSERT(!_aboutToRemoveOrInsert);
   
-  beginRemoveRows(parent, row, row);
-  item->removeChild(parent.column(), row);
-  endRemoveRows();
-  return true;
+  _aboutToRemoveOrInsert = true;
+  _childStatus = ChildStatus(parent, rowCount(parent), firstRow, lastRow);
+  beginInsertRows(parent, firstRow, lastRow);
 }
 
-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::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, cs.parent.column());
+  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(parent.column(), i));
+  }
+  endInsertRows();
+}
 
-  // out of range check
-  if(row + count - 1 > rowCount(parent) || row < 0 || count < 0) 
-    return false;
-  
-  AbstractTreeItem *item;
-  if(!parent.isValid())
-    item = rootItem;
-  else
-    item = static_cast<AbstractTreeItem *>(parent.internalPointer());
-  
+void TreeModel::beginRemoveChilds(int column, 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, column);
+  Q_ASSERT(firstRow <= lastRow);
+  Q_ASSERT(parentItem->childCount(column) > 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(parent.column(), 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, cs.parent.column());
+  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();
 }