src/client/treemodel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #include "treemodel.h"
  22
  23 #include <QDebug>
  24
  25 /*****************************************
  26  *  Abstract Items of a TreeModel
  27  *****************************************/
  28 AbstractTreeItem::AbstractTreeItem(AbstractTreeItem *parent)
  29   : QObject(parent),
  30     _flags(Qt::ItemIsSelectable | Qt::ItemIsEnabled)
  31 {
  32 }
  33
  34 AbstractTreeItem::~AbstractTreeItem() {
  35   removeAllChilds();
  36 }
  37
  38 quint64 AbstractTreeItem::id() const {
  39   return (quint64)this;
  40 }
  41
  42 int AbstractTreeItem::defaultColumn() const {
  43   // invalid QModelIndexes aka rootNodes get their Childs stuffed into column -1
  44   // all others to 0
  45   if(parent() == 0)
  46     return -1;
  47   else
  48     return 0;
  49 }
  50
  51 void AbstractTreeItem::appendChild(int column, AbstractTreeItem *item) {
  52   if(!_childItems.contains(column)) {
  53     _childItems[column] = QList<AbstractTreeItem *>();
  54     _childHash[column] = QHash<quint64, AbstractTreeItem *>();
  55   }
  56
  57   _childItems[column].append(item);
  58   _childHash[column][item->id()] = item;
  59
  60   connect(item, SIGNAL(destroyed()), this, SLOT(childDestroyed()));
  61 }
  62
  63 void AbstractTreeItem::appendChild(AbstractTreeItem *child) {
  64   appendChild(defaultColumn(), child);
  65 }
  66
  67 void AbstractTreeItem::removeChild(int column, int row) {
  68   if(!_childItems.contains(column)
  69      || _childItems[column].size() <= row)
  70     return;
  71
  72   if(column == defaultColumn())
  73     emit beginRemoveChilds(row, row);
  74
  75   AbstractTreeItem *treeitem = _childItems[column].value(row);
  76   _childItems[column].removeAt(row);
  77   _childHash[column].remove(_childHash[column].key(treeitem));
  78   disconnect(treeitem, 0, this, 0);
  79   treeitem->deleteLater();
  80
  81   if(column == defaultColumn())
  82     emit endRemoveChilds();
  83 }
  84
  85 void AbstractTreeItem::removeChild(int row) {
  86   removeChild(defaultColumn(), row);
  87 }
  88
  89 void AbstractTreeItem::removeAllChilds() {
  90   if(childCount() == 0)
  91     return;
  92
  93   emit beginRemoveChilds(0, childCount() - 1);
  94
  95   AbstractTreeItem *child;
  96   foreach(int key, _childItems.keys()) {
  97     QList<AbstractTreeItem *>::iterator iter = _childItems[key].begin();
  98     while(iter != _childItems[key].end()) {
  99       child = *iter;
 100       iter = _childItems[key].erase(iter);
 101       disconnect(child, 0, this, 0);
 102       child->removeAllChilds();
 103       child->deleteLater();
 104     }
 105   }
 106   emit endRemoveChilds();
 107 }
 108
 109 AbstractTreeItem *AbstractTreeItem::child(int column, int row) const {
 110   if(!_childItems.contains(column)
 111      || _childItems[column].size() <= row)
 112     return 0;
 113   else
 114     return _childItems[column].value(row);
 115 }
 116
 117 AbstractTreeItem *AbstractTreeItem::child(int row) const {
 118   return child(defaultColumn(), row);
 119 }
 120
 121 AbstractTreeItem *AbstractTreeItem::childById(int column, const quint64 &id) const {
 122   if(!_childHash.contains(column)
 123      || !_childHash[column].contains(id))
 124     return 0;
 125   else
 126     return _childHash[column].value(id);
 127 }
 128
 129 AbstractTreeItem *AbstractTreeItem::childById(const quint64 &id) const {
 130   return childById(defaultColumn(), id);
 131 }
 132
 133 int AbstractTreeItem::childCount(int column) const {
 134   if(!_childItems.contains(column))
 135     return 0;
 136   else
 137     return _childItems[column].count();
 138 }
 139
 140 int AbstractTreeItem::childCount() const {
 141   return childCount(defaultColumn());
 142 }
 143
 144 int AbstractTreeItem::column() const {
 145   if(!parent())
 146     return -1;
 147
 148   QHash<int, QList<AbstractTreeItem*> >::const_iterator iter = parent()->_childItems.constBegin();
 149   while(iter != parent()->_childItems.constEnd()) {
 150     if(iter.value().contains(const_cast<AbstractTreeItem *>(this)))
 151       return iter.key();
 152     iter++;
 153   }
 154
 155   // unable to find us o_O
 156   return parent()->defaultColumn();
 157 }
 158
 159 int AbstractTreeItem::row() const {
 160   if(!parent())
 161     return -1;
 162   else
 163     return parent()->_childItems[column()].indexOf(const_cast<AbstractTreeItem*>(this));
 164 }
 165
 166 AbstractTreeItem *AbstractTreeItem::parent() const {
 167   return qobject_cast<AbstractTreeItem *>(QObject::parent());
 168 }
 169
 170 Qt::ItemFlags AbstractTreeItem::flags() const {
 171   return _flags;
 172 }
 173
 174 void AbstractTreeItem::setFlags(Qt::ItemFlags flags) {
 175   _flags = flags;
 176 }
 177
 178 void AbstractTreeItem::childDestroyed() {
 179   AbstractTreeItem *item = static_cast<AbstractTreeItem*>(sender());
 180
 181   if(!item) {
 182     qWarning() << "AbstractTreeItem::childDestroyed() received null pointer!";
 183     return;
 184   }
 185
 186   QHash<int, QList<AbstractTreeItem*> >::const_iterator iter = _childItems.constBegin();
 187   int column, row = -1;
 188   while(iter != _childItems.constEnd()) {
 189     row = iter.value().indexOf(item);
 190     if(row != -1) {
 191       column = iter.key();
 192       break;
 193     }
 194     iter++;
 195   }
 196
 197   if(row == -1) {
 198     qWarning() << "AbstractTreeItem::childDestroyed(): unknown Child died:" << item << "parent:" << this;
 199     return;
 200   }
 201
 202   _childItems[column].removeAt(row);
 203   _childHash[column].remove(_childHash[column].key(item));
 204   emit beginRemoveChilds(row, row);
 205   emit endRemoveChilds();
 206 }
 207
 208 /*****************************************
 209  * SimpleTreeItem
 210  *****************************************/
 211 SimpleTreeItem::SimpleTreeItem(const QList<QVariant> &data, AbstractTreeItem *parent)
 212   : AbstractTreeItem(parent),
 213     _itemData(data)
 214 {
 215 }
 216
 217 SimpleTreeItem::~SimpleTreeItem() {
 218 }
 219
 220 QVariant SimpleTreeItem::data(int column, int role) const {
 221   if(role == Qt::DisplayRole && column < _itemData.count())
 222     return _itemData[column];
 223   else
 224     return QVariant();
 225 }
 226
 227 int SimpleTreeItem::columnCount() const {
 228   return _itemData.count();
 229 }
 230
 231 /*****************************************
 232  * PropertyMapItem
 233  *****************************************/
 234 PropertyMapItem::PropertyMapItem(const QStringList &propertyOrder, AbstractTreeItem *parent)
 235   : AbstractTreeItem(parent),
 236     _propertyOrder(propertyOrder)
 237 {
 238 }
 239
 240 PropertyMapItem::PropertyMapItem(AbstractTreeItem *parent)
 241   : AbstractTreeItem(parent),
 242     _propertyOrder(QStringList())
 243 {
 244 }
 245
 246
 247 PropertyMapItem::~PropertyMapItem() {
 248 }
 249
 250 QVariant PropertyMapItem::data(int column, int role) const {
 251   if(column >= columnCount())
 252     return QVariant();
 253
 254   if(role != Qt::DisplayRole)
 255     return QVariant();
 256
 257   return property(_propertyOrder[column].toAscii());
 258 }
 259
 260 int PropertyMapItem::columnCount() const {
 261   return _propertyOrder.count();
 262 }
 263
 264 void PropertyMapItem::appendProperty(const QString &property) {
 265   _propertyOrder << property;
 266 }
 267
 268
 269
 270 /*****************************************
 271  * TreeModel
 272  *****************************************/
 273 TreeModel::TreeModel(const QList<QVariant> &data, QObject *parent)
 274   : QAbstractItemModel(parent)
 275 {
 276   rootItem = new SimpleTreeItem(data, 0);
 277 }
 278
 279 TreeModel::~TreeModel() {
 280   delete rootItem;
 281 }
 282
 283 QModelIndex TreeModel::index(int row, int column, const QModelIndex &parent) const {
 284   if(!hasIndex(row, column, parent))
 285     return QModelIndex();
 286
 287   AbstractTreeItem *parentItem;
 288
 289   if(!parent.isValid())
 290     parentItem = rootItem;
 291   else
 292     parentItem = static_cast<AbstractTreeItem*>(parent.internalPointer());
 293
 294   AbstractTreeItem *childItem = parentItem->child(parent.column(), row);
 295
 296   if(childItem)
 297     return createIndex(row, column, childItem);
 298   else
 299     return QModelIndex();
 300 }
 301
 302 QModelIndex TreeModel::indexById(quint64 id, const QModelIndex &parent) const {
 303   AbstractTreeItem *parentItem;
 304
 305   if(!parent.isValid())
 306     parentItem = rootItem;
 307   else
 308     parentItem = static_cast<AbstractTreeItem *>(parent.internalPointer());
 309
 310   AbstractTreeItem *childItem = parentItem->childById(parent.column(), id);
 311
 312   if(childItem)
 313     return createIndex(childItem->row(), 0, childItem);
 314   else
 315     return QModelIndex();
 316 }
 317
 318 QModelIndex TreeModel::indexByItem(AbstractTreeItem *item) const {
 319   if(item == 0) {
 320     qWarning() << "TreeModel::indexByItem(AbstractTreeItem *item) received NULL-Pointer";
 321     return QModelIndex();
 322   }
 323
 324   if(item == rootItem)
 325     return QModelIndex();
 326   else
 327     return createIndex(item->row(), 0, item);
 328
 329 }
 330
 331 QModelIndex TreeModel::parent(const QModelIndex &index) const {
 332   if(!index.isValid())
 333     return QModelIndex();
 334
 335   AbstractTreeItem *childItem = static_cast<AbstractTreeItem *>(index.internalPointer());
 336   AbstractTreeItem *parentItem = static_cast<AbstractTreeItem *>(childItem->parent());
 337
 338   if(parentItem == rootItem)
 339     return QModelIndex();
 340
 341   return createIndex(parentItem->row(), 0, parentItem);
 342 }
 343
 344 int TreeModel::rowCount(const QModelIndex &parent) const {
 345   AbstractTreeItem *parentItem;
 346   if(!parent.isValid())
 347     parentItem = rootItem;
 348   else
 349     parentItem = static_cast<AbstractTreeItem*>(parent.internalPointer());
 350
 351   return parentItem->childCount(parent.column());
 352 }
 353
 354 int TreeModel::columnCount(const QModelIndex &parent) const {
 355   Q_UNUSED(parent)
 356   // since there the Qt Views don't draw more columns than the header has columns
 357   // we can be lazy and simply return the count of header columns
 358   // actually this gives us more freedom cause we don't have to ensure that a rows parent
 359   // has equal or more columns than that row
 360
 361 //   if(parent.isValid()) {
 362 //     AbstractTreeItem *child;
 363 //     if(child = static_cast<AbstractTreeItem *>(parent.internalPointer())->child(parent.column(), parent.row()))
 364 //       return child->columnCount();
 365 //     else
 366 //       return static_cast<AbstractTreeItem*>(parent.internalPointer())->columnCount();
 367 //   } else {
 368 //     return rootItem->columnCount();
 369 //   }
 370
 371   return rootItem->columnCount();
 372 }
 373
 374 QVariant TreeModel::data(const QModelIndex &index, int role) const {
 375   if(!index.isValid())
 376     return QVariant();
 377
 378   AbstractTreeItem *item = static_cast<AbstractTreeItem*>(index.internalPointer());
 379   return item->data(index.column(), role);
 380 }
 381
 382 Qt::ItemFlags TreeModel::flags(const QModelIndex &index) const {
 383   AbstractTreeItem *item;
 384   if(!index.isValid())
 385     item = rootItem;
 386   else
 387     item = static_cast<AbstractTreeItem *>(index.internalPointer());
 388   return item->flags();
 389 }
 390
 391 QVariant TreeModel::headerData(int section, Qt::Orientation orientation, int role) const {
 392   if (orientation == Qt::Horizontal && role == Qt::DisplayRole)
 393     return rootItem->data(section, role);
 394   else
 395     return QVariant();
 396 }
 397
 398 void TreeModel::itemDataChanged(int column) {
 399   AbstractTreeItem *item = qobject_cast<AbstractTreeItem *>(sender());
 400   QModelIndex leftIndex, rightIndex;
 401
 402   if(item == rootItem)
 403     return;
 404
 405   if(column == -1) {
 406     leftIndex = createIndex(item->row(), 0, item);
 407     rightIndex = createIndex(item->row(), item->columnCount()-1, item);
 408   } else {
 409     leftIndex = createIndex(item->row(), column, item);
 410     rightIndex = leftIndex;
 411   }
 412
 413   emit dataChanged(leftIndex, rightIndex);
 414 }
 415
 416 void TreeModel::appendChild(AbstractTreeItem *parent, AbstractTreeItem *child) {
 417   if(parent == 0 or child == 0) {
 418     qWarning() << "TreeModel::appendChild(parent, child) parent and child have to be valid pointers!" << parent << child;
 419     return;
 420   }
 421
 422   int nextRow = parent->childCount();
 423   beginInsertRows(indexByItem(parent), nextRow, nextRow);
 424   parent->appendChild(child);
 425   endInsertRows();
 426
 427   connect(child, SIGNAL(dataChanged(int)),
 428           this, SLOT(itemDataChanged(int)));
 429
 430   connect(child, SIGNAL(newChild(AbstractTreeItem *)),
 431           this, SLOT(newChild(AbstractTreeItem *)));
 432
 433 //   connect(child, SIGNAL(childRemoved(int)),
 434 //        this, SLOT(childRemoved(int)));
 435
 436   connect(child, SIGNAL(beginRemoveChilds(int, int)),
 437           this, SLOT(beginRemoveChilds(int, int)));
 438
 439   connect(child, SIGNAL(endRemoveChilds()),
 440           this, SLOT(endRemoveChilds()));
 441 }
 442
 443 void TreeModel::newChild(AbstractTreeItem *child) {
 444   appendChild(static_cast<AbstractTreeItem *>(sender()), child);
 445 }
 446
 447 void TreeModel::beginRemoveChilds(int firstRow, int lastRow) {
 448   QModelIndex parent = indexByItem(static_cast<AbstractTreeItem *>(sender()));
 449   beginRemoveRows(parent, firstRow, lastRow);
 450 }
 451
 452 void TreeModel::endRemoveChilds() {
 453   endRemoveRows();
 454 }
 455
 456 void TreeModel::childRemoved(int row) {
 457   QModelIndex parent = indexByItem(static_cast<AbstractTreeItem *>(sender()));
 458   beginRemoveRows(parent, row, row);
 459   endRemoveRows();
 460 }
 461
 462 void TreeModel::childsRemoved(int firstRow, int lastRow) {
 463   QModelIndex parent = indexByItem(static_cast<AbstractTreeItem *>(sender()));
 464   beginRemoveRows(parent, firstRow, lastRow);
 465   endRemoveRows();
 466
 467 }
 468
 469 bool TreeModel::removeRow(int row, const QModelIndex &parent) {
 470   if(row > rowCount(parent))
 471     return false;
 472
 473   AbstractTreeItem *item;
 474   if(!parent.isValid())
 475     item = rootItem;
 476   else
 477     item = static_cast<AbstractTreeItem*>(parent.internalPointer());
 478
 479   beginRemoveRows(parent, row, row);
 480   item->removeChild(parent.column(), row);
 481   endRemoveRows();
 482   return true;
 483 }
 484
 485 bool TreeModel::removeRows(int row, int count, const QModelIndex &parent) {
 486   // check if there is work to be done
 487   if(count == 0)
 488     return true;
 489
 490   // out of range check
 491   if(row + count - 1 > rowCount(parent) || row < 0 || count < 0)
 492     return false;
 493
 494   AbstractTreeItem *item;
 495   if(!parent.isValid())
 496     item = rootItem;
 497   else
 498     item = static_cast<AbstractTreeItem *>(parent.internalPointer());
 499
 500
 501   beginRemoveRows(parent, row, row + count - 1);
 502
 503   for(int i = row + count - 1; i >= 0; i--) {
 504     item->removeChild(parent.column(), i);
 505   }
 506   endRemoveRows();
 507   return true;
 508 }
 509
 510 void TreeModel::clear() {
 511   removeRows(0, rowCount());
 512   reset();
 513 }