Merge branch 'seezer'
[quassel.git] / 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<=(const SignedId &other) const { return id <= other.id; }
41     inline bool operator>(const SignedId &other) const { return id > other.id; }
42     inline bool operator>=(const SignedId &other) const { return id >= other.id; }
43     inline bool operator==(int i) const { return id == i; }
44     inline bool operator!=(int i) const { return id != i; }
45     inline bool operator<(int i) const { return id < i; }
46     inline bool operator>(int i) const { return id > i; }
47     inline bool operator<=(int i) const { return id <= i; }
48
49     inline SignedId operator++(int) { id++; return *this; }
50     //inline operator int() const { return toInt(); } // no automatic conversion!
51
52     friend QDataStream &operator>>(QDataStream &in, SignedId &signedId);
53 };
54
55 inline QDataStream &operator<<(QDataStream &out, const SignedId &signedId) { out << signedId.toInt(); return out; }
56 inline QDataStream &operator>>(QDataStream &in, SignedId &signedId) { in >> signedId.id; return in; }
57 inline QDebug operator<<(QDebug dbg, const SignedId &signedId) { dbg.space() << signedId.toInt(); return dbg; }
58 inline uint qHash(const SignedId &id) { return qHash(id.toInt()); }
59
60 struct UserId : public SignedId {
61   inline UserId(int _id = 0) : SignedId(_id) {};
62   //inline operator QVariant() const { return QVariant::fromValue<UserId>(*this); }  // no automatic conversion!
63 };
64
65 struct MsgId : public SignedId {
66   inline MsgId(int _id = 0) : SignedId(_id) {};
67   //inline operator QVariant() const { return QVariant::fromValue<MsgId>(*this); }
68 };
69
70 struct BufferId : public SignedId {
71   inline BufferId(int _id = 0) : SignedId(_id) {};
72   //inline operator QVariant() const { return QVariant::fromValue<BufferId>(*this); }
73 };
74
75 struct NetworkId : public SignedId {
76   inline NetworkId(int _id = 0) : SignedId(_id) {};
77   //inline operator QVariant() const { return QVariant::fromValue<NetworkId>(*this); }
78 };
79
80 struct IdentityId : public SignedId {
81   inline IdentityId(int _id = 0) : SignedId(_id) {};
82   //inline operator QVariant() const { return QVariant::fromValue<IdentityId>(*this); }
83 };
84
85 struct AccountId : public SignedId {
86   inline AccountId(int _id = 0) : SignedId(_id) {};
87 };
88
89 Q_DECLARE_METATYPE(UserId);
90 Q_DECLARE_METATYPE(MsgId);
91 Q_DECLARE_METATYPE(BufferId);
92 Q_DECLARE_METATYPE(NetworkId);
93 Q_DECLARE_METATYPE(IdentityId);
94 Q_DECLARE_METATYPE(AccountId);
95
96 //! Base class for exceptions.
97 struct Exception {
98   Exception(QString msg = "Unknown Exception") : _msg(msg) {};
99   virtual ~Exception() {}; // make gcc happy
100   virtual inline QString msg() { return _msg; }
101
102   protected:
103     QString _msg;
104
105 };
106
107 #endif