src/client/messagemodel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2011 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 <QAbstractListModel>
  25 #include <QDateTime>
  26
  27 #include "message.h"
  28 #include "types.h"
  29
  30 class MessageModelItem;
  31 struct MsgId;
  32
  33 class MessageModel : public QAbstractListModel {
  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 int rowCount(const QModelIndex &parent = QModelIndex()) const { return parent.isValid() ? 0 : messageCount(); }
  60   inline int columnCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return 3; }
  61
  62   virtual QVariant data(const QModelIndex &index, int role) const;
  63   virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
  64
  65   //virtual Qt::ItemFlags flags(const QModelIndex &index) const;
  66
  67   bool insertMessage(const Message &, bool fakeMsg = false);
  68   void insertMessages(const QList<Message> &);
  69
  70   void clear();
  71
  72 signals:
  73   void finishedBacklogFetch(BufferId bufferId);
  74
  75 public slots:
  76   void requestBacklog(BufferId bufferId);
  77   void messagesReceived(BufferId bufferId, int count);
  78   void buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2);
  79   void insertErrorMessage(BufferInfo bufferInfo, const QString &errorString);
  80
  81 protected:
  82 //   virtual MessageModelItem *createMessageModelItem(const Message &) = 0;
  83
  84   virtual int messageCount() const = 0;
  85   virtual bool messagesIsEmpty() const = 0;
  86   virtual const MessageModelItem *messageItemAt(int i) const = 0;
  87   virtual MessageModelItem *messageItemAt(int i) = 0;
  88   virtual const MessageModelItem *firstMessageItem() const= 0;
  89   virtual MessageModelItem *firstMessageItem() = 0;
  90   virtual const MessageModelItem *lastMessageItem() const= 0;
  91   virtual MessageModelItem *lastMessageItem() = 0;
  92   virtual void insertMessage__(int pos, const Message &) = 0;
  93   virtual void insertMessages__(int pos, const QList<Message> &) = 0;
  94   virtual void removeMessageAt(int i) = 0;
  95   virtual void removeAllMessages() = 0;
  96   virtual Message takeMessageAt(int i) = 0;
  97
  98   virtual void customEvent(QEvent *event);
  99
 100 private slots:
 101   void changeOfDay();
 102
 103 private:
 104   void insertMessageGroup(const QList<Message> &);
 105   int insertMessagesGracefully(const QList<Message> &); // inserts as many contiguous msgs as possible. returns numer of inserted msgs.
 106   int indexForId(MsgId);
 107
 108   //  QList<MessageModelItem *> _messageList;
 109   QList<Message> _messageBuffer;
 110   QTimer _dayChangeTimer;
 111   QDateTime _nextDayChange;
 112   QHash<BufferId, int> _messagesWaiting;
 113 };
 114
 115 // **************************************************
 116 //  MessageModelItem
 117 // **************************************************
 118 class MessageModelItem {
 119 public:
 120   //! Creates a MessageModelItem from a Message object.
 121   /** This baseclass implementation takes care of all Message data *except* the stylable strings.
 122    *  Subclasses need to provide Qt::DisplayRole at least, which should describe the plaintext
 123    *  strings without formattings (e.g. for searching purposes).
 124    */
 125   MessageModelItem() {}
 126   inline virtual ~MessageModelItem() {}
 127
 128   virtual QVariant data(int column, int role) const;
 129   virtual bool setData(int column, const QVariant &value, int role);
 130
 131   virtual const Message &message() const = 0;
 132   virtual const QDateTime &timestamp() const = 0;
 133   virtual const MsgId &msgId() const = 0;
 134   virtual const BufferId &bufferId() const = 0;
 135   virtual void setBufferId(BufferId bufferId) = 0;
 136   virtual Message::Type msgType() const = 0;
 137   virtual Message::Flags msgFlags() const = 0;
 138
 139   // For sorting
 140   bool operator<(const MessageModelItem &) const;
 141   bool operator==(const MessageModelItem &) const;
 142   bool operator>(const MessageModelItem &) const;
 143   static bool lessThan(const MessageModelItem *m1, const MessageModelItem *m2);
 144
 145 private:
 146   BufferId _redirectedTo;
 147 };
 148
 149 QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem);
 150
 151 #endif