Clean up

[quassel.git] / src / common / syncableobject.h

diff --git a/src/common/syncableobject.h b/src/common/syncableobject.h
index f89c168..1275cc3 100644 (file)
--- a/src/common/syncableobject.h
+++ b/src/common/syncableobject.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-2015 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -15,49 +15,101 @@
  *   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.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef _SYNCABLEOBJECT_H_
-#define _SYNCABLEOBJECT_H_
+#ifndef SYNCABLEOBJECT_H
+#define SYNCABLEOBJECT_H
 
 #include <QDataStream>
 #include <QMetaType>
 #include <QObject>
 #include <QVariantMap>
 
-class SyncableObject : public QObject {
-  Q_OBJECT
+#include "signalproxy.h"
 
-  public:
+#define SYNCABLE_OBJECT static const int _classNameOffset__;
+#define INIT_SYNCABLE_OBJECT(x) const int x ::_classNameOffset__ = QByteArray(staticMetaObject.className()).length() + 2;
+
+#ifdef Q_CC_MSVC
+#    define SYNC(...) sync_call__(SignalProxy::Server, (__FUNCTION__ + _classNameOffset__), __VA_ARGS__);
+#    define REQUEST(...) sync_call__(SignalProxy::Client, (__FUNCTION__ + _classNameOffset__), __VA_ARGS__);
+#else
+#    define SYNC(...) sync_call__(SignalProxy::Server, __func__, __VA_ARGS__);
+#    define REQUEST(...) sync_call__(SignalProxy::Client, __func__, __VA_ARGS__);
+#endif //Q_CC_MSVC
+
+#define SYNC_OTHER(x, ...) sync_call__(SignalProxy::Server, #x, __VA_ARGS__);
+#define REQUEST_OTHER(x, ...) sync_call__(SignalProxy::Client, #x, __VA_ARGS__);
+
+#define ARG(x) const_cast<void *>(reinterpret_cast<const void *>(&x))
+#define NO_ARG 0
+
+class SyncableObject : public QObject
+{
+    SYNCABLE_OBJECT
+        Q_OBJECT
+
+public:
     SyncableObject(QObject *parent = 0);
+    SyncableObject(const QString &objectName, QObject *parent = 0);
     SyncableObject(const SyncableObject &other, QObject *parent = 0);
+    ~SyncableObject();
 
     //! Stores the object's state into a QVariantMap.
     /** The default implementation takes dynamic properties as well as getters that have
      *  names starting with "init" and stores them in a QVariantMap. Override this method in
      *  derived classes in order to store the object state in a custom form.
-     *  \Note: This is used by SignalProxy to transmit the state of the object to clients
+     *  \note  This is used by SignalProxy to transmit the state of the object to clients
      *         that request the initial object state. Later updates use a different mechanism
      *         and assume that the state is completely covered by properties and init* getters.
      *         DO NOT OVERRIDE THIS unless you know exactly what you do!
+     *
      *  \return The object's state in a QVariantMap
      */
     virtual QVariantMap toVariantMap();
 
     //! Initialize the object's state from a given QVariantMap.
-    /** \see toVarianMap() for important information concerning this method.
+    /** \see toVariantMap() for important information concerning this method.
      */
-    virtual void fromVariantMap(const QVariantMap &map);
+    virtual void fromVariantMap(const QVariantMap &properties);
+
+    virtual bool isInitialized() const;
+
+    virtual const QMetaObject *syncMetaObject() const { return metaObject(); }
+
+    inline void setAllowClientUpdates(bool allow) { _allowClientUpdates = allow; }
+    inline bool allowClientUpdates() const { return _allowClientUpdates; }
+
+public slots:
+    virtual void setInitialized();
+    void requestUpdate(const QVariantMap &properties);
+    virtual void update(const QVariantMap &properties);
+
+protected:
+    void sync_call__(SignalProxy::ProxyMode modeType, const char *funcname, ...) const;
+
+    void renameObject(const QString &newName);
+    SyncableObject &operator=(const SyncableObject &other);
+
+signals:
+    void initDone();
+    void updatedRemotely();
+    void updated();
+
+private:
+    void synchronize(SignalProxy *proxy);
+    void stopSynchronize(SignalProxy *proxy);
 
-  private:
     bool setInitValue(const QString &property, const QVariant &value);
 
-};
+    bool _initialized;
+    bool _allowClientUpdates;
 
-QDataStream &operator<<(QDataStream &out, SyncableObject object);
-QDataStream &operator>>(QDataStream &in, SyncableObject &object);
+    QList<SignalProxy *> _signalProxies;
+
+    friend class SignalProxy;
+};
 
-Q_DECLARE_METATYPE(SyncableObject);
 
 #endif