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