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