src/common/types.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2014 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 #ifndef TYPES_H_
  22 #define TYPES_H_
  23
  24 #include <QDebug>
  25 #include <QString>
  26 #include <QVariant>
  27 #include <QDataStream>
  28 #include <QTextStream>
  29 #include <QHostAddress>
  30 #include <QDataStream>
  31
  32 // We need to special-case Peer* in attached signals/slots, so typedef it for the meta type system
  33 class Peer;
  34 typedef Peer * PeerPtr;
  35 Q_DECLARE_METATYPE(PeerPtr)
  36
  37 class SignedId
  38 {
  39 protected:
  40     qint32 id;
  41
  42 public:
  43     inline SignedId(int _id = 0) { id = _id; }
  44     inline qint32 toInt() const { return id; }
  45     inline bool isValid() const { return id > 0; }
  46
  47     inline bool operator==(const SignedId &other) const { return id == other.id; }
  48     inline bool operator!=(const SignedId &other) const { return id != other.id; }
  49     inline bool operator<(const SignedId &other) const { return id < other.id; }
  50     inline bool operator<=(const SignedId &other) const { return id <= other.id; }
  51     inline bool operator>(const SignedId &other) const { return id > other.id; }
  52     inline bool operator>=(const SignedId &other) const { return id >= other.id; }
  53     inline bool operator==(int i) const { return id == i; }
  54     inline bool operator!=(int i) const { return id != i; }
  55     inline bool operator<(int i) const { return id < i; }
  56     inline bool operator>(int i) const { return id > i; }
  57     inline bool operator<=(int i) const { return id <= i; }
  58
  59     inline SignedId operator++(int) { id++; return *this; }
  60     //inline operator int() const { return toInt(); } // no automatic conversion!
  61
  62     friend QDataStream &operator>>(QDataStream &in, SignedId &signedId);
  63 };
  64
  65
  66 inline QDataStream &operator<<(QDataStream &out, const SignedId &signedId) { out << signedId.toInt(); return out; }
  67 inline QDataStream &operator>>(QDataStream &in, SignedId &signedId) { in >> signedId.id; return in; }
  68 inline QTextStream &operator<<(QTextStream &out, const SignedId &signedId) { out << QString::number(signedId.toInt()); return out; }
  69 inline QDebug operator<<(QDebug dbg, const SignedId &signedId) { dbg.space() << signedId.toInt(); return dbg; }
  70 inline uint qHash(const SignedId &id) { return qHash(id.toInt()); }
  71
  72 struct UserId : public SignedId {
  73     inline UserId(int _id = 0) : SignedId(_id) {}
  74     //inline operator QVariant() const { return QVariant::fromValue<UserId>(*this); }  // no automatic conversion!
  75 };
  76
  77 struct MsgId : public SignedId {
  78     inline MsgId(int _id = 0) : SignedId(_id) {}
  79     //inline operator QVariant() const { return QVariant::fromValue<MsgId>(*this); }
  80 };
  81
  82 struct BufferId : public SignedId {
  83     inline BufferId(int _id = 0) : SignedId(_id) {}
  84     //inline operator QVariant() const { return QVariant::fromValue<BufferId>(*this); }
  85 };
  86
  87 struct NetworkId : public SignedId {
  88     inline NetworkId(int _id = 0) : SignedId(_id) {}
  89     //inline operator QVariant() const { return QVariant::fromValue<NetworkId>(*this); }
  90 };
  91
  92 struct IdentityId : public SignedId {
  93     inline IdentityId(int _id = 0) : SignedId(_id) {}
  94     //inline operator QVariant() const { return QVariant::fromValue<IdentityId>(*this); }
  95 };
  96
  97 struct AccountId : public SignedId {
  98     inline AccountId(int _id = 0) : SignedId(_id) {}
  99 };
 100
 101 Q_DECLARE_METATYPE(UserId)
 102 Q_DECLARE_METATYPE(MsgId)
 103 Q_DECLARE_METATYPE(BufferId)
 104 Q_DECLARE_METATYPE(NetworkId)
 105 Q_DECLARE_METATYPE(IdentityId)
 106 Q_DECLARE_METATYPE(AccountId)
 107
 108 Q_DECLARE_METATYPE(QHostAddress)
 109
 110 // a few typedefs
 111 typedef QList<MsgId> MsgIdList;
 112 typedef QList<BufferId> BufferIdList;
 113
 114 //! Base class for exceptions.
 115 struct Exception {
 116     Exception(QString msg = "Unknown Exception") : _msg(msg) {}
 117     virtual ~Exception() {} // make gcc happy
 118     virtual inline QString msg() { return _msg; }
 119
 120 protected:
 121     QString _msg;
 122 };
 123
 124 #endif