src/common/message.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include "common-export.h"
  24
  25 #include <QCoreApplication>
  26 #include <QDateTime>
  27
  28 #include "bufferinfo.h"
  29 #include "types.h"
  30
  31 class COMMON_EXPORT Message
  32 {
  33     Q_DECLARE_TR_FUNCTIONS(Message)
  34
  35 public:
  36     /** The different types a message can have for display */
  37     enum Type {
  38         Plain     = 0x00001,
  39         Notice    = 0x00002,
  40         Action    = 0x00004,
  41         Nick      = 0x00008,
  42         Mode      = 0x00010,
  43         Join      = 0x00020,
  44         Part      = 0x00040,
  45         Quit      = 0x00080,
  46         Kick      = 0x00100,
  47         Kill      = 0x00200,
  48         Server    = 0x00400,
  49         Info      = 0x00800,
  50         Error     = 0x01000,
  51         DayChange = 0x02000,
  52         Topic     = 0x04000,
  53         NetsplitJoin = 0x08000,
  54         NetsplitQuit = 0x10000,
  55         Invite = 0x20000,
  56     };
  57     Q_DECLARE_FLAGS(Types, Type)
  58
  59     // DO NOT CHANGE without knowing what you do, some of these flags are stored in the database
  60     enum Flag {
  61         None = 0x00,
  62         Self = 0x01,
  63         Highlight = 0x02,
  64         Redirected = 0x04,
  65         ServerMsg = 0x08,
  66         StatusMsg = 0x10,
  67         Backlog = 0x80
  68     };
  69     Q_DECLARE_FLAGS(Flags, Flag)
  70
  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);
  77
  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; }
  81
  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 &timestamp() const { return _timestamp; }
  94
  95     inline bool isValid() const { return _msgId.isValid(); }
  96
  97     inline bool operator<(const Message &other) const { return _msgId < other._msgId; }
  98
  99 private:
 100     QDateTime _timestamp;
 101     MsgId _msgId;
 102     BufferInfo _bufferInfo;
 103     QString _contents;
 104     QString _sender;
 105     QString _senderPrefixes;
 106     QString _realName;
 107     QString _avatarUrl;
 108     Type _type;
 109     Flags _flags;
 110
 111     friend QDataStream &operator>>(QDataStream &in, Message &msg);
 112 };
 113
 114
 115 using MessageList = QList<Message>;
 116
 117 QDataStream &operator<<(QDataStream &out, const Message &msg);
 118 QDataStream &operator>>(QDataStream &in, Message &msg);
 119 QDebug operator<<(QDebug dbg, const Message &msg);
 120
 121 Q_DECLARE_METATYPE(Message)
 122 Q_DECLARE_OPERATORS_FOR_FLAGS(Message::Types)
 123 Q_DECLARE_OPERATORS_FOR_FLAGS(Message::Flags)