src/common/syncableobject.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2022 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 { return &staticMetaObject; }                                                 \
  42                                                                                                                                            \
  43 private:
  44
  45 #define SYNC(...) sync_call__(SignalProxy::Server, __func__, __VA_ARGS__);
  46 #define REQUEST(...) sync_call__(SignalProxy::Client, __func__, __VA_ARGS__);
  47
  48 #define SYNC_OTHER(x, ...) sync_call__(SignalProxy::Server, #x, __VA_ARGS__);
  49 #define REQUEST_OTHER(x, ...) sync_call__(SignalProxy::Client, #x, __VA_ARGS__);
  50
  51 #define ARG(x) const_cast<void*>(reinterpret_cast<const void*>(&x))
  52 #define NO_ARG 0
  53
  54 class COMMON_EXPORT SyncableObject : public QObject
  55 {
  56     Q_OBJECT
  57
  58 public:
  59     SyncableObject(QObject* parent = nullptr);
  60     SyncableObject(const QString& objectName, QObject* parent = nullptr);
  61     ~SyncableObject() override;
  62
  63     //! Stores the object's state into a QVariantMap.
  64     /** The default implementation takes dynamic properties as well as getters that have
  65      *  names starting with "init" and stores them in a QVariantMap. Override this method in
  66      *  derived classes in order to store the object state in a custom form.
  67      *  \note  This is used by SignalProxy to transmit the state of the object to clients
  68      *         that request the initial object state. Later updates use a different mechanism
  69      *         and assume that the state is completely covered by properties and init* getters.
  70      *         DO NOT OVERRIDE THIS unless you know exactly what you do!
  71      *
  72      *  \return The object's state in a QVariantMap
  73      */
  74     virtual QVariantMap toVariantMap();
  75
  76     //! Initialize the object's state from a given QVariantMap.
  77     /** \see toVariantMap() for important information concerning this method.
  78      */
  79     virtual void fromVariantMap(const QVariantMap& properties);
  80
  81     virtual bool isInitialized() const;
  82
  83     virtual const QMetaObject* syncMetaObject() const { return metaObject(); }
  84
  85     inline void setAllowClientUpdates(bool allow) { _allowClientUpdates = allow; }
  86     inline bool allowClientUpdates() const { return _allowClientUpdates; }
  87
  88 public slots:
  89     virtual void setInitialized();
  90     void requestUpdate(const QVariantMap& properties);
  91     virtual void update(const QVariantMap& properties);
  92
  93 protected:
  94     void sync_call__(SignalProxy::ProxyMode modeType, const char* funcname, ...) const;
  95
  96 signals:
  97     void initDone();
  98     void updatedRemotely();
  99     void updated();
 100
 101 private:
 102     void synchronize(SignalProxy* proxy);
 103     void stopSynchronize(SignalProxy* proxy);
 104
 105     bool setInitValue(const QString& property, const QVariant& value);
 106
 107 private:
 108     QString _objectName;
 109     bool _initialized{false};
 110     bool _allowClientUpdates{false};
 111
 112     QList<SignalProxy*> _signalProxies;
 113
 114     friend class SignalProxy;
 115 };