Finaly got rid of the synchronizers, making Quassel quite a bit more lightweight...
[quassel.git] / src / common / signalproxy.h
index 3e7136a..5001060 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by The Quassel IRC Development Team             *
+ *   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  *
  *   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 _RPCPEER_H_
-#define _RPCPEER_H_
+#ifndef _SIGNALPROXY_H_
+#define _SIGNALPROXY_H_
+
+#include <QList>
+#include <QHash>
+#include <QVariant>
+#include <QVariantMap>
+#include <QPair>
+#include <QString>
+#include <QByteArray>
 
-#include "qxtrpcpeer.h"
-#include <QtCore>
+class SignalRelay;
+class QMetaObject;
 
 class SignalProxy : public QObject {
   Q_OBJECT
 
-  public:
+public:
+  enum ProxyMode {
+    Server,
+    Client
+  };
+
+  enum RequestType {
+    Sync = 0,
+    InitRequest,
+    InitData
+  };
+
+  SignalProxy(QObject *parent);
+  SignalProxy(ProxyMode mode, QObject *parent);
+  SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent);
+  virtual ~SignalProxy();
 
-    enum ProxyType { Client, Server };
+  void setProxyMode(ProxyMode mode);
+  ProxyMode proxyMode() const;
 
-    SignalProxy(ProxyType type, QIODevice *device = 0, QObject *parent = 0);
-    ~SignalProxy();
+  bool addPeer(QIODevice *iodev);
+  void removePeer(QIODevice *iodev = 0);
 
-  ProxyType proxyType() const { return type; }
-    void attachSignal(QObject* sender, const char* signal, const QByteArray& rpcFunction = QByteArray());
-    void 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);
 
-  public slots:
-    void addPeer(QIODevice *device);
+  void synchronize(QObject *obj);
+  void synchronizeAsMaster(QObject *obj);
+  void synchronizeAsSlave(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);
+  
+  static void writeDataToDevice(QIODevice *dev, const QVariant &item);
+  static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item);
 
-    void sendSignal(const char *signal, QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(), QVariant p4 = QVariant(),
-              QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant(), QVariant p8 = QVariant(), QVariant p9 = QVariant());
+  static QString methodBaseName(const QMetaMethod &method);
   
-    //void detachSender();
-    void detachObject(QObject *);
+  const QList<int> &argTypes(QObject *obj, int methodId);
+  const QByteArray &methodName(QObject *obj, int methodId);
+  const QHash<int, 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;
+  };
+
+  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(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 setSyncMap(QObject *obj);
 
-  signals:
-    void peerDisconnected();
+  bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const;
 
-  private slots:
-    void socketDisconnected();
+  void dispatchSignal(QIODevice *receiver, const QVariant &identifier, const QVariantList &params);
+  void dispatchSignal(const QVariant &identifier, 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);
 
-  private:
-    struct Connection {
-      QPointer<QxtRPCPeer> peer;
-      QPointer<QIODevice> device;
-    };
+  bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params);
 
-    struct SignalDesc {
-      QObject *sender;
-      QByteArray signal;
-      QByteArray rpcFunction;
+  QVariantMap initData(QObject *obj) const;
+  void setInitData(QObject *obj, const QVariantMap &properties);
+  bool setInitValue(QObject *obj, const QString &property, const QVariant &value);
 
-      SignalDesc(QObject *sndr, const char *sig, const QByteArray &func) : sender(sndr), signal(sig), rpcFunction(func) {}
-    };
+  void _detachSignals(QObject *sender);
+  void _detachSlots(QObject *receiver);
 
-    struct SlotDesc {
-      QByteArray rpcFunction;
-      QObject *recv;
-      QByteArray slot;
+  // containg a list of argtypes for fast access
+  QHash<const QMetaObject *, ClassInfo*> _classInfo;
 
-      SlotDesc(const QByteArray& func, QObject* r, const char* s) : rpcFunction(func), recv(r), slot(s) {}
-    };
+  // we use one SignalRelay per QObject
+  QHash<QObject*, SignalRelay *> _relayHash;
 
-    ProxyType type;
-    QList<Connection> peers;
-    QList<SignalDesc> attachedSignals;
-    QList<SlotDesc> attachedSlots;
+  // RPC function -> (object, slot ID)
+  typedef QPair<QObject*, int> MethodId;
+  typedef QMultiHash<QByteArray, MethodId> SlotHash;
+  SlotHash _attachedSlots;
 
-};
+  // slaves for sync
+  typedef QHash<QString, QObject *> ObjectId;
+  QHash<QByteArray, ObjectId> _syncSlave;
+
+  // Hash of used QIODevices
+  QHash<QIODevice*, quint32> _peerByteCount;
 
+  ProxyMode _proxyMode;
 
+  friend class SignalRelay;
+};
 
 #endif