Handle STATUSMSG messages
[quassel.git] / src / common / message.h
index 8ce0cfe..a7fb493 100644 (file)
@@ -1,11 +1,11 @@
 /***************************************************************************
- *   Copyright (C) 2005/06 by The Quassel Team                             *
+ *   Copyright (C) 2005-2015 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_
-
-#include <QtCore>
-#include "global.h"
-
-struct Message {
-
-  /** 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 };
-
-  uint msgId;
-  Type type;
-  quint8 flags;
-  QString target;
-  QString sender;
-  QString text;
-  QDateTime timeStamp;
-  BufferId buffer;
-
-  Message(QString _target, Type _type = Plain, QString _text = "", QString _sender = "", quint8 _flags = None)
-  : target(_target), text(_text), sender(_sender), type(_type), flags(_flags) { timeStamp = QDateTime::currentDateTime().toUTC(); }
-
-  Message(BufferId _buffer = BufferId(), Type _type = Plain, QString _text = "", QString _sender = "", quint8 _flags = None)
-  : buffer(_buffer), text(_text), sender(_sender), type(_type), flags(_flags) { timeStamp = QDateTime::currentDateTime().toUTC(); }
-
-  Message(QDateTime _ts, BufferId _buffer = BufferId(), Type _type = Plain, QString _text = "", QString _sender = "", quint8 _flags = None)
-  : timeStamp(_ts), buffer(_buffer), text(_text), sender(_sender), type(_type), flags(_flags) {}
-  
-/*
-  static Message plain(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message notice(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message action(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message nick(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message mode(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message join(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message part(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message quit(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message kick(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message kill(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message server(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message info(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-  static Message error(QString _target, QString _text, QString _sender = "", quint8 _flags = None);
-*/
+#ifndef MESSAGE_H_
+#define MESSAGE_H_
+
+#include <QCoreApplication>
+#include <QDateTime>
+
+#include "bufferinfo.h"
+#include "types.h"
+
+class Message
+{
+    Q_DECLARE_TR_FUNCTIONS(Message)
+
+public:
+    /** 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,
+    };
+
+    // 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(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 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 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;
+
+    friend QDataStream &operator>>(QDataStream &in, Message &msg);
 };
 
+
+typedef QList<Message> MessageList;
+
 QDataStream &operator<<(QDataStream &out, const Message &msg);
 QDataStream &operator>>(QDataStream &in, Message &msg);
+QDebug operator<<(QDebug dbg, const Message &msg);
 
-Q_DECLARE_METATYPE(Message);
+Q_DECLARE_METATYPE(Message)
+Q_DECLARE_OPERATORS_FOR_FLAGS(Message::Flags)
 
 #endif