mitkBaseApplication.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 mitkBaseApplication_h
#define mitkBaseApplication_h

#include <MitkAppUtilExports.h>

#include <Poco/Util/Application.h>

#include <QString>
#include <QVariant>

class ctkPluginContext;
class ctkPluginFramework;

class QCoreApplication;
class QTranslator;

namespace mitk
{
  class MITKAPPUTIL_EXPORT BaseApplication : public Poco::Util::Application
  {
  public:
    // Command line arguments

    static const QString ARG_APPLICATION;
    static const QString ARG_CLEAN;
    static const QString ARG_CONSOLELOG;
    static const QString ARG_DEBUG;
    static const QString ARG_FORCE_PLUGIN_INSTALL;
    static const QString ARG_HOME;
    static const QString ARG_NEWINSTANCE;
    static const QString ARG_NO_LAZY_REGISTRY_CACHE_LOADING;
    static const QString ARG_NO_REGISTRY_CACHE;
    static const QString ARG_PLUGIN_CACHE;
    static const QString ARG_PLUGIN_DIRS;
    static const QString ARG_PRELOAD_LIBRARY;
    static const QString ARG_PRODUCT;
    static const QString ARG_PROVISIONING;
    static const QString ARG_REGISTRY_MULTI_LANGUAGE;
    static const QString ARG_SPLASH_IMAGE;
    static const QString ARG_STORAGE_DIR;
    static const QString ARG_XARGS;

    // BlueBerry specific plugin framework properties

    static const QString PROP_APPLICATION;
    static const QString PROP_FORCE_PLUGIN_INSTALL;
    static const QString PROP_NEWINSTANCE;
    static const QString PROP_NO_LAZY_REGISTRY_CACHE_LOADING;
    static const QString PROP_NO_REGISTRY_CACHE;
    static const QString PROP_PRODUCT;
    static const QString PROP_REGISTRY_MULTI_LANGUAGE;

    BaseApplication(int argc, char **argv);
    ~BaseApplication() override;

    void initializeQt();

    int run() override;

    void printHelp(const std::string &name, const std::string &value);

    void setApplicationName(const QString &name);
    QString getApplicationName() const;

    void setOrganizationName(const QString &name);
    QString getOrganizationName() const;

    void setOrganizationDomain(const QString &name);
    QString getOrganizationDomain() const;

    void setSingleMode(bool singleMode);
    bool getSingleMode() const;

    void setSafeMode(bool safeMode);
    bool getSafeMode() const;

    void setPreloadLibraries(const QStringList &libraryBaseNames);

    QStringList getPreloadLibraries() const;

    void setProvisioningFilePath(const QString &filePath);

    QString getProvisioningFilePath() const;

    void setProperty(const QString &property, const QVariant &value);
    QVariant getProperty(const QString &property) const;

    void installTranslator(QTranslator*);

    bool isRunning();

    void sendMessage(const QByteArray);

  protected:
    void initialize(Poco::Util::Application &self) override;

    void uninitialize() override;

    int getArgc() const;
    char **getArgv() const;

    virtual QString getCTKFrameworkStorageDir() const;

    virtual void initializeCppMicroServices();

    virtual QCoreApplication *getQApplication() const;

    virtual void initializeLibraryPaths();

    int main(const std::vector<std::string> &args) override;

    void defineOptions(Poco::Util::OptionSet &options) override;

    QSharedPointer<ctkPluginFramework> getFramework() const;
    ctkPluginContext *getFrameworkContext() const;

    QHash<QString, QVariant> getFrameworkProperties() const;

    /*
    * Initialize and display the splash screen if an image filename is given
    *
    */
    void initializeSplashScreen(QCoreApplication * application) const;

private:
    struct Impl;
    Impl* d;
  };
}

#endif // MITKBASEAPPLICATION_H