endpoint.h

/*
  endpoint.h

  This file is part of GammaRay, the Qt application inspection and
  manipulation tool.

  Copyright (C) 2013-2015 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
  Author: Volker Krause <volker.krause@kdab.com>

  Licensees holding valid commercial KDAB GammaRay licenses may use this file in
  acuordance with GammaRay Commercial License Agreement provided with the Software.

  Contact info@kdab.com if any conditions of this licensing are not clear to you.

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef GAMMARAY_ENDPOINT_H
#define GAMMARAY_ENDPOINT_H

#include "gammaray_common_export.h"
#include "protocol.h"

#include <QMetaMethod>
#include <QObject>
#include <QPointer>

class QIODevice;
class QUrl;

namespace GammaRay {

class Message;
class PropertySyncer;

class GAMMARAY_COMMON_EXPORT Endpoint : public QObject
{
  Q_OBJECT
public:
  ~Endpoint();

  static void send(const Message &msg);

  static bool isConnected();

  static quint16 defaultPort();
  static quint16 broadcastPort();

  Protocol::ObjectAddress objectAddress(const QString &objectName) const;

  static Endpoint* instance();

  virtual Protocol::ObjectAddress registerObject(const QString &name, QObject *object);

  virtual void invokeObject(const QString &objectName, const char *method, const QVariantList &args = QVariantList()) const;

  void waitForMessagesWritten();

  QString label() const;

  void setLabel(const QString &label);

  virtual bool isRemoteClient() const = 0;

  virtual QUrl serverAddress() const = 0;

  virtual void registerMessageHandler(Protocol::ObjectAddress objectAddress, QObject *receiver, const char* messageHandlerName);

  virtual void unregisterMessageHandler(Protocol::ObjectAddress objectAddress);

public slots:
  void sendMessage(const GammaRay::Message &msg);

signals:
  void disconnected();

  void objectRegistered(const QString &objectName, Protocol::ObjectAddress objectAddress);
  void objectUnregistered(const QString &objectName, Protocol::ObjectAddress objectAddress);

protected:
  Endpoint(QObject* parent = 0);
  void setDevice(QIODevice* device);

  Protocol::ObjectAddress endpointAddress() const;

  virtual void messageReceived(const Message &msg) = 0;

  void addObjectNameAddressMapping(const QString &objectName, Protocol::ObjectAddress objectAddress);
  void removeObjectNameAddressMapping(const QString& objectName);

  virtual void handlerDestroyed(Protocol::ObjectAddress objectAddress, const QString &objectName) = 0;

  virtual void objectDestroyed(Protocol::ObjectAddress objectAddress, const QString &objectName, QObject *object) = 0;

  void dispatchMessage(const GammaRay::Message& msg);

  QVector<QPair<Protocol::ObjectAddress, QString> > objectAddresses() const;

  static Endpoint *s_instance;

  void invokeObjectLocal(QObject *object, const char *method, const QVariantList &args) const;

  PropertySyncer *m_propertySyncer;

private slots:
  void readyRead();
  void connectionClosed();
  void handlerDestroyed(QObject* obj);
  void objectDestroyed(QObject* obj);

private:
  struct ObjectInfo
  {
    ObjectInfo()
      : address(Protocol::InvalidObjectAddress)
      , object(0)
      , receiver(0)
    {
    }
    QString name;
    Protocol::ObjectAddress address;
    // the locally registered object
    QObject *object;

    // custom message handling support
    QObject *receiver;
    QMetaMethod messageHandler;
  };

  void insertObjectInfo(ObjectInfo *oi);
  void removeObjectInfo(ObjectInfo *oi);

  QHash<QString, ObjectInfo*> m_nameMap;
  QHash<Protocol::ObjectAddress, ObjectInfo*> m_addressMap;
  QHash<QObject*, ObjectInfo*> m_objectMap;
  QMultiHash<QObject*, ObjectInfo*> m_handlerMap;

  QPointer<QIODevice> m_socket;
  Protocol::ObjectAddress m_myAddress;

  QString m_label;
};

}

#endif // GAMMARAY_ENDPOINT_H