Added some featues to the SignalProxy. Now SyncSlaves can request that objects residi...
[quassel.git] / src / common / signalproxy.h
index 1e013f7..23dbc9f 100644 (file)
-/****************************************************************************
- **
- ** Copyright (C) Qxt Foundation. Some rights reserved.
- **
- ** This file is part of the QxtNetwork module of the Qt eXTension library
- **
- ** This library is free software; you can redistribute it and/or modify it
- ** under the terms of th Common Public License, version 1.0, as published by
- ** IBM.
- **
- ** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY
- ** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY
- ** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR
- ** FITNESS FOR A PARTICULAR PURPOSE.
- **
- ** You should have received a copy of the CPL along with this file.
- ** See the LICENSE file and the cpl1.0.txt file included with the source
- ** distribution for more information. If you did not receive a copy of the
- ** license, contact the Qxt Foundation.
- **
- ** <http://libqxt.sourceforge.net>  <foundation@libqxt.org>
- **
- ****************************************************************************/
+/***************************************************************************
+ *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
+ *   devel@quassel-irc.org                                                 *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) version 3.                                           *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
 
 #ifndef _SIGNALPROXY_H_
 #define _SIGNALPROXY_H_
 
-#include <QObject>
 #include <QList>
 #include <QHash>
 #include <QVariant>
+#include <QVariantMap>
 #include <QPair>
 #include <QString>
 #include <QByteArray>
 
-class ClassIntrospector;
+#include <QMutex>
+
+class SignalRelay;
+class QMetaObject;
 
 class SignalProxy : public QObject {
   Q_OBJECT
 
 public:
-  enum RPCTypes {
+  enum ProxyMode {
     Server,
-    Client,
-    Peer
+    Client
+  };
+
+  enum RequestType {
+    Sync = 0,
+    InitRequest,
+    InitData
   };
 
-  SignalProxy(QObjectparent);
-  SignalProxy(RPCTypes type, QObject* parent);
-  SignalProxy(RPCTypes type, QIODevice* device, QObject* parent);
+  SignalProxy(QObject *parent);
+  SignalProxy(ProxyMode mode, QObject *parent);
+  SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent);
   virtual ~SignalProxy();
 
-  void setRPCType(RPCTypes type);
-  RPCTypes rpcType() const;
+  void setProxyMode(ProxyMode mode);
+  ProxyMode proxyMode() const;
 
-  bool maxPeersReached();
-  
   bool addPeer(QIODevice *iodev);
   void removePeer(QIODevice *iodev = 0);
 
-  bool attachSignal(QObject* sender, const char* signal, const QByteArray& rpcFunction = QByteArray());
-  bool attachSlot(const QByteArray& rpcFunction, QObject* recv, const char* slot);
+  bool attachSignal(QObject *sender, const char *signal, const QByteArray& sigName = QByteArray());
+  bool attachSlot(const QByteArray& sigName, QObject *recv, const char *slot);
+
+  void synchronize(QObject *obj);
+
+  void setInitialized(QObject *obj);
+  bool initialized(QObject *obj);
+  void requestInit(QObject *obj);
 
   void detachObject(QObject *obj);
   void detachSignals(QObject *sender);
   void detachSlots(QObject *receiver);
-  
-  void call(const char *signal , QVariant p1, QVariant p2, QVariant p3, QVariant p4,
-           QVariant p5, QVariant p6, QVariant p7, QVariant p8, QVariant p9);
-  void call(const QByteArray &funcName, const QVariantList &params);
+  void stopSync(QObject *obj);
 
+  //! Writes a QVariant to a device.
+  /** The data item is prefixed with the resulting blocksize,
+   *  so the corresponding function readDataFromDevice() can check if enough data is available
+   *  at the device to reread the item.
+   */
   static void writeDataToDevice(QIODevice *dev, const QVariant &item);
+
+  //! Reads a data item from a device that has been written by writeDataToDevice().
+  /** If not enough data bytes are available, the function returns false and the QVariant reference
+   *  remains untouched.
+   */
   static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item);
