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