/***************************************************************************
- * Copyright (C) 2005-07 by The Quassel IRC Development Team *
+ * Copyright (C) 2005-2019 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
+ * (at your option) version 3. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* 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 _MESSAGE_H_
-#define _MESSAGE_H_
+#pragma once
+
+#include "common-export.h"
#include <QCoreApplication>
-#include <QString>
#include <QDateTime>
-#include "global.h"
+#include "bufferinfo.h"
+#include "types.h"
-class Message {
- Q_DECLARE_TR_FUNCTIONS(Message);
+class COMMON_EXPORT Message
+{
+ Q_DECLARE_TR_FUNCTIONS(Message)
- public:
+public:
/** The different types a message can have for display */
- enum Type { Plain, Notice, Action, Nick, Mode, Join, Part, Quit, Kick, Kill, Server, Info, Error };
- enum Flags { None = 0, Self = 1, PrivMsg = 2, Highlight = 4 };
-
- Message(BufferId buffer = BufferId(), Type type = Plain, QString text = "", QString sender = "", quint8 flags = None);
-
- Message(QDateTime ts, BufferId buffer = BufferId(), Type type = Plain, QString text = "", QString sender = "", quint8 flags = None);
-
- MsgId msgId() const;
- void setMsgId(MsgId id);
-
- BufferId buffer() const;
- QString text() const;
- QString sender() const;
- Type type() const;
- quint8 flags() const;
- QDateTime timeStamp() const;
-
- QString formattedTimeStamp();
- QString formattedSender();
- QString formattedText();
-
- void format();
-
- private:
- QDateTime _timeStamp;
+ enum Type
+ {
+ Plain = 0x00001,
+ Notice = 0x00002,
+ Action = 0x00004,
+ Nick = 0x00008,
+ Mode = 0x00010,
+ Join = 0x00020,
+ Part = 0x00040,
+ Quit = 0x00080,
+ Kick = 0x00100,
+ Kill = 0x00200,
+ Server = 0x00400,
+ Info = 0x00800,
+ Error = 0x01000,
+ DayChange = 0x02000,
+ Topic = 0x04000,
+ NetsplitJoin = 0x08000,
+ NetsplitQuit = 0x10000,
+ Invite = 0x20000,
+ };
+ Q_DECLARE_FLAGS(Types, Type)
+
+ // DO NOT CHANGE without knowing what you do, some of these flags are stored in the database
+ enum Flag
+ {
+ None = 0x00,
+ Self = 0x01,
+ Highlight = 0x02,
+ Redirected = 0x04,
+ ServerMsg = 0x08,
+ StatusMsg = 0x10,
+ Backlog = 0x80
+ };
+ Q_DECLARE_FLAGS(Flags, Flag)
+
+ Message(BufferInfo bufferInfo = BufferInfo(),
+ Type type = Plain,
+ QString contents = {},
+ QString sender = {},
+ QString senderPrefixes = {},
+ QString realName = {},
+ QString avatarUrl = {},
+ Flags flags = None);
+ Message(QDateTime ts,
+ BufferInfo buffer = BufferInfo(),
+ Type type = Plain,
+ QString contents = {},
+ QString sender = {},
+ QString senderPrefixes = {},
+ QString realName = {},
+ QString avatarUrl = {},
+ Flags flags = None);
+
+ inline static Message ChangeOfDay(const QDateTime& day) { return Message(day, BufferInfo(), DayChange); }
+ inline const MsgId& msgId() const { return _msgId; }
+ inline void setMsgId(MsgId id) { _msgId = id; }
+
+ inline const BufferInfo& bufferInfo() const { return _bufferInfo; }
+ inline const BufferId& bufferId() const { return _bufferInfo.bufferId(); }
+ inline void setBufferId(BufferId id) { _bufferInfo.setBufferId(id); }
+ inline const QString& contents() const { return _contents; }
+ inline const QString& sender() const { return _sender; }
+ inline const QString& senderPrefixes() const { return _senderPrefixes; }
+ inline const QString& realName() const { return _realName; }
+ inline const QString& avatarUrl() const { return _avatarUrl; }
+ inline Type type() const { return _type; }
+ inline Flags flags() const { return _flags; }
+ inline void setFlags(Flags flags) { _flags = flags; }
+ inline const QDateTime& timestamp() const { return _timestamp; }
+
+ inline bool isValid() const { return _msgId.isValid(); }
+
+ inline bool operator<(const Message& other) const { return _msgId < other._msgId; }
+
+private:
+ QDateTime _timestamp;
MsgId _msgId;
- BufferId _buffer;
- QString _text;
+ BufferInfo _bufferInfo;
+ QString _contents;
QString _sender;
+ QString _senderPrefixes;
+ QString _realName;
+ QString _avatarUrl;
Type _type;
- quint8 _flags;
-
- QString _formattedTimeStamp, _formattedSender, _formattedText; // cache
-
- /** Convert mIRC control codes to our own */
- QString mircToInternal(QString);
+ Flags _flags;
- friend QDataStream &operator>>(QDataStream &in, Message &msg);
+ friend QDataStream& operator>>(QDataStream& in, Message& msg);
};
-QDataStream &operator<<(QDataStream &out, const Message &msg);
-QDataStream &operator>>(QDataStream &in, Message &msg);
+using MessageList = QList<Message>;
-Q_DECLARE_METATYPE(Message);
+QDataStream& operator<<(QDataStream& out, const Message& msg);
+QDataStream& operator>>(QDataStream& in, Message& msg);
+QDebug operator<<(QDebug dbg, const Message& msg);
-#endif
+Q_DECLARE_METATYPE(Message)
+Q_DECLARE_OPERATORS_FOR_FLAGS(Message::Types)
+Q_DECLARE_OPERATORS_FOR_FLAGS(Message::Flags)