diff --git a/Applications/CoreApp/CMakeLists.txt b/Applications/CoreApp/CMakeLists.txt index 03e5ec36c2..fee4eb37b2 100644 --- a/Applications/CoreApp/CMakeLists.txt +++ b/Applications/CoreApp/CMakeLists.txt @@ -1,34 +1,37 @@ project(CoreApp) set(_app_options) if(MITK_SHOW_CONSOLE_WINDOW) list(APPEND _app_options SHOW_CONSOLE) endif() # Create a cache entry for the provisioning file which is used to export # the file name in the MITKConfig.cmake file. This will keep external projects # which rely on this file happy. set(MITK_COREAPP_PROVISIONING_FILE "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/MitkCoreApp.provisioning" CACHE INTERNAL "CoreApp provisioning file" FORCE) set(_plugins org.mitk.gui.qt.coreapplication org.mitk.gui.qt.stdmultiwidgeteditor ) # Plug-ins listed below will not be # - added as a build-time dependency to the executable # - listed in the provisioning file for the executable # - installed if they are external plug-ins set(_exclude_plugins ) -FunctionCreateBlueBerryApplication( +mitkFunctionCreateBlueBerryApplication( NAME MitkCoreApp DESCRIPTION "MITK - CoreApp Application" PLUGINS ${_plugins} ${_app_options} ) -mitk_use_modules(TARGET MitkCoreApp PACKAGES Qt4|QtGui Qt5|Widgets) + +mitk_use_modules(TARGET MitkCoreApp + MODULES MitkAppUtil +) # subproject support add_dependencies(MITK-CoreUI MitkCoreApp) diff --git a/Applications/CoreApp/MitkCoreApp.cpp b/Applications/CoreApp/MitkCoreApp.cpp index 437a904e65..e76b6e3517 100644 --- a/Applications/CoreApp/MitkCoreApp.cpp +++ b/Applications/CoreApp/MitkCoreApp.cpp @@ -1,91 +1,42 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ -#include -#include +#include -#include -#include - -class QSafeApplication : public QApplication -{ - -public: - - QSafeApplication(int& argc, char** argv) - : QApplication(argc, argv) - {} - - /** - * Reimplement notify to catch unhandled exceptions and open an error message. - * - * @param receiver - * @param event - * @return - */ - bool notify(QObject* receiver, QEvent* event) - { - QString msg; - try - { - return QApplication::notify(receiver, event); - } catch (Poco::Exception& e) - { - msg = QString::fromStdString(e.displayText()); - } catch (std::exception& e) - { - msg = e.what(); - } catch (...) - { - msg = "Unknown exception"; - } - - QString - text( - "An error occurred. You should save all data and quit the program to prevent possible data loss.\nSee the error log for details.\n\n"); - text += msg; - QMessageBox::critical(0, "Error", text); - return false; - } - -}; +#include +#include int main(int argc, char** argv) { - QSafeApplication safeApp(argc, argv); - safeApp.setApplicationName("MitkCoreApp"); - safeApp.setOrganizationName("DKFZ"); - - // These paths replace the .ini file and are tailored for installation - // packages created with CPack. If a .ini file is presented, it will - // overwrite the settings in MapConfiguration - QDir basePath(QCoreApplication::applicationDirPath()); + mitk::BaseApplication app(argc, argv); - QString provFile = basePath.absoluteFilePath("MitkCoreApp.provisioning"); - - Poco::Util::MapConfiguration* coreConfig(new Poco::Util::MapConfiguration()); - coreConfig->setString(berry::Platform::ARG_PROVISIONING.toStdString(), provFile.toStdString()); - coreConfig->setString(berry::Platform::ARG_APPLICATION.toStdString(), "org.mitk.qt.coreapplication"); + app.setApplicationName("MitkCoreApp"); + app.setOrganizationName("DKFZ"); // Preload the org.mitk.gui.qt.common plug-in (and hence also Qmitk) to speed // up a clean-cache start. This also works around bugs in older gcc and glibc implementations, // which have difficulties with multiple dynamic opening and closing of shared libraries with // many global static initializers. It also helps if dependent libraries have weird static // initialization methods and/or missing de-initialization code. - coreConfig->setString(berry::Platform::ARG_PRELOAD_LIBRARY.toStdString(), "liborg_mitk_gui_qt_common"); + QStringList preloadLibs; + preloadLibs << "liborg_mitk_gui_qt_common"; + app.setPreloadLibraries(preloadLibs); + + app.setProperty(mitk::BaseApplication::PROP_APPLICATION, "org.mitk.qt.coreapplication"); - return berry::Starter::Run(argc, argv, coreConfig); + // Run the workbench + return app.run(); } diff --git a/Applications/Diffusion/CMakeLists.txt b/Applications/Diffusion/CMakeLists.txt index 23510a93b6..1ba585eddd 100644 --- a/Applications/Diffusion/CMakeLists.txt +++ b/Applications/Diffusion/CMakeLists.txt @@ -1,92 +1,92 @@ project(MitkDiffusion) set(DIFFUSIONAPP_NAME MitkDiffusion) set(_app_options) if(MITK_SHOW_CONSOLE_WINDOW) list(APPEND _app_options SHOW_CONSOLE) endif() # Create a cache entry for the provisioning file which is used to export # the file name in the MITKConfig.cmake file. This will keep external projects # which rely on this file happy. set(DIFFUSIONIMAGINGAPP_PROVISIONING_FILE "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${DIFFUSIONAPP_NAME}.provisioning" CACHE INTERNAL "${DIFFUSIONAPP_NAME} provisioning file" FORCE) # should be identical to the list in /CMake/mitkBuildConfigurationmitkDiffusion.cmake # remember to set plugins which should be automatically toggled in target_libraries.cmake set(_plugins org.commontk.configadmin org.commontk.eventadmin org.blueberry.core.runtime org.blueberry.core.expressions org.blueberry.core.commands org.blueberry.ui.qt org.blueberry.ui.qt.log org.blueberry.ui.qt.help org.mitk.core.services org.mitk.gui.common org.mitk.planarfigure org.mitk.core.ext org.mitk.diffusionimaging org.mitk.gui.qt.application org.mitk.gui.qt.ext org.mitk.gui.qt.diffusionimagingapp org.mitk.gui.qt.common org.mitk.gui.qt.stdmultiwidgeteditor org.mitk.gui.qt.common.legacy org.mitk.gui.qt.datamanager org.mitk.gui.qt.measurementtoolbox org.mitk.gui.qt.segmentation org.mitk.gui.qt.volumevisualization org.mitk.gui.qt.diffusionimaging org.mitk.gui.qt.imagenavigator org.mitk.gui.qt.moviemaker org.mitk.gui.qt.basicimageprocessing org.mitk.gui.qt.registration org.mitk.gui.qt.properties org.mitk.gui.qt.viewnavigator org.mitk.gui.qt.cmdlinemodules ) # Plug-ins listed below will not be # - added as a build-time dependency to the executable # - listed in the provisioning file for the executable # - installed if they are external plug-ins set(_exclude_plugins org.blueberry.test org.blueberry.uitest org.mitk.gui.qt.coreapplication org.mitk.gui.qt.extapplication ) set(_src_files MitkDiffusion.cpp ) if(MITK_USE_Qt4) qt4_add_resources(_src_files splashscreen.qrc) else() qt5_add_resources(_src_files splashscreen.qrc) endif() -FunctionCreateBlueBerryApplication( +mitkFunctionCreateBlueBerryApplication( NAME ${DIFFUSIONAPP_NAME} DESCRIPTION "MITK Diffusion" PLUGINS ${_plugins} EXCLUDE_PLUGINS ${_exclude_plugins} SOURCES ${_src_files} ${_app_options} ) -mitk_use_modules(TARGET ${DIFFUSIONAPP_NAME} MODULES qtsingleapplication) +mitk_use_modules(TARGET ${DIFFUSIONAPP_NAME} MODULES MitkAppUtil) # Add meta dependencies (e.g. on auto-load modules from depending modules) if(TARGET ${CMAKE_PROJECT_NAME}-autoload) add_dependencies(${DIFFUSIONAPP_NAME} ${CMAKE_PROJECT_NAME}-autoload) endif() # Add a build time dependency to legacy BlueBerry bundles. if(MITK_MODULES_ENABLED_PLUGINS) add_dependencies(${DIFFUSIONAPP_NAME} ${MITK_MODULES_ENABLED_PLUGINS}) endif() diff --git a/Applications/Diffusion/MitkDiffusion.cpp b/Applications/Diffusion/MitkDiffusion.cpp index a6386e740f..c2a8197d89 100644 --- a/Applications/Diffusion/MitkDiffusion.cpp +++ b/Applications/Diffusion/MitkDiffusion.cpp @@ -1,186 +1,65 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ -#include -#include +#include -#include -#include -#include - -#include +#include #include -#include #include -#include -#include -#include - -class QtSafeApplication : public QtSingleApplication -{ - -public: - - QtSafeApplication(int& argc, char** argv) : QtSingleApplication(argc, argv) - {} - - /** - * Reimplement notify to catch unhandled exceptions and open an error message. - * - * @param receiver - * @param event - * @return - */ - bool notify(QObject* receiver, QEvent* event) - { - QString msg; - try - { - return QApplication::notify(receiver, event); - } - catch (Poco::Exception& e) - { - msg = QString::fromStdString(e.displayText()); - } - catch (std::exception& e) - { - msg = e.what(); - } - catch (...) - { - msg = "Unknown exception"; - } - - QString text("An error occurred. You should save all data and quit the program to " - "prevent possible data loss.\nSee the error log for details.\n\n"); - text += msg; - - QMessageBox::critical(0, "Error", text); - return false; - } - -}; +#include int main(int argc, char** argv) { + mitk::BaseApplication app(argc, argv); - // Create a QApplication instance first - QtSafeApplication qSafeApp(argc, argv); - qSafeApp.setApplicationName("MitkDiffusion"); - qSafeApp.setOrganizationName("DKFZ"); + app.setSingleMode(true); + app.setApplicationName("MitkDiffusion"); + app.setOrganizationName("DKFZ"); + /* bool showSplashScreen(true); - QPixmap pixmap( ":/splash/splashscreen.png" ); - QSplashScreen splash( pixmap ); - splash.setMask( pixmap.mask() ); - splash.setWindowFlags( Qt::SplashScreen | Qt::WindowStaysOnTopHint | Qt::FramelessWindowHint ); + QPixmap pixmap(":/splash/splashscreen.png"); + QSplashScreen splash(pixmap); + splash.setMask(pixmap.mask()); + splash.setWindowFlags(Qt::SplashScreen | Qt::WindowStaysOnTopHint | Qt::FramelessWindowHint); if (showSplashScreen) { splash.show(); - qSafeApp.sendPostedEvents(); - qSafeApp.processEvents(); + app.sendPostedEvents(); + app.processEvents(); qSafeApp.flush(); - QTimer::singleShot(4000, &splash, SLOT(close()) ); + QTimer::singleShot(4000, &splash, SLOT(close())); } - - // This function checks if an instance is already running - // and either sends a message to it (containing the command - // line arguments) or checks if a new instance was forced by - // providing the BlueBerry.newInstance command line argument. - // In the latter case, a path to a temporary directory for - // the new application's storage directory is returned. - QString storageDir = handleNewAppInstance(&qSafeApp, argc, argv, "BlueBerry.newInstance"); - - // These paths replace the .ini file and are tailored for installation - // packages created with CPack. If a .ini file is presented, it will - // overwrite the settings in MapConfiguration - QDir basePath(QCoreApplication::applicationDirPath()); - - QString provFile = basePath.absoluteFilePath("MitkDiffusion.provisioning"); - - Poco::Util::MapConfiguration* diffConfig(new Poco::Util::MapConfiguration()); - if (!storageDir.isEmpty()) - { - diffConfig->setString(berry::Platform::ARG_STORAGE_DIR.toStdString(), storageDir.toUtf8().constData()); - } - - diffConfig->setString(berry::Platform::ARG_PROVISIONING.toStdString(), provFile.toStdString()); - diffConfig->setString(berry::Platform::ARG_APPLICATION.toStdString(), "org.mitk.qt.diffusionimagingapp"); - - QStringList preloadLibs; - + */ // Preload the org.mitk.gui.qt.ext plug-in (and hence also QmitkExt) to speed // up a clean-cache start. This also works around bugs in older gcc and glibc implementations, // which have difficulties with multiple dynamic opening and closing of shared libraries with // many global static initializers. It also helps if dependent libraries have weird static // initialization methods and/or missing de-initialization code. + QStringList preloadLibs; preloadLibs << "liborg_mitk_gui_qt_ext"; + app.setPreloadLibraries(preloadLibs); - QMap preloadLibVersion; - -#ifdef Q_OS_MAC - const QString libSuffix = ".dylib"; -#elif defined(Q_OS_UNIX) - const QString libSuffix = ".so"; -#elif defined(Q_OS_WIN) - const QString libSuffix = ".dll"; -#else - const QString libSuffix; -#endif - - for (QStringList::Iterator preloadLibIter = preloadLibs.begin(), - iterEnd = preloadLibs.end(); preloadLibIter != iterEnd; ++preloadLibIter) - { - QString& preloadLib = *preloadLibIter; - // In case the application is started from an install directory - QString tempLibraryPath = basePath.absoluteFilePath("plugins/" + preloadLib + libSuffix); - QFile preloadLibrary (tempLibraryPath); -#ifdef Q_OS_MAC - if (!preloadLibrary.exists()) - { - // In case the application is started from a build tree - QString relPath = "../../../plugins/" + preloadLib + libSuffix; - tempLibraryPath = QDir::cleanPath(basePath.absoluteFilePath(relPath)); - preloadLibrary.setFileName(tempLibraryPath); - } -#endif - if(preloadLibrary.exists()) - { - preloadLib = tempLibraryPath; - } - // Else fall back to the QLibrary search logic - } - - QString preloadConfig; - Q_FOREACH(const QString& preloadLib, preloadLibs) - { - preloadConfig += preloadLib + preloadLibVersion[preloadLib] + ","; - } - preloadConfig.chop(1); - - diffConfig->setString(berry::Platform::ARG_PRELOAD_LIBRARY.toStdString(), preloadConfig.toStdString()); - - // Seed the random number generator, once at startup. - QTime time = QTime::currentTime(); - qsrand((uint)time.msec()); + app.setProperty(mitk::BaseApplication::PROP_APPLICATION, "org.mitk.qt.diffusionimagingapp"); - return berry::Starter::Run(argc, argv, diffConfig); -} + // Run the workbench. + return app.run(); +} \ No newline at end of file diff --git a/Applications/PluginGenerator/PluginTemplate/CMakeLists.txt b/Applications/PluginGenerator/PluginTemplate/CMakeLists.txt index 78f3b80eff..f859fc08a5 100644 --- a/Applications/PluginGenerator/PluginTemplate/CMakeLists.txt +++ b/Applications/PluginGenerator/PluginTemplate/CMakeLists.txt @@ -1,14 +1,7 @@ project($(plugin-target)) -if(MITK_USE_Qt5) - find_package(Qt5OpenGL REQUIRED) - find_package(Qt5Sql REQUIRED) - find_package(Qt5Widgets REQUIRED) - find_package(Qt5Xml REQUIRED) -endif() - -MACRO_CREATE_MITK_CTK_PLUGIN( +mitk_create_plugin( EXPORT_DIRECTIVE $(plugin-export-directive) EXPORTED_INCLUDE_SUFFIXES src MODULE_DEPENDS MitkQtWidgetsExt ) diff --git a/Applications/PluginGenerator/ProjectTemplate/Apps/TemplateApp/CMakeLists.txt b/Applications/PluginGenerator/ProjectTemplate/Apps/TemplateApp/CMakeLists.txt index 0ceaaca758..da6dfb9f2e 100644 --- a/Applications/PluginGenerator/ProjectTemplate/Apps/TemplateApp/CMakeLists.txt +++ b/Applications/PluginGenerator/ProjectTemplate/Apps/TemplateApp/CMakeLists.txt @@ -1,22 +1,25 @@ set(_app_options) if(${MY_PROJECT_NAME}_SHOW_CONSOLE_WINDOW) list(APPEND _app_options SHOW_CONSOLE) endif() # Plug-ins listed below will not be # - added as a build-time dependency to the executable # - listed in the provisioning file for the executable # - installed if they are external plug-ins set(_exclude_plugins ) -FunctionCreateBlueBerryApplication( +mitkFunctionCreateBlueBerryApplication( NAME ${MY_APP_NAME} DESCRIPTION "MITK - ${MY_APP_NAME} Application" EXCLUDE_PLUGINS ${_exclude_plugins} ${_app_options} ) -mitk_use_modules(TARGET ${MY_APP_NAME} PACKAGES Qt4|QtGui Qt5|Widgets) +mitk_use_modules(TARGET ${MY_APP_NAME} + MODULES MitkAppUtil + PACKAGES Qt4|QtGui Qt5|Widgets +) diff --git a/Applications/PluginGenerator/ProjectTemplate/Apps/TemplateApp/TemplateApp.cpp b/Applications/PluginGenerator/ProjectTemplate/Apps/TemplateApp/TemplateApp.cpp index df01562144..a34db80af4 100644 --- a/Applications/PluginGenerator/ProjectTemplate/Apps/TemplateApp/TemplateApp.cpp +++ b/Applications/PluginGenerator/ProjectTemplate/Apps/TemplateApp/TemplateApp.cpp @@ -1,28 +1,16 @@ $(license) -#include -#include +#include -#include +#include int main(int argc, char** argv) { // Create a QApplication instance first - QApplication myApp(argc, argv); - myApp.setApplicationName("$(project-app-name)"); - myApp.setOrganizationName("$(vendor)"); + mitk::BaseApplication myApp(argc, argv); + myApp.setApplicationName("TestApp"); + myApp.setOrganizationName("DKFZ"); - // These paths replace the .ini file and are tailored for installation - // packages created with CPack. If a .ini file is presented, it will - // overwrite the settings in MapConfiguration - Poco::Path basePath(argv[0]); - basePath.setFileName(""); - - Poco::Path provFile(basePath); - provFile.setFileName("$(project-app-name).provisioning"); - - Poco::Util::MapConfiguration* sbConfig(new Poco::Util::MapConfiguration()); - sbConfig->setString(berry::Platform::ARG_PROVISIONING.toStdString(), provFile.toString()); - sbConfig->setString(berry::Platform::ARG_APPLICATION.toStdString(), "org.mitk.qt.extapplication"); - return berry::Starter::Run(argc, argv, sbConfig); + myApp.setProperty(mitk::BaseApplication::PROP_APPLICATION, "org.mitk.qt.extapplication"); + return myApp.run(); } diff --git a/Applications/Workbench/CMakeLists.txt b/Applications/Solstice/CMakeLists.txt similarity index 50% copy from Applications/Workbench/CMakeLists.txt copy to Applications/Solstice/CMakeLists.txt index 8062a68538..9cc9b05aa8 100644 --- a/Applications/Workbench/CMakeLists.txt +++ b/Applications/Solstice/CMakeLists.txt @@ -1,48 +1,68 @@ -project(Workbench) +project(Solstice) set(_app_options) if(MITK_SHOW_CONSOLE_WINDOW) list(APPEND _app_options SHOW_CONSOLE) endif() -# Create a cache entry for the provisioning file which is used to export -# the file name in the MITKConfig.cmake file. This will keep external projects -# which rely on this file happy. -set(MITK_EXTAPP_PROVISIONING_FILE "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/MitkWorkbench.provisioning" CACHE INTERNAL "MitkWorkbench provisioning file" FORCE) +set(MITK_EXTAPP_PROVISIONING_FILE "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/MitkWorkbench.provisioning") # Plug-ins listed below will not be # - added as a build-time dependency to the executable # - listed in the provisioning file for the executable # - installed if they are external plug-ins set(_exclude_plugins org.blueberry.test org.blueberry.uitest org.mitk.gui.qt.coreapplication org.mitk.gui.qt.diffusionimagingapp ) FunctionCreateBlueBerryApplication( - NAME MitkWorkbench + NAME MitkSolstice DESCRIPTION "MITK Workbench" EXCLUDE_PLUGINS ${_exclude_plugins} ${_app_options} ) -mitk_use_modules(TARGET MitkWorkbench MODULES qtsingleapplication MitkCore) + +add_executable(${OSGI_APP} MACOSX_BUNDLE "src/application/berryMain.cpp") + +target_link_libraries(${OSGI_APP} PRIVATE ${PROJECT_NAME} mbilog) +if(_ctk_test_plugins) + add_dependencies(${OSGI_APP} ${_ctk_test_plugins}) + add_dependencies(BlueBerry ${OSGI_APP}) + set_property(TARGET ${OSGI_APP} APPEND PROPERTY LABELS BlueBerry) +endif() + +configure_file(src/application/solstice.ini + ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${OSGI_APP}.ini) + + +add_executable(${OSGI_UI_APP} MACOSX_BUNDLE "src/application/berryMainUI.cpp") + +target_link_libraries(${OSGI_UI_APP} PRIVATE ${PROJECT_NAME} mbilog) +if(MITK_USE_Qt5) + target_link_libraries(${OSGI_UI_APP} PRIVATE Qt5::Widgets) +endif() + +if(_ctk_test_plugins) + add_dependencies(${OSGI_UI_APP} ${_ctk_test_plugins}) + add_dependencies(BlueBerry ${OSGI_UI_APP}) + set_property(TARGET ${OSGI_UI_APP} APPEND PROPERTY LABELS BlueBerry) +endif() + +configure_file(src/application/solstice.ini + ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${OSGI_UI_APP}.ini) # Add meta dependencies (e.g. on auto-load modules from depending modules) if(TARGET ${CMAKE_PROJECT_NAME}-autoload) add_dependencies(MitkWorkbench ${CMAKE_PROJECT_NAME}-autoload) endif() #Setting application icon for mac os x systems set_target_properties(MitkWorkbench PROPERTIES MACOSX_BUNDLE_ICON_FILE "icon.icns") if(APPLE) install(FILES "icons/icon.icns" DESTINATION "MitkWorkbench.app/Contents/Resources") endif(APPLE) - -# Add a build time dependency to legacy BlueBerry bundles. -if(MITK_MODULES_ENABLED_PLUGINS) - add_dependencies(MitkWorkbench ${MITK_MODULES_ENABLED_PLUGINS}) -endif() diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryMain.cpp b/Applications/Solstice/MitkSolstice.cpp similarity index 100% rename from BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryMain.cpp rename to Applications/Solstice/MitkSolstice.cpp diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/application/solstice.ini b/Applications/Solstice/MitkSolstice.ini similarity index 100% rename from BlueBerry/Bundles/org.blueberry.core.runtime/src/application/solstice.ini rename to Applications/Solstice/MitkSolstice.ini diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryMainUI.cpp b/Applications/Solstice/MitkSolsticeUI.cpp similarity index 100% rename from BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryMainUI.cpp rename to Applications/Solstice/MitkSolsticeUI.cpp diff --git a/Applications/Workbench/CMakeLists.txt b/Applications/Workbench/CMakeLists.txt index 8062a68538..916a1c5730 100644 --- a/Applications/Workbench/CMakeLists.txt +++ b/Applications/Workbench/CMakeLists.txt @@ -1,48 +1,48 @@ project(Workbench) set(_app_options) if(MITK_SHOW_CONSOLE_WINDOW) list(APPEND _app_options SHOW_CONSOLE) endif() # Create a cache entry for the provisioning file which is used to export # the file name in the MITKConfig.cmake file. This will keep external projects # which rely on this file happy. set(MITK_EXTAPP_PROVISIONING_FILE "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/MitkWorkbench.provisioning" CACHE INTERNAL "MitkWorkbench provisioning file" FORCE) # Plug-ins listed below will not be # - added as a build-time dependency to the executable # - listed in the provisioning file for the executable # - installed if they are external plug-ins set(_exclude_plugins org.blueberry.test org.blueberry.uitest org.mitk.gui.qt.coreapplication org.mitk.gui.qt.diffusionimagingapp ) -FunctionCreateBlueBerryApplication( +mitkFunctionCreateBlueBerryApplication( NAME MitkWorkbench DESCRIPTION "MITK Workbench" EXCLUDE_PLUGINS ${_exclude_plugins} ${_app_options} ) -mitk_use_modules(TARGET MitkWorkbench MODULES qtsingleapplication MitkCore) +mitk_use_modules(TARGET MitkWorkbench MODULES MitkAppUtil) # Add meta dependencies (e.g. on auto-load modules from depending modules) if(TARGET ${CMAKE_PROJECT_NAME}-autoload) add_dependencies(MitkWorkbench ${CMAKE_PROJECT_NAME}-autoload) endif() #Setting application icon for mac os x systems set_target_properties(MitkWorkbench PROPERTIES MACOSX_BUNDLE_ICON_FILE "icon.icns") if(APPLE) install(FILES "icons/icon.icns" DESTINATION "MitkWorkbench.app/Contents/Resources") endif(APPLE) # Add a build time dependency to legacy BlueBerry bundles. if(MITK_MODULES_ENABLED_PLUGINS) add_dependencies(MitkWorkbench ${MITK_MODULES_ENABLED_PLUGINS}) endif() diff --git a/Applications/Workbench/MitkWorkbench.cpp b/Applications/Workbench/MitkWorkbench.cpp index 31df068251..e0428a9f86 100644 --- a/Applications/Workbench/MitkWorkbench.cpp +++ b/Applications/Workbench/MitkWorkbench.cpp @@ -1,214 +1,42 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include - -#include -#include - -class QtSafeApplication : public QtSingleApplication -{ - -public: - - QtSafeApplication(int& argc, char** argv) : QtSingleApplication(argc, argv) - {} - - /** - * Reimplement notify to catch unhandled exceptions and open an error message. - * - * @param receiver - * @param event - * @return - */ - bool notify(QObject* receiver, QEvent* event) - { - QString msg; - try - { - return QApplication::notify(receiver, event); - } - catch (mitk::Exception& e) - { - msg = QString("MITK Exception:\n\n") - + QString("Description: ") - + QString(e.GetDescription()) + QString("\n\n") - + QString("Filename: ") + QString(e.GetFile()) + QString("\n\n") - + QString("Line: ") + QString::number(e.GetLine()); - } - catch (Poco::Exception& e) - { - msg = QString::fromStdString(e.displayText()); - } - catch (std::exception& e) - { - msg = e.what(); - } - catch (...) - { - msg = "Unknown exception"; - } - MITK_ERROR << "An error occurred: " << msg.toStdString(); - - QMessageBox msgBox; - msgBox.setText("An error occurred. You should save all data and quit the program to prevent possible data loss."); - msgBox.setDetailedText(msg); - msgBox.setIcon(QMessageBox::Critical); - msgBox.addButton(trUtf8("Exit immediately"), QMessageBox::YesRole); - msgBox.addButton(trUtf8("Ignore"), QMessageBox::NoRole); - - int ret = msgBox.exec(); - - switch(ret) - { - case 0: - MITK_ERROR << "The program was closed."; - this->closeAllWindows(); - break; - case 1: - MITK_ERROR << "The error was ignored by the user. The program may be in a corrupt state and don't behave like expected!"; - break; - } - - return false; - } - -}; +#include +#include int main(int argc, char** argv) { - // Create a QApplication instance first - QtSafeApplication qSafeApp(argc, argv); - qSafeApp.setApplicationName("MITK Workbench"); - qSafeApp.setOrganizationName("DKFZ"); + mitk::BaseApplication app(argc, argv); - // This function checks if an instance is already running - // and either sends a message to it (containing the command - // line arguments) or checks if a new instance was forced by - // providing the BlueBerry.newInstance command line argument. - // In the latter case, a path to a temporary directory for - // the new application's storage directory is returned. - QString storageDir = handleNewAppInstance(&qSafeApp, argc, argv, "BlueBerry.newInstance"); - - if (storageDir.isEmpty()) - { - // This is a new instance and no other instance is already running. We specify - // the storage directory here (this is the same code as in berryInternalPlatform.cpp - // so that we can re-use the location for the persistent data location of the - // the CppMicroServices library. - - // Append a hash value of the absolute path of the executable to the data location. - // This allows to start the same application from different build or install trees. -#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) - storageDir = QStandardPaths::writableLocation(QStandardPaths::DataLocation) + '_'; -#else - storageDir = QDesktopServices::storageLocation(QDesktopServices::DataLocation) + '_'; -#endif - storageDir += QString::number(qHash(QCoreApplication::applicationDirPath())) + QDir::separator(); - } - us::ModuleSettings::SetStoragePath((storageDir + QString("us") + QDir::separator()).toStdString()); - - // These paths replace the .ini file and are tailored for installation - // packages created with CPack. If a .ini file is presented, it will - // overwrite the settings in MapConfiguration - QDir basePath(QCoreApplication::applicationDirPath()); - - QString provFile = basePath.absoluteFilePath("MitkWorkbench.provisioning"); - - Poco::Util::MapConfiguration* extConfig(new Poco::Util::MapConfiguration()); - if (!storageDir.isEmpty()) - { - extConfig->setString(berry::Platform::ARG_STORAGE_DIR.toStdString(), storageDir.toUtf8().constData()); - } - extConfig->setString(berry::Platform::ARG_PROVISIONING.toStdString(), provFile.toStdString()); - extConfig->setString(berry::Platform::ARG_APPLICATION.toStdString(), "org.mitk.qt.extapplication"); - - QStringList preloadLibs; + app.setSingleMode(true); + app.setApplicationName("MITK Workbench"); + app.setOrganizationName("DKFZ"); // Preload the org.mitk.gui.qt.ext plug-in (and hence also QmitkExt) to speed // up a clean-cache start. This also works around bugs in older gcc and glibc implementations, // which have difficulties with multiple dynamic opening and closing of shared libraries with // many global static initializers. It also helps if dependent libraries have weird static // initialization methods and/or missing de-initialization code. + QStringList preloadLibs; preloadLibs << "liborg_mitk_gui_qt_ext"; + app.setPreloadLibraries(preloadLibs); - QMap preloadLibVersion; - -#ifdef Q_OS_MAC - const QString libSuffix = ".dylib"; -#elif defined(Q_OS_UNIX) - const QString libSuffix = ".so"; -#elif defined(Q_OS_WIN) - const QString libSuffix = ".dll"; -#else - const QString libSuffix; -#endif - - for (QStringList::Iterator preloadLibIter = preloadLibs.begin(), - iterEnd = preloadLibs.end(); preloadLibIter != iterEnd; ++preloadLibIter) - { - QString& preloadLib = *preloadLibIter; - // In case the application is started from an install directory - QString tempLibraryPath = basePath.absoluteFilePath("plugins/" + preloadLib + libSuffix); - QFile preloadLibrary (tempLibraryPath); -#ifdef Q_OS_MAC - if (!preloadLibrary.exists()) - { - // In case the application is started from a build tree - QString relPath = "../../../plugins/" + preloadLib + libSuffix; - tempLibraryPath = QDir::cleanPath(basePath.absoluteFilePath(relPath)); - preloadLibrary.setFileName(tempLibraryPath); - } -#endif - if(preloadLibrary.exists()) - { - preloadLib = tempLibraryPath; - } - // Else fall back to the QLibrary search logic - } - - QString preloadConfig; - Q_FOREACH(const QString& preloadLib, preloadLibs) - { - preloadConfig += preloadLib + preloadLibVersion[preloadLib] + ","; - } - preloadConfig.chop(1); - - extConfig->setString(berry::Platform::ARG_PRELOAD_LIBRARY.toStdString(), preloadConfig.toStdString()); - - // Seed the random number generator, once at startup. - QTime time = QTime::currentTime(); - qsrand((uint)time.msec()); + app.setProperty(mitk::BaseApplication::PROP_APPLICATION, "org.mitk.qt.extapplication"); // Run the workbench. - return berry::Starter::Run(argc, argv, extConfig); + return app.run(); } diff --git a/BlueBerry/BlueBerryConfig.cmake.in b/BlueBerry/BlueBerryConfig.cmake.in deleted file mode 100644 index 168d036274..0000000000 --- a/BlueBerry/BlueBerryConfig.cmake.in +++ /dev/null @@ -1,91 +0,0 @@ - -# ------------------------------------------------------------------------- -# Package requirements -# ------------------------------------------------------------------------- - -set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "@BLUEBERRY_SOURCE_DIR@/CMake") - -set(CTK_DIR "@CTK_DIR@") -find_package(CTK REQUIRED) - -set(mbilog_DIR "@mbilog_DIR@") -find_package(mbilog REQUIRED) - -find_package(Poco COMPONENTS Foundation Util XML CONFIG REQUIRED) - -set(DOXYGEN_EXECUTABLE "@DOXYGEN_EXECUTABLE@") -set(DOXYGEN_DOT_EXECUTABLE "@DOXYGEN_DOT_EXECUTABLE@") - -find_package(Doxygen) - - -# ------------------------------------------------------------------------- -# BlueBerry directory vars -# ------------------------------------------------------------------------- - -set(BLUEBERRY_PLUGINS_SOURCE_DIR "@BLUEBERRY_PLUGINS_SOURCE_DIR@") -set(BLUEBERRY_PLUGINS_BINARY_DIR "@BLUEBERRY_PLUGINS_BINARY_DIR@") - -set(BLUEBERRY_PLUGIN_SOURCE_DIRS "@BLUEBERRY_PLUGINS_SOURCE_DIR@") - -set(BLUEBERRY_SOURCE_DIR "@BLUEBERRY_SOURCE_DIR@") -set(BlueBerry_SOURCE_DIR "@BLUEBERRY_SOURCE_DIR@") -set(BLUEBERRY_BINARY_DIR "@BLUEBERRY_BINARY_DIR@") - - -# ------------------------------------------------------------------------- -# BlueBerry CMake file includes -# ------------------------------------------------------------------------- - -set(BLUEBERRY_PLUGIN_USE_FILE @BB_PLUGIN_USE_FILE@) -if(BLUEBERRY_PLUGIN_USE_FILE) - if(EXISTS ${BLUEBERRY_PLUGIN_USE_FILE}) - include(${BLUEBERRY_PLUGIN_USE_FILE}) - endif() -endif() - -if(NOT BB_PLUGIN_EXPORTS_FILE_INCLUDED AND NOT CMAKE_PROJECT_NAME STREQUAL "MITK") - include("@BB_PLUGIN_EXPORTS_FILE@") - set(BB_PLUGIN_EXPORTS_FILE_INCLUDED 1) -endif() - - -# ------------------------------------------------------------------------- -# BlueBerry CMake variables -# ------------------------------------------------------------------------- - -set(BLUEBERRY_DEBUG_POSTFIX @BLUEBERRY_DEBUG_POSTFIX@) - -set(BLUEBERRY_USE_QT_HELP @BLUEBERRY_USE_QT_HELP@) -if(BLUEBERRY_USE_QT_HELP AND DOXYGEN_VERSION VERSION_LESS "1.8.7") - message("Setting BLUEBERRY_USE_QT_HELP to OFF because Doxygen version 1.8.7 or newer not found.") - set(BLUEBERRY_USE_QT_HELP OFF) -endif() - -set(BLUEBERRY_QTPLUGIN_PATH "@BLUEBERRY_QTPLUGIN_PATH@") - -set(QT_HELPGENERATOR_EXECUTABLE "@QT_HELPGENERATOR_EXECUTABLE@") -set(QT_COLLECTIONGENERATOR_EXECUTABLE "@QT_COLLECTIONGENERATOR_EXECUTABLE@") -set(QT_ASSISTANT_EXECUTABLE "@QT_ASSISTANT_EXECUTABLE@") -set(QT_XMLPATTERNS_EXECUTABLE "@QT_XMLPATTERNS_EXECUTABLE@") - -set(BLUEBERRY_PLUGIN_TARGETS @my_plugin_targets@) - -set(BLUEBERRY_PLUGIN_PROVISIONING_FILE "@BLUEBERRY_PROVISIONING_FILE@") - -set(BLUEBERRY_DOXYGEN_TAGFILE_NAME @BLUEBERRY_DOXYGEN_TAGFILE_NAME@) - - -# ------------------------------------------------------------------------- -# BlueBerry CMake macros -# ------------------------------------------------------------------------- - -include(MacroParseArguments) -include(MacroConvertSchema) -include(MacroOrganizeSources) -include(MacroCreateCTKPlugin) -include(MacroCreateQtHelp) -include(MacroInstallCTKPlugin) -include(FunctionInstallThirdPartyCTKPlugins) -include(FunctionCreateProvisioningFile) -include(FunctionCreateBlueBerryApplication) diff --git a/BlueBerry/Bundles/org.blueberry.core.commands/CMakeLists.txt b/BlueBerry/Bundles/org.blueberry.core.commands/CMakeLists.txt deleted file mode 100644 index 73b53dda71..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.commands/CMakeLists.txt +++ /dev/null @@ -1,4 +0,0 @@ -project(org_blueberry_core_commands) - -MACRO_CREATE_CTK_PLUGIN(EXPORT_DIRECTIVE BERRY_COMMANDS - EXPORTED_INCLUDE_SUFFIXES src src/common src/util) diff --git a/BlueBerry/Bundles/org.blueberry.core.expressions/CMakeLists.txt b/BlueBerry/Bundles/org.blueberry.core.expressions/CMakeLists.txt deleted file mode 100644 index 9c6ed4592a..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.expressions/CMakeLists.txt +++ /dev/null @@ -1,4 +0,0 @@ -project(org_blueberry_core_expressions) - -MACRO_CREATE_CTK_PLUGIN(EXPORT_DIRECTIVE BERRY_EXPRESSIONS - EXPORTED_INCLUDE_SUFFIXES src) diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/CMakeLists.txt b/BlueBerry/Bundles/org.blueberry.core.runtime/CMakeLists.txt deleted file mode 100644 index 378e17bfbd..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/CMakeLists.txt +++ /dev/null @@ -1,50 +0,0 @@ -project(org_blueberry_core_runtime) - -set(QT_USE_QTXML 1) - -MACRO_CREATE_CTK_PLUGIN(EXPORT_DIRECTIVE org_blueberry_core_runtime_EXPORT - EXPORTED_INCLUDE_SUFFIXES src - src/application - src/debug - src/dynamichelpers - src/registry -) - -target_link_libraries(${PLUGIN_TARGET} PUBLIC Poco::Foundation Poco::Util Poco::XML) -if(MITK_USE_Qt5) - target_link_libraries(${PLUGIN_TARGET} PRIVATE Qt5::Gui Qt5::Xml) -endif() - -# Set compiler flags -target_compile_definitions(${PLUGIN_TARGET} PUBLIC "$<$:POCO_NO_UNWINDOWS;WIN32_LEAN_AND_MEAN>") - -add_executable(${OSGI_APP} MACOSX_BUNDLE "src/application/berryMain.cpp") - -target_link_libraries(${OSGI_APP} PRIVATE ${PROJECT_NAME} mbilog) -if(_ctk_test_plugins) - add_dependencies(${OSGI_APP} ${_ctk_test_plugins}) - add_dependencies(BlueBerry ${OSGI_APP}) - set_property(TARGET ${OSGI_APP} APPEND PROPERTY LABELS BlueBerry) -endif() - -configure_file(src/application/solstice.ini - ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${OSGI_APP}.ini) - - -add_executable(${OSGI_UI_APP} MACOSX_BUNDLE "src/application/berryMainUI.cpp") - -target_link_libraries(${OSGI_UI_APP} PRIVATE ${PROJECT_NAME} mbilog) -if(MITK_USE_Qt5) - target_link_libraries(${OSGI_UI_APP} PRIVATE Qt5::Widgets) -endif() - -if(_ctk_test_plugins) - add_dependencies(${OSGI_UI_APP} ${_ctk_test_plugins}) - add_dependencies(BlueBerry ${OSGI_UI_APP}) - set_property(TARGET ${OSGI_UI_APP} APPEND PROPERTY LABELS BlueBerry) -endif() - -configure_file(src/application/solstice.ini - ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${OSGI_UI_APP}.ini) - -configure_file("${CMAKE_CURRENT_SOURCE_DIR}/src/berryConfig.h.in" "${CMAKE_CURRENT_BINARY_DIR}/berryConfig.h" @ONLY) diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/plugin.xml b/BlueBerry/Bundles/org.blueberry.core.runtime/plugin.xml deleted file mode 100644 index df15956878..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/plugin.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - - - \ No newline at end of file diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryStarter.cpp b/BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryStarter.cpp deleted file mode 100644 index edf3f318ee..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryStarter.cpp +++ /dev/null @@ -1,210 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ - -#include "berryLog.h" - -#include "berryStarter.h" - -#include "berryPlatform.h" - -#include "internal/berryInternalPlatform.h" - -#include -#include -#include -#include - -#include - -#include - -namespace berry -{ - -const QString Starter::XP_APPLICATIONS = "org.blueberry.osgi.applications"; - -int Starter::Run(int& argc, char** argv, - Poco::Util::AbstractConfiguration* config) -{ - - // The CTK PluginFramework needs a QCoreApplication - if (!qApp) - { - BERRY_FATAL << "No QCoreApplication instance found. You need to create one prior to calling Starter::Run()"; - } - - InternalPlatform* platform = InternalPlatform::GetInstance(); - - int returnCode = 0; - - // startup the internal platform - try - { - platform->Initialize(argc, argv, config); - } - // the Initialize call can throw exceptions so catch them properly - catch( const std::exception& e) - { - BERRY_ERROR << "Caught exception while initializing the Platform : " << e.what(); - BERRY_FATAL << "Platform initialization failed. Aborting... \n"; - return 1; - } - - platform->Launch(); - - - bool consoleLog = platform->ConsoleLog(); - - // Add search paths for Qt plugins - foreach(QString qtPluginPath, Platform::GetProperty(Platform::PROP_QTPLUGIN_PATH).split(';', QString::SkipEmptyParts)) - { - if (QFile::exists(qtPluginPath)) - { - QCoreApplication::addLibraryPath(qtPluginPath); - } - else if (consoleLog) - { - BERRY_WARN << "Qt plugin path does not exist: " << qtPluginPath.toStdString(); - } - } - - // Add a default search path. It is assumed that installed applications - // provide their Qt plugins in that path. - static const QString defaultQtPluginPath = QCoreApplication::applicationDirPath() + "/plugins"; - if (QFile::exists(defaultQtPluginPath)) - { - QCoreApplication::addLibraryPath(defaultQtPluginPath); - } - - if (consoleLog) - { - std::string pathList; - foreach(QString libPath, QCoreApplication::libraryPaths()) - { - pathList += (pathList.empty() ? "" : ", ") + libPath.toStdString(); - } - BERRY_INFO << "Qt library search paths: " << pathList; - } - - // run the application - IExtensionRegistry* service = platform->GetExtensionRegistry(); - if (service == 0) - { - std::string msg = "The extension point service could not be retrieved. This usually indicates that the org.blueberry.core.runtime plug-in could not be loaded."; - platform->GetLogger()->log( - Poco::Message( - "Starter", - msg, - Poco::Message::PRIO_FATAL)); - BERRY_FATAL << msg; - returnCode = 1; - } - else - { - QList extensions( - service->GetConfigurationElementsFor(Starter::XP_APPLICATIONS)); - QList::iterator iter; - - for (iter = extensions.begin(); iter != extensions.end();) - { - if ((*iter)->GetName() != "application") - iter = extensions.erase(iter); - else - ++iter; - } - - std::string argApplication = Platform::GetConfiguration().getString( - Platform::ARG_APPLICATION.toStdString(), ""); - - IApplication* app = 0; - if (extensions.size() == 0) - { - BERRY_FATAL - << "No extensions configured into extension-point '" << Starter::XP_APPLICATIONS << "' found. Aborting.\n"; - returnCode = 0; - } - else if (extensions.size() == 1) - { - if (!argApplication.empty()) - BERRY_INFO(consoleLog) - << "One '" << Starter::XP_APPLICATIONS << "' extension found, ignoring " - << Platform::ARG_APPLICATION << " argument.\n"; - QList runs( - extensions[0]->GetChildren("run")); - app = runs.front()->CreateExecutableExtension("class"); - } - else - { - if (argApplication.empty()) - { - BERRY_WARN << "You must provide an application id via \"" - << Platform::ARG_APPLICATION << "=\""; - BERRY_INFO << "Possible application ids are:"; - for (iter = extensions.begin(); iter != extensions.end(); ++iter) - { - QString appid = (*iter)->GetAttribute("id"); - if (!appid.isEmpty()) - { - BERRY_INFO << appid.toStdString(); - } - } - returnCode = 0; - } - else - { - for (iter = extensions.begin(); iter != extensions.end(); ++iter) - { - BERRY_INFO(consoleLog) << "Checking applications extension from: " - << (*iter)->GetContributor()->GetName().toStdString() << std::endl; - - QString appid = (*iter)->GetAttribute("id"); - if (!appid.isNull()) - { - BERRY_INFO(consoleLog) << "Found id: " << appid.toStdString() << std::endl; - if (!appid.isEmpty() && appid == QString::fromStdString(argApplication)) - { - QList runs((*iter)->GetChildren("run")); - app = runs.front()->CreateExecutableExtension("class"); - break; - } - } - else - { - BERRY_ERROR << "missing attribute: id"; - } - } - } - } - - if (app == 0) - { - BERRY_ERROR - << "Could not create executable application extension for id: " - << argApplication << std::endl; - returnCode = 1; - } - else - { - returnCode = app->Start(); - delete app; - } - } - - platform->Shutdown(); - return returnCode; -} - -} diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryStarter.h b/BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryStarter.h deleted file mode 100644 index 88e051663e..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/src/application/berryStarter.h +++ /dev/null @@ -1,42 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ - -#ifndef BERRYSTARTER_H_ -#define BERRYSTARTER_H_ - -#include - -#include "berryPlatform.h" -#include - -#include - -namespace berry { - -class org_blueberry_core_runtime_EXPORT Starter -{ - -public: - - static const QString XP_APPLICATIONS; - - static int Run(int& argc, char** argv, Poco::Util::AbstractConfiguration* config = 0); - -}; - -} - -#endif /*BERRYSTARTER_H_*/ diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/berryPlatform.cpp b/BlueBerry/Bundles/org.blueberry.core.runtime/src/berryPlatform.cpp deleted file mode 100644 index 8423167ca1..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/src/berryPlatform.cpp +++ /dev/null @@ -1,257 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ - -#include - - -#include "berryPlatform.h" -#include "internal/berryInternalPlatform.h" -#include "internal/berryIRuntimeConstants.h" - -namespace berry { - -const QString Platform::PI_RUNTIME = IRuntimeConstants::PI_RUNTIME(); - -int Platform::OS_FREE_BSD = BERRY_OS_FREE_BSD; -int Platform::OS_AIX = BERRY_OS_AIX; -int Platform::OS_HPUX = BERRY_OS_HPUX; -int Platform::OS_TRU64 = BERRY_OS_TRU64; -int Platform::OS_LINUX = BERRY_OS_LINUX; -int Platform::OS_MAC_OS_X = BERRY_OS_MAC_OS_X; -int Platform::OS_NET_BSD = BERRY_OS_NET_BSD; -int Platform::OS_OPEN_BSD = BERRY_OS_OPEN_BSD; -int Platform::OS_IRIX = BERRY_OS_IRIX; -int Platform::OS_SOLARIS = BERRY_OS_SOLARIS; -int Platform::OS_QNX = BERRY_OS_QNX; -int Platform::OS_VXWORKS = BERRY_OS_VXWORKS; -int Platform::OS_CYGWIN = BERRY_OS_CYGWIN; -int Platform::OS_UNKNOWN_UNIX = BERRY_OS_UNKNOWN_UNIX; -int Platform::OS_WINDOWS_NT = BERRY_OS_WINDOWS_NT; -int Platform::OS_WINDOWS_CE = BERRY_OS_WINDOWS_CE; -int Platform::OS_VMS = BERRY_OS_VMS; - -int Platform::ARCH_ALPHA = BERRY_ARCH_ALPHA; -int Platform::ARCH_IA32 = BERRY_ARCH_IA32; -int Platform::ARCH_IA64 = BERRY_ARCH_IA64; -int Platform::ARCH_MIPS = BERRY_ARCH_MIPS; -int Platform::ARCH_HPPA = BERRY_ARCH_HPPA; -int Platform::ARCH_PPC = BERRY_ARCH_PPC; -int Platform::ARCH_POWER = BERRY_ARCH_POWER; -int Platform::ARCH_SPARC = BERRY_ARCH_SPARC; -int Platform::ARCH_AMD64 = BERRY_ARCH_AMD64; -int Platform::ARCH_ARM = BERRY_ARCH_ARM; - -QString Platform::PROP_QTPLUGIN_PATH = "BlueBerry.qtplugin_path"; - -QString Platform::ARG_NEWINSTANCE = "BlueBerry.newInstance"; -QString Platform::ARG_CLEAN = "BlueBerry.clean"; -QString Platform::ARG_APPLICATION = "BlueBerry.application"; -QString Platform::ARG_HOME = "BlueBerry.home"; -QString Platform::ARG_STORAGE_DIR = "BlueBerry.storageDir"; -QString Platform::ARG_PLUGIN_CACHE = "BlueBerry.plugin_cache_dir"; -QString Platform::ARG_PLUGIN_DIRS = "BlueBerry.plugin_dirs"; -QString Platform::ARG_FORCE_PLUGIN_INSTALL = "BlueBerry.forcePlugins"; -QString Platform::ARG_PRELOAD_LIBRARY = "BlueBerry.preloadLibrary"; -QString Platform::ARG_PROVISIONING = "BlueBerry.provisioning"; -QString Platform::ARG_DEBUG = "BlueBerry.debug"; -QString Platform::ARG_CONSOLELOG = "BlueBerry.consoleLog"; -QString Platform::ARG_TESTPLUGIN = "BlueBerry.testplugin"; -QString Platform::ARG_TESTAPPLICATION = "BlueBerry.testapplication"; - -QString Platform::ARG_NO_REGISTRY_CACHE = "BlueBerry.noRegistryCache"; -QString Platform::ARG_NO_LAZY_REGISTRY_CACHE_LOADING = "BlueBerry.noLazyRegistryCacheLoading"; -QString Platform::ARG_REGISTRY_MULTI_LANGUAGE = "BlueBerry.registryMultiLanguage"; - -QString Platform::ARG_XARGS = "xargs"; - -QDir Platform::GetConfigurationPath() -{ - return InternalPlatform::GetInstance()->GetConfigurationPath(); -} - -IAdapterManager* Platform::GetAdapterManager() -{ - return InternalPlatform::GetInstance()->GetAdapterManager(); -} - -IExtensionRegistry *Platform::GetExtensionRegistry() -{ - return InternalPlatform::GetInstance()->GetExtensionRegistry(); -} - -IPreferencesService *Platform::GetPreferencesService() -{ - return InternalPlatform::GetInstance()->GetPreferencesService(); -} - -//PlatformEvents& Platform::GetEvents() -//{ -// return InternalPlatform::GetInstance()->GetEvents(); -//} - -QDir Platform::GetInstallPath() -{ - return InternalPlatform::GetInstance()->GetInstallPath(); -} - -QDir Platform::GetInstancePath() -{ - return InternalPlatform::GetInstance()->GetInstancePath(); -} - -int Platform::GetOS() -{ - return BERRY_OS; -} - -int Platform::GetOSArch() -{ - return BERRY_ARCH; -} - -bool Platform::IsUnix() -{ -#ifdef BERRY_OS_FAMILY_UNIX - return true; -#else - return false; -#endif -} - -bool Platform::IsWindows() -{ -#ifdef BERRY_OS_FAMILY_WINDOWS - return true; -#else - return false; -#endif -} - -bool Platform::IsBSD() -{ -#ifdef BERRY_OS_FAMILY_BSD - return true; -#else - return false; -#endif -} - -bool Platform::IsLinux() -{ -#ifdef BERRY_OS_FAMILY_LINUX - return true; -#else - return false; -#endif -} - -bool Platform::IsVMS() -{ -#ifdef BERRY_OS_FAMILY_VMS - return true; -#else - return false; -#endif -} - -bool Platform::GetStatePath(QDir& statePath, const QSharedPointer& plugin, bool create) -{ - return InternalPlatform::GetInstance()->GetStatePath(statePath, plugin, create); -} - -QDir Platform::GetUserPath() -{ - return InternalPlatform::GetInstance()->GetUserPath(); -} - -QString Platform::GetProperty(const QString& key) -{ - if (!GetConfiguration().hasProperty(key.toStdString())) return QString::null; - return QString::fromStdString(GetConfiguration().getString(key.toStdString(), "")); -} - -bool Platform::IsRunning() -{ - return InternalPlatform::GetInstance()->IsRunning(); -} - -int& Platform::GetRawApplicationArgs(char**& argv) -{ - return InternalPlatform::GetInstance()->GetRawApplicationArgs(argv); -} - -QStringList Platform::GetApplicationArgs() -{ - return InternalPlatform::GetInstance()->GetApplicationArgs(); -} - -QString Platform::GetExtendedApplicationArgs() -{ - return QString::fromStdString(InternalPlatform::GetInstance()->GetConfiguration().getString(ARG_XARGS.toStdString(), "")); -} - -void Platform::GetOptionSet(Poco::Util::OptionSet& os) -{ - InternalPlatform::GetInstance()->defineOptions(os); -} - -Poco::Util::LayeredConfiguration& Platform::GetConfiguration() -{ - return InternalPlatform::GetInstance()->GetConfiguration(); -} - -QSharedPointer Platform::GetCTKPlugin(const QString& symbolicName) -{ - QList > plugins = - InternalPlatform::GetInstance()->GetCTKPluginFrameworkContext()->getPlugins(); - - foreach(QSharedPointer plugin, plugins) - { - if (plugin->getSymbolicName() == symbolicName) - return plugin; - } - return QSharedPointer(0); -} - -QSharedPointer Platform::GetCTKPlugin(long id) -{ - return InternalPlatform::GetInstance()->GetCTKPluginFrameworkContext()->getPlugin(id); -} - -QSharedPointer Platform::GetPlugin(const QString& symbolicName) -{ - return InternalPlatform::GetInstance()->GetPlugin(symbolicName); -} - -QList > Platform::GetPlugins(const QString& symbolicName, - const QString& version) -{ - return InternalPlatform::GetInstance()->GetPlugins(symbolicName, version); -} - -QVariant berry::Platform::GetDebugOption(const QString& option) -{ - return InternalPlatform::GetInstance()->GetOption(option); -} - -IProduct* berry::Platform::GetProduct() -{ - //TODO - //return InternalPlatform::GetDefault()->GetProduct(); - return nullptr; -} - -} diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/debug/berryDebugOptionsListener.cpp b/BlueBerry/Bundles/org.blueberry.core.runtime/src/debug/berryDebugOptionsListener.cpp deleted file mode 100644 index 152bf5bccc..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/src/debug/berryDebugOptionsListener.cpp +++ /dev/null @@ -1,25 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ - -#include "berryDebugOptionsListener.h" - -namespace berry { - -DebugOptionsListener::~DebugOptionsListener() -{ -} - -} diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/debug/berryDebugOptionsListener.h b/BlueBerry/Bundles/org.blueberry.core.runtime/src/debug/berryDebugOptionsListener.h deleted file mode 100644 index 5c67ce6ff3..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/src/debug/berryDebugOptionsListener.h +++ /dev/null @@ -1,85 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ - -#ifndef BERRYDEBUGOPTIONSLISTENER_H -#define BERRYDEBUGOPTIONSLISTENER_H - -#include - -#include - -namespace berry { - -class DebugOptions; - -/** - * A debug options listener is notified whenever one of its plug-in option-path entries is - * changed. A listener is registered as a service using the DebugOptions#LISTENER_SYMBOLICNAME - * service property to specify the symbolic name of the debug options listener. - *

