modernize: Pass arguments by value and move in constructors

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

diff --git a/src/common/protocol.h b/src/common/protocol.h
index 89625f4..47dabd9 100644 (file)
--- a/src/common/protocol.h
+++ b/src/common/protocol.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,32 +18,181 @@
  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef PROTOCOL_H_
-#define PROTOCOL_H_
+#pragma once
 
 #include <QByteArray>
 #include <QDateTime>
 #include <QVariantList>
+#include <utility>
+
+#include "quassel.h"
 
 namespace Protocol {
 
-enum Handler {
-    SignalProxy
+const quint32 magic = 0x42b33f00;
+
+enum Type {
+    InternalProtocol = 0x00,
+    LegacyProtocol = 0x01,
+    DataStreamProtocol = 0x02
+};
+
+
+enum Feature {
+    Encryption = 0x01,
+    Compression = 0x02
+};
+
+
+enum class Handler {
+    SignalProxy,
+    AuthHandler
+};
+
+
+/*** Handshake, handled by AuthHandler ***/
+
+struct HandshakeMessage {
+    inline Handler handler() const { return Handler::AuthHandler; }
+};
+
+
+struct RegisterClient : public HandshakeMessage
+{
+    inline RegisterClient(Quassel::Features clientFeatures, QString clientVersion, QString buildDate, bool sslSupported = false)
+        : features(std::move(clientFeatures))
+        , clientVersion(std::move(clientVersion))
+        , buildDate(std::move(buildDate))
+        , sslSupported(sslSupported)
+    {}
+
+    Quassel::Features features;
+    QString clientVersion;
+    QString buildDate;
+
+    // this is only used by the LegacyProtocol in compat mode
+    bool sslSupported;
+};
+
+
+struct ClientDenied : public HandshakeMessage
+{
+    inline ClientDenied(QString errorString)
+    : errorString(std::move(errorString)) {}
+
+    QString errorString;
+};
+
+
+struct ClientRegistered : public HandshakeMessage
+{
+    inline ClientRegistered(Quassel::Features coreFeatures, bool coreConfigured, QVariantList backendInfo, QVariantList authenticatorInfo, bool sslSupported)
+        : features(std::move(coreFeatures))
+        , coreConfigured(coreConfigured)
+        , backendInfo(std::move(backendInfo))
+        , authenticatorInfo(std::move(authenticatorInfo))
+        , sslSupported(sslSupported)
+    {}
+
+    Quassel::Features features;
+    bool coreConfigured;
+    QVariantList backendInfo; // TODO: abstract this better
+
+    // The authenticatorInfo should be optional!
+    QVariantList authenticatorInfo;
+
+    // this is only used by the LegacyProtocol in compat mode
+    bool sslSupported;
 };
 
 
+struct SetupData : public HandshakeMessage
+{
+    inline SetupData(QString adminUser, QString adminPassword, QString backend,
+                     QVariantMap setupData, QString authenticator = QString(),
+                     QVariantMap authSetupData = QVariantMap())
+    : adminUser(std::move(adminUser))
+    , adminPassword(std::move(adminPassword))
+    , backend(std::move(backend))
+    , setupData(std::move(setupData))
+    , authenticator(std::move(authenticator))
+    , authSetupData(std::move(authSetupData))
+    {}
+
+    QString adminUser;
+    QString adminPassword;
+    QString backend;
+    QVariantMap setupData;
+    QString authenticator;
+    QVariantMap authSetupData;
+};
+
+
+struct SetupFailed : public HandshakeMessage
+{
+    inline SetupFailed(QString errorString)
+    : errorString(std::move(errorString)) {}
+
+    QString errorString;
+};
+
+
+struct SetupDone : public HandshakeMessage
+{
+    inline SetupDone() {}
+};
+
+
+struct Login : public HandshakeMessage
+{
+    inline Login(QString user, QString password)
+    : user(std::move(user)), password(std::move(password)) {}
+
+    QString user;
+    QString password;
+};
+
+
+struct LoginFailed : public HandshakeMessage
+{
+    inline LoginFailed(QString errorString)
+    : errorString(std::move(errorString)) {}
+
+    QString errorString;
+};
+
+
+struct LoginSuccess : public HandshakeMessage
+{
+    inline LoginSuccess() {}
+};
+
+
+// TODO: more generic format
+struct SessionState : public HandshakeMessage
+{
+    inline SessionState() {} // needed for QMetaType (for the mono client)
+    inline SessionState(QVariantList identities, QVariantList bufferInfos, QVariantList networkIds)
+    : identities(std::move(identities)), bufferInfos(std::move(bufferInfos)), networkIds(std::move(networkIds)) {}
+
+    QVariantList identities;
+    QVariantList bufferInfos;
+    QVariantList networkIds;
+};
+
 /*** handled by SignalProxy ***/
 
 struct SignalProxyMessage
 {
-    inline Handler handler() const { return SignalProxy; }
+    inline Handler handler() const { return Handler::SignalProxy; }
 };
 
 
 struct SyncMessage : public SignalProxyMessage
 {
-    inline SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList &params)
-    : className(className), objectName(objectName), slotName(slotName), params(params) {}
+    SyncMessage() = default;
+    SyncMessage(QByteArray className, QString objectName, QByteArray slotName, QVariantList params)
+        : className(std::move(className)), objectName(std::move(objectName)), slotName(std::move(slotName)), params(std::move(params)) {}
 
     QByteArray className;
     QString objectName;
@@ -54,8 +203,9 @@ struct SyncMessage : public SignalProxyMessage
 
 struct RpcCall : public SignalProxyMessage
 {
-    inline RpcCall(const QByteArray &slotName, const QVariantList &params)
-    : slotName(slotName), params(params) {}
+    RpcCall() = default;
+    RpcCall(QByteArray slotName, QVariantList params)
+        : slotName(std::move(slotName)), params(std::move(params)) {}
 
     QByteArray slotName;
     QVariantList params;
@@ -64,8 +214,9 @@ struct RpcCall : public SignalProxyMessage
 
 struct InitRequest : public SignalProxyMessage
 {
-    inline InitRequest(const QByteArray &className, const QString &objectName)
-    : className(className), objectName(objectName) {}
+    InitRequest() = default;
+    InitRequest(QByteArray className, QString objectName)
+        : className(std::move(className)), objectName(std::move(objectName)) {}
 
     QByteArray className;
     QString objectName;
@@ -74,8 +225,9 @@ struct InitRequest : public SignalProxyMessage
 
 struct InitData : public SignalProxyMessage
 {
-    inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
-    : className(className), objectName(objectName), initData(initData) {}
+    InitData() = default;
+    InitData(QByteArray className, QString objectName, QVariantMap initData)
+        : className(std::move(className)), objectName(std::move(objectName)), initData(std::move(initData)) {}
 
     QByteArray className;
     QString objectName;
@@ -87,7 +239,7 @@ struct InitData : public SignalProxyMessage
 
 struct HeartBeat
 {
-    inline HeartBeat(const QDateTime &timestamp) : timestamp(timestamp) {}
+    inline HeartBeat(QDateTime timestamp) : timestamp(std::move(timestamp)) {}
 
     QDateTime timestamp;
 };
@@ -95,12 +247,16 @@ struct HeartBeat
 
 struct HeartBeatReply
 {
-    inline HeartBeatReply(const QDateTime &timestamp) : timestamp(timestamp) {}
+    inline HeartBeatReply(QDateTime timestamp) : timestamp(std::move(timestamp)) {}
 
     QDateTime timestamp;
 };
 
 
-};
+}
 
-#endif
+// Required for InternalPeer
+Q_DECLARE_METATYPE(Protocol::SyncMessage)
+Q_DECLARE_METATYPE(Protocol::RpcCall)
+Q_DECLARE_METATYPE(Protocol::InitRequest)
+Q_DECLARE_METATYPE(Protocol::InitData)