src/common/signalproxy.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
   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 _SIGNALPROXY_H_
  22 #define _SIGNALPROXY_H_
  23
  24 #include <QList>
  25 #include <QHash>
  26 #include <QVariant>
  27 #include <QVariantMap>
  28 #include <QPair>
  29 #include <QString>
  30 #include <QByteArray>
  31
  32 class SignalRelay;
  33 class QMetaObject;
  34
  35 class SignalProxy : public QObject {
  36   Q_OBJECT
  37
  38 public:
  39   enum ProxyMode {
  40     Server,
  41     Client
  42   };
  43
  44   enum RequestType {
  45     Sync = 0,
  46     InitRequest,
  47     InitData
  48   };
  49
  50   SignalProxy(QObject *parent);
  51   SignalProxy(ProxyMode mode, QObject *parent);
  52   SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent);
  53   virtual ~SignalProxy();
  54
  55   void setProxyMode(ProxyMode mode);
  56   ProxyMode proxyMode() const;
  57
  58   bool addPeer(QIODevice *iodev);
  59   void removePeer(QIODevice *iodev = 0);
  60
  61   bool attachSignal(QObject *sender, const char *signal, const QByteArray& sigName = QByteArray());
  62   bool attachSlot(const QByteArray& sigName, QObject *recv, const char *slot);
  63
  64   void synchronize(QObject *obj);
  65   void synchronizeAsMaster(QObject *obj);
  66   void synchronizeAsSlave(QObject *obj);
  67
  68   void setInitialized(QObject *obj);
  69   bool initialized(QObject *obj);
  70   void requestInit(QObject *obj);
  71
  72   void detachObject(QObject *obj);
  73   void detachSignals(QObject *sender);
  74   void detachSlots(QObject *receiver);
  75
  76   //! Writes a QVariant to a device.
  77   /** The data item is prefixed with the resulting blocksize,
  78    *  so the corresponding function readDataFromDevice() can check if enough data is available
  79    *  at the device to reread the item.
  80    */
  81   static void writeDataToDevice(QIODevice *dev, const QVariant &item);
  82
  83   //! Reads a data item from a device that has been written by writeDataToDevice().
  84   /** If not enough data bytes are available, the function returns false and the QVariant reference
  85    *  remains untouched.
  86    */
  87   static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item);
  88
  89   static QString methodBaseName(const QMetaMethod &method);
  90
  91   const QList<int> &argTypes(QObject *obj, int methodId);
  92   const QByteArray &methodName(QObject *obj, int methodId);
  93   const QHash<int, int> &syncMap(QObject *obj);
  94
  95   typedef QHash<int, QList<int> > ArgHash;
  96   typedef QHash<int, QByteArray> MethodNameHash;
  97   struct ClassInfo {
  98     ArgHash argTypes;
  99     MethodNameHash methodNames;
 100     QHash<int, int> syncMap;
 101   };
 102
 103   void dumpProxyStats();
 104
 105 private slots:
 106   void dataAvailable();
 107   void detachSender();
 108   void removePeerBySender();
 109   void objectRenamed(QString oldname, QString newname);
 110   void objectRenamed(QByteArray classname, QString oldname, QString newname);
 111
 112 signals:
 113   void peerRemoved(QIODevice *obj);
 114   void connected();
 115   void disconnected();
 116
 117 private:
 118   void initServer();
 119   void initClient();
 120
 121   void createClassInfo(QObject *obj);
 122   void setArgTypes(QObject *obj, int methodId);
 123   void setMethodName(QObject *obj, int methodId);
 124   void setSyncMap(QObject *obj);
 125
 126   bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const;
 127
 128   void dispatchSignal(QIODevice *receiver, const QVariant &identifier, const QVariantList &params);
 129   void dispatchSignal(const QVariant &identifier, const QVariantList &params);
 130
 131   void receivePeerSignal(QIODevice *sender, const QVariant &packedFunc);
 132   void handleSync(QVariantList params);
 133   void handleInitRequest(QIODevice *sender, const QVariantList &params);
 134   void handleInitData(QIODevice *sender, const QVariantList &params);
 135   void handleSignal(const QByteArray &funcName, const QVariantList &params);
 136
 137   bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params);
 138
 139   QVariantMap initData(QObject *obj) const;
 140   void setInitData(QObject *obj, const QVariantMap &properties);
 141   bool setInitValue(QObject *obj, const QString &property, const QVariant &value);
 142
 143   void _detachSignals(QObject *sender);
 144   void _detachSlots(QObject *receiver);
 145
 146     void dumpSyncMap(QObject *object);
 147
 148   // containg a list of argtypes for fast access
 149   QHash<const QMetaObject *, ClassInfo*> _classInfo;
 150
 151   // we use one SignalRelay per QObject
 152   QHash<QObject*, SignalRelay *> _relayHash;
 153
 154   // RPC function -> (object, slot ID)
 155   typedef QPair<QObject*, int> MethodId;
 156   typedef QMultiHash<QByteArray, MethodId> SlotHash;
 157   SlotHash _attachedSlots;
 158
 159   // slaves for sync
 160   typedef QHash<QString, QObject *> ObjectId;
 161   QHash<QByteArray, ObjectId> _syncSlave;
 162
 163   // Hash of used QIODevices
 164   QHash<QIODevice*, quint32> _peerByteCount;
 165
 166   ProxyMode _proxyMode;
 167
 168   friend class SignalRelay;
 169 };
 170
 171 #endif