1 /***************************************************************************
2 * Copyright (C) 2005-2018 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
23 #include "common-export.h"
25 #include <QCoreApplication>
28 #include "bufferinfo.h"
31 class COMMON_EXPORT Message
33 Q_DECLARE_TR_FUNCTIONS(Message)
36 /** The different types a message can have for display */
53 NetsplitJoin = 0x08000,
54 NetsplitQuit = 0x10000,
57 Q_DECLARE_FLAGS(Types, Type)
59 // DO NOT CHANGE without knowing what you do, some of these flags are stored in the database
69 Q_DECLARE_FLAGS(Flags, Flag)
71 Message(BufferInfo bufferInfo = BufferInfo(), Type type = Plain, QString contents = {},
72 QString sender = {}, QString senderPrefixes = {}, QString realName = {},
73 QString avatarUrl = {}, Flags flags = None);
74 Message(QDateTime ts, BufferInfo buffer = BufferInfo(), Type type = Plain,
75 QString contents = {}, QString sender = {}, QString senderPrefixes = {},
76 QString realName = {}, QString avatarUrl = {}, Flags flags = None);
78 inline static Message ChangeOfDay(const QDateTime &day) { return Message(day, BufferInfo(), DayChange); }
79 inline const MsgId &msgId() const { return _msgId; }
80 inline void setMsgId(MsgId id) { _msgId = id; }
82 inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
83 inline const BufferId &bufferId() const { return _bufferInfo.bufferId(); }
84 inline void setBufferId(BufferId id) { _bufferInfo.setBufferId(id); }
85 inline const QString &contents() const { return _contents; }
86 inline const QString &sender() const { return _sender; }
87 inline const QString &senderPrefixes() const { return _senderPrefixes; }
88 inline const QString &realName() const { return _realName; }
89 inline const QString &avatarUrl() const { return _avatarUrl; }
90 inline Type type() const { return _type; }
91 inline Flags flags() const { return _flags; }
92 inline void setFlags(Flags flags) { _flags = flags; }
93 inline const QDateTime ×tamp() const { return _timestamp; }
95 inline bool isValid() const { return _msgId.isValid(); }
97 inline bool operator<(const Message &other) const { return _msgId < other._msgId; }
100 QDateTime _timestamp;
102 BufferInfo _bufferInfo;
105 QString _senderPrefixes;
111 friend QDataStream &operator>>(QDataStream &in, Message &msg);
115 using MessageList = QList<Message>;
117 QDataStream &operator<<(QDataStream &out, const Message &msg);
118 QDataStream &operator>>(QDataStream &in, Message &msg);
119 QDebug operator<<(QDebug dbg, const Message &msg);
121 Q_DECLARE_METATYPE(Message)
122 Q_DECLARE_OPERATORS_FOR_FLAGS(Message::Types)
123 Q_DECLARE_OPERATORS_FOR_FLAGS(Message::Flags)