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