- * The DebugOptionsListener#OptionsChanged(const DebugOptions&) method will automatically - * be called upon registration of the debug options listener service. This allows the - * listener to obtain the initial debug options. This initial call to the listener - * will happen even if debug is not enabled at the time of registration - * DebugOptions#IsDebugEnabled() will return false in this case). - *

- * A debug options listener allows a plug-in to cache trace option values in boolean fields for performance - * and code cleanliness. For example: - * 
- * class Activator : ctkPluginActivator, DebugOptionsListener
- * {
- *   static bool DEBUG = false;
- *
- *   void Start(ctkPluginContext* context)
- *   {
- *     ctkDictionary props;
- *     props.insert(DebugOptions::LISTENER_SYMBOLICNAME, "com.mycompany.mybundle");
- *     context->registerService(this, props);
- *   }
- *
- *   void OptionsChanged(const DebugOptions& options)
- *   {
- *     DEBUG = options->GetBooleanOption("com.mycompany.mybundle/debug", false);
- *   }
- *
- *   void DoSomeWork()
- *   {
- *     if (DEBUG) BERRY_INFO << "foo";
- *   }
- *   ...
- * }
- *
- */ -struct org_blueberry_core_runtime_EXPORT DebugOptionsListener -{ - virtual ~DebugOptionsListener(); - - /** - * Notifies this listener that an option-path for its plug-in has changed. - * This method is also called initially by the DebugOptions implementation - * when the listener is registered as a service. This allows the listener - * to obtain the initial set of debug options without the need to - * acquire the debug options service. - * @param options a reference to the DebugOptions - */ - virtual void OptionsChanged(const DebugOptions& options) = 0; -}; - -} - -Q_DECLARE_INTERFACE(berry::DebugOptionsListener, "org.blueberry.DebugOptionsListener") - -#endif // BERRYDEBUGOPTIONSLISTENER_H diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/debug/berryIDebugOptions.h b/BlueBerry/Bundles/org.blueberry.core.runtime/src/debug/berryIDebugOptions.h deleted file mode 100644 index 8e55c6ec83..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/src/debug/berryIDebugOptions.h +++ /dev/null @@ -1,178 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ - -#ifndef BERRYIDEBUGOPTIONS_H -#define BERRYIDEBUGOPTIONS_H - -#include - -#include -#include -#include - -namespace berry { - -/** - * Used to get debug options settings. - */ -struct org_blueberry_core_runtime_EXPORT IDebugOptions -{ - - virtual ~IDebugOptions(); - - /** - * The service property (named "listener.symbolic.name") which specifies - * the bundle symbolic name of a {@link DebugOptionsListener} service. - */ - static const QString LISTENER_SYMBOLICNAME; // = "listener.symbolic.name"; - - /** - * Returns the identified option as a boolean value. The specified - * defaultValue is returned if no such option is found or if debug is not enabled. - * - *

