tweaking the SignalProxy resulted in some casualties... fixed.\nUpdated and distclean...
[quassel.git] / src / common / signalproxy.h
index ebc4ae7..e5bd0f6 100644 (file)
@@ -1,11 +1,11 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-08 by the Quassel Project                          *
  *   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) any later version.                                   *
+ *   (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        *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
- ***************************************************************************
- *   SignalProxy has been inspired by QxtRPCPeer, part of libqxt,          *
- *   the Qt eXTension Library <http://www.libqxt.org>. We would like to    *
- *   thank Arvid "aep" Picciani and Adam "ahigerd" Higerd for providing    *
- *   QxtRPCPeer, valuable input and the genius idea to (ab)use Qt's        *
- *   Meta Object System for transmitting signals over the network.         *
- *                                                                         *
- *   To make contribution back into libqxt possible, redistribution and    *
- *   modification of this file is additionally allowed under the terms of  *
- *   the Common Public License, version 1.0, as published by IBM.          *
  ***************************************************************************/
 
 #ifndef _SIGNALPROXY_H_
 #include <QList>
 #include <QHash>
 #include <QVariant>
+#include <QVariantMap>
 #include <QPair>
 #include <QString>
 #include <QByteArray>
+#include <QTimer>
 
 class SignalRelay;
+class SyncableObject;
+class QMetaObject;
 
 class SignalProxy : public QObject {
   Q_OBJECT
@@ -49,9 +43,17 @@ public:
     Client
   };
 
-  SignalProxy(QObject* parent);
-  SignalProxy(ProxyMode mode, QObject* parent);
-  SignalProxy(ProxyMode mode, QIODevice* device, QObject* parent);
+  enum RequestType {
+    Sync = 1,
+    RpcCall,
+    InitRequest,
+    InitData,
+    HeartBeat
+  };
+
+  SignalProxy(QObject *parent);
+  SignalProxy(ProxyMode mode, QObject *parent);
+  SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent);
   virtual ~SignalProxy();
 
   void setProxyMode(ProxyMode mode);
@@ -60,29 +62,49 @@ public:
   bool addPeer(QIODevice *iodev);
   void removePeer(QIODevice *iodev = 0);
 
-  bool attachSignal(QObject* sender, const char* signal, const QByteArray& sigName = QByteArray());
-  bool attachSlot(const QByteArray& sigName, 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(SyncableObject *obj);
+
+  void setInitialized(SyncableObject *obj);
+  bool isInitialized(SyncableObject *obj) const;
+  void requestInit(SyncableObject *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(SyncableObject *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);
-  
-  const QList<int> &argTypes(QObject* obj, int methodId);
-  const QByteArray &methodName(QObject* obj, int methodId);
-  
+
+  static QString methodBaseName(const QMetaMethod &method);
+
+  const QList<int> &argTypes(QObject *obj, int methodId);
+  const int &minArgCount(QObject *obj, int methodId);
+  const QByteArray &methodName(QObject *obj, int methodId);
+  const QHash<QByteArray, int> &syncMap(SyncableObject *obj);
+  int updatedRemotelyId(SyncableObject *obj);
+
   typedef QHash<int, QList<int> > ArgHash;
   typedef QHash<int, QByteArray> MethodNameHash;
   struct ClassInfo {
     ArgHash argTypes;
+    QHash<int, int> minArgCount;
     MethodNameHash methodNames;
-    // QHash<int, int> syncMap
+    int updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
+    QHash<QByteArray, int> syncMap;
   };
 
   void dumpProxyStats();
@@ -91,24 +113,52 @@ private slots:
   void dataAvailable();
   void detachSender();
   void removePeerBySender();
+  void objectRenamed(QString oldname, QString newname);
+  void objectRenamed(QByteArray classname, QString oldname, QString newname);
+  void sendHeartBeat();
 
 signals:
-  void peerRemoved(QIODeviceobj);
+  void peerRemoved(QIODevice *obj);
   void connected();
   void disconnected();
+  void objectInitialized(SyncableObject *);
   
 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 setMinArgCount(QObject *obj, int methodId);
+  void setMethodName(QObject *obj, int methodId);
+  void setSyncMap(SyncableObject *obj);
+  void setUpdatedRemotelyId(QObject *obj);
+
+  bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const;
+
+  void dispatchSignal(QIODevice *receiver, const RequestType &requestType, const QVariantList &params);
+  void dispatchSignal(const RequestType &requestType, const QVariantList &params);
+  
+  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 = QVariantList());
 
-  void receivePeerSignal(const QVariant &packedFunc);
+  QVariantMap initData(SyncableObject *obj) const;
+  void setInitData(SyncableObject *obj, const QVariantMap &properties);
 
-  void _detachSignals(QObject *sender);
-  void _detachSlots(QObject *receiver);
+public:
+  void dumpSyncMap(SyncableObject *object);
+  
+private:
+  // Hash of used QIODevices
+  QHash<QIODevice*, quint32> _peerByteCount;
 
   // containg a list of argtypes for fast access
-  QHash<QByteArray, ClassInfo*> _classInfo;
+  QHash<const QMetaObject *, ClassInfo*> _classInfo;
 
   // we use one SignalRelay per QObject
   QHash<QObject*, SignalRelay *> _relayHash;
@@ -117,15 +167,16 @@ private:
   typedef QPair<QObject*, int> MethodId;
   typedef QMultiHash<QByteArray, MethodId> SlotHash;
   SlotHash _attachedSlots;
-  
 
-  // Hash of used QIODevices
-  QHash<QIODevice*, quint32> _peerByteCount;
+  // slaves for sync
+  typedef QHash<QString, SyncableObject *> ObjectId;
+  QHash<QByteArray, ObjectId> _syncSlave;
+
 
   ProxyMode _proxyMode;
+  QTimer _heartBeatTimer;
+  
+  friend class SignalRelay;
 };
 
-
-
-
 #endif