src/client/messagemodel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
   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 "messagemodel.h"
  22
  23 #include "message.h"
  24
  25 MessageModel::MessageModel(QObject *parent)
  26   : QAbstractItemModel(parent)
  27 {
  28 }
  29
  30 QVariant MessageModel::data(const QModelIndex &index, int role) const {
  31   int row = index.row(); int column = index.column();
  32   if(row < 0 || row >= _messageList.count() || column < 0)
  33     return QVariant();
  34
  35   if(role == ColumnTypeRole)
  36     return column;
  37
  38   return _messageList[row]->data(index.column(), role);
  39 }
  40
  41 bool MessageModel::setData(const QModelIndex &index, const QVariant &value, int role) {
  42   int row = index.row();
  43   if(row < 0 || row >= _messageList.count())
  44     return false;
  45
  46   if(_messageList[row]->setData(index.column(), value, role)) {
  47     emit dataChanged(index, index);
  48     return true;
  49   }
  50
  51   return false;
  52 }
  53
  54
  55
  56 bool MessageModel::insertMessage(const Message &msg, bool fakeMsg) {
  57   MsgId id = msg.msgId();
  58   int idx = indexForId(id);
  59   if(!fakeMsg && idx < _messageList.count()) { // check for duplicate
  60     if(_messageList[idx]->msgId() == id)
  61       return false;
  62   }
  63
  64   MessageModelItem *item = createMessageModelItem(msg);
  65   beginInsertRows(QModelIndex(), idx, idx);
  66   _messageList.insert(idx, item);
  67   endInsertRows();
  68   return true;
  69 }
  70
  71
  72 void MessageModel::insertMessageGroup(const QList<Message> &msglist) {
  73   if(msglist.isEmpty()) return;
  74
  75   int idx = indexForId(msglist.first().msgId());
  76   beginInsertRows(QModelIndex(), idx, idx+msglist.count()-1);
  77
  78   foreach(Message msg, msglist) {
  79     _messageList.insert(idx, createMessageModelItem(msg));
  80     idx++;
  81   }
  82
  83   endInsertRows();
  84 }
  85
  86
  87 void MessageModel::insertMessages(const QList<Message> &msglist) {
  88   if(msglist.isEmpty())
  89     return;
  90
  91   if(_messageList.isEmpty()) {
  92     insertMessageGroup(msglist);
  93     return;
  94   }
  95
  96   bool inOrder = (msglist.first().msgId() < msglist.last().msgId());
  97
  98   // check if the whole bunch fits in at one position
  99   if(indexForId(msglist.first().msgId()) == indexForId(msglist.last().msgId())) {
 100     if(inOrder) {
 101       insertMessageGroup(msglist);
 102     } else {
 103       QList<Message> messages = msglist;
 104       qSort(messages);
 105       insertMessageGroup(messages);
 106     }
 107     return;
 108   }
 109
 110   // depending on the order we have to traverse from the front to the back or vice versa
 111   // for the sake of performance we have a little code duplication here
 112   // if you need to do some changes here you'll probably need to change them at all
 113   // places marked DUPE
 114
 115
 116   // FIXME: keep scrollbars from jumping
 117   // the somewhat bulk insert leads to a jumpy scrollbar when the user requests further backlog.
 118   // it would probably be the best to stop processing each time we actually insert a messagegroup
 119   // and give back controll to the eventloop (similar to what the QtUiMessageProcessor used to do)
 120   QList<Message> grouplist;
 121   MsgId id;
 122   bool fastForward = false;
 123   QList<Message>::const_iterator iter;
 124   if(inOrder) {
 125     iter = msglist.constEnd();
 126     iter--; // this op is safe as we've allready passed an empty check
 127   } else {
 128     iter = msglist.constBegin();
 129   }
 130
 131   // DUPE (1 / 3)
 132   int idx = indexForId((*iter).msgId());
 133   // we always compare to the previous entry...
 134   // if there isn't, we can fastforward to the top
 135   if(idx - 1 >= 0) // also safe as we've passed another empty check
 136     id = _messageList[idx - 1]->msgId();
 137   else
 138     fastForward = true;
 139   grouplist << *iter;
 140
 141   if(!inOrder)
 142     iter++;
 143
 144   if(inOrder) {
 145     while(iter != msglist.constBegin()) {
 146       iter--;
 147       // DUPE (2 / 3)
 148       if(!fastForward && (*iter).msgId() < id) {
 149         insertMessageGroup(grouplist);
 150         grouplist.clear();
 151
 152         // build new group
 153         int idx = indexForId((*iter).msgId());
 154         if(idx - 1 >= 0)
 155           id = _messageList[idx - 1]->msgId();
 156         else
 157           fastForward = true;
 158       }
 159       grouplist.prepend(*iter);
 160     }
 161   } else {
 162     while(iter != msglist.constEnd()) {
 163       // DUPE (3 / 3)
 164       if(!fastForward && (*iter).msgId() < id) {
 165         insertMessageGroup(grouplist);
 166         grouplist.clear();
 167
 168         // build new group
 169         int idx = indexForId((*iter).msgId());
 170         if(idx - 1 >= 0)
 171           id = _messageList[idx - 1]->msgId();
 172         else
 173           fastForward = true;
 174       }
 175       grouplist.prepend(*iter);
 176       iter++;
 177     }
 178   }
 179
 180   if(!grouplist.isEmpty()) {
 181     insertMessageGroup(grouplist);
 182   }
 183
 184   return;
 185 }
 186
 187
 188 void MessageModel::clear() {
 189   beginRemoveRows(QModelIndex(), 0, rowCount() - 1);
 190   qDeleteAll(_messageList);
 191   _messageList.clear();
 192   endRemoveRows();
 193 }
 194
 195
 196 // returns index of msg with given Id or of the next message after that (i.e., the index where we'd insert this msg)
 197 int MessageModel::indexForId(MsgId id) {
 198   if(_messageList.isEmpty() || id <= _messageList.value(0)->data(0, MsgIdRole).value<MsgId>()) return 0;
 199   if(id > _messageList.last()->data(0, MsgIdRole).value<MsgId>()) return _messageList.count();
 200   // binary search
 201   int start = 0; int end = _messageList.count()-1;
 202   while(1) {
 203     if(end - start == 1) return end;
 204     int pivot = (end + start) / 2;
 205     if(id <= _messageList.value(pivot)->data(0, MsgIdRole).value<MsgId>()) end = pivot;
 206     else start = pivot;
 207   }
 208 }
 209
 210 /**********************************************************************************/
 211
 212 MessageModelItem::MessageModelItem(const Message &msg) :
 213   _timestamp(msg.timestamp()),
 214   _msgId(msg.msgId()),
 215   _bufferId(msg.bufferInfo().bufferId()),
 216   _type(msg.type()),
 217   _flags(msg.flags())
 218 {
 219 }
 220
 221 QVariant MessageModelItem::data(int column, int role) const {
 222   if(column < MessageModel::TimestampColumn || column > MessageModel::ContentsColumn)
 223     return QVariant();
 224
 225   switch(role) {
 226   case MessageModel::MsgIdRole: return QVariant::fromValue<MsgId>(_msgId);
 227   case MessageModel::BufferIdRole: return QVariant::fromValue<BufferId>(_bufferId);
 228   case MessageModel::TypeRole: return _type;
 229   case MessageModel::FlagsRole: return (int)_flags;
 230   case MessageModel::TimestampRole: return _timestamp;
 231   default: return QVariant();
 232   }
 233 }
 234
 235
 236 // Stuff for later
 237 bool MessageModelItem::lessThan(const MessageModelItem *m1, const MessageModelItem *m2){
 238   return (*m1) < (*m2);
 239 }
 240
 241 bool MessageModelItem::operator<(const MessageModelItem &other) const {
 242   return _msgId < other._msgId;
 243 }
 244
 245 bool MessageModelItem::operator==(const MessageModelItem &other) const {
 246   return _msgId == other._msgId;
 247 }
 248
 249 bool MessageModelItem::operator>(const MessageModelItem &other) const {
 250   return _msgId > other._msgId;
 251 }