modernize: Use override instead of virtual

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

diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h
index a1f9e71..935df5e 100644 (file)
--- a/src/common/signalproxy.h
+++ b/src/common/signalproxy.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2013 by the Quassel Project                        *
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -18,29 +18,25 @@
  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef SIGNALPROXY_H
-#define SIGNALPROXY_H
+#pragma once
+
+#include "common-export.h"
 
-#include <QAbstractSocket>
 #include <QEvent>
-#include <QList>
-#include <QHash>
-#include <QVariant>
-#include <QVariantMap>
-#include <QPair>
 #include <QSet>
-#include <QString>
-#include <QByteArray>
-#include <QTimer>
+
+#include <functional>
+#include <initializer_list>
 
 #include "protocol.h"
 
-class QMetaObject;
+struct QMetaObject;
+class QIODevice;
 
 class Peer;
 class SyncableObject;
 
-class SignalProxy : public QObject
+class COMMON_EXPORT SignalProxy : public QObject
 {
     Q_OBJECT
 
@@ -58,7 +54,7 @@ public:
 
     SignalProxy(QObject *parent);
     SignalProxy(ProxyMode mode, QObject *parent);
-    virtual ~SignalProxy();
+    ~SignalProxy() override;
 
     void setProxyMode(ProxyMode mode);
     inline ProxyMode proxyMode() const { return _proxyMode; }
@@ -85,7 +81,46 @@ public:
     bool isSecure() const { return _secure; }
     void dumpProxyStats();
     void dumpSyncMap(SyncableObject *object);
-    inline int peerCount() const { return _peers.size(); }
+
+    static SignalProxy *current();
+
+    /**@{*/
+    /**
+     * This method allows to send a signal only to a limited set of peers
+     * @param peers A list of peers that should receive it
+     * @param closure Code you want to execute within of that restricted environment
+     */
+    void restrictTargetPeers(QSet<Peer*> peers, std::function<void()> closure);
+    void restrictTargetPeers(Peer *peer, std::function<void()> closure) {
+        QSet<Peer*> set;
+        set.insert(peer);
+        restrictTargetPeers(set, std::move(closure));
+    }
+
+    //A better version, but only implemented on Qt5 if Initializer Lists exist
+#ifdef Q_COMPILER_INITIALIZER_LISTS
+    void restrictTargetPeers(std::initializer_list<Peer*> peers, std::function<void()> closure) {
+        restrictTargetPeers(QSet<Peer*>(peers), std::move(closure));
+    }
+#endif
+    /**}@*/
+
+    inline int peerCount() const { return _peerMap.size(); }
+    QVariantList peerData();
+
+    Peer *peerById(int peerId);
+
+    /**
+     * @return If handling a signal, the Peer from which the current signal originates
+     */
+    Peer *sourcePeer();
+    void setSourcePeer(Peer *sourcePeer);
+
+    /**
+     * @return If sending a signal, the Peer to which the current signal is directed
+     */
+    Peer *targetPeer();
+    void setTargetPeer(Peer *targetPeer);
 
 public slots:
     void detachObject(QObject *obj);
@@ -93,7 +128,7 @@ public slots:
     void detachSlots(QObject *receiver);
 
 protected:
-    void customEvent(QEvent *event);
+    void customEvent(QEvent *event) override;
     void sync_call__(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap);
     void renameObject(const SyncableObject *obj, const QString &newname, const QString &oldname);
 
@@ -125,8 +160,14 @@ private:
     void removePeer(Peer *peer);
     void removeAllPeers();
 
+    int nextPeerId() {
+        return _lastPeerId++;
+    }
+
     template<class T>
     void dispatch(const T &protoMessage);
+    template<class T>
+    void dispatch(Peer *peer, const T &protoMessage);
 
     void handle(Peer *peer, const Protocol::SyncMessage &syncMessage);
     void handle(Peer *peer, const Protocol::RpcCall &rpcCall);
@@ -134,10 +175,10 @@ private:
     void handle(Peer *peer, const Protocol::InitData &initData);
 
     template<class T>
-    void handle(Peer *peer, T) { Q_ASSERT(0); }
+    void handle(Peer *, T) { Q_ASSERT(0); }
 
-    bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params, QVariant &returnValue);
-    bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params = QVariantList());
+    bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params, QVariant &returnValue, Peer *peer = nullptr);
+    bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params = QVariantList(), Peer *peer = nullptr);
 
     void requestInit(SyncableObject *obj);
     QVariantMap initData(SyncableObject *obj) const;
@@ -145,7 +186,7 @@ private:
 
     static void disconnectDevice(QIODevice *dev, const QString &reason = QString());
 
-    QSet<Peer *> _peers;
+    QHash<int, Peer*> _peerMap;
 
     // containg a list of argtypes for fast access
     QHash<const QMetaObject *, ExtendedMetaObject *> _extendedMetaObjects;
@@ -168,6 +209,14 @@ private:
 
     bool _secure; // determines if all connections are in a secured state (using ssl or internal connections)
 
+    int _lastPeerId = 0;
+
+    QSet<Peer *> _restrictedTargets;
+    bool _restrictMessageTarget = false;
+
+    Peer *_sourcePeer = nullptr;
+    Peer *_targetPeer = nullptr;
+
     friend class SignalRelay;
     friend class SyncableObject;
     friend class Peer;
@@ -231,5 +280,3 @@ private:
     QHash<QByteArray, int> _methodIds;
     QHash<int, int> _receiveMap; // if slot x is called then hand over the result to slot y
 };
-
-#endif