src/common/syncableobject.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include "common-export.h"
  24
  25 #include <QDataStream>
  26 #include <QMetaType>
  27 #include <QObject>
  28 #include <QVariantMap>
  29
  30 #include "signalproxy.h"
  31
  32 /**
  33  * This macro needs to be declared in syncable objects, next to the Q_OBJECT macro.
  34  *
  35  * @note: Specializations of a base syncable object for core/client must not use the macro;
  36  *        i.e., if you have Foo, ClientFoo and/or CoreFoo, the SYNCABLE_OBJECT macro would
  37  *        only be declared in the class declaration of Foo.
  38  */
  39 #define SYNCABLE_OBJECT \
  40     public: \
  41         const QMetaObject *syncMetaObject() const final override { \
  42             return &staticMetaObject; \
  43         } \
  44     private: \
  45
  46 #define SYNC(...) sync_call__(SignalProxy::Server, __func__, __VA_ARGS__);
  47 #define REQUEST(...) sync_call__(SignalProxy::Client, __func__, __VA_ARGS__);
  48
  49 #define SYNC_OTHER(x, ...) sync_call__(SignalProxy::Server, #x, __VA_ARGS__);
  50 #define REQUEST_OTHER(x, ...) sync_call__(SignalProxy::Client, #x, __VA_ARGS__);
  51
  52 #define ARG(x) const_cast<void *>(reinterpret_cast<const void *>(&x))
  53 #define NO_ARG 0
  54
  55 class COMMON_EXPORT SyncableObject : public QObject
  56 {
  57     Q_OBJECT
  58
  59 public:
  60     SyncableObject(QObject *parent = nullptr);
  61     SyncableObject(const QString &objectName, QObject *parent = nullptr);
  62     SyncableObject(const SyncableObject &other, QObject *parent = nullptr);
  63     ~SyncableObject() override;
  64
  65     //! Stores the object's state into a QVariantMap.
  66     /** The default implementation takes dynamic properties as well as getters that have
  67      *  names starting with "init" and stores them in a QVariantMap. Override this method in
  68      *  derived classes in order to store the object state in a custom form.
  69      *  \note  This is used by SignalProxy to transmit the state of the object to clients
  70      *         that request the initial object state. Later updates use a different mechanism
  71      *         and assume that the state is completely covered by properties and init* getters.
  72      *         DO NOT OVERRIDE THIS unless you know exactly what you do!
  73      *
  74      *  \return The object's state in a QVariantMap
  75      */
  76     virtual QVariantMap toVariantMap();
  77
  78     //! Initialize the object's state from a given QVariantMap.
  79     /** \see toVariantMap() for important information concerning this method.
  80      */
  81     virtual void fromVariantMap(const QVariantMap &properties);
  82
  83     virtual bool isInitialized() const;
  84
  85     virtual const QMetaObject *syncMetaObject() const { return metaObject(); }
  86
  87     inline void setAllowClientUpdates(bool allow) { _allowClientUpdates = allow; }
  88     inline bool allowClientUpdates() const { return _allowClientUpdates; }
  89
  90 public slots:
  91     virtual void setInitialized();
  92     void requestUpdate(const QVariantMap &properties);
  93     virtual void update(const QVariantMap &properties);
  94
  95 protected:
  96     void sync_call__(SignalProxy::ProxyMode modeType, const char *funcname, ...) const;
  97
  98     void renameObject(const QString &newName);
  99     SyncableObject &operator=(const SyncableObject &other);
 100
 101 signals:
 102     void initDone();
 103     void updatedRemotely();
 104     void updated();
 105
 106 private:
 107     void synchronize(SignalProxy *proxy);
 108     void stopSynchronize(SignalProxy *proxy);
 109
 110     bool setInitValue(const QString &property, const QVariant &value);
 111
 112     bool _initialized;
 113     bool _allowClientUpdates;
 114
 115     QList<SignalProxy *> _signalProxies;
 116
 117     friend class SignalProxy;
 118 };