src/common/types.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 _TYPES_H_
  22 #define _TYPES_H_
  23
  24 #include <QDebug>
  25 #include <QString>
  26 #include <QVariant>
  27
  28 class SignedId {
  29   protected:
  30     qint32 id;
  31
  32   public:
  33     inline SignedId(int _id = 0) { id = _id; }
  34     inline qint32 toInt() const { return id; }
  35     inline bool isValid() const { return id > 0; }
  36
  37     inline bool operator==(const SignedId &other) const { return id == other.id; }
  38     inline bool operator!=(const SignedId &other) const { return id != other.id; }
  39     inline bool operator<(const SignedId &other) const { return id < other.id; }
  40     inline bool operator==(int i) const { return id == i; }
  41     inline bool operator!=(int i) const { return id != i; }
  42     inline bool operator<(int i) const { return id < i; }
  43     inline bool operator>(int i) const { return id > i; }
  44     inline bool operator<=(int i) const { return id <= i; }
  45
  46     inline SignedId operator++(int) { id++; return *this; }
  47     //inline operator int() const { return toInt(); } // no automatic conversion!
  48
  49     friend QDataStream &operator>>(QDataStream &in, SignedId &signedId);
  50 };
  51
  52 inline QDataStream &operator<<(QDataStream &out, const SignedId &signedId) { out << signedId.toInt(); return out; }
  53 inline QDataStream &operator>>(QDataStream &in, SignedId &signedId) { in >> signedId.id; return in; }
  54 inline QDebug operator<<(QDebug dbg, const SignedId &signedId) { dbg.space() << signedId.toInt(); return dbg; }
  55 inline uint qHash(const SignedId &id) { return qHash(id.toInt()); }
  56
  57 struct UserId : public SignedId {
  58   inline UserId(int _id = 0) : SignedId(_id) {};
  59   //inline operator QVariant() const { return QVariant::fromValue<UserId>(*this); }  // no automatic conversion!
  60 };
  61
  62 struct MsgId : public SignedId {
  63   inline MsgId(int _id = 0) : SignedId(_id) {};
  64   //inline operator QVariant() const { return QVariant::fromValue<MsgId>(*this); }
  65 };
  66
  67 struct BufferId : public SignedId {
  68   inline BufferId(int _id = 0) : SignedId(_id) {};
  69   //inline operator QVariant() const { return QVariant::fromValue<BufferId>(*this); }
  70 };
  71
  72 struct NetworkId : public SignedId {
  73   inline NetworkId(int _id = 0) : SignedId(_id) {};
  74   //inline operator QVariant() const { return QVariant::fromValue<NetworkId>(*this); }
  75 };
  76
  77 struct IdentityId : public SignedId {
  78   inline IdentityId(int _id = 0) : SignedId(_id) {};
  79   //inline operator QVariant() const { return QVariant::fromValue<IdentityId>(*this); }
  80 };
  81
  82 struct AccountId : public SignedId {
  83   inline AccountId(int _id = 0) : SignedId(_id) {};
  84 };
  85
  86 Q_DECLARE_METATYPE(UserId);
  87 Q_DECLARE_METATYPE(MsgId);
  88 Q_DECLARE_METATYPE(BufferId);
  89 Q_DECLARE_METATYPE(NetworkId);
  90 Q_DECLARE_METATYPE(IdentityId);
  91 Q_DECLARE_METATYPE(AccountId);
  92
  93 //! Base class for exceptions.
  94 struct Exception {
  95   Exception(QString msg = "Unknown Exception") : _msg(msg) {};
  96   virtual ~Exception() {}; // make gcc happy
  97   virtual inline QString msg() { return _msg; }
  98
  99   protected:
 100     QString _msg;
 101
 102 };
 103
 104 #endif