/***************************************************************************
- * Copyright (C) 2005-08 by the Quassel IRC Team *
+ * Copyright (C) 2005-2020 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef MESSAGEMODEL_H_
-#define MESSAGEMODEL_H_
+#pragma once
+
+#include "client-export.h"
#include <QAbstractItemModel>
#include <QDateTime>
+#include <QTimer>
#include "message.h"
#include "types.h"
class MessageModelItem;
struct MsgId;
-class MessageModel : public QAbstractItemModel {
- Q_OBJECT
+class CLIENT_EXPORT MessageModel : public QAbstractItemModel
+{
+ Q_OBJECT
public:
- enum MessageRole {
- DisplayRole = Qt::DisplayRole,
- EditRole = Qt::EditRole,
- MsgIdRole = Qt::UserRole,
- BufferIdRole,
- TypeRole,
- FlagsRole,
- TimestampRole,
- FormatRole,
- ColumnTypeRole,
- UserRole
- };
-
- enum ColumnType {
- TimestampColumn, SenderColumn, ContentsColumn, UserColumnType
- };
-
- MessageModel(QObject *parent);
-
- inline QModelIndex index(int row, int column, const QModelIndex &/*parent*/ = QModelIndex()) const { return createIndex(row, column); }
- inline QModelIndex parent(const QModelIndex &) const { return QModelIndex(); }
- inline int rowCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return _messageList.count(); }
- inline int columnCount(const QModelIndex &/*parent*/ = QModelIndex()) const { return 3; }
-
- virtual QVariant data(const QModelIndex &index, int role) const;
- virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
-
- //virtual Qt::ItemFlags flags(const QModelIndex &index) const;
-
- bool insertMessage(const Message &, bool fakeMsg = false);
- void insertMessages(const QList<Message> &);
-
- void clear();
+ enum MessageModelRole
+ {
+ DisplayRole = Qt::DisplayRole,
+ EditRole = Qt::EditRole,
+ BackgroundRole = Qt::BackgroundRole,
+ MessageRole = Qt::UserRole,
+ MsgIdRole,
+ BufferIdRole,
+ TypeRole,
+ FlagsRole,
+ TimestampRole,
+ FormatRole,
+ ColumnTypeRole,
+ RedirectedToRole,
+ UserRole
+ };
+
+ enum ColumnType
+ {
+ TimestampColumn,
+ SenderColumn,
+ ContentsColumn,
+ UserColumnType
+ };
+
+ MessageModel(QObject* parent);
+
+ inline QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const override;
+ inline QModelIndex parent(const QModelIndex&) const override { return {}; }
+ inline int rowCount(const QModelIndex& parent = QModelIndex()) const override { return parent.isValid() ? 0 : messageCount(); }
+ inline int columnCount(const QModelIndex& /*parent*/ = QModelIndex()) const override { return 3; }
+
+ QVariant data(const QModelIndex& index, int role) const override;
+ bool setData(const QModelIndex& index, const QVariant& value, int role) override;
+
+ // virtual Qt::ItemFlags flags(const QModelIndex &index) const;
+
+ bool insertMessage(const Message&, bool fakeMsg = false);
+ void insertMessages(const QList<Message>&);
+
+ void clear();
+
+signals:
+ void finishedBacklogFetch(BufferId bufferId);
public slots:
- void requestBacklog(BufferId bufferId);
- void messagesReceived(BufferId bufferId, int count);
+ void requestBacklog(BufferId bufferId);
+ void messagesReceived(BufferId bufferId, int count);
+ void buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2);
+ void insertErrorMessage(BufferInfo bufferInfo, const QString& errorString);
protected:
- virtual MessageModelItem *createMessageModelItem(const Message &) = 0;
- virtual void customEvent(QEvent *event);
+ // virtual MessageModelItem *createMessageModelItem(const Message &) = 0;
+
+ virtual int messageCount() const = 0;
+ virtual bool messagesIsEmpty() const = 0;
+ virtual const MessageModelItem* messageItemAt(int i) const = 0;
+ virtual MessageModelItem* messageItemAt(int i) = 0;
+ virtual const MessageModelItem* firstMessageItem() const = 0;
+ virtual MessageModelItem* firstMessageItem() = 0;
+ virtual const MessageModelItem* lastMessageItem() const = 0;
+ virtual MessageModelItem* lastMessageItem() = 0;
+ virtual void insertMessage__(int pos, const Message&) = 0;
+ virtual void insertMessages__(int pos, const QList<Message>&) = 0;
+ virtual void removeMessageAt(int i) = 0;
+ virtual void removeAllMessages() = 0;
+ virtual Message takeMessageAt(int i) = 0;
+
+ void customEvent(QEvent* event) override;
private slots:
- void changeOfDay();
+ void changeOfDay();
private:
- void insertMessageGroup(const QList<Message> &);
- int insertMessagesGracefully(const QList<Message> &); // inserts as many contiguous msgs as possible. returns numer of inserted msgs.
- int indexForId(MsgId);
-
- QList<MessageModelItem *> _messageList;
- QList<Message> _messageBuffer;
- QTimer _dayChangeTimer;
- QDateTime _nextDayChange;
- QHash<BufferId, int> _messagesWaiting;
+ void insertMessageGroup(const QList<Message>&);
+ int insertMessagesGracefully(const QList<Message>&); // inserts as many contiguous msgs as possible. returns numer of inserted msgs.
+ int indexForId(MsgId);
+
+ // QList<MessageModelItem *> _messageList;
+ QList<Message> _messageBuffer;
+ QTimer _dayChangeTimer;
+ QDateTime _nextDayChange;
+ QHash<BufferId, int> _messagesWaiting;
+
+ /// Period of time for one day in milliseconds
+ /// 24 hours * 60 minutes * 60 seconds * 1000 milliseconds
+ const qint64 DAY_IN_MSECS = 24 * 60 * 60 * 1000;
};
+// inlines
+QModelIndex MessageModel::index(int row, int column, const QModelIndex& parent) const
+{
+ if (row < 0 || row >= rowCount(parent) || column < 0 || column >= columnCount(parent))
+ return {};
+
+ return createIndex(row, column);
+}
+
// **************************************************
// MessageModelItem
// **************************************************
-class MessageModelItem {
+//! Creates a MessageModelItem from a Message object.
+/** This baseclass implementation takes care of all Message data *except* the stylable strings.
+ * Subclasses need to provide Qt::DisplayRole at least, which should describe the plaintext
+ * strings without formattings (e.g. for searching purposes).
+ */
+class CLIENT_EXPORT MessageModelItem
+{
public:
- //! Creates a MessageModelItem from a Message object.
- /** This baseclass implementation takes care of all Message data *except* the stylable strings.
- * Subclasses need to provide Qt::DisplayRole at least, which should describe the plaintext
- * strings without formattings (e.g. for searching purposes).
- */
- MessageModelItem(const Message &);
- inline virtual ~MessageModelItem() {}
-
- virtual QVariant data(int column, int role) const;
- virtual bool setData(int column, const QVariant &value, int role) = 0;
-
- inline const QDateTime &timeStamp() const { return _timestamp; }
- inline MsgId msgId() const { return _msgId; }
- inline BufferId bufferId() const { return _bufferId; }
- inline Message::Type msgType() const { return _type; }
- inline Message::Flags msgFlags() const { return _flags; }
-
- // For sorting
- bool operator<(const MessageModelItem &) const;
- bool operator==(const MessageModelItem &) const;
- bool operator>(const MessageModelItem &) const;
- static bool lessThan(const MessageModelItem *m1, const MessageModelItem *m2);
+ inline virtual ~MessageModelItem() = default;
+
+ virtual QVariant data(int column, int role) const;
+ virtual bool setData(int column, const QVariant& value, int role);
+
+ virtual const Message& message() const = 0;
+ virtual const QDateTime& timestamp() const = 0;
+ virtual const MsgId& msgId() const = 0;
+ virtual const BufferId& bufferId() const = 0;
+ virtual void setBufferId(BufferId bufferId) = 0;
+ virtual Message::Type msgType() const = 0;
+ virtual Message::Flags msgFlags() const = 0;
+
+ // For sorting
+ bool operator<(const MessageModelItem&) const;
+ bool operator==(const MessageModelItem&) const;
+ bool operator>(const MessageModelItem&) const;
+ static bool lessThan(const MessageModelItem* m1, const MessageModelItem* m2);
private:
- QDateTime _timestamp;
- MsgId _msgId;
- BufferId _bufferId;
- Message::Type _type;
- Message::Flags _flags;
+ BufferId _redirectedTo;
};
-QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem);
-
-#endif
+QDebug operator<<(QDebug dbg, const MessageModelItem& msgItem);