/***************************************************************************
- * Copyright (C) 2005-2015 by the Quassel Project *
+ * Copyright (C) 2005-2020 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef SYNCABLEOBJECT_H
-#define SYNCABLEOBJECT_H
+#pragma once
+
+#include "common-export.h"
#include <QDataStream>
#include <QMetaType>
#include "signalproxy.h"
-#define SYNCABLE_OBJECT static const int _classNameOffset__;
-#define INIT_SYNCABLE_OBJECT(x) const int x ::_classNameOffset__ = QByteArray(staticMetaObject.className()).length() + 2;
+/**
+ * This macro needs to be declared in syncable objects, next to the Q_OBJECT macro.
+ *
+ * @note: Specializations of a base syncable object for core/client must not use the macro;
+ * i.e., if you have Foo, ClientFoo and/or CoreFoo, the SYNCABLE_OBJECT macro would
+ * only be declared in the class declaration of Foo.
+ */
+#define SYNCABLE_OBJECT \
+public: \
+ const QMetaObject* syncMetaObject() const final override { return &staticMetaObject; } \
+ \
+private:
-#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(...) sync_call__(SignalProxy::Server, __func__, __VA_ARGS__);
+#define REQUEST(...) sync_call__(SignalProxy::Client, __func__, __VA_ARGS__);
#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 ARG(x) const_cast<void*>(reinterpret_cast<const void*>(&x))
#define NO_ARG 0
-class SyncableObject : public QObject
+class COMMON_EXPORT SyncableObject : public QObject
{
- SYNCABLE_OBJECT
- Q_OBJECT
+ Q_OBJECT
public:
- SyncableObject(QObject *parent = 0);
- SyncableObject(const QString &objectName, QObject *parent = 0);
- SyncableObject(const SyncableObject &other, QObject *parent = 0);
- ~SyncableObject();
+ SyncableObject(QObject* parent = nullptr);
+ SyncableObject(const QString& objectName, QObject* parent = nullptr);
+ ~SyncableObject() override;
//! Stores the object's state into a QVariantMap.
/** The default implementation takes dynamic properties as well as getters that have
//! Initialize the object's state from a given QVariantMap.
/** \see toVariantMap() for important information concerning this method.
*/
- virtual void fromVariantMap(const QVariantMap &properties);
+ virtual void fromVariantMap(const QVariantMap& properties);
virtual bool isInitialized() const;
- virtual const QMetaObject *syncMetaObject() const { return metaObject(); }
+ 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);
+ 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);
+ void sync_call__(SignalProxy::ProxyMode modeType, const char* funcname, ...) const;
signals:
void initDone();
void updated();
private:
- void synchronize(SignalProxy *proxy);
- void stopSynchronize(SignalProxy *proxy);
+ void synchronize(SignalProxy* proxy);
+ void stopSynchronize(SignalProxy* proxy);
- bool setInitValue(const QString &property, const QVariant &value);
+ bool setInitValue(const QString& property, const QVariant& value);
- bool _initialized;
- bool _allowClientUpdates;
+private:
+ QString _objectName;
+ bool _initialized{false};
+ bool _allowClientUpdates{false};
- QList<SignalProxy *> _signalProxies;
+ QList<SignalProxy*> _signalProxies;
friend class SignalProxy;
};
-
-
-#endif