src/client/messagemodel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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 #ifndef MESSAGEMODEL_H_
  22 #define MESSAGEMODEL_H_
  23
  24 #include <QAbstractItemModel>
  25 #include <QDateTime>
  26
  27 #include "message.h"
  28 #include "types.h"
  29
  30 class MessageModelItem;
  31 struct MsgId;
  32
  33 class MessageModel : public QAbstractItemModel {
  34   Q_OBJECT
  35
  36 public:
  37   enum MessageModelRole {
  38     DisplayRole = Qt::DisplayRole,
  39     EditRole = Qt::EditRole,
  40     BackgroundRole = Qt::BackgroundRole,
  41     MessageRole = Qt::UserRole,
  42     MsgIdRole,
  43     BufferIdRole,
  44     TypeRole,
  45     FlagsRole,
  46     TimestampRole,
  47     FormatRole,
  48     ColumnTypeRole,
  49     RedirectedToRole,
  50     UserRole
  51   };
  52
  53   enum ColumnType {
  54     TimestampColumn, SenderColumn, ContentsColumn, UserColumnType
  55   };
  56
  57   MessageModel(QObject *parent);
  58
  59   inline QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
  60   inline QModelIndex parent(const QModelIndex &) const { return QModelIndex(); }
  61   inline int rowCount(const QModelIndex &parent = QModelIndex()) const { return parent.isValid() ? 0 : messageCount(); }
  62   inline int columnCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return 3; }
  63
  64   virtual QVariant data(const QModelIndex &index, int role) const;
  65   virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
  66
  67   //virtual Qt::ItemFlags flags(const QModelIndex &index) const;
  68
  69   bool insertMessage(const Message &, bool fakeMsg = false);
  70   void insertMessages(const QList<Message> &);
  71
  72   void clear();
  73
  74 signals:
  75   void finishedBacklogFetch(BufferId bufferId);
  76
  77 public slots:
  78   void requestBacklog(BufferId bufferId);
  79   void messagesReceived(BufferId bufferId, int count);
  80   void buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2);
  81   void insertErrorMessage(BufferInfo bufferInfo, const QString &errorString);
  82
  83 protected:
  84 //   virtual MessageModelItem *createMessageModelItem(const Message &) = 0;
  85
  86   virtual int messageCount() const = 0;
  87   virtual bool messagesIsEmpty() const = 0;
  88   virtual const MessageModelItem *messageItemAt(int i) const = 0;
  89   virtual MessageModelItem *messageItemAt(int i) = 0;
  90   virtual const MessageModelItem *firstMessageItem() const= 0;
  91   virtual MessageModelItem *firstMessageItem() = 0;
  92   virtual const MessageModelItem *lastMessageItem() const= 0;
  93   virtual MessageModelItem *lastMessageItem() = 0;
  94   virtual void insertMessage__(int pos, const Message &) = 0;
  95   virtual void insertMessages__(int pos, const QList<Message> &) = 0;
  96   virtual void removeMessageAt(int i) = 0;
  97   virtual void removeAllMessages() = 0;
  98   virtual Message takeMessageAt(int i) = 0;
  99
 100   virtual void customEvent(QEvent *event);
 101
 102 private slots:
 103   void changeOfDay();
 104
 105 private:
 106   void insertMessageGroup(const QList<Message> &);
 107   int insertMessagesGracefully(const QList<Message> &); // inserts as many contiguous msgs as possible. returns numer of inserted msgs.
 108   int indexForId(MsgId);
 109
 110   //  QList<MessageModelItem *> _messageList;
 111   QList<Message> _messageBuffer;
 112   QTimer _dayChangeTimer;
 113   QDateTime _nextDayChange;
 114   QHash<BufferId, int> _messagesWaiting;
 115 };
 116
 117 // inlines
 118 QModelIndex MessageModel::index(int row, int column, const QModelIndex &parent) const {
 119   if(row < 0 || row >= rowCount(parent) || column < 0 || column >= columnCount(parent))
 120     return QModelIndex();
 121
 122   return createIndex(row, column);
 123 }
 124
 125 // **************************************************
 126 //  MessageModelItem
 127 // **************************************************
 128 class MessageModelItem {
 129 public:
 130   //! Creates a MessageModelItem from a Message object.
 131   /** This baseclass implementation takes care of all Message data *except* the stylable strings.
 132    *  Subclasses need to provide Qt::DisplayRole at least, which should describe the plaintext
 133    *  strings without formattings (e.g. for searching purposes).
 134    */
 135   MessageModelItem() {}
 136   inline virtual ~MessageModelItem() {}
 137
 138   virtual QVariant data(int column, int role) const;
 139   virtual bool setData(int column, const QVariant &value, int role);
 140
 141   virtual const Message &message() const = 0;
 142   virtual const QDateTime &timestamp() const = 0;
 143   virtual const MsgId &msgId() const = 0;
 144   virtual const BufferId &bufferId() const = 0;
 145   virtual void setBufferId(BufferId bufferId) = 0;
 146   virtual Message::Type msgType() const = 0;
 147   virtual Message::Flags msgFlags() const = 0;
 148
 149   // For sorting
 150   bool operator<(const MessageModelItem &) const;
 151   bool operator==(const MessageModelItem &) const;
 152   bool operator>(const MessageModelItem &) const;
 153   static bool lessThan(const MessageModelItem *m1, const MessageModelItem *m2);
 154
 155 private:
 156   BufferId _redirectedTo;
 157 };
 158
 159 QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem);
 160
 161 #endif