+
+  static QString methodBaseName(const QMetaMethod &method);
   
-  const QList<int> &argTypes(QObject* obj, int methodId);
-  const QByteArray &methodName(QObject* obj, int methodId);
-  
+  const QList<int> &argTypes(QObject *obj, int methodId);
+  const QByteArray &methodName(QObject *obj, int methodId);
+  const QHash<QByteArray, int> &syncMap(QObject *obj);
+
   typedef QHash<int, QList<int> > ArgHash;
   typedef QHash<int, QByteArray> MethodNameHash;
   struct ClassInfo {
     ArgHash argTypes;
     MethodNameHash methodNames;
-    // QHash<int, int> syncMap
+    QHash<QByteArray, int> syncMap;
   };
+
+  void dumpProxyStats();
   
 private slots:
   void dataAvailable();
   void detachSender();
   void removePeerBySender();
+  void objectRenamed(QString oldname, QString newname);
+  void objectRenamed(QByteArray classname, QString oldname, QString newname);
 
 signals:
-  void peerRemoved(QIODeviceobj);
+  void peerRemoved(QIODevice *obj);
   void connected();
   void disconnected();
   
 private:
+  void initServer();
+  void initClient();
+  
   void createClassInfo(QObject *obj);
-  void setArgTypes(QObject* obj, int methodId);
-  void setMethodName(QObject* obj, int methodId);
+  void setArgTypes(QObject *obj, int methodId);
+  void setMethodName(QObject *obj, int methodId);
+  void setSyncMap(QObject *obj);
+
+  bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const;
+
+  void dispatchSignal(QIODevice *receiver, const QVariant &identifier, const QVariantList &params);
+  void dispatchSignal(const QVariant &identifier, const QVariantList &params);
   
-  void receivePeerSignal(const QVariant &packedFunc);
+  void receivePeerSignal(QIODevice *sender, const QVariant &packedFunc);
+  void handleSync(QVariantList params);
+  void handleInitRequest(QIODevice *sender, const QVariantList &params);
+  void handleInitData(QIODevice *sender, const QVariantList &params);
+  void handleSignal(const QByteArray &funcName, const QVariantList &params);
+
+  bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params);
+
+  QVariantMap initData(QObject *obj) const;
+  void setInitData(QObject *obj, const QVariantMap &properties);
+  bool setInitValue(QObject *obj, const QString &property, const QVariant &value);
 
   void _detachSignals(QObject *sender);
   void _detachSlots(QObject *receiver);
+  void _stopSync(QObject *obj);
 
-  // containg a list of argtypes for fast access
-  QHash<QByteArray, ClassInfo*> _classInfo;
+  void dumpSyncMap(QObject *object);
   
-  // we use one introSpector per QObject
-  QHash<QObject*, ClassIntrospector*> _specHash;
+  // Hash of used QIODevices
+  QHash<QIODevice*, quint32> _peerByteCount;
+
+  // containg a list of argtypes for fast access
+  QHash<const QMetaObject *, ClassInfo*> _classInfo;
+
+  // we use one SignalRelay per QObject
+  QHash<QObject*, SignalRelay *> _relayHash;
 
   // RPC function -> (object, slot ID)
   typedef QPair<QObject*, int> MethodId;
   typedef QMultiHash<QByteArray, MethodId> SlotHash;
   SlotHash _attachedSlots;
-  
-
-  // Hash of used QIODevices
-  QHash<QIODevice*, quint32> _peerByteCount;
-
-  int _rpcType;
-  int _maxClients;
-};
 
+  // slaves for sync
+  typedef QHash<QString, QObject *> ObjectId;
+  QHash<QByteArray, ObjectId> _syncSlave;
 
 
+  ProxyMode _proxyMode;
+  
+  // the slaveMutex protects both containers:
+  //  - _syncSlaves for sync and init calls
+  //  - _attachedSlots
+  QMutex slaveMutex;
+  
+  friend class SignalRelay;
+};
 
 #endif