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,
  37     Notice,
  38     Action,
  39     Nick,
  40     Mode,
  41     Join,
  42     Part,
  43     Quit,
  44     Kick,
  45     Kill,
  46     Server,
  47     Info,
  48     Error
  49   };
  50
  51   enum Flags {
  52     None = 0,
  53     Self = 1,
  54     Highlight = 2
  55   };
  56   Q_DECLARE_FLAGS(MessageFlags, Flags)
  57
  58
  59   Message(BufferInfo bufferInfo = BufferInfo(), Type type = Plain, QString text = "", QString sender = "", quint8 flags = None);
  60
  61   Message(QDateTime ts, BufferInfo buffer = BufferInfo(), Type type = Plain, QString text = "", QString sender = "", quint8 flags = None);
  62
  63   inline MsgId msgId() const { return _msgId; }
  64   inline void setMsgId(MsgId id) { _msgId = id; }
  65
  66   inline BufferInfo bufferInfo() const { return _bufferInfo; }
  67   inline QString text() const { return _text; }
  68   inline QString sender() const { return _sender; }
  69   inline Type type() const { return _type; }
  70   inline quint8 flags() const { return _flags; }
  71   inline QDateTime timestamp() const { return _timestamp; }
  72
  73   QString formattedTimestamp();
  74   QString formattedSender();
  75   QString formattedText();
  76
  77   //static QString formattedToHtml(const QString &);
  78
  79   void format();
  80
  81 private:
  82   QDateTime _timestamp;
  83   MsgId _msgId;
  84   BufferInfo _bufferInfo;
  85   QString _text;
  86   QString _sender;
  87   Type _type;
  88   quint8 _flags;
  89
  90   QString _formattedTimestamp, _formattedSender, _formattedText; // cache
  91
  92   /** Convert mIRC control codes to our own */
  93   QString mircToInternal(QString);
  94
  95   friend QDataStream &operator>>(QDataStream &in, Message &msg);
  96 };
  97
  98 QDataStream &operator<<(QDataStream &out, const Message &msg);
  99 QDataStream &operator>>(QDataStream &in, Message &msg);
 100
 101 Q_DECLARE_METATYPE(Message);
 102 Q_DECLARE_OPERATORS_FOR_FLAGS(Message::MessageFlags)
 103
 104 #endif