CTK/Libs/PluginFramework/ctkPluginContext.h

/*=============================================================================

  Library: CTK

  Copyright (c) 2010 German Cancer Research Center,
    Division of Medical and Biological Informatics

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=============================================================================*/

#ifndef CTKPLUGINCONTEXT_H_
#define CTKPLUGINCONTEXT_H_

#include <QHash>
#include <QString>
#include <QVariant>
#include <QUrl>

#include "CTKPluginFrameworkExport.h"


namespace ctk {

  class Plugin;
  class PluginPrivate;
  class ServiceRegistration;
  class ServiceReference;
  class PluginContextPrivate;

  class CTK_PLUGINFW_EXPORT PluginContext
  {

	  Q_DECLARE_PRIVATE(PluginContext)

  public:

    typedef QHash<QString, QVariant> ServiceProperties;

    ~PluginContext();

    Plugin* getPlugin(int id) const;

    QList<Plugin*> getPlugins() const;

    ServiceRegistration registerService(const QStringList& clazzes, QObject* service, const ServiceProperties& properties = ServiceProperties());

    QList<ServiceReference> getServiceReferences(const QString& clazz, const QString& filter = QString());

    ServiceReference getServiceReference(const QString& clazz);

    QObject* getService(const ServiceReference& reference);

    Plugin* installPlugin(const QUrl& location, QIODevice* in = 0);

  protected:

    friend class PluginFrameworkPrivate;

    PluginContext(PluginPrivate* plugin);

    PluginContextPrivate * const d_ptr;
  };

}

#endif /* CTKPLUGINCONTEXT_H_ */