- * Options are specified in the general form <Plugin-SymbolicName>/<option-path>. - * For example, org.blueberry.core.runtime/debug - *

- * - * @param option the name of the option to lookup - * @param defaultValue the value to return if no such option is found - * @return the value of the requested debug option or the - * defaultValue if no such option is found. - */ - virtual bool GetBooleanOption(const QString& option, bool defaultValue) const = 0; - - /** - * Returns the identified option. A null value - * is returned if no such option is found or if debug is not enabled. - * - *

- * Options are specified - * in the general form <Plugin-SymbolicName>/<option-path>. - * For example, org.blueberry.core.runtime/debug - *

- * - * @param option the name of the option to lookup - * @return the value of the requested debug option or null - */ - virtual QVariant GetOption(const QString& option) const = 0; - - /** - * Returns the identified option. The specified defaultValue is - * returned if no such option is found or if debug is not enabled. - * - *

- * Options are specified - * in the general form <Plugin-SymbolicName>/<option-path>. - * For example, org.blueberry.core.runtime/debug - *

- * - * @param option the name of the option to lookup - * @param defaultValue the value to return if no such option is found - * @return the value of the requested debug option or the - * defaultValue if no such option is found. - */ - virtual QVariant GetOption(const QString& option, const QVariant& defaultValue) const = 0; - - /** - * Returns the identified option as an int value. The specified - * defaultValue is returned if no such option is found or if an - * error occurs while converting the option value - * to an integer or if debug is not enabled. - * - *

- * Options are specified - * in the general form <Plugin-SymbolicName>/<option-path>. - * For example, org.blueberry.core.runtime/debug - *

- * - * @param option the name of the option to lookup - * @param defaultValue the value to return if no such option is found - * @return the value of the requested debug option or the - * defaultValue if no such option is found. - */ - virtual int GetIntegerOption(const QString& option, int defaultValue) const = 0; - - /** - * Returns a snapshot of the current options. All - * keys and values are of type string. If no - * options are set then an empty map is returned. - *

- * If debug is not enabled then the snapshot of the current disabled - * values is returned. See SetDebugEnabled(bool). - *

- * @return a snapshot of the current options. - */ - virtual QHash GetOptions() const = 0; - - /** - * Sets the identified option to the identified value. If debug is - * not enabled then the specified option is not changed. - * @param option the name of the option to set - * @param value the value of the option to set - */ - virtual void SetOption(const QString& option, const QVariant& value) = 0; - - /** - * Sets the current option key/value pairs to the specified options. - * The specified map replaces all keys and values of the current debug options. - *

- * If debug is not enabled then the specified options are saved as - * the disabled values and no notifications will be sent. - * See SetDebugEnabled(bool). - * If debug is enabled then notifications will be sent to the - * listeners which have options that have been changed, added or removed. - *

- * - * @param options the new set of options - */ - virtual void SetOptions(const QHash& ops) = 0; - - /** - * Removes the identified option. If debug is not enabled then - * the specified option is not removed. - * @param option the name of the option to remove - */ - virtual void RemoveOption(const QString& option) = 0; - - /** - * Returns true if debugging/tracing is currently enabled. - * @return true if debugging/tracing is currently enabled; Otherwise false is returned. - */ - virtual bool IsDebugEnabled() const = 0; - - /** - * Enables or disables debugging/tracing. - *

- * When debug is disabled all debug options are unset. - * When disabling debug the current debug option values are - * stored in memory as disabled values. If debug is re-enabled the - * disabled values will be set back and enabled. The disabled values - * are only stored in memory and if the framework is restarted then - * the disabled option values will be lost. - *

- * @param value If true, debug is enabled, otherwise - * debug is disabled. - */ - virtual void SetDebugEnabled(bool enabled) = 0; - -}; - -} - -Q_DECLARE_INTERFACE(berry::IDebugOptions, "org.blueberry.IDebugOptions") - -#endif // BERRYIDEBUGOPTIONS_H diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/internal/berryDebugOptions.cpp b/BlueBerry/Bundles/org.blueberry.core.runtime/src/internal/berryDebugOptions.cpp deleted file mode 100644 index cf1691e561..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/src/internal/berryDebugOptions.cpp +++ /dev/null @@ -1,350 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ - -#include "berryDebugOptions.h" - -#include -#include - -#include -#include - -#include -#include -#include -#if (QT_VERSION < QT_VERSION_CHECK(5,0,0)) -#include -#else -#include -#endif - -namespace berry { - - -const QString DebugOptions::BLUEBERRY_DEBUG = "blueberry.debug"; -const QString DebugOptions::OPTIONS = ".blueberry.options"; - - -DebugOptions::DebugOptions() - : enabled(false) - , context(nullptr) -{ - // if no debug option was specified, don't even bother to try. - // Must ensure that the options slot is null as this is the signal to the - // platform that debugging is not enabled. - QString debugOptionsFilename = Platform::GetProperty(BLUEBERRY_DEBUG); - if (debugOptionsFilename.isNull()) return; - - if (debugOptionsFilename.isEmpty()) - { - // default options location is user.dir (install location may be r/o so - // is not a good candidate for a trace options that need to be updatable by - // by the user) -#if (QT_VERSION < QT_VERSION_CHECK(5,0,0)) - QDir userDir(QDesktopServices::storageLocation(QDesktopServices::HomeLocation)); -#else - QDir userDir(QStandardPaths::standardLocations(QStandardPaths::HomeLocation).front()); -#endif - debugOptionsFilename = userDir.absoluteFilePath(OPTIONS); - } - QFile optionsFile(debugOptionsFilename); - QString msgState; - if (!optionsFile.exists()) - { - msgState = "not found"; - } - else - { - QSettings settings(debugOptionsFilename, QSettings::IniFormat); - if (settings.status() != QSettings::NoError) - { - msgState = ".... did not parse"; - } - else - { - foreach (const QString& key, settings.allKeys()) - { - this->options.insert(key, settings.value(key)); - } - this->enabled = true; - } - } - BERRY_INFO << "Debug options:\n " << optionsFile.fileName() << " " << msgState; -} - -void DebugOptions::Start(ctkPluginContext* pc) -{ - this->context = pc; - this->listenerTracker.reset(new ctkServiceTracker(pc, this)); - this->listenerTracker->open(); -} - -void DebugOptions::Stop(ctkPluginContext* /*pc*/) -{ - this->listenerTracker->close(); - this->listenerTracker.reset(); - this->context = nullptr; -} - -bool DebugOptions::GetBooleanOption(const QString& option, bool defaultValue) const -{ - return this->GetOption(option, defaultValue).toBool(); -} - -QVariant DebugOptions::GetOption(const QString& option) const -{ - return GetOption(option, QVariant()); -} - -QVariant DebugOptions::GetOption(const QString& option, const QVariant& defaultValue) const -{ - QMutexLocker lock(&this->mutex); - return this->options.value(option, defaultValue); -} - -int DebugOptions::GetIntegerOption(const QString& option, int defaultValue) const -{ - return this->options.value(option, defaultValue).toInt(); -} - -QHash DebugOptions::GetOptions() const -{ - QHash snapShot; - { - QMutexLocker lock(&this->mutex); - if (this->IsDebugEnabled()) - { - snapShot = this->options; - } - else - { - snapShot = this->disabledOptions; - } - } - return snapShot; -} - -void DebugOptions::SetOption(const QString& option, const QVariant& value) -{ - if (!this->IsDebugEnabled()) return; - - QString fireChangedEvent; - { - QMutexLocker lock(&this->mutex); - // get the current value - auto currentValue = this->options.find(option); - if (currentValue != this->options.end()) - { - if (currentValue.value() != value) - { - fireChangedEvent = this->GetSymbolicName(option); - } - } - else - { - if (!value.isNull()) - { - fireChangedEvent = this->GetSymbolicName(option); - } - } - if (!fireChangedEvent.isEmpty()) - { - this->options.insert(option, value); - } - } - // Send the options change event outside the sync block - if (!fireChangedEvent.isEmpty()) - { - this->OptionsChanged(fireChangedEvent); - } -} - -void DebugOptions::SetOptions(const QHash& ops) -{ - QHash newOptions = ops; - QSet fireChangesTo; - { - QMutexLocker lock(&this->mutex); - if (!this->IsDebugEnabled()) - { - this->disabledOptions = newOptions; - // no events to fire - return; - } - // first check for removals - foreach (const QString& key, this->options.keys()) - { - if (!newOptions.contains(key)) - { - QString symbolicName = this->GetSymbolicName(key); - if (!symbolicName.isEmpty()) - { - fireChangesTo.insert(symbolicName); - } - } - } - // now check for changes to existing values - for(auto iter = newOptions.begin(); iter != newOptions.end(); ++iter) - { - QVariant existingValue = this->options.value(iter.key()); - if (iter.value() != existingValue) - { - QString symbolicName = this->GetSymbolicName(iter.key()); - if (!symbolicName.isEmpty()) - { - fireChangesTo.insert(symbolicName); - } - } - } - // finally set the actual options - this->options = newOptions; - } - foreach (const QString& symbolicName, fireChangesTo) - { - this->OptionsChanged(symbolicName); - } -} - -void DebugOptions::RemoveOption(const QString& option) -{ - if (!this->IsDebugEnabled()) return; - QString fireChangedEvent; - { - QMutexLocker lock(&this->mutex); - if (this->options.remove(option)) - { - fireChangedEvent = this->GetSymbolicName(option); - } - } - // Send the options change event outside the sync block - if (!fireChangedEvent.isEmpty()) - { - this->OptionsChanged(fireChangedEvent); - } -} - -bool DebugOptions::IsDebugEnabled() const -{ - QMutexLocker lock(&this->mutex); - return this->enabled; -} - -void DebugOptions::SetDebugEnabled(bool enabled) -{ - bool fireChangedEvent = false; - { - QMutexLocker lock(&this->mutex); - if (enabled) - { - if (this->IsDebugEnabled()) return; - - // enable platform debugging - there is no .options file - Platform::GetConfiguration().setString(BLUEBERRY_DEBUG.toStdString(), ""); - this->options = this->disabledOptions; - this->disabledOptions.clear(); - this->enabled = true; - if (!this->options.isEmpty()) - { - // fire changed event to indicate some options were re-enabled - fireChangedEvent = true; - } - } - else - { - if (!this->IsDebugEnabled()) return; - // disable platform debugging. - Platform::GetConfiguration().remove(BLUEBERRY_DEBUG.toStdString()); - if (!this->options.isEmpty()) - { - // Save the current options off in case debug is re-enabled - this->disabledOptions = this->options; - // fire changed event to indicate some options were disabled - fireChangedEvent = true; - } - this->options.clear(); - this->enabled = false; - } - } - if (fireChangedEvent) - { - // need to fire event to listeners that options have been disabled - this->OptionsChanged("*"); - } -} - -QString DebugOptions::GetSymbolicName(const QString& option) const -{ - int firstSlashIndex = option.indexOf("/"); - if (firstSlashIndex > 0) - return option.left(firstSlashIndex); - return QString::null; -} - -void DebugOptions::OptionsChanged(const QString& pluginSymbolicName) -{ - // use osgi services to get the listeners - if (context == nullptr) - return; - // do not use the service tracker because that is only used to call all listeners initially when they are registered - // here we only want the services with the specified name. - QList listenerRefs; - try - { - listenerRefs = context->getServiceReferences( "(" + DebugOptions::LISTENER_SYMBOLICNAME + "=" + pluginSymbolicName + ")"); - } - catch (const ctkInvalidArgumentException& /*e*/) - { - // consider logging; should not happen - } - if (listenerRefs.empty()) return; - - foreach (const ctkServiceReference& ref, listenerRefs) - { - DebugOptionsListener* service = context->getService(ref); - if (service == nullptr) continue; - - try - { - service->OptionsChanged(*this); - } - catch (const std::exception& /*e*/) - { - // TODO consider logging - } - context->ungetService(ref); - } -} - -DebugOptionsListener* DebugOptions::addingService(const ctkServiceReference& reference) -{ - DebugOptionsListener* listener = context->getService(reference); - listener->OptionsChanged(*this); - return listener; -} - -void DebugOptions::modifiedService(const ctkServiceReference& /*reference*/, - DebugOptionsListener* /*service*/) -{ - // nothing -} - -void DebugOptions::removedService(const ctkServiceReference& reference, - DebugOptionsListener* /*service*/) -{ - context->ungetService(reference); -} - -} diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/internal/berryDebugOptions.h b/BlueBerry/Bundles/org.blueberry.core.runtime/src/internal/berryDebugOptions.h deleted file mode 100644 index 509c5da1ee..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/src/internal/berryDebugOptions.h +++ /dev/null @@ -1,101 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ - -#ifndef BERRYDEBUGOPTIONS_H -#define BERRYDEBUGOPTIONS_H - -#include - -#include "berryDebugOptionsListener.h" - -#include -#include - -namespace berry { - -/** - * Used to get debug options settings. - */ -class org_blueberry_core_runtime_EXPORT DebugOptions : public QObject, public IDebugOptions, - private ctkServiceTrackerCustomizer -{ - Q_OBJECT - Q_INTERFACES(berry::IDebugOptions) - -public: - - DebugOptions(); - - void Start(ctkPluginContext* pc); - void Stop(ctkPluginContext* pc); - - bool GetBooleanOption(const QString& option, bool defaultValue) const; - QVariant GetOption(const QString& option) const; - QVariant GetOption(const QString& option, const QVariant& defaultValue) const; - - int GetIntegerOption(const QString& option, int defaultValue) const; - - QHash GetOptions() const; - - void SetOption(const QString& option, const QVariant& value); - - void SetOptions(const QHash& ops); - - void RemoveOption(const QString& option); - - bool IsDebugEnabled() const; - - void SetDebugEnabled(bool enabled); - -private: - - static const QString BLUEBERRY_DEBUG; - - /** mutex used to lock the options maps */ - mutable QMutex mutex; - /** A boolean value indicating if debug was enabled */ - bool enabled; - /** A current map of all the options with values set */ - QHash options; - /** A map of all the disabled options with values set at the time debug was disabled */ - QHash disabledOptions; - /** The singleton object of this class */ - //static Impl* singleton = nullptr; - /** The default name of the .options file if loading when the -debug command-line argument is used */ - static const QString OPTIONS; - - ctkPluginContext* context; - QScopedPointer > listenerTracker; - - QString GetSymbolicName(const QString& option) const; - - /** - * Notifies the trace listener for the specified plug-in that its option-path has changed. - * @param pluginSymbolicName The plug-in of the owning trace listener to notify. - */ - void OptionsChanged(const QString& bundleSymbolicName); - - DebugOptionsListener* addingService(const ctkServiceReference& reference); - void modifiedService(const ctkServiceReference& reference, - DebugOptionsListener* service); - void removedService(const ctkServiceReference& reference, - DebugOptionsListener* service); - -}; - -} - -#endif // BERRYDEBUGOPTIONS_H diff --git a/BlueBerry/Bundles/org.blueberry.core.runtime/src/internal/berryInternalPlatform.cpp b/BlueBerry/Bundles/org.blueberry.core.runtime/src/internal/berryInternalPlatform.cpp deleted file mode 100644 index 5c96496672..0000000000 --- a/BlueBerry/Bundles/org.blueberry.core.runtime/src/internal/berryInternalPlatform.cpp +++ /dev/null @@ -1,677 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ - -#ifndef NOMINMAX -#define NOMINMAX -#endif - -#include "berryInternalPlatform.h" -#include "berryLog.h" - -#include -#include -#include -#include -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include - -#include - -#include "berryPlatform.h" -#include "berryPlatformException.h" -#include "berryDebugUtil.h" -#include "berryDebugOptions.h" -//#include "event/berryPlatformEvents.h" -//#include "berryPlatformLogChannel.h" -#include "berryProvisioningInfo.h" -#include "berryCTKPluginActivator.h" -#include "berryLogImpl.h" - -#include -#include - -#include -#include -#include - -namespace berry { - -Poco::Mutex InternalPlatform::m_Mutex; - -bool InternalPlatform::DEBUG = false; -bool InternalPlatform::DEBUG_PLUGIN_PREFERENCES = false; - -InternalPlatform::InternalPlatform() - : m_Initialized(false) - , m_Running(false) - , m_ConsoleLog(false) - , m_Context(nullptr) - , m_PlatformLogger(0) - , m_ctkPluginFrameworkFactory(0) -{ -} - -InternalPlatform::~InternalPlatform() -{ - -} - -InternalPlatform* InternalPlatform::GetInstance() -{ - Poco::Mutex::ScopedLock lock(m_Mutex); - static InternalPlatform instance; - return &instance; -} - -bool InternalPlatform::ConsoleLog() const -{ - return m_ConsoleLog; -} - -QVariant InternalPlatform::GetOption(const QString& option, const QVariant& defaultValue) const -{ - IDebugOptions* options = GetDebugOptions(); - if (options != nullptr) - { - return options->GetOption(option, defaultValue); - } - return QVariant(); -} - -ctkPluginContext* InternalPlatform::GetCTKPluginFrameworkContext() const -{ - if (m_ctkPluginFrameworkFactory) - { - return m_ctkPluginFrameworkFactory->getFramework()->getPluginContext(); - } - return 0; -} - -IAdapterManager* InternalPlatform::GetAdapterManager() const -{ - AssertInitialized(); - return NULL; -} - -void InternalPlatform::Initialize(int& argc, char** argv, Poco::Util::AbstractConfiguration* config) -{ - // initialization - Poco::Mutex::ScopedLock lock(m_Mutex); - - m_Argc = &argc; - m_Argv = argv; - - try - { - this->init(argc, argv); - } - catch (const Poco::Util::UnknownOptionException& e) - { - BERRY_WARN << e.displayText(); - } - this->loadConfiguration(); - if (config) - { - this->config().add(config, 50, false); - } - - m_ConsoleLog = this->GetConfiguration().hasProperty(Platform::ARG_CONSOLELOG.toStdString()); - - m_ConfigPath.setPath(QString::fromStdString(this->GetConfiguration().getString("application.configDir"))); - m_InstancePath.setPath(QString::fromStdString(this->GetConfiguration().getString("application.dir"))); - try - { - m_InstallPath.setPath(QString::fromStdString(this->GetConfiguration().getString(Platform::ARG_HOME.toStdString()))); - } - catch (Poco::NotFoundException& ) - { - m_InstallPath = m_InstancePath; - } - - if (this->GetConfiguration().hasProperty(Platform::ARG_STORAGE_DIR.toStdString())) - { - QString dataLocation = QString::fromStdString(this->GetConfiguration().getString(Platform::ARG_STORAGE_DIR.toStdString(), "")); - if (dataLocation.at(dataLocation.size()-1) != '/') - { - dataLocation += '/'; - } - m_UserPath.setPath(dataLocation); - } - else - { - // Append a hash value of the absolute path of the executable to the data location. - // This allows to start the same application from different build or install trees. -#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) - QString dataLocation = QStandardPaths::writableLocation(QStandardPaths::DataLocation) + '_'; -#else - QString dataLocation = QDesktopServices::storageLocation(QDesktopServices::DataLocation) + '_'; -#endif - dataLocation += QString::number(qHash(QCoreApplication::applicationDirPath())) + "/"; - m_UserPath.setPath(dataLocation); - } - BERRY_INFO(m_ConsoleLog) << "Framework storage dir: " << m_UserPath.absolutePath(); - - QFileInfo userFile(m_UserPath.absolutePath()); - - if (!QDir().mkpath(userFile.absoluteFilePath()) || !userFile.isWritable()) - { - QString tmpPath = QDir::temp().absoluteFilePath(QString::fromStdString(this->commandName())); - BERRY_WARN << "Storage dir " << userFile.absoluteFilePath() << " is not writable. Falling back to temporary path " << tmpPath; - QDir().mkpath(tmpPath); - userFile.setFile(tmpPath); - } - - // Initialize the CTK Plugin Framework - ctkProperties fwProps; - fwProps.insert(ctkPluginConstants::FRAMEWORK_STORAGE, userFile.absoluteFilePath()); - if (this->GetConfiguration().hasProperty(Platform::ARG_CLEAN.toStdString())) - { - fwProps.insert(ctkPluginConstants::FRAMEWORK_STORAGE_CLEAN, ctkPluginConstants::FRAMEWORK_STORAGE_CLEAN_ONFIRSTINIT); - } - if (this->GetConfiguration().hasProperty(Platform::ARG_CONSOLELOG.toStdString())) - { - fwProps.insert("org.commontk.pluginfw.debug.framework", true); - fwProps.insert("org.commontk.pluginfw.debug.errors", true); - fwProps.insert("org.commontk.pluginfw.debug.pluginfw", true); - fwProps.insert("org.commontk.pluginfw.debug.lazy_activation", true); - fwProps.insert("org.commontk.pluginfw.debug.resolve", true); - } - if (this->GetConfiguration().hasProperty(Platform::ARG_PRELOAD_LIBRARY.toStdString())) - { - QString preloadLibs = QString::fromStdString(this->GetConfiguration().getString(Platform::ARG_PRELOAD_LIBRARY.toStdString())); - fwProps.insert(ctkPluginConstants::FRAMEWORK_PRELOAD_LIBRARIES, preloadLibs.split(',', QString::SkipEmptyParts)); - } - m_ctkPluginFrameworkFactory = new ctkPluginFrameworkFactory(fwProps); - QSharedPointer pfw = m_ctkPluginFrameworkFactory->getFramework(); - pfw->init(); - ctkPluginContext* pfwContext = pfw->getPluginContext(); - - // FIXME: This is a quick-fix for Bug 16224 - Umlaut and other special characters in install/binary path - // Assumption : linux provides utf8, windows provides ascii encoded argv lists -#ifdef Q_OS_WIN - QString provisioningFile = QString::fromStdString(this->GetConfiguration().getString(Platform::ARG_PROVISIONING.toStdString())); -#else - QString provisioningFile = QString::fromUtf8(this->GetConfiguration().getString(Platform::ARG_PROVISIONING.toStdString()).c_str()); -#endif - if (!provisioningFile.isEmpty()) - { - BERRY_INFO(m_ConsoleLog) << "Using provisioning file: " << provisioningFile; - ProvisioningInfo provInfo(provisioningFile); - // it can still happen, that the encoding is not compatible with the fromUtf8 function ( i.e. when manipulating the LANG variable - // in such case, the QStringList in provInfo is empty which we can easily check for - if( provInfo.getPluginDirs().empty() ) - { - BERRY_ERROR << "Cannot search for provisioning file, the retrieved directory list is empty.\n" << - "This can occur if there are some special (non-ascii) characters in the install path."; - throw berry::PlatformException("No provisioning file specified. Terminating..."); - } - foreach(QString pluginPath, provInfo.getPluginDirs()) - { - ctkPluginFrameworkLauncher::addSearchPath(pluginPath); - } - - bool forcePluginOverwrite = this->GetConfiguration().hasOption(Platform::ARG_FORCE_PLUGIN_INSTALL.toStdString()); - QList pluginsToStart = provInfo.getPluginsToStart(); - foreach(QUrl pluginUrl, provInfo.getPluginsToInstall()) - { - if (forcePluginOverwrite) - { - uninstallPugin(pluginUrl, pfwContext); - } - try - { - BERRY_INFO(m_ConsoleLog) << "Installing CTK plug-in from: " << pluginUrl.toString().toStdString(); - QSharedPointer plugin = pfwContext->installPlugin(pluginUrl); - if (pluginsToStart.contains(pluginUrl)) - { - m_CTKPluginsToStart << plugin->getPluginId(); - } - } - catch (const ctkPluginException& e) - { - QString errorMsg; - QDebug dbg(&errorMsg); - dbg << e.printStackTrace(); - BERRY_ERROR << qPrintable(errorMsg); - } - } - } - else - { - BERRY_INFO << "No provisioning file set."; - } - - m_BaseStatePath.setPath(m_UserPath.absolutePath() + "/bb-metadata/bb-plugins"); - - QString logPath(m_UserPath.absoluteFilePath(QString::fromStdString(this->commandName()) + ".log")); - m_PlatformLogChannel = new Poco::SimpleFileChannel(logPath.toStdString()); - m_PlatformLogger = &Poco::Logger::create("PlatformLogger", m_PlatformLogChannel, Poco::Message::PRIO_TRACE); - - m_Initialized = true; - -#ifdef BLUEBERRY_DEBUG_SMARTPOINTER - DebugUtil::RestoreState(m_UserPath); -#endif - -} - -void InternalPlatform::uninstallPugin(const QUrl& pluginUrl, ctkPluginContext* pfwContext) -{ - QFileInfo libInfo(pluginUrl.toLocalFile()); - QString libName = libInfo.baseName(); - if (libName.startsWith("lib")) - { - libName = libName.mid(3); - } - QString symbolicName = libName.replace('_', '.'); - - foreach(QSharedPointer plugin, pfwContext->getPlugins()) - { - if (plugin->getSymbolicName() == symbolicName && - plugin->getLocation() != pluginUrl.toString()) - { - BERRY_WARN << "A plug-in with the symbolic name " << symbolicName.toStdString() << - " but different location is already installed. Trying to uninstall " << plugin->getLocation().toStdString(); - plugin->uninstall(); - return; - } - } -} - -IDebugOptions* InternalPlatform::GetDebugOptions() const -{ - return m_DebugTracker.isNull() ? nullptr : m_DebugTracker->getService(); -} - -void InternalPlatform::Launch() -{ - AssertInitialized(); - - if (m_Running) return; - - m_Running = true; - - this->run(); -} - -void InternalPlatform::Shutdown() -{ - QSharedPointer ctkPluginFW; - - { - Poco::Mutex::ScopedLock lock(m_Mutex); - AssertInitialized(); - DebugUtil::SaveState(m_UserPath); - ctkPluginFW = m_ctkPluginFrameworkFactory->getFramework(); - m_Initialized = false; - } - - ctkPluginFW->stop(); - - this->uninitialize(); - - // wait 10 seconds for the CTK plugin framework to stop - ctkPluginFW->waitForStop(10000); -} - -void InternalPlatform::Start(ctkPluginContext* context) -{ - this->m_Context = context; - OpenServiceTrackers(); - InitializeDebugFlags(); -} - -void InternalPlatform::Stop(ctkPluginContext* /*context*/) -{ - CloseServiceTrackers(); - this->m_Context = nullptr; -} - - -void InternalPlatform::AssertInitialized() const -{ - if (!m_Initialized) - throw Poco::SystemException("The Platform has not been initialized yet!"); -} - -void InternalPlatform::OpenServiceTrackers() -{ - ctkPluginContext* context = this->m_Context; - - m_PreferencesTracker.reset(new ctkServiceTracker(context)); - m_PreferencesTracker->open(); - - m_RegistryTracker.reset(new ctkServiceTracker(context)); - m_RegistryTracker->open(); - - m_DebugTracker.reset(new ctkServiceTracker(context)); - m_DebugTracker->open(); -} - -void InternalPlatform::CloseServiceTrackers() -{ - if (!m_PreferencesTracker.isNull()) - { - m_PreferencesTracker->close(); - m_PreferencesTracker.reset(); - } - if (!m_RegistryTracker.isNull()) - { - m_RegistryTracker->close(); - m_RegistryTracker.reset(); - } - if (!m_DebugTracker.isNull()) - { - m_DebugTracker->close(); - m_DebugTracker.reset(); - } -} - -void InternalPlatform::InitializeDebugFlags() -{ - DEBUG = this->GetOption(Platform::PI_RUNTIME + "/debug", false).toBool(); - if (DEBUG) - { - DEBUG_PLUGIN_PREFERENCES = GetOption(Platform::PI_RUNTIME + "/preferences/plugin", false).toBool(); - } -} - -IExtensionRegistry* InternalPlatform::GetExtensionRegistry() -{ - return m_RegistryTracker.isNull() ? nullptr : m_RegistryTracker->getService(); -} - -IPreferencesService *InternalPlatform::GetPreferencesService() -{ - return m_PreferencesTracker.isNull() ? nullptr : m_PreferencesTracker->getService(); -} - -QDir InternalPlatform::GetConfigurationPath() -{ - return m_ConfigPath; -} - -QDir InternalPlatform::GetInstallPath() -{ - return m_InstallPath; -} - -QDir InternalPlatform::GetInstancePath() -{ - return m_InstancePath; -} - -bool InternalPlatform::GetStatePath(QDir& statePath, const QSharedPointer& plugin, bool create) -{ - QFileInfo tmpStatePath(m_BaseStatePath.absoluteFilePath(plugin->getSymbolicName())); - if (tmpStatePath.exists()) - { - if (tmpStatePath.isDir() && tmpStatePath.isWritable() && tmpStatePath.isReadable()) - { - statePath.setPath(tmpStatePath.absoluteFilePath()); - return true; - } - else - { - return false; - } - } - else if (create) - { - bool created = statePath.mkpath(tmpStatePath.absoluteFilePath()); - if (created) - { - statePath.setPath(tmpStatePath.absoluteFilePath()); - return true; - } - return false; - } - return false; -} - -//PlatformEvents& InternalPlatform::GetEvents() -//{ -// return m_Events; -//} - -QDir InternalPlatform::GetUserPath() -{ - return m_UserPath; -} - -ILog *InternalPlatform::GetLog(const QSharedPointer &plugin) const -{ - LogImpl* result = m_Logs.value(plugin->getPluginId()); - if (result != NULL) - return result; - -// ExtendedLogService logService = (ExtendedLogService) extendedLogTracker.getService(); -// Logger logger = logService == null ? null : logService.getLogger(bundle, PlatformLogWriter.EQUINOX_LOGGER_NAME); -// result = new Log(bundle, logger); -// ExtendedLogReaderService logReader = (ExtendedLogReaderService) logReaderTracker.getService(); -// logReader.addLogListener(result, result); -// logs.put(bundle, result); -// return result; - - result = new LogImpl(plugin); - m_Logs.insert(plugin->getPluginId(), result); - return result; -} - -bool InternalPlatform::IsRunning() const -{ - Poco::Mutex::ScopedLock lock(m_Mutex); - return (m_Initialized && m_Running); -} - -QSharedPointer InternalPlatform::GetPlugin(const QString &symbolicName) -{ - QList > plugins = - InternalPlatform::GetInstance()->GetCTKPluginFrameworkContext()->getPlugins(); - - QSharedPointer res(0); - foreach(QSharedPointer plugin, plugins) - { - if ((plugin->getState() & (ctkPlugin::INSTALLED | ctkPlugin::UNINSTALLED)) == 0 && - plugin->getSymbolicName() == symbolicName) - { - if (res.isNull()) - { - res = plugin; - } - else if (res->getVersion().compare(plugin->getVersion()) < 0) - { - res = plugin; - } - } - } - return res; -} - -QList > InternalPlatform::GetPlugins(const QString &symbolicName, const QString &version) -{ - QList > plugins = - InternalPlatform::GetInstance()->GetCTKPluginFrameworkContext()->getPlugins(); - - QMap > selected; - ctkVersion versionObj(version); - foreach(QSharedPointer plugin, plugins) - { - if ((plugin->getState() & (ctkPlugin::INSTALLED | ctkPlugin::UNINSTALLED)) == 0 && - plugin->getSymbolicName() == symbolicName) - { - if (plugin->getVersion().compare(versionObj) > -1) - { - selected.insert(plugin->getVersion(), plugin); - } - } - } - QList > sortedPlugins = selected.values(); - QList > reversePlugins; - qCopyBackward(sortedPlugins.begin(), sortedPlugins.end(), reversePlugins.end()); - return reversePlugins; -} - -Poco::Logger* InternalPlatform::GetLogger() -{ - return m_PlatformLogger; -} - -Poco::Util::LayeredConfiguration& InternalPlatform::GetConfiguration() const -{ - return this->config(); -} - -QStringList InternalPlatform::GetApplicationArgs() const -{ - return m_FilteredArgs; -} - -int& InternalPlatform::GetRawApplicationArgs(char**& argv) -{ - argv = m_Argv; - return *m_Argc; -} - -void InternalPlatform::defineOptions(Poco::Util::OptionSet& options) -{ - Poco::Util::Option helpOption("help", "h", "print this help text"); - helpOption.callback(Poco::Util::OptionCallback(this, &InternalPlatform::PrintHelp)); - options.addOption(helpOption); - - Poco::Util::Option newInstanceOption(Platform::ARG_NEWINSTANCE.toStdString(), "", "forces a new instance of this application"); - newInstanceOption.binding(Platform::ARG_NEWINSTANCE.toStdString()); - options.addOption(newInstanceOption); - - Poco::Util::Option cleanOption(Platform::ARG_CLEAN.toStdString(), "", "cleans the plugin cache"); - cleanOption.binding(Platform::ARG_CLEAN.toStdString()); - options.addOption(cleanOption); - - Poco::Util::Option appOption(Platform::ARG_APPLICATION.toStdString(), "", "the id of the application extension to be executed"); - appOption.argument("").binding(Platform::ARG_APPLICATION.toStdString()); - options.addOption(appOption); - - Poco::Util::Option storageDirOption(Platform::ARG_STORAGE_DIR.toStdString(), "", "the location for storing persistent application data"); - storageDirOption.argument("").binding(Platform::ARG_STORAGE_DIR.toStdString()); - options.addOption(storageDirOption); - - Poco::Util::Option consoleLogOption(Platform::ARG_CONSOLELOG.toStdString(), "", "log messages to the console"); - consoleLogOption.binding(Platform::ARG_CONSOLELOG.toStdString()); - options.addOption(consoleLogOption); - - Poco::Util::Option debugOption(Platform::ARG_DEBUG.toStdString(), "", "enable debug mode"); - debugOption.argument("", false).binding("blueberry.debug"); - options.addOption(debugOption); - - Poco::Util::Option forcePluginOption(Platform::ARG_FORCE_PLUGIN_INSTALL.toStdString(), "", "force installing plug-ins with same symbolic name"); - forcePluginOption.binding(Platform::ARG_FORCE_PLUGIN_INSTALL.toStdString()); - options.addOption(forcePluginOption); - - Poco::Util::Option preloadLibsOption(Platform::ARG_PRELOAD_LIBRARY.toStdString(), "", "preload a library"); - preloadLibsOption.argument("").repeatable(true).callback(Poco::Util::OptionCallback(this, &InternalPlatform::handlePreloadLibraryOption)); - options.addOption(preloadLibsOption); - - Poco::Util::Option testPluginOption(Platform::ARG_TESTPLUGIN.toStdString(), "", "the plug-in to be tested"); - testPluginOption.argument("").binding(Platform::ARG_TESTPLUGIN.toStdString()); - options.addOption(testPluginOption); - - Poco::Util::Option testAppOption(Platform::ARG_TESTAPPLICATION.toStdString(), "", "the application to be tested"); - testAppOption.argument("").binding(Platform::ARG_TESTAPPLICATION.toStdString()); - options.addOption(testAppOption); - - Poco::Util::Option noRegistryCacheOption(Platform::ARG_NO_REGISTRY_CACHE.toStdString(), "", "do not use a cache for the registry"); - noRegistryCacheOption.binding(Platform::ARG_NO_REGISTRY_CACHE.toStdString()); - options.addOption(noRegistryCacheOption); - - Poco::Util::Option noLazyRegistryCacheLoadingOption(Platform::ARG_NO_LAZY_REGISTRY_CACHE_LOADING.toStdString(), "", "do not use lazy cache loading for the registry"); - noLazyRegistryCacheLoadingOption.binding(Platform::ARG_NO_LAZY_REGISTRY_CACHE_LOADING.toStdString()); - options.addOption(noLazyRegistryCacheLoadingOption); - - Poco::Util::Option registryMultiLanguageOption(Platform::ARG_REGISTRY_MULTI_LANGUAGE.toStdString(), "", "enable multi-language support for the registry"); - registryMultiLanguageOption.binding(Platform::ARG_REGISTRY_MULTI_LANGUAGE.toStdString()); - options.addOption(registryMultiLanguageOption); - - Poco::Util::Option xargsOption(Platform::ARG_XARGS.toStdString(), "", "Extended argument list"); - xargsOption.argument("").binding(Platform::ARG_XARGS.toStdString()); - options.addOption(xargsOption); - - Poco::Util::Application::defineOptions(options); -} - -void InternalPlatform::handlePreloadLibraryOption(const std::string& /*name*/, const std::string& value) -{ - std::string oldVal; - if (this->config().hasProperty(Platform::ARG_PRELOAD_LIBRARY.toStdString())) - { - oldVal = this->config().getString(Platform::ARG_PRELOAD_LIBRARY.toStdString()); - } - this->config().setString(Platform::ARG_PRELOAD_LIBRARY.toStdString(), oldVal + "," + value); -} - -int InternalPlatform::main(const std::vector& args) -{ - for(std::vector::const_iterator i = args.begin(); i != args.end(); ++i) - { - m_FilteredArgs << QString::fromStdString(*i); - } - //m_FilteredArgs.insert(m_FilteredArgs.begin(), this->config().getString("application.argv[0]")); - - ctkPluginContext* context = GetCTKPluginFrameworkContext(); - QFileInfo storageDir = context->getDataFile(""); - - m_ctkPluginFrameworkFactory->getFramework()->start(); - foreach(long pluginId, m_CTKPluginsToStart) - { - BERRY_INFO(m_ConsoleLog) << "Starting CTK plug-in: " << context->getPlugin(pluginId)->getSymbolicName().toStdString() - << " [" << pluginId << "]"; - // do not change the autostart setting of this plugin - try - { - context->getPlugin(pluginId)->start(ctkPlugin::START_TRANSIENT | ctkPlugin::START_ACTIVATION_POLICY); - } - catch (const ctkException& e) - { - qDebug() << e.printStackTrace(); - } - catch (const std::exception& e) - { - qDebug() << e.what(); - } - } - - return EXIT_OK; -} - -void InternalPlatform::PrintHelp(const std::string&, const std::string&) -{ - Poco::Util::HelpFormatter help(this->options()); - help.setAutoIndent(); - help.setCommand(this->commandName()); - help.format(std::cout); - - exit(EXIT_OK); -} - -} diff --git a/BlueBerry/CMake/FunctionCMakeDoxygenFilterCompile.cmake b/BlueBerry/CMake/FunctionCMakeDoxygenFilterCompile.cmake deleted file mode 100644 index 261f56c3de..0000000000 --- a/BlueBerry/CMake/FunctionCMakeDoxygenFilterCompile.cmake +++ /dev/null @@ -1,87 +0,0 @@ -#! -#! \brief Download and compile a CMake doxygen input filter -#! -#! \param OUT (optional) Supply an absolute filename for -#! the generated executable. -#! \param NAMESPACE (optional) Supply a C++ namespace in -#! which the generated function declrarations -#! should be wrapped. -#! -#! \return This function sets the CMakeDoxygenFilter_EXECUTABLE -#! variable to the absolute path of the generated input filter executable -#! in the parent scope. If is specified, they will be the same. -#! -#! This CMake function compiles the http://github.com/saschazelzer/CMakeDoxygenFilter -#! project into a doxygen input filter executable. See -#! http://github.com/saschazelzer/CMakeDoxygenFilter/blob/master/README for more details. -#! -function(FunctionCMakeDoxygenFilterCompile) - - #-------------------- parse function arguments ------------------- - - set(DEFAULT_ARGS) - set(prefix "FILTER") - set(arg_names "OUT;NAMESPACE") - set(option_names "") - - foreach(arg_name ${arg_names}) - set(${prefix}_${arg_name}) - endforeach(arg_name) - - foreach(option ${option_names}) - set(${prefix}_${option} FALSE) - endforeach(option) - - set(current_arg_name DEFAULT_ARGS) - set(current_arg_list) - - foreach(arg ${ARGN}) - set(larg_names ${arg_names}) - list(FIND larg_names "${arg}" is_arg_name) - if(is_arg_name GREATER -1) - set(${prefix}_${current_arg_name} ${current_arg_list}) - set(current_arg_name "${arg}") - set(current_arg_list) - else(is_arg_name GREATER -1) - set(loption_names ${option_names}) - list(FIND loption_names "${arg}" is_option) - if(is_option GREATER -1) - set(${prefix}_${arg} TRUE) - else(is_option GREATER -1) - set(current_arg_list ${current_arg_list} "${arg}") - endif(is_option GREATER -1) - endif(is_arg_name GREATER -1) - endforeach(arg ${ARGN}) - - set(${prefix}_${current_arg_name} ${current_arg_list}) - - #------------------- finished parsing arguments ---------------------- - - if(FILTER_OUT) - set(copy_file "${FILTER_OUT}") - else() - set(copy_file "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/CMakeDoxygenFilter${CMAKE_EXECUTABLE_SUFFIX}") - endif() - - set(compile_defs "") - if(FILTER_NAMESPACE) - set(compile_defs "${compile_defs} -DUSE_NAMESPACE=${FILTER_NAMESPACE}") - endif() - - set(cmake_doxygen_filter_src "${CMAKE_CURRENT_SOURCE_DIR}/CMakeDoxygenFilter.cpp") - - try_compile(result_var - "${CMAKE_CURRENT_BINARY_DIR}" - "${cmake_doxygen_filter_src}" - COMPILE_DEFINITIONS ${compile_defs} - OUTPUT_VARIABLE compile_output - COPY_FILE ${copy_file} - ) - - if(NOT result_var) - message(FATAL_ERROR "error: Faild to compile ${cmake_doxygen_filter_src} (result: ${result_var})\n${compile_output}") - endif() - - set(CMakeDoxygenFilter_EXECUTABLE "${copy_file}" PARENT_SCOPE) - -endfunction() diff --git a/BlueBerry/CMake/FunctionCompileSnippets.cmake b/BlueBerry/CMake/FunctionCompileSnippets.cmake deleted file mode 100644 index 92c50efa82..0000000000 --- a/BlueBerry/CMake/FunctionCompileSnippets.cmake +++ /dev/null @@ -1,49 +0,0 @@ -function(FunctionCompileSnippets snippet_path) - - # get all files called "main.cpp" - file(GLOB_RECURSE main_cpp_list "${snippet_path}/main.cpp") - - foreach(main_cpp_file ${main_cpp_list}) - # get the directory containing the main.cpp file - get_filename_component(main_cpp_dir "${main_cpp_file}" PATH) - - set(snippet_src_files ) - - # If there exists a "files.cmake" file in the snippet directory, - # include it and assume it sets the variable "snippet_src_files" - # to a list of source files for the snippet. - if(EXISTS "${main_cpp_dir}/files.cmake") - include("${main_cpp_dir}/files.cmake") - set(_tmp_src_files ${snippet_src_files}) - set(snippet_src_files ) - foreach(_src_file ${_tmp_src_files}) - if(IS_ABSOLUTE ${_src_file}) - list(APPEND snippet_src_files ${_src_file}) - else() - list(APPEND snippet_src_files ${main_cpp_dir}/${_src_file}) - endif() - endforeach() - else() - # glob all files in the directory and add them to the snippet src list - file(GLOB_RECURSE snippet_src_files "${main_cpp_dir}/*") - endif() - - # Uset the top-level directory name as the executable name - string(REPLACE "/" ";" main_cpp_dir_tokens "${main_cpp_dir}") - list(GET main_cpp_dir_tokens -1 snippet_exec_name) - set(snippet_target_name "Snippet-${snippet_exec_name}") - add_executable(${snippet_target_name} ${snippet_src_files}) - if(ARGN) - target_link_libraries(${snippet_target_name} ${ARGN}) - endif() - set_target_properties(${snippet_target_name} PROPERTIES - LABELS Documentation - RUNTIME_OUTPUT_DIRECTORY "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/snippets" - ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/snippets" - LIBRARY_OUTPUT_DIRECTORY "${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/snippets" - OUTPUT_NAME ${snippet_exec_name} - ) - - endforeach() - -endfunction() diff --git a/BlueBerry/CMake/MacroConvertSchema.cmake b/BlueBerry/CMake/MacroConvertSchema.cmake deleted file mode 100644 index f3aafcdc1f..0000000000 --- a/BlueBerry/CMake/MacroConvertSchema.cmake +++ /dev/null @@ -1,33 +0,0 @@ -# MACRO_CONVERT_SCHEMA(INPUT plugin.xml ... -# OUTPUT_DIR output_dir -# TARGET_NAME target_name -# [DEPENDS depends] -# [WORKING_DIR working_dir] -# ) - -macro(MACRO_CONVERT_SCHEMA) - -cmake_parse_arguments(_SCHEMA "" "OUTPUT_DIR;TARGET_NAME;WORKING_DIR" "INPUT;DEPENDS" ${ARGN}) - -set(XP_ANT_TASKS) -foreach(_file ${_SCHEMA_INPUT}) - set(XP_ANT_TASKS "${XP_ANT_TASKS} - ") -endforeach(_file ${_SCHEMA_INPUT}) - -set(XP_DOC_DESTINATION "${_SCHEMA_OUTPUT_DIR}") - -if(NOT _SCHEMA_WORKING_DIR) - set(_SCHEMA_WORKING_DIR ${CMAKE_CURRENT_BINARY_DIR}) -endif(NOT _SCHEMA_WORKING_DIR) - -configure_file("${BLUEBERRY_SOURCE_DIR}/Build/ConvertSchemaToHTML/buildExtPointDoc.xml.in" - "${_SCHEMA_WORKING_DIR}/buildExtPointDoc.xml" @ONLY) - -add_custom_target(${_SCHEMA_TARGET_NAME} - ant -f ${_SCHEMA_WORKING_DIR}/buildExtPointDoc.xml - DEPENDS ${_SCHEMA_DEPENDS} - WORKING_DIRECTORY ${_SCHEMA_WORKING_DIR} - VERBATIM) - -endmacro(MACRO_CONVERT_SCHEMA) diff --git a/BlueBerry/CMake/MacroCreateQtHelp.cmake b/BlueBerry/CMake/MacroCreateQtHelp.cmake deleted file mode 100644 index ebae13cb0e..0000000000 --- a/BlueBerry/CMake/MacroCreateQtHelp.cmake +++ /dev/null @@ -1,42 +0,0 @@ - -function(_FUNCTION_CREATE_CTK_QT_COMPRESSED_HELP qch_file use_xsl) - - set(_manifest_path "${CMAKE_CURRENT_SOURCE_DIR}/manifest_headers.cmake") - if(NOT EXISTS ${_manifest_path}) - message(FATAL_ERROR "${_manifest_path} not found") - endif() - - include(${_manifest_path}) - string(REPLACE "_" "." Plugin-SymbolicName "${PLUGIN_TARGET}") - - configure_file(${BlueBerry_SOURCE_DIR}/CMake/berryCTKQtHelpDoxygen.conf.in - ${PLUGIN_DOXYGEN_OUTPUT_DIR}/doxygen.conf - ) - - set(_qhp_xsl_file "${BlueBerry_SOURCE_DIR}/CMake/qhp_toc.xsl") - set(_generated_qhp_file "${PLUGIN_DOXYGEN_OUTPUT_DIR}/html/index.qhp") - set(_transformed_qhp_file "${PLUGIN_DOXYGEN_OUTPUT_DIR}/html/${PLUGIN_TARGET}.qhp") - set(${qch_file} "${CMAKE_CURRENT_BINARY_DIR}/resources/${PLUGIN_TARGET}.qch") - - set(_xsl_command ) - if(use_xsl) - set(_xsl_command COMMAND ${QT_XMLPATTERNS_EXECUTABLE} ${_qhp_xsl_file} ${_generated_qhp_file} -output ${_transformed_qhp_file}) - endif() - - file(GLOB _file_dependencies "${PLUGIN_DOXYGEN_INPUT_DIR}/*") - - add_custom_command(OUTPUT ${${qch_file}} - # Generate a Qt help project (index.qhp) with doxygen - COMMAND ${DOXYGEN_EXECUTABLE} ${PLUGIN_DOXYGEN_OUTPUT_DIR}/doxygen.conf - # Use a XSL transformation to get rid of the top-level entry - ${_xsl_command} - # Generate the final Qt compressed help file (.qch) - COMMAND ${QT_HELPGENERATOR_EXECUTABLE} ${_transformed_qhp_file} -o ${${qch_file}} - DEPENDS ${PLUGIN_DOXYGEN_OUTPUT_DIR}/doxygen.conf ${_file_dependencies} - ) - - #set_source_files_properties(${qch_file} PROPERTIES GENERATED 1) - - set(${qch_file} ${${qch_file}} PARENT_SCOPE) - -endfunction() diff --git a/BlueBerry/CMake/MacroOrganizeSources.cmake b/BlueBerry/CMake/MacroOrganizeSources.cmake deleted file mode 100644 index e605e7f828..0000000000 --- a/BlueBerry/CMake/MacroOrganizeSources.cmake +++ /dev/null @@ -1,71 +0,0 @@ -# this macro gets a filelist as input and looks -# for corresponding h-files to add them to the project. -# -# additionally files are grouped in source-groups. -# -# No parameters explicitly declared here, because -# we want to allow for variable argument lists, which -# are later access by the keyword foreach(_file ${ARGV}) -# -# output: after calling the macro, files that were found -# correspondigly to the given files are stored in the -# variable: -# ${CORRESPONDING__H_FILES} -# -# GLOBBED__H_FILES - - -macro(MACRO_ORGANIZE_SOURCES) - - cmake_parse_arguments(_ORG "" "" "HEADER;SOURCE;TXX;DOC;MOC;GEN_QRC;GEN_UI;META;UI;QRC" ${ARGN}) - - set(CORRESPONDING__H_FILES "") - set(GLOBBED__H_FILES "") - - if(_ORG_SOURCE) - foreach(_file ${_ORG_SOURCE}) - string(REGEX REPLACE "(.*)\\.(txx|cpp|c|cxx)$" "\\1.h" H_FILE ${_file}) - if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${H_FILE}") - list(APPEND CORRESPONDING__H_FILES "${H_FILE}") - endif() - endforeach() - else() - file(GLOB_RECURSE GLOBBED__H_FILES *.h) - endif() - - if(_ORG_GEN_QRC OR _ORG_GEN_UI OR _ORG_MOC) - source_group("Generated\\Qt QRC Source Files" FILES ${_ORG_GEN_QRC}) - source_group("Generated\\Qt UI Header Files" FILES ${_ORG_GEN_UI}) - source_group("Generated\\Qt MOC Source Files" FILES ${_ORG_MOC}) - endif() - - #_MACRO_APPEND_TO_LIST(_ORG_SOURCE "${CMAKE_CURRENT_SOURCE_DIR}/") - source_group("== Source Files ==" FILES ${_ORG_SOURCE}) - - #_MACRO_APPEND_TO_LIST(_ORG_TXX "${CMAKE_CURRENT_SOURCE_DIR}/") - source_group("== Template Files ==" FILES ${_ORG_TXX}) - - #_MACRO_APPEND_TO_LIST(_ORG_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/") - source_group("== Header Files ==" FILES ${_ORG_HEADER} ${CORRESPONDING__H_FILES} ${GLOBBED__H_FILES}) - - #_MACRO_APPEND_TO_LIST(_ORG_UI "${CMAKE_CURRENT_SOURCE_DIR}/") - source_group("QT UI Files" FILES ${_ORG_UI}) - - #_MACRO_APPEND_TO_LIST(_ORG_DOC "${CMAKE_CURRENT_SOURCE_DIR}/") - source_group("Doxygen Files" FILES ${_ORG_DOC}) - - #_MACRO_APPEND_TO_LIST(_ORG_QRC "${CMAKE_CURRENT_SOURCE_DIR}/") - source_group("Qt Resource Files" FILES ${_ORG_QRC}) - - source_group("Plugin META Files" FILES ${_ORG_META}) - -endmacro() - -macro(_MACRO_APPEND_TO_LIST _list _value) - set(_origlist ${${_list}}) - set(${_list} ) - foreach(_element ${_origlist}) - list(APPEND ${_list} "${_value}${_element}") - endforeach() -endmacro() - diff --git a/BlueBerry/CMakeLists.txt b/BlueBerry/CMakeLists.txt deleted file mode 100644 index 4ef3e9934a..0000000000 --- a/BlueBerry/CMakeLists.txt +++ /dev/null @@ -1,283 +0,0 @@ -project(BlueBerry) -if (${CMAKE_SOURCE_DIR} EQUAL ${PROJECT_SOURCE_DIR}) - cmake_minimum_required(VERSION 2.8.9) -endif() - -set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/CMake/") - -include(CMakeParseArguments) -include(MacroConvertSchema) -include(MacroOrganizeSources) -include(MacroCreateCTKPlugin) -include(MacroCreateQtHelp) -include(MacroInstallCTKPlugin) -include(FunctionCreateProvisioningFile) - -set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${BLUEBERRY_CXX_FLAGS}") -set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} ${BLUEBERRY_CXX_FLAGS_RELEASE}") -set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${BLUEBERRY_C_FLAGS}") - -if(MSVC) - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DNOMINMAX /wd4250 /wd4275 /wd4251 /wd4503") -endif() - -if(NOT CMAKE_RUNTIME_OUTPUT_DIRECTORY) - set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin) -endif() - -find_package(mbilog REQUIRED) -include_directories(${mbilog_INCLUDE_DIRS}) - -if(MITK_USE_Qt4) - find_package(Qt4 4.7 REQUIRED) -else() - find_package(Qt5Concurrent ${MITK_QT5_MINIMUM_VERSION} REQUIRED) - find_package(Qt5Help ${MITK_QT5_MINIMUM_VERSION} REQUIRED) - find_package(Qt5Sql ${MITK_QT5_MINIMUM_VERSION} REQUIRED) - find_package(Qt5WebKitWidgets ${MITK_QT5_MINIMUM_VERSION} REQUIRED) - find_package(Qt5Widgets ${MITK_QT5_MINIMUM_VERSION} REQUIRED) - find_package(Qt5Xml ${MITK_QT5_MINIMUM_VERSION} REQUIRED) -endif() - -if(QT_QMAKE_CHANGED) - set(QT_HELPGENERATOR_EXECUTABLE NOTFOUND) - set(QT_COLLECTIONGENERATOR_EXECUTABLE NOTFOUND) - set(QT_ASSISTANT_EXECUTABLE NOTFOUND) - set(QT_XMLPATTERNS_EXECUTABLE NOTFOUND) -endif() - -find_program(QT_HELPGENERATOR_EXECUTABLE - NAMES qhelpgenerator qhelpgenerator-qt4 qhelpgenerator4 - PATHS ${QT_BINARY_DIR} - NO_DEFAULT_PATH -) - -find_program(QT_COLLECTIONGENERATOR_EXECUTABLE - NAMES qcollectiongenerator qcollectiongenerator-qt4 qcollectiongenerator4 - PATHS ${QT_BINARY_DIR} - NO_DEFAULT_PATH -) - -find_program(QT_ASSISTANT_EXECUTABLE - NAMES assistant-qt4 assistant4 assistant - PATHS ${QT_BINARY_DIR} - NO_DEFAULT_PATH -) - -find_program(QT_XMLPATTERNS_EXECUTABLE - NAMES xmlpatterns - PATHS ${QT_BINARY_DIR} - NO_DEFAULT_PATH -) - -find_package(Doxygen) - -option(BLUEBERRY_USE_QT_HELP "Enable support for integrating bundle documentation into Qt Help" ${DOXYGEN_FOUND}) - -mark_as_advanced(BLUEBERRY_USE_QT_HELP - QT_HELPGENERATOR_EXECUTABLE - QT_COLLECTIONGENERATOR_EXECUTABLE - QT_ASSISTANT_EXECUTABLE - QT_XMLPATTERNS_EXECUTABLE) - -if(BLUEBERRY_USE_QT_HELP) - set(_force_blueberry_use_qt_help_to_off 0) - if(NOT DOXYGEN_FOUND) - message("> Forcing BLUEBERRY_USE_QT_HELP to OFF because Doxygen was not found.") - set(_force_blueberry_use_qt_help_to_off 1) - endif() - if(DOXYGEN_FOUND AND DOXYGEN_VERSION VERSION_LESS 1.8.7) - message("> Forcing BLUEBERRY_USE_QT_HELP to OFF because Doxygen version 1.8.7 or newer not found.") - set(_force_blueberry_use_qt_help_to_off 1) - endif() - - if(NOT QT_HELPGENERATOR_EXECUTABLE) - message("> Forcing BLUEBERRY_USE_QT_HELP to OFF because QT_HELPGENERATOR_EXECUTABLE is empty.") - set(_force_blueberry_use_qt_help_to_off 1) - endif() - - if(NOT QT_XMLPATTERNS_EXECUTABLE) - message("You have enabled Qt Help support, but QT_XMLPATTERNS_EXECUTABLE is empty") - set(_force_blueberry_use_qt_help_to_off 1) - endif() - - if(_force_blueberry_use_qt_help_to_off) - set(BLUEBERRY_USE_QT_HELP OFF CACHE BOOL "Enable support for integrating bundle documentation into Qt Help" FORCE) - endif() -endif(BLUEBERRY_USE_QT_HELP) - -if(BLUEBERRY_QT_HELP_REQUIRED AND NOT BLUEBERRY_USE_QT_HELP) - message(FATAL_ERROR "BLUEBERRY_USE_QT_HELP is required to be set to ON") -endif() - -if(MITK_USE_Qt4) - include(${QT_USE_FILE}) -endif() - -# ========= CTK specific CMake stuff ============ -cmake_policy(SET CMP0012 NEW) - -find_package(CTK REQUIRED) - -# Extract all library names starting with org_blueberry_ -macro(GetMyTargetLibraries all_target_libraries varname) - set(re_ctkplugin "^org_blueberry_[a-zA-Z0-9_]+$") - set(_tmp_list) - list(APPEND _tmp_list ${all_target_libraries}) - ctkMacroListFilter(_tmp_list re_ctkplugin OUTPUT_VARIABLE ${varname}) -endmacro() -# ================================================ - -option(BLUEBERRY_BUILD_ALL_PLUGINS "Build all BlueBerry plugins (overriding selection)" OFF) -mark_as_advanced(BLUEBERRY_BUILD_ALL_PLUGINS) - -if(BLUEBERRY_BUILD_ALL_PLUGINS) - set(BLUEBERRY_BUILD_ALL_PLUGINS_OPTION "FORCE_BUILD_ALL") -endif() - -option(BLUEBERRY_STATIC "Build all plugins as static libraries" OFF) -mark_as_advanced(BLUEBERRY_STATIC) - -option(BLUEBERRY_DEBUG_SMARTPOINTER "Enable code for debugging smart pointers" OFF) -mark_as_advanced(BLUEBERRY_DEBUG_SMARTPOINTER) - -find_package(Poco PATHS ${Poco_DIR} COMPONENTS Foundation Util XML REQUIRED) -find_package(Ant) -find_package(Eclipse) - -set(BLUEBERRY_SOURCE_DIR ${BlueBerry_SOURCE_DIR}) -set(BLUEBERRY_BINARY_DIR ${BlueBerry_BINARY_DIR}) - -set(BLUEBERRY_PLUGINS_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/Bundles) -set(BLUEBERRY_PLUGINS_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/Bundles) - -set(OSGI_APP solstice) -set(OSGI_UI_APP solstice_ui) - -if(Eclipse_DIR) - set(BLUEBERRY_DOC_TOOLS_DIR "${Eclipse_DIR}" CACHE PATH "Directory containing additional tools needed for generating the documentation") -else() - set(BLUEBERRY_DOC_TOOLS_DIR "" CACHE PATH "Directory containing additional tools needed for generating the documentation") -endif() - -set(BLUEBERRY_DEBUG_POSTFIX d) - -# Testing options - -if(DEFINED BLUEBERRY_BUILD_TESTING) - option(BLUEBERRY_BUILD_TESTING "Build the BlueBerry tests." ${BLUEBERRY_BUILD_TESTING}) -else() - option(BLUEBERRY_BUILD_TESTING "Build the BlueBerry tests." ${BUILD_TESTING}) -endif() - -if(WIN32) - set(_gui_testing_default "ON") -else() - set(_gui_testing_default "OFF") -endif() - -option(BLUEBERRY_ENABLE_GUI_TESTING "Enable the BlueBerry GUI tests" ${_gui_testing_default}) -mark_as_advanced(BLUEBERRY_ENABLE_GUI_TESTING) - -if(BLUEBERRY_BUILD_TESTING) - enable_testing() -endif() - - -# Add CTK plugins - -set(_ctk_plugins - Bundles/org.blueberry.core.runtime:ON - Bundles/org.blueberry.core.expressions:OFF - Bundles/org.blueberry.core.commands:OFF - Bundles/org.blueberry.core.jobs:OFF - Bundles/org.blueberry.ui.qt:OFF - Bundles/org.blueberry.ui.qt.help:OFF - Bundles/org.blueberry.ui.qt.log:ON - Bundles/org.blueberry.ui.qt.objectinspector:OFF -) - -set(_ctk_test_plugins ) - -if(BLUEBERRY_BUILD_TESTING) - find_package(CppUnit PATHS ${CppUnit_DIR} REQUIRED) - include(berryTestingHelpers) - - set(BLUEBERRY_TEST_APP "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${OSGI_APP}") - #get_target_property(_is_macosx_bundle ${OSGI_APP} MACOSX_BUNDLE) - #if(APPLE AND _is_macosx_bundle) - # set(BLUEBERRY_TEST_APP "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${OSGI_APP}.app/Contents/MacOS/${OSGI_APP}") - #endif() - - set(_ctk_testinfrastructure_plugins - Bundles/org.blueberry.test:ON - Bundles/org.blueberry.uitest:ON - ) - - set(_ctk_test_plugins -# Testing/org.blueberry.core.runtime.tests:ON -# Testing/org.blueberry.osgi.tests:ON - ) - - if(BLUEBERRY_ENABLE_GUI_TESTING) -# list(APPEND _ctk_test_plugins Testing/org.blueberry.ui.tests:ON) - - set(BLUEBERRY_UI_TEST_APP "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${OSGI_UI_APP}") - #get_target_property(_is_macosx_bundle ${OSGI_UI_APP} MACOSX_BUNDLE) - #if(APPLE AND _is_macosx_bundle) - # set(BLUEBERRY_UI_TEST_APP "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${OSGI_UI_APP}.app/Contents/MacOS/${OSGI_UI_APP}") - #endif() - endif() -endif() - -set(BLUEBERRY_TESTING_PROVISIONING_FILE "${BlueBerry_BINARY_DIR}/BlueBerryTesting.provisioning") - -add_custom_target(BlueBerry) - -ctkMacroSetupPlugins(${_ctk_plugins} ${_ctk_testinfrastructure_plugins} ${_ctk_test_plugins} - BUILD_OPTION_PREFIX BLUEBERRY_BUILD_ - BUILD_ALL ${BLUEBERRY_BUILD_ALL_PLUGINS} - COMPACT_OPTIONS) - -set(BLUEBERRY_PROVISIONING_FILE "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/BlueBerry.provisioning") -FunctionCreateProvisioningFile( - FILE ${BLUEBERRY_PROVISIONING_FILE} - PLUGINS ${_ctk_plugins} -) - -FunctionCreateProvisioningFile( - FILE ${BLUEBERRY_TESTING_PROVISIONING_FILE} - INCLUDE ${BLUEBERRY_PROVISIONING_FILE} - PLUGINS ${_ctk_testinfrastructure_plugins} ${_ctk_test_plugins} -) - -if(${CMAKE_PROJECT_NAME}_PLUGIN_LIBRARIES) - add_dependencies(BlueBerry ${${CMAKE_PROJECT_NAME}_PLUGIN_LIBRARIES}) -endif() -set_property(TARGET ${${CMAKE_PROJECT_NAME}_PLUGIN_LIBRARIES} PROPERTY LABELS BlueBerry) - -set(BB_PLUGIN_USE_FILE "${BlueBerry_BINARY_DIR}/BlueBerryPluginUseFile.cmake") -if(${PROJECT_NAME}_PLUGIN_LIBRARIES) - ctkFunctionGeneratePluginUseFile(${BB_PLUGIN_USE_FILE}) -else() - file(REMOVE ${BB_PLUGIN_USE_FILE}) - set(BB_PLUGIN_USE_FILE ) -endif() - -# CTK Plugin Exports -set(BB_PLUGIN_EXPORTS_FILE "${CMAKE_CURRENT_BINARY_DIR}/BlueBerryPluginExports.cmake") -GetMyTargetLibraries("${${PROJECT_NAME}_PLUGIN_LIBRARIES}" my_plugin_targets) -set(additional_export_targets mbilog) -export(TARGETS ${my_plugin_targets} ${additional_export_targets} - FILE ${BB_PLUGIN_EXPORTS_FILE}) - - -add_subdirectory(Documentation) - -set(BLUEBERRY_QTPLUGIN_PATH ) -if(CTK_QTDESIGNERPLUGINS_DIR AND EXISTS ${CTK_QTDESIGNERPLUGINS_DIR}) - set(BLUEBERRY_QTPLUGIN_PATH "${CTK_QTDESIGNERPLUGINS_DIR}") -endif() - -configure_file(BlueBerryConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/BlueBerryConfig.cmake @ONLY) - diff --git a/BlueBerry/COPYRIGHT_HEADER b/BlueBerry/COPYRIGHT_HEADER deleted file mode 100644 index e22431bdf9..0000000000 --- a/BlueBerry/COPYRIGHT_HEADER +++ /dev/null @@ -1,15 +0,0 @@ -/*=================================================================== - -BlueBerry Platform - -Copyright (c) German Cancer Research Center, -Division of Medical and Biological Informatics. -All rights reserved. - -This software is distributed WITHOUT ANY WARRANTY; without -even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. - -See LICENSE.txt or http://www.mitk.org for details. - -===================================================================*/ diff --git a/BlueBerry/Documentation/CMakeDoxygenFilter.cpp b/BlueBerry/Documentation/CMakeDoxygenFilter.cpp deleted file mode 100644 index 31304f57c4..0000000000 --- a/BlueBerry/Documentation/CMakeDoxygenFilter.cpp +++ /dev/null @@ -1,495 +0,0 @@ -/*============================================================================= - - Copyright (c) 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. - -=============================================================================*/ - -#include -#include -#include -#include - -#include - -//-------------------------------------- -// Utilitiy classes and functions -//-------------------------------------- - -struct ci_char_traits : public std::char_traits - // just inherit all the other functions - // that we don't need to override -{ - static bool eq(char c1, char c2) - { return toupper(c1) == toupper(c2); } - - static bool ne(char c1, char c2) - { return toupper(c1) != toupper(c2); } - - static bool lt(char c1, char c2) - { return toupper(c1) < toupper(c2); } - - static bool gt(char c1, char c2) - { return toupper(c1) > toupper(c2); } - - static int compare(const char* s1, const char* s2, std::size_t n) - { - while (n-- > 0) - { - if (lt(*s1, *s2)) return -1; - if (gt(*s1, *s2)) return 1; - ++s1; ++s2; - } - return 0; - } - - static const char* find(const char* s, int n, char a) - { - while (n-- > 0 && toupper(*s) != toupper(a)) - { - ++s; - } - return s; - } -}; - -typedef std::basic_string ci_string; - -//-------------------------------------- -// Lexer -//-------------------------------------- - -class CMakeLexer -{ -public: - - enum Token { - TOK_EOF = -1, - TOK_EOL = -2, - - // commands - TOK_MACRO = -3, TOK_ENDMACRO = -4, - TOK_FUNCTION = -5, TOK_ENDFUNCTION = -6, - TOK_DOXYGEN_COMMENT = -7, - TOK_SET = -8, - TOK_STRING_LITERAL = -100, - TOK_NUMBER_LITERAL = -102, - - // primary - TOK_IDENTIFIER = -200 - }; - - CMakeLexer(std::istream& is) - : _lastChar(' '), _is(is), _line(1), _col(1) - {} - - int getToken() - { - // skip whitespace - while (isspace(_lastChar) && _lastChar != '\r' && _lastChar != '\n') - { - _lastChar = getChar(); - } - - if (isalpha(_lastChar) || _lastChar == '_') - { - _identifier = _lastChar; - while (isalnum(_lastChar = getChar()) || _lastChar == '-' || _lastChar == '_') - { - _identifier += _lastChar; - } - - if (_identifier == "set") - return TOK_SET; - if (_identifier == "function") - return TOK_FUNCTION; - if (_identifier == "macro") - return TOK_MACRO; - if (_identifier == "endfunction") - return TOK_ENDFUNCTION; - if (_identifier == "endmacro") - return TOK_ENDMACRO; - return TOK_IDENTIFIER; - } - - if (isdigit(_lastChar)) - { - // very lax!! number detection - _identifier = _lastChar; - while (isalnum(_lastChar = getChar()) || _lastChar == '.' || _lastChar == ',') - { - _identifier += _lastChar; - } - return TOK_NUMBER_LITERAL; - } - - if (_lastChar == '#') - { - _lastChar = getChar(); - if (_lastChar == '!') - { - // found a doxygen comment marker - _identifier.clear(); - - _lastChar = getChar(); - while (_lastChar != EOF && _lastChar != '\n' && _lastChar != '\r') - { - _identifier += _lastChar; - _lastChar = getChar(); - } - return TOK_DOXYGEN_COMMENT; - } - - // skip the comment - while (_lastChar != EOF && _lastChar != '\n' && _lastChar != '\r') - { - _lastChar = getChar(); - } - } - - if (_lastChar == '"') - { - _lastChar = getChar(); - _identifier.clear(); - while (_lastChar != EOF && _lastChar != '"') - { - _identifier += _lastChar; - _lastChar = getChar(); - } - - // eat the closing " - _lastChar = getChar(); - return TOK_STRING_LITERAL; - } - - // don't eat the EOF - if (_lastChar == EOF) return TOK_EOF; - - // don't eat the EOL - if (_lastChar == '\r' || _lastChar == '\n') - { - if (_lastChar == '\r') _lastChar = getChar(); - if (_lastChar == '\n') _lastChar = getChar(); - return TOK_EOL; - } - - // return the character as its ascii value - int thisChar = _lastChar; - _lastChar = getChar(); - return thisChar; - } - - std::string getIdentifier() const - { - return std::string(_identifier.c_str()); - } - - int curLine() const - { return _line; } - - int curCol() const - { return _col; } - - int getChar() - { - int c = _is.get(); - updateLoc(c); - return c; - } - -private: - - void updateLoc(int c) - { - if (c == '\n' || c == '\r') - { - ++_line; - _col = 1; - } - else - { - ++_col; - } - } - - ci_string _identifier; - int _lastChar; - std::istream& _is; - - int _line; - int _col; -}; - -//-------------------------------------- -// Parser -//-------------------------------------- - -class CMakeParser -{ - -public: - - CMakeParser(std::istream& is, std::ostream& os) - : _is(is), _os(os), _lexer(is), _curToken(CMakeLexer::TOK_EOF), _lastToken(CMakeLexer::TOK_EOF) - { } - - int curToken() - { - return _curToken; - } - - int nextToken() - { - _lastToken = _curToken; - _curToken = _lexer.getToken(); - while (_curToken == CMakeLexer::TOK_EOL) - { - // Try to preserve lines in output to allow correct line number referencing by doxygen. - _os << std::endl; - _curToken = _lexer.getToken(); - } - return _curToken; - } - - void handleMacro() - { - if(!parseMacro()) - { - // skip token for error recovery - nextToken(); - } - } - - void handleFunction() - { - if(!parseFunction()) - { - // skip token for error recovery - nextToken(); - } - } - - void handleSet() - { - // SET(var ...) following a documentation block is assumed to be a variable declaration. - if (_lastToken != CMakeLexer::TOK_DOXYGEN_COMMENT) - { - // No comment block before - nextToken(); - } else if(!parseSet()) - { - // skip token for error recovery - nextToken(); - } - } - - void handleDoxygenComment() - { - _os << "///" << _lexer.getIdentifier(); - nextToken(); - } - - void handleTopLevelExpression() - { - // skip token - nextToken(); - } - -private: - - void printError(const char* str) - { - std::cerr << "Error: " << str << " (at line " << _lexer.curLine() << ", col " << _lexer.curCol() << ")"; - } - - bool parseMacro() - { - if (nextToken() != '(') - { - printError("Expected '(' after MACRO"); - return false; - } - - nextToken(); - std::string macroName = _lexer.getIdentifier(); - if (curToken() != CMakeLexer::TOK_IDENTIFIER || macroName.empty()) - { - printError("Expected macro name"); - return false; - } - - _os << macroName << '('; - if (nextToken() == CMakeLexer::TOK_IDENTIFIER) - { - _os << _lexer.getIdentifier(); - while (nextToken() == CMakeLexer::TOK_IDENTIFIER) - { - _os << ", " << _lexer.getIdentifier(); - } - } - - if (curToken() != ')') - { - printError("Missing expected ')'"); - } - else - { - _os << ");"; - } - - // eat the ')' - nextToken(); - return true; - } - - bool parseSet() - { - if (nextToken() != '(') - { - printError("Expected '(' after SET"); - return false; - } - - nextToken(); - std::string variableName = _lexer.getIdentifier(); - if (curToken() != CMakeLexer::TOK_IDENTIFIER || variableName.empty()) - { - printError("Expected variable name"); - return false; - } - - _os << "CMAKE_VARIABLE " << variableName; - - nextToken(); - while ((curToken() == CMakeLexer::TOK_IDENTIFIER) - || (curToken() == CMakeLexer::TOK_STRING_LITERAL) - || (curToken() == CMakeLexer::TOK_NUMBER_LITERAL)) - { - nextToken(); - } - - if (curToken() != ')') - { - printError("Missing expected ')'"); - } - else - { - _os << ";"; - } - - // eat the ')' - nextToken(); - return true; - } - - bool parseFunction() - { - if (nextToken() != '(') - { - printError("Expected '(' after FUNCTION"); - return false; - } - - nextToken(); - std::string funcName = _lexer.getIdentifier(); - if (curToken() != CMakeLexer::TOK_IDENTIFIER || funcName.empty()) - { - printError("Expected function name"); - return false; - } - - _os << funcName << '('; - if (nextToken() == CMakeLexer::TOK_IDENTIFIER) - { - _os << _lexer.getIdentifier(); - while (nextToken() == CMakeLexer::TOK_IDENTIFIER) - { - _os << ", " << _lexer.getIdentifier(); - } - } - - if (curToken() != ')') - { - printError("Missing expected ')'"); - } - else - { - _os << ");"; - } - - // eat the ')' - nextToken(); - - return true; - } - - std::istream& _is; - std::ostream& _os; - CMakeLexer _lexer; - int _curToken; - int _lastToken; -}; - - -#define STRINGIFY(a) #a -#define DOUBLESTRINGIFY(a) STRINGIFY(a) - -int main(int argc, char** argv) -{ - assert(argc > 1); - - for (int i = 1; i < argc; ++i) - { - std::ifstream ifs(argv[i]); - std::ostream& os = std::cout; - - #ifdef USE_NAMESPACE - os << "namespace " << DOUBLESTRINGIFY(USE_NAMESPACE) << " {\n"; - #endif - - CMakeParser parser(ifs, os); - parser.nextToken(); - while (ifs.good()) - { - switch (parser.curToken()) - { - case CMakeLexer::TOK_EOF: - return ifs.get(); // eat EOF - case CMakeLexer::TOK_MACRO: - parser.handleMacro(); - break; - case CMakeLexer::TOK_FUNCTION: - parser.handleFunction(); - break; - case CMakeLexer::TOK_SET: - parser.handleSet(); - break; - case CMakeLexer::TOK_DOXYGEN_COMMENT: - parser.handleDoxygenComment(); - break; - default: - parser.handleTopLevelExpression(); - break; - } - } - - #ifdef USE_NAMESPACE - os << "}\n"; - #endif - } - - return EXIT_SUCCESS; -} - diff --git a/BlueBerry/Documentation/CMakeLists.txt b/BlueBerry/Documentation/CMakeLists.txt deleted file mode 100755 index 70ec28eafe..0000000000 --- a/BlueBerry/Documentation/CMakeLists.txt +++ /dev/null @@ -1,95 +0,0 @@ -# -# Variables: -# BLUEBERRY_DOCS_OUTPUT_DIR: documentation output directory (optional) - -add_subdirectory(snippets) - -find_package(Doxygen) - -if(DOXYGEN_FOUND) - -option(USE_DOT "Use dot program for generating graphical class diagrams with doxygen, if available" ON) -mark_as_advanced(USE_DOT) - -set(HAVE_DOT "NO") -if(DOXYGEN_DOT_EXECUTABLE AND USE_DOT) - set(HAVE_DOT "YES") -endif() - -if(NOT BLUEBERRY_DOCS_OUTPUT_DIR) - set(BLUEBERRY_DOCS_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE PATH - "BlueBerry output directory for all generated documentation.") -endif() -if(NOT BLUEBERRY_DOXYGEN_OUTPUT_DIR) - set(BLUEBERRY_DOXYGEN_OUTPUT_DIR ${BLUEBERRY_DOCS_OUTPUT_DIR}/reference/api CACHE INTERNAL - "BlueBerry doxygen output directory") -endif() -if(NOT BLUEBERRY_XPDOC_OUTPUT_DIR) - set(BLUEBERRY_XPDOC_OUTPUT_DIR ${BLUEBERRY_DOCS_OUTPUT_DIR}/reference/extension-points) -endif() - -set(BLUEBERRY_DOXYGEN_TAGFILE_NAME ${BLUEBERRY_DOXYGEN_OUTPUT_DIR}/BlueBerry.tag CACHE INTERNAL "BlueBerry Doxygen tag file") - -# This is relative to the working directory of the doxygen command -set(BLUEBERRY_DOXYGEN_STYLESHEET bb_doxygen.css) -configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${BLUEBERRY_DOXYGEN_STYLESHEET} - ${CMAKE_CURRENT_BINARY_DIR}/${BLUEBERRY_DOXYGEN_STYLESHEET} COPYONLY) - -file(RELATIVE_PATH BLUEBERRY_DOXYGEN_XP_RELATIVEDIR ${BLUEBERRY_DOXYGEN_OUTPUT_DIR}/html ${BLUEBERRY_XPDOC_OUTPUT_DIR}/) - -set(_doxygen_qt4bundles ) -set(_doxygen_bundles ) -set(_doxygen_binary_qt4bundles ) -set(_doxygen_binary_bundles ) -file(GLOB _bundle_dirs RELATIVE "${BLUEBERRY_PLUGINS_SOURCE_DIR}" "${BLUEBERRY_PLUGINS_SOURCE_DIR}/*") -foreach(_bundle_dir ${_bundle_dirs}) - string(REGEX MATCH "^\\..*" _matched_hidden "${_bundle_dir}") - if(NOT _matched_hidden) - if(IS_DIRECTORY "${BLUEBERRY_PLUGINS_SOURCE_DIR}/${_bundle_dir}") - string(REGEX MATCH ".*\\.qt.*" _matched "${_bundle_dir}") - if(_matched) - if(QT4_FOUND) - set(_doxygen_qt4bundles "${_doxygen_qt4bundles} \"${BLUEBERRY_PLUGINS_SOURCE_DIR}/${_bundle_dir}\"") - set(_doxygen_binary_qt4bundles "${_doxygen_binary_qt4bundles} \"${BLUEBERRY_PLUGINS_BINARY_DIR}/${_bundle_dir}\"") - endif() - else() - set(_doxygen_bundles "${_doxygen_bundles} \"${BLUEBERRY_PLUGINS_SOURCE_DIR}/${_bundle_dir}\"") - set(_doxygen_binary_bundles "${_doxygen_binary_bundles} \"${BLUEBERRY_PLUGINS_BINARY_DIR}/${_bundle_dir}\"") - endif() - endif() - endif() -endforeach() - -# Compile a doxygen input filter for processing CMake scripts -include(FunctionCMakeDoxygenFilterCompile) -FunctionCMakeDoxygenFilterCompile(NAMESPACE "CMake") - -configure_file(doxygen.conf.in - ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf) - -find_package(Doxygen) -# doxygen does not necessarily create the output dir if it does not exist -if(NOT EXISTS ${BLUEBERRY_DOXYGEN_OUTPUT_DIR}) - file(MAKE_DIRECTORY ${BLUEBERRY_DOXYGEN_OUTPUT_DIR}) -endif() - -add_custom_target(BlueBerryDoc - ${DOXYGEN} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - DEPENDS ${_BlueBerryDoc_depends} - ) - -# convert the extension points schema files into html -if(ANT_FOUND AND BLUEBERRY_DOC_TOOLS_DIR) - file(GLOB_RECURSE _plugin_xmls ${BLUEBERRY_PLUGINS_SOURCE_DIR}/plugin.xml) - MACRO_CONVERT_SCHEMA(INPUT ${_plugin_xmls} - OUTPUT_DIR "${BLUEBERRY_XPDOC_OUTPUT_DIR}" - TARGET_NAME BlueBerryXPDoc - ) - - add_dependencies(BlueBerryDoc BlueBerryXPDoc) -endif(ANT_FOUND AND BLUEBERRY_DOC_TOOLS_DIR) - -configure_file(schema.css ${BLUEBERRY_DOCS_OUTPUT_DIR}/schema.css) - -endif(DOXYGEN_FOUND) diff --git a/BlueBerry/Documentation/bb_doxygen.css b/BlueBerry/Documentation/bb_doxygen.css deleted file mode 100644 index 8d49f5c166..0000000000 --- a/BlueBerry/Documentation/bb_doxygen.css +++ /dev/null @@ -1,1010 +0,0 @@ -/* The standard CSS for doxygen */ - -body, table, div, p, dl { - font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; - font-size: 12px; -} - -/* @group Heading Levels */ - -h1 { - font-size: 150%; -} - -.title { - font-size: 150%; - font-weight: bold; - margin: 10px 2px; -} - -h2 { - font-size: 120%; -} - -h3 { - font-size: 100%; -} - -dt { - font-weight: bold; -} - -div.multicol { - -moz-column-gap: 1em; - -webkit-column-gap: 1em; - -moz-column-count: 3; - -webkit-column-count: 3; -} - -p.startli, p.startdd, p.starttd { - margin-top: 2px; -} - -p.endli { - margin-bottom: 0px; -} - -p.enddd { - margin-bottom: 4px; -} - -p.endtd { - margin-bottom: 2px; -} - -/* @end */ - -caption { - font-weight: bold; -} - -span.legend { - font-size: 70%; - text-align: center; -} - -h3.version { - font-size: 90%; - text-align: center; -} - -div.qindex, div.navtab{ - background-color: #EBEFF6; - border: 1px solid #A3B4D7; - text-align: center; -} - -div.qindex, div.navpath { - width: 100%; - line-height: 140%; -} - -div.navtab { - margin-right: 15px; -} - -/* @group Link Styling */ - -a { - color: #3D578C; - font-weight: normal; - text-decoration: none; -} - -.contents a:visited { - color: #4665A2; -} - -a:hover { - text-decoration: underline; -} - -a.qindex { - font-weight: bold; -} - -a.qindexHL { - font-weight: bold; - background-color: #9CAFD4; - color: #ffffff; - border: 1px double #869DCA; -} - -.contents a.qindexHL:visited { - color: #ffffff; -} - -a.el { - font-weight: bold; -} - -a.elRef { -} - -a.code { - color: #4665A2; -} - -a.codeRef { - color: #4665A2; -} - -/* @end */ - -dl.el { - margin-left: -1cm; -} - -.fragment { - font-family: monospace, fixed; - font-size: 105%; -} - -pre.fragment { - border: 1px solid #C4CFE5; - background-color: #FBFCFD; - padding: 4px 6px; - margin: 4px 8px 4px 2px; - overflow: auto; - word-wrap: break-word; - font-size: 9pt; - line-height: 125%; -} - -div.ah { - background-color: black; - font-weight: bold; - color: #ffffff; - margin-bottom: 3px; - margin-top: 3px; - padding: 0.2em; - border: solid thin #333; - border-radius: 0.5em; - -webkit-border-radius: .5em; - -moz-border-radius: .5em; - box-shadow: 2px 2px 3px #999; - -webkit-box-shadow: 2px 2px 3px #999; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; - background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); - background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); -} - -div.groupHeader { - margin-left: 16px; - margin-top: 12px; - font-weight: bold; -} - -div.groupText { - margin-left: 16px; - font-style: italic; -} - -body { - background-color: white; - color: black; - margin: 0; -} - -div.contents { - margin-top: 10px; - margin-left: 8px; - margin-right: 8px; -} - -td.indexkey { - background-color: #EBEFF6; - font-weight: bold; - border: 1px solid #C4CFE5; - margin: 2px 0px 2px 0; - padding: 2px 10px; -} - -td.indexvalue { - background-color: #EBEFF6; - border: 1px solid #C4CFE5; - padding: 2px 10px; - margin: 2px 0px; -} - -tr.memlist { - background-color: #EEF1F7; -} - -p.formulaDsp { - text-align: center; -} - -img.formulaDsp { - -} - -img.formulaInl { - vertical-align: middle; -} - -div.center { - text-align: center; - margin-top: 0px; - margin-bottom: 0px; - padding: 0px; -} - -div.center img { - border: 0px; -} - -address.footer { - text-align: right; - padding-right: 12px; -} - -img.footer { - border: 0px; - vertical-align: middle; -} - -/* @group Code Colorization */ - -span.keyword { - color: #008000 -} - -span.keywordtype { - color: #604020 -} - -span.keywordflow { - color: #e08000 -} - -span.comment { - color: #800000 -} - -span.preprocessor { - color: #806020 -} - -span.stringliteral { - color: #002080 -} - -span.charliteral { - color: #008080 -} - -span.vhdldigit { - color: #ff00ff -} - -span.vhdlchar { - color: #000000 -} - -span.vhdlkeyword { - color: #700070 -} - -span.vhdllogic { - color: #ff0000 -} - -/* @end */ - -/* -.search { - color: #003399; - font-weight: bold; -} - -form.search { - margin-bottom: 0px; - margin-top: 0px; -} - -input.search { - font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; -} -*/ - -td.tiny { - font-size: 75%; -} - -.dirtab { - padding: 4px; - border-collapse: collapse; - border: 1px solid #A3B4D7; -} - -th.dirtab { - background: #EBEFF6; - font-weight: bold; -} - -hr { - height: 0px; - border: none; - border-top: 1px solid #4A6AAA; -} - -hr.footer { - height: 1px; -} - -/* @group Member Descriptions */ - -table.memberdecls { - border-spacing: 0px; - padding: 0px; -} - -.mdescLeft, .mdescRight, -.memItemLeft, .memItemRight, -.memTemplItemLeft, .memTemplItemRight, .memTemplParams { - background-color: #F9FAFC; - border: none; - margin: 4px; - padding: 1px 0 0 8px; -} - -.mdescLeft, .mdescRight { - padding: 0px 8px 4px 8px; - color: #555; -} - -.memItemLeft, .memItemRight, .memTemplParams { - border-top: 1px solid #C4CFE5; -} - -.memItemLeft, .memTemplItemLeft { - white-space: nowrap; -} - -.memItemRight { - width: 100%; -} - -.memTemplParams { - color: #4665A2; - white-space: nowrap; -} - -/* @end */ - -/* @group Member Details */ - -/* Styles for detailed member documentation */ - -.memtemplate { - font-size: 80%; - color: #4665A2; - font-weight: normal; - margin-left: 9px; -} - -.memnav { - background-color: #EBEFF6; - border: 1px solid #A3B4D7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} - -.mempage { - width: 100%; -} - -.memitem { - padding: 0; - margin-bottom: 10px; - margin-right: 5px; -} - -.memname { - white-space: nowrap; - font-weight: bold; - margin-left: 6px; -} - -.memproto, dl.reflist dt { - border-top: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; - padding: 6px 0px 6px 0px; - color: #253555; - font-weight: bold; - text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); - /* opera specific markup */ - box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - border-top-right-radius: 8px; - border-top-left-radius: 8px; - /* firefox specific markup */ - -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; - -moz-border-radius-topright: 8px; - -moz-border-radius-topleft: 8px; - /* webkit specific markup */ - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - -webkit-border-top-right-radius: 8px; - -webkit-border-top-left-radius: 8px; - background-image:url('nav_f.png'); - background-repeat:repeat-x; - background-color: #E2E8F2; - -} - -.memdoc, dl.reflist dd { - border-bottom: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; - padding: 2px 5px; - background-color: #FBFCFD; - border-top-width: 0; - /* opera specific markup */ - border-bottom-left-radius: 8px; - border-bottom-right-radius: 8px; - box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - /* firefox specific markup */ - -moz-border-radius-bottomleft: 8px; - -moz-border-radius-bottomright: 8px; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; - background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7); - /* webkit specific markup */ - -webkit-border-bottom-left-radius: 8px; - -webkit-border-bottom-right-radius: 8px; - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7)); -} - -dl.reflist dt { - padding: 5px; -} - -dl.reflist dd { - margin: 0px 0px 10px 0px; - padding: 5px; -} - -.paramkey { - text-align: right; -} - -.paramtype { - white-space: nowrap; -} - -.paramname { - color: #602020; - white-space: nowrap; -} -.paramname em { - font-style: normal; -} - -.params, .retval, .exception, .tparams { - border-spacing: 6px 2px; -} - -.params .paramname, .retval .paramname { - font-weight: bold; - vertical-align: top; -} - -.params .paramtype { - font-style: italic; - vertical-align: top; -} - -.params .paramdir { - font-family: "courier new",courier,monospace; - vertical-align: top; -} - - - - -/* @end */ - -/* @group Directory (tree) */ - -/* for the tree view */ - -.ftvtree { - font-family: sans-serif; - margin: 0px; -} - -/* these are for tree view when used as main index */ - -.directory { - font-size: 9pt; - font-weight: bold; - margin: 5px; -} - -.directory h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} - -/* -The following two styles can be used to replace the root node title -with an image of your choice. Simply uncomment the next two styles, -specify the name of your image and be sure to set 'height' to the -proper pixel height of your image. -*/ - -/* -.directory h3.swap { - height: 61px; - background-repeat: no-repeat; - background-image: url("yourimage.gif"); -} -.directory h3.swap span { - display: none; -} -*/ - -.directory > h3 { - margin-top: 0; -} - -.directory p { - margin: 0px; - white-space: nowrap; -} - -.directory div { - display: none; - margin: 0px; -} - -.directory img { - vertical-align: -30%; -} - -/* these are for tree view when not used as main index */ - -.directory-alt { - font-size: 100%; - font-weight: bold; -} - -.directory-alt h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} - -.directory-alt > h3 { - margin-top: 0; -} - -.directory-alt p { - margin: 0px; - white-space: nowrap; -} - -.directory-alt div { - display: none; - margin: 0px; -} - -.directory-alt img { - vertical-align: -30%; -} - -/* @end */ - -div.dynheader { - margin-top: 8px; -} - -address { - font-style: normal; - color: #2A3D61; -} - -table.doxtable { - border-collapse:collapse; -} - -table.doxtable td, table.doxtable th { - border: 1px solid #2D4068; - padding: 3px 7px 2px; -} - -table.doxtable th { - background-color: #374F7F; - color: #FFFFFF; - font-size: 110%; - padding-bottom: 4px; - padding-top: 5px; - text-align:left; -} - -table.fieldtable { - width: 100%; - margin-bottom: 10px; - border: 1px solid #A8B8D9; - border-spacing: 0px; - -moz-border-radius: 4px; - -webkit-border-radius: 4px; - border-radius: 4px; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; - -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); - box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); -} - -.fieldtable td, .fieldtable th { - padding: 3px 7px 2px; -} - -.fieldtable td.fieldtype, .fieldtable td.fieldname { - white-space: nowrap; - border-right: 1px solid #A8B8D9; - border-bottom: 1px solid #A8B8D9; - vertical-align: top; -} - -.fieldtable td.fielddoc { - border-bottom: 1px solid #A8B8D9; - width: 100%; -} - -.fieldtable tr:last-child td { - border-bottom: none; -} - -.fieldtable th { - background-image:url('nav_f.png'); - background-repeat:repeat-x; - background-color: #E2E8F2; - font-size: 90%; - color: #253555; - padding-bottom: 4px; - padding-top: 5px; - text-align:left; - -moz-border-radius-topleft: 4px; - -moz-border-radius-topright: 4px; - -webkit-border-top-left-radius: 4px; - -webkit-border-top-right-radius: 4px; - border-top-left-radius: 4px; - border-top-right-radius: 4px; - border-bottom: 1px solid #A8B8D9; -} - - -.tabsearch { - top: 0px; - left: 10px; - height: 36px; - background-image: url('tab_b.png'); - z-index: 101; - overflow: hidden; - font-size: 13px; -} - -.navpath ul -{ - font-size: 11px; - background-image:url('tab_b.png'); - background-repeat:repeat-x; - height:30px; - line-height:30px; - color:#8AA0CC; - border:solid 1px #C2CDE4; - overflow:hidden; - margin:0px; - padding:0px; -} - -.navpath li -{ - list-style-type:none; - float:left; - padding-left:10px; - padding-right:15px; - background-image:url('bc_s.png'); - background-repeat:no-repeat; - background-position:right; - color:#364D7C; -} - -.navpath li.navelem a -{ - height:32px; - display:block; - text-decoration: none; - outline: none; -} - -.navpath li.navelem a:hover -{ - color:#6884BD; -} - -.navpath li.footer -{ - list-style-type:none; - float:right; - padding-left:10px; - padding-right:15px; - background-image:none; - background-repeat:no-repeat; - background-position:right; - color:#364D7C; - font-size: 8pt; -} - - -div.summary -{ - float: right; - font-size: 8pt; - padding-right: 5px; - width: 50%; - text-align: right; -} - -div.summary a -{ - white-space: nowrap; -} - -div.ingroups -{ - margin-left: 5px; - font-size: 8pt; - padding-left: 5px; - width: 50%; - text-align: left; -} - -div.ingroups a -{ - white-space: nowrap; -} - -div.header -{ - background-image:url('nav_h.png'); - background-repeat:repeat-x; - background-color: #F9FAFC; - margin: 0px; - border-bottom: 1px solid #C4CFE5; -} - -div.headertitle -{ - padding: 5px 5px 5px 7px; -} - -dl -{ - padding: 0 0 0 10px; -} - -dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug -{ - border-left:4px solid; - padding: 0 0 0 6px; -} - -dl.note -{ - border-color: #D0C000; -} - -dl.warning, dl.attention -{ - border-color: #FF0000; -} - -dl.pre, dl.post, dl.invariant -{ - border-color: #00D000; -} - -dl.deprecated -{ - border-color: #505050; -} - -dl.todo -{ - border-color: #00C0E0; -} - -dl.test -{ - border-color: #3030E0; -} - -dl.bug -{ - border-color: #C08050; -} - -#projectlogo -{ - text-align: center; - vertical-align: bottom; - border-collapse: separate; -} - -#projectlogo img -{ - border: 0px none; -} - -#projectname -{ - font: 300% Tahoma, Arial,sans-serif; - margin: 0px; - padding: 2px 0px; -} - -#projectbrief -{ - font: 120% Tahoma, Arial,sans-serif; - margin: 0px; - padding: 0px; -} - -#projectnumber -{ - font: 50% Tahoma, Arial,sans-serif; - margin: 0px; - padding: 0px; -} - -#titlearea -{ - padding: 0px; - margin: 0px; - width: 100%; - border-bottom: 1px solid #5373B4; -} - -.image -{ - text-align: center; -} - -.dotgraph -{ - text-align: center; -} - -.mscgraph -{ - text-align: center; -} - -.caption -{ - font-weight: bold; -} - -div.zoom -{ - border: 1px solid #90A5CE; -} - -dl.citelist { - margin-bottom:50px; -} - -dl.citelist dt { - color:#334975; - float:left; - font-weight:bold; - margin-right:10px; - padding:5px; -} - -dl.citelist dd { - margin:2px 0; - padding:5px 0; -} - -@media print -{ - #top { display: none; } - #side-nav { display: none; } - #nav-path { display: none; } - body { overflow:visible; } - h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } - .summary { display: none; } - .memitem { page-break-inside: avoid; } - #doc-content - { - margin-left:0 !important; - height:auto !important; - width:auto !important; - overflow:inherit; - display:inline; - } - pre.fragment - { - overflow: visible; - text-wrap: unrestricted; - white-space: -moz-pre-wrap; /* Moz */ - white-space: -pre-wrap; /* Opera 4-6 */ - white-space: -o-pre-wrap; /* Opera 7 */ - white-space: pre-wrap; /* CSS3 */ - word-wrap: break-word; /* IE 5.5+ */ - } -} - - -/* CSS for the generated extension point documentation, copied from schema.css */ - -H6.SchemaHeader { - font-size:16px; - display:inline -} - -P.SchemaCopyright { - font-size: smaller; - font-style: normal; - color: #336699; - display:inline; - margin-top: 3.000000pt; - margin-bottom: 11.000000pt; - margin-right: 0.000000pt; - margin-left: 0.000000pt; -} - -P.SchemaDtd { - color: #800000; - margin-top: 0.000000pt; - margin-bottom: 0.000000pt; - margin-right: 0.000000pt; - margin-left: 10.000000pt; -} - -P.SchemaDtdAttlist { - color: #800000; - margin-top: 0.000000pt; - margin-bottom: 0.000000pt; - margin-right: 0.000000pt; - margin-left: 20.000000pt; -} - -span.SchemaTag { - color: #000080; -} - -span.SchemaCstring { - color: #008000; -} - -pre.Example { - margin-top: 0.000000pt; -} - -.ConfigMarkupElementDesc { - color: black; - margin-top: 0.000000pt; - margin-bottom: 0.000000pt; - margin-right: 0.000000pt; - margin-left: 10.000000pt; -} - -.ConfigMarkupAttlistDesc { - color: black; - margin-top: 0.000000pt; - margin-bottom: 0.000000pt; - margin-right: 0.000000pt; - margin-left: 32.000000pt; -} - - diff --git a/BlueBerry/Documentation/doxygen.conf.in b/BlueBerry/Documentation/doxygen.conf.in deleted file mode 100644 index d801417ef2..0000000000 --- a/BlueBerry/Documentation/doxygen.conf.in +++ /dev/null @@ -1,2359 +0,0 @@ -# Doxyfile 1.8.8 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = BlueBerry - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = @BLUEBERRY_VERSION_STRING@ - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = "A modular, cross-platform, C++ application framework" - -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = "@BLUEBERRY_DOXYGEN_OUTPUT_DIR@" - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = NO - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 8 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = "FIXME=\par Fix Me's:\n" - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = YES - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = NO - -# This flag is only useful for Objective-C code. When set to YES local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = YES - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 0 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. -# Note: If this tag is empty the current directory is searched. - -INPUT = ./ \ - @BLUEBERRY_SOURCE_DIR@/Documentation/ \ - @BLUEBERRY_SOURCE_DIR@/CMake/ \ - @_doxygen_bundles@ \ - @_doxygen_qt4bundles@ \ - @_doxygen_binary_bundles@ \ - @_doxygen_binary_qt4bundles@ - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. - -FILE_PATTERNS = *.h \ - *.cpp \ - *.dox \ - *.txx \ - *.cxx \ - *.cmake - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = @BLUEBERRY_SOURCE_DIR@/CMake/BundleTemplate/ \ - @BLUEBERRY_SOURCE_DIR@/Documentation/snippets/ - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = moc_* \ - Register* \ - */files.cmake \ - */.git/* \ - @BLUEBERRY_BINARY_DIR@/*.cmake - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = _MACRO_* \ - _FUNCTION_* - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = @BLUEBERRY_DOXYGEN_OUTPUT_DIR@/../extension-points \ - @BLUEBERRY_SOURCE_DIR@/Documentation/snippets/ - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = "@BLUEBERRY_SOURCE_DIR@" - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = *.cmake=@CMakeDoxygenFilter_EXECUTABLE@ - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = YES - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = YES - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 3 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = @BLUEBERRY_DOXYGEN_STYLESHEET@ - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra stylesheet files is of importance (e.g. the last -# stylesheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = YES - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 300 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using prerendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://www.mathjax.org/mathjax - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /