src/common/message.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef _MESSAGE_H_
  22 #define _MESSAGE_H_
  23
  24 #include <QString>
  25 #include <QDateTime>
  26
  27 #include "bufferinfo.h"
  28 #include "types.h"
  29
  30 class Message {
  31   Q_DECLARE_TR_FUNCTIONS(Message)
  32
  33 public:
  34   /** The different types a message can have for display */
  35   enum Type {
  36     Plain  = 0x0001,
  37     Notice = 0x0002,
  38     Action = 0x0004,
  39     Nick   = 0x0008,
  40     Mode   = 0x0010,
  41     Join   = 0x0020,
  42     Part   = 0x0040,
  43     Quit   = 0x0080,
  44     Kick   = 0x0100,
  45     Kill   = 0x0200,
  46     Server = 0x0400,
  47     Info   = 0x0800,
  48     Error  = 0x1000
  49   };
  50
  51   // DO NOT CHANGE without knowing what you do, some of these flags are stored in the database
  52   enum Flag {
  53     None = 0x00,
  54     Self = 0x01,
  55     Highlight = 0x02,
  56     Redirected = 0x04,
  57     Backlog = 0x80
  58   };
  59   Q_DECLARE_FLAGS(Flags, Flag)
  60
  61
  62   Message(const BufferInfo &bufferInfo = BufferInfo(), Type type = Plain, const QString &contents = "", const QString &sender = "", Flags flags = None);
  63   Message(const QDateTime &ts, const BufferInfo &buffer = BufferInfo(), Type type = Plain,
  64           const QString &contents = "", const QString &sender = "", Flags flags = None);
  65
  66   inline MsgId msgId() const { return _msgId; }
  67   inline void setMsgId(MsgId id) { _msgId = id; }
  68
  69   inline BufferInfo bufferInfo() const { return _bufferInfo; }
  70   inline QString contents() const { return _contents; }
  71   inline QString sender() const { return _sender; }
  72   inline Type type() const { return _type; }
  73   inline Flags flags() const { return _flags; }
  74   inline QDateTime timestamp() const { return _timestamp; }
  75
  76   void setFlags(Flags flags);
  77
  78 private:
  79   QDateTime _timestamp;
  80   MsgId _msgId;
  81   BufferInfo _bufferInfo;
  82   QString _contents;
  83   QString _sender;
  84   Type _type;
  85   Flags _flags;
  86
  87   QString _formattedTimestamp, _formattedSender, _formattedText; // cache
  88
  89
  90   friend QDataStream &operator>>(QDataStream &in, Message &msg);
  91 };
  92
  93 QDataStream &operator<<(QDataStream &out, const Message &msg);
  94 QDataStream &operator>>(QDataStream &in, Message &msg);
  95
  96 Q_DECLARE_METATYPE(Message)
  97 Q_DECLARE_OPERATORS_FOR_FLAGS(Message::Flags)
  98
  99 #endif