1 /***************************************************************************
2 * Copyright (C) 2005-07 by the Quassel IRC 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) version 3. *
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 ***************************************************************************/
21 #ifndef _SIGNALPROXY_H_
22 #define _SIGNALPROXY_H_
27 #include <QVariantMap>
37 class SignalProxy : public QObject {
52 SignalProxy(QObject *parent);
53 SignalProxy(ProxyMode mode, QObject *parent);
54 SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent);
55 virtual ~SignalProxy();
57 void setProxyMode(ProxyMode mode);
58 ProxyMode proxyMode() const;
60 bool addPeer(QIODevice *iodev);
61 void removePeer(QIODevice *iodev = 0);
63 bool attachSignal(QObject *sender, const char *signal, const QByteArray& sigName = QByteArray());
64 bool attachSlot(const QByteArray& sigName, QObject *recv, const char *slot);
66 void synchronize(QObject *obj);
68 void setInitialized(QObject *obj);
69 bool initialized(QObject *obj);
70 void requestInit(QObject *obj);
72 void detachObject(QObject *obj);
73 void detachSignals(QObject *sender);
74 void detachSlots(QObject *receiver);
75 void stopSync(QObject *obj);
77 //! Writes a QVariant to a device.
78 /** The data item is prefixed with the resulting blocksize,
79 * so the corresponding function readDataFromDevice() can check if enough data is available
80 * at the device to reread the item.
82 static void writeDataToDevice(QIODevice *dev, const QVariant &item);
84 //! Reads a data item from a device that has been written by writeDataToDevice().
85 /** If not enough data bytes are available, the function returns false and the QVariant reference
88 static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item);
90 static QString methodBaseName(const QMetaMethod &method);
92 const QList<int> &argTypes(QObject *obj, int methodId);
93 const QByteArray &methodName(QObject *obj, int methodId);
94 const QHash<QByteArray, int> &syncMap(QObject *obj);
96 typedef QHash<int, QList<int> > ArgHash;
97 typedef QHash<int, QByteArray> MethodNameHash;
100 MethodNameHash methodNames;
101 QHash<QByteArray, int> syncMap;
104 void dumpProxyStats();
107 void dataAvailable();
109 void removePeerBySender();
110 void objectRenamed(QString oldname, QString newname);
111 void objectRenamed(QByteArray classname, QString oldname, QString newname);
114 void peerRemoved(QIODevice *obj);
122 void createClassInfo(QObject *obj);
123 void setArgTypes(QObject *obj, int methodId);
124 void setMethodName(QObject *obj, int methodId);
125 void setSyncMap(QObject *obj);
127 bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const;
129 void dispatchSignal(QIODevice *receiver, const QVariant &identifier, const QVariantList ¶ms);
130 void dispatchSignal(const QVariant &identifier, const QVariantList ¶ms);
132 void receivePeerSignal(QIODevice *sender, const QVariant &packedFunc);
133 void handleSync(QVariantList params);
134 void handleInitRequest(QIODevice *sender, const QVariantList ¶ms);
135 void handleInitData(QIODevice *sender, const QVariantList ¶ms);
136 void handleSignal(const QByteArray &funcName, const QVariantList ¶ms);
138 bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms);
140 QVariantMap initData(QObject *obj) const;
141 void setInitData(QObject *obj, const QVariantMap &properties);
142 bool setInitValue(QObject *obj, const QString &property, const QVariant &value);
144 void _detachSignals(QObject *sender);
145 void _detachSlots(QObject *receiver);
146 void _stopSync(QObject *obj);
148 void dumpSyncMap(QObject *object);
150 // Hash of used QIODevices
151 QHash<QIODevice*, quint32> _peerByteCount;
153 // containg a list of argtypes for fast access
154 QHash<const QMetaObject *, ClassInfo*> _classInfo;
156 // we use one SignalRelay per QObject
157 QHash<QObject*, SignalRelay *> _relayHash;
159 // RPC function -> (object, slot ID)
160 typedef QPair<QObject*, int> MethodId;
161 typedef QMultiHash<QByteArray, MethodId> SlotHash;
162 SlotHash _attachedSlots;
165 typedef QHash<QString, QObject *> ObjectId;
166 QHash<QByteArray, ObjectId> _syncSlave;
169 ProxyMode _proxyMode;
171 // the slaveMutex protects both containers:
172 // - _syncSlaves for sync and init calls
176 friend class SignalRelay;