1 /***************************************************************************
2 * Copyright (C) 2005 by The Quassel Team *
3 * devel@quassel-irc.org *
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) any later version. *
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. *
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 ***************************************************************************/
24 /** The protocol version we use fo the communication between core and GUI */
25 #define GUI_PROTOCOL 1
27 #define BACKLOG_FORMAT 2
28 #define BACKLOG_STRING "QuasselIRC Backlog File"
35 /* Some global stuff */
36 typedef QMap<QString, QVariant> VarMap;
37 extern Global *global;
43 * This class is mostly a globally synchronized data store, meant for storing systemwide settings such
44 * as identities or network lists. This class is a singleton, but not static as we'd like to use signals and
46 * The global object is used in both Core and GUI clients. Storing and retrieving data is thread-safe.
47 * \note While updated data is propagated to all the remote parts of Quassel quite quickly, the synchronization
48 * protocol is in no way designed to guarantee strict consistency at all times. In other words, it may
49 * well happen that different instances of global data differ from one another for a little while until
50 * all update messages have been processed. You should never rely on all global data stores being consistent.
52 class Global : public QObject {
57 //static Logger *getLogger();
58 //static void setLogger(Logger *);
60 // static QIcon *getIcon(QString symbol);
62 QVariant getData(QString key, QVariant defaultValue = QVariant());
63 QStringList getKeys();
66 void putData(QString key, QVariant data); ///< Store data changed locally, will be propagated to all other clients and the core
67 void updateData(QString key, QVariant data); ///< Update stored data if requested by the core or other clients
70 void dataPutLocally(QString key);
71 void dataUpdatedRemotely(QString key); // sent by remote update only!
74 enum RunMode { Monolithic, GUIOnly, CoreOnly };
75 static RunMode runMode;
76 static QString quasselDir;
79 static void initIconMap();
81 //static Logger *logger;
83 // static QString iconPath;
84 QHash<QString, QString> iconMap;
86 QHash<QString, QVariant> data;
91 Exception(QString msg = "Unknown Exception") : _msg(msg) {};
92 virtual inline QString msg() { return _msg; }
101 BufferId() { id = gid = 0; } // FIXME
102 BufferId(uint uid, QString net, QString buf, uint gid = 0);
104 inline uint uid() { return id; }
105 inline uint groupId() { return gid; }
106 inline QString network() { return net; }
107 QString buffer(); // nickfrommask?
109 void setGroupId(uint _gid) { gid = _gid; }
111 inline bool operator==(const BufferId &other) const { return id == other.id; }
118 friend uint qHash(const BufferId &);
119 friend QDataStream &operator<<(QDataStream &out, const BufferId &bufferId);
120 friend QDataStream &operator>>(QDataStream &in, BufferId &bufferId);
123 QDataStream &operator<<(QDataStream &out, const BufferId &bufferId);
124 QDataStream &operator>>(QDataStream &in, BufferId &bufferId);
126 Q_DECLARE_METATYPE(BufferId);
128 uint qHash(const BufferId &);