serializers: Fix quint16 deserialization, remove code duplication
[quassel.git] / src / common / message.h
index 9bb1c9c..4c700ef 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2018 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 _MESSAGE_H_
-#define _MESSAGE_H_
+#pragma once
 
-#include <QString>
+#include "common-export.h"
+
+#include <QCoreApplication>
 #include <QDateTime>
 
 #include "bufferinfo.h"
 #include "types.h"
 
-class Message {
-  Q_DECLARE_TR_FUNCTIONS(Message);
+class COMMON_EXPORT Message
+{
+    Q_DECLARE_TR_FUNCTIONS(Message)
 
 public:
-  /** The different types a message can have for display */
-  enum Type {
-    Plain  = 0x0001,
-    Notice = 0x0002,
-    Action = 0x0004,
-    Nick   = 0x0008,
-    Mode   = 0x0010,
-    Join   = 0x0020,
-    Part   = 0x0040,
-    Quit   = 0x0080,
-    Kick   = 0x0100,
-    Kill   = 0x0200,
-    Server = 0x0400,
-    Info   = 0x0800,
-    Error  = 0x1000
-  };
-
-  // 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,
-    Backlog = 0x80
-  };
-  Q_DECLARE_FLAGS(Flags, Flag)
-
-
-  Message(const BufferInfo &bufferInfo = BufferInfo(), Type type = Plain, const QString &contents = "", const QString &sender = "", Flags flags = None);
-  Message(const QDateTime &ts, const BufferInfo &buffer = BufferInfo(), Type type = Plain,
-          const QString &contents = "", const QString &sender = "", Flags flags = None);
-
-  inline MsgId msgId() const { return _msgId; }
-  inline void setMsgId(MsgId id) { _msgId = id; }
-
-  inline BufferInfo bufferInfo() const { return _bufferInfo; }
-  inline QString contents() const { return _contents; }
-  inline QString sender() const { return _sender; }
-  inline Type type() const { return _type; }
-  inline Flags flags() const { return _flags; }
-  inline QDateTime timestamp() const { return _timestamp; }
-
-  void setFlags(Flags flags);
+    /** The different types a message can have for display */
+    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;
-  BufferInfo _bufferInfo;
-  QString _contents;
-  QString _sender;
-  Type _type;
-  Flags _flags;
-
-  QString _formattedTimestamp, _formattedSender, _formattedText; // cache
-
-
-  friend QDataStream &operator>>(QDataStream &in, Message &msg);
+    QDateTime _timestamp;
+    MsgId _msgId;
+    BufferInfo _bufferInfo;
+    QString _contents;
+    QString _sender;
+    QString _senderPrefixes;
+    QString _realName;
+    QString _avatarUrl;
+    Type _type;
+    Flags _flags;
+
+    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);
-Q_DECLARE_OPERATORS_FOR_FLAGS(Message::Flags)
+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)