berryWorkbenchPlugin.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef BERRYWORKBENCHPLUGIN_H_
#define BERRYWORKBENCHPLUGIN_H_

#include <Poco/Path.h>

#include <berryIExtensionPoint.h>
#include <berryIExtensionRegistry.h>
#include <berryPlatform.h>
#include <berryCoreException.h>

#include "berryAbstractUICTKPlugin.h"
#include "berryPlatformUI.h"
#include "presentations/berryIPresentationFactory.h"


#include "internal/berryViewRegistry.h"
#include "internal/berryEditorRegistry.h"
#include "internal/berryPerspectiveRegistry.h"
#include "internal/intro/berryIntroRegistry.h"

namespace berry {

class QtStyleManager;

class BERRY_UI_QT WorkbenchPlugin : public AbstractUICTKPlugin
{

  Q_OBJECT
  Q_PLUGIN_METADATA(IID "org_blueberry_ui_qt")
  Q_INTERFACES(ctkPluginActivator)

private:

  //static const QString UI_BUNDLE_ACTIVATOR = "org.blueberry.ui.internal.UIPlugin"; //$NON-NLS-1$

  // Default instance of the receiver
  static WorkbenchPlugin* inst;

  // The presentation factory
  IPresentationFactory* presentationFactory;

  // Manager that maps resources to descriptors of editors to use
  EditorRegistry* editorRegistry;

  // The context within which this plugin was started.
  ctkPluginContext* bundleContext;

  // Other data.
  //WorkbenchPreferenceManager preferenceManager;

  ViewRegistry* viewRegistry;

  PerspectiveRegistry* perspRegistry;

  IntroRegistry* introRegistry;

  //SharedImages sharedImages;

  QScopedPointer<QtStyleManager> styleManager;


public:

  static bool DEBUG;

  static char PREFERENCE_PAGE_CATEGORY_SEPARATOR;


  WorkbenchPlugin();

  ~WorkbenchPlugin() override;


  /*
   * Creates an extension.  If the extension plugin has not
   * been loaded a busy cursor will be activated during the duration of
   * the load.
   *
   * @param element the config element defining the extension
   * @param classAttribute the name of the attribute carrying the class
   * @return the extension object
   * @throws CoreException if the extension cannot be created
   */
//    template<class E>
//    static E* CreateExtension(IConfigurationElement::ConstPointer element,
//            const QString& classAttribute) {
//        try {
//            // If plugin has been loaded create extension.
//            // Otherwise, show busy cursor then create extension.
//            if (BundleUtility.isActivated(element.getDeclaringExtension()
//                    .getNamespace())) {
//                return element.createExecutableExtension(classAttribute);
//            }
//            final Object[] ret = new Object[1];
//            final CoreException[] exc = new CoreException[1];
//            BusyIndicator.showWhile(null, new Runnable() {
//                public void run() {
//                    try {
//                        ret[0] = element
//                                .createExecutableExtension(classAttribute);
//                    } catch (CoreException e) {
//                        exc[0] = e;
//                    }
//                }
//            });
//            if (exc[0] != null) {
//        throw exc[0];
//      }
//            return ret[0];
//
//        } catch (CoreException core) {
//            throw core;
//        } catch (Exception e) {
//            throw new CoreException(new Status(IStatus.ERR, PI_WORKBENCH,
//                    IStatus.ERR, WorkbenchMessages.WorkbenchPlugin_extension,e));
//        }
//    }

  static bool HasExecutableExtension(const IConfigurationElement::Pointer& element,
                                     const QString& extensionName);

  static bool IsBundleLoadedForExecutableExtension(
      const IConfigurationElement::Pointer& element, const QString& extensionName);

  static QSharedPointer<ctkPlugin> GetBundleForExecutableExtension(
      const IConfigurationElement::Pointer& element, const QString& extensionName);


  static WorkbenchPlugin* GetDefault();

  std::size_t GetBundleCount();

  IEditorRegistry* GetEditorRegistry();

  IElementFactory* GetElementFactory(const QString& targetID) const;

  IPresentationFactory* GetPresentationFactory();


private:

  template<class C>
  C* CreateExtension(const QString& extensionPointId, const QString& elementName,
                     const QString& targetID)
  {
    IExtensionPoint::Pointer extensionPoint = Platform::GetExtensionRegistry()
        ->GetExtensionPoint(PlatformUI::PLUGIN_ID() + "." + extensionPointId);
    if (extensionPoint == 0)
    {
      WorkbenchPlugin::Log("Unable to find extension. Extension point: " +
                           extensionPointId + " not found");
      return nullptr;
    }

    // Loop through the config elements.
    IConfigurationElement::Pointer targetElement(nullptr);
    QList<IConfigurationElement::Pointer> elements(
          Platform::GetExtensionRegistry()->GetConfigurationElementsFor(PlatformUI::PLUGIN_ID() + "." + extensionPointId));
    for (int j = 0; j < elements.size(); j++)
    {
      if (elementName == "" || elementName == elements[j]->GetName())
      {
        QString strID = elements[j]->GetAttribute("id");
        if (targetID == strID)
        {
            targetElement = elements[j];
            break;
        }
      }
    }
    if (targetElement.IsNull())
    {
      // log it since we cannot safely display a dialog.
      WorkbenchPlugin::Log("Unable to find extension: " + targetID
                           + " in extension point: " + extensionPointId);
      return nullptr;
    }

    // Create the extension.
    try
    {
      return targetElement->CreateExecutableExtension<C>("class");
    }
    catch (const CoreException& /*e*/)
    {
      // log it since we cannot safely display a dialog.
      WorkbenchPlugin::Log("Unable to create extension: " + targetID
                           + " in extension point: " + extensionPointId);
    }
    return nullptr;
  }


public:

  IPerspectiveRegistry* GetPerspectiveRegistry();


  IIntroRegistry* GetIntroRegistry();

  /*
   * Get the preference manager.
   * @return PreferenceManager the preference manager for
   * the receiver.
   */
  //PreferenceManager getPreferenceManager();

  IViewRegistry* GetViewRegistry();


  static void Log(const QString &message);

  static void Log(const ctkException& exc);


  static void Log(const QString &message, const ctkException& t);

  static void Log(const QString &clazz, const QString &methodName, const ctkException& t);

  static void Log(const QString& message, const SmartPointer<IStatus>& status);

  static void Log(const SmartPointer<IStatus>& status);

  /*
   *  (non-Javadoc)
   * @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)
   */
  void start(ctkPluginContext* context) override;


  /*
   * Return an array of all bundles contained in this workbench.
   *
   * @return an array of bundles in the workbench or an empty array if none
   */
  //const QList<IBundle::Pointer> GetBundles();

  ctkPluginContext* GetPluginContext();


  /* (non-Javadoc)
   * @see org.blueberry.ui.plugin.AbstractUICTKPlugin#stop(org.osgi.framework.BundleContext)
   */
  void stop(ctkPluginContext* context) override;


  QString GetDataLocation() const;

};

}

#endif /*BERRYWORKBENCHPLUGIN_H_*/