|
|
@@ -0,0 +1,187 @@
|
|
|
+###########################################################################
|
|
|
+#
|
|
|
+# Library: CTK
|
|
|
+#
|
|
|
+# 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.
|
|
|
+#
|
|
|
+###########################################################################
|
|
|
+
|
|
|
+MACRO(ctkMacroSetupExternalPlugins )
|
|
|
+ MESSAGE(SEND_ERROR "This macro has been renamed. Please use ctkMacroSetupPlugins instead")
|
|
|
+ENDMACRO()
|
|
|
+
|
|
|
+#! This is the main macro to set up your CTK plug-ins inside your own CMake project.
|
|
|
+#!
|
|
|
+#! This macro takes care of validating the current set of plug-in build options,
|
|
|
+#! enables and/or checks required plug-ins and handles all aspects of plug-in
|
|
|
+#! dependencies. Additionally, it calls add_subdirectory() on each given plug-in.
|
|
|
+#!
|
|
|
+#! Macro signature:
|
|
|
+#! \code
|
|
|
+#! ctkMacroSetupPlugins(plugins...
|
|
|
+#! [BUILD_OPTION_PREFIX <option_prefix>]
|
|
|
+#! [APPS <apps...>]
|
|
|
+#! [BUILD_ALL <build_all_flag>]
|
|
|
+#! [COMPACT_OPTIONS])
|
|
|
+#! \endcode
|
|
|
+#!
|
|
|
+#! \param plugins (required) A list of directories (absolute or relative to the current
|
|
|
+#! source dir) with default build options. E.g. an item of the list may look like
|
|
|
+#! "Plugins/org.myproject.example:ON"
|
|
|
+#! \param BUILD_OPTION_PREFIX (optional) The prefix to use for the build option of th
|
|
|
+#! plug-in. Defaults to "BUILD_".
|
|
|
+#! \param APPS (optional) A list of directories with build option names containing
|
|
|
+#! CTK-style applications. This can be used to automatically enable plug-ins
|
|
|
+#! required by the application. The application directoy must contain a CMakeLists.txt
|
|
|
+#! file containing a "project(...)" command and a target_libraries.cmake file
|
|
|
+#! containing a list of required plug-in targets, e.g. "set(target_libraries org_myproject_example)".
|
|
|
+#! An item of the list may look like "Apps/MyExampleApp^^BUILD_APP_MyExampleApp" where
|
|
|
+#! Apps/MyExampleApp is the directory containing the applicatios CMakeLists.txt file
|
|
|
+#! and BUILD_APP_MyExampleApp is the build option used to conditionally build the app.
|
|
|
+#! \param BUILD_ALL (optional) If the build_all_flag is true, all entries in the plugins list
|
|
|
+#! will be enabled (but their build option will not be forced to change). Default is OFF
|
|
|
+#! \param COMPACT_OPTIONS (optional) If this flag is given, the created build options for the
|
|
|
+#! plugins will not contain the relative path but just the last directory entry which
|
|
|
+#! usually is the plug-in symbolic name.
|
|
|
+#!
|
|
|
+#! Example invocation:
|
|
|
+#!
|
|
|
+#! \code
|
|
|
+#! set(plugin_list Plugins/org.myproject.example:OFF)
|
|
|
+#! set(app_list Apps/MyExampleApp^^MYPROJECT_BUILD_MyExampleApp)
|
|
|
+#!
|
|
|
+#! ctkMacroSetupPlugins(${plugin_list}
|
|
|
+#! BUILD_OPTION_PREFIX MYPROJECT_BUILD_
|
|
|
+#! APPS ${app_list}
|
|
|
+#! COMPACT_OPTIONS
|
|
|
+#! )
|
|
|
+#! \endcode
|
|
|
+#!
|
|
|
+#! \ingroup CMakeAPI
|
|
|
+MACRO(ctkMacroSetupPlugins )
|
|
|
+
|
|
|
+ ctkMacroParseArguments(MY "BUILD_OPTION_PREFIX;APPS;BUILD_ALL" "COMPACT_OPTIONS" ${ARGN})
|
|
|
+
|
|
|
+ IF(NOT MY_DEFAULT_ARGS)
|
|
|
+ MESSAGE(FATAL_ERROR "Empty plugin list")
|
|
|
+ ENDIF()
|
|
|
+
|
|
|
+ SET(plugin_list ${MY_DEFAULT_ARGS})
|
|
|
+
|
|
|
+ IF(NOT MY_BUILD_OPTION_PREFIX)
|
|
|
+ SET(MY_BUILD_OPTION_PREFIX "BUILD_")
|
|
|
+ ENDIF()
|
|
|
+
|
|
|
+ IF(NOT MY_BUILD_ALL)
|
|
|
+ SET(MY_BUILD_ALL 0)
|
|
|
+ ENDIF()
|
|
|
+
|
|
|
+ # Check if this is the first invocation of this macro
|
|
|
+ GET_PROPERTY(_repeated GLOBAL PROPERTY ctkMacroSetupExternalPlugins_called SET)
|
|
|
+ IF(NOT _repeated)
|
|
|
+ # Clear the internal cache variable containing all enabled plug-in targets
|
|
|
+ # This variable will be set in ctkMacroBuildPlugin
|
|
|
+ SET(${CMAKE_PROJECT_NAME}_PLUGIN_LIBRARIES CACHE INTERNAL "CTK plug-in targets" FORCE)
|
|
|
+ SET_PROPERTY(GLOBAL PROPERTY ctkMacroSetupExternalPlugins_called 1)
|
|
|
+
|
|
|
+ # Add the project specific variable name containing plug-in targets to the list
|
|
|
+ set_property(GLOBAL APPEND PROPERTY CTK_PLUGIN_LIBRARIES_VARS ${CMAKE_PROJECT_NAME}_PLUGIN_LIBRARIES)
|
|
|
+ ENDIF()
|
|
|
+
|
|
|
+ # Set up Qt, if not already done
|
|
|
+ IF(NOT QT4_FOUND)
|
|
|
+ SET(minimum_required_qt_version "4.6")
|
|
|
+ FIND_PACKAGE(Qt4 REQUIRED)
|
|
|
+
|
|
|
+ IF("${QT_VERSION_MAJOR}.${QT_VERSION_MINOR}" VERSION_LESS "${minimum_required_qt_version}")
|
|
|
+ MESSAGE(FATAL_ERROR "error: CTK requires Qt >= ${minimum_required_qt_version} -- you cannot use Qt ${QT_VERSION_MAJOR}.${QT_VERSION_MINOR}.${QT_VERSION_PATCH}.")
|
|
|
+ ENDIF()
|
|
|
+ ENDIF()
|
|
|
+
|
|
|
+ # Set the variable QT_INSTALLED_LIBRARY_DIR that contains all
|
|
|
+ # Qt shared libraries
|
|
|
+ SET(QT_INSTALLED_LIBRARY_DIR ${QT_LIBRARY_DIR})
|
|
|
+ IF(WIN32)
|
|
|
+ GET_FILENAME_COMPONENT(QT_INSTALLED_LIBRARY_DIR ${QT_QMAKE_EXECUTABLE} PATH)
|
|
|
+ ENDIF()
|
|
|
+
|
|
|
+ SET(plugin_dirswithoption )
|
|
|
+ SET(plugin_subdirs )
|
|
|
+ FOREACH(plugin ${plugin_list})
|
|
|
+ ctkFunctionExtractOptionNameAndValue(${plugin} plugin_name plugin_value)
|
|
|
+ IF(MY_COMPACT_OPTIONS)
|
|
|
+ STRING(REPLACE "/" ";" _tokens ${plugin_name})
|
|
|
+ LIST(GET _tokens -1 option_name)
|
|
|
+ SET(option_name ${MY_BUILD_OPTION_PREFIX}${option_name})
|
|
|
+ ELSE()
|
|
|
+ SET(option_name ${MY_BUILD_OPTION_PREFIX}${plugin_name})
|
|
|
+ ENDIF()
|
|
|
+ # This variable may have the form "Plugins/org.commontk.bla_option_name"
|
|
|
+ SET(${plugin_name}_option_name ${option_name})
|
|
|
+ # Additionally create a variable of the form "org_commontk_bla_option_name"
|
|
|
+ STRING(REPLACE "/" ";" _tokens ${plugin_name})
|
|
|
+ LIST(GET _tokens -1 plugin_symbolic_name)
|
|
|
+ STRING(REPLACE "." "_" plugin_target ${plugin_symbolic_name})
|
|
|
+ SET(${plugin_target}_option_name ${option_name})
|
|
|
+
|
|
|
+ OPTION(${option_name} "Build ${plugin_name} Plugin." ${plugin_value})
|
|
|
+ IF(MY_BUILD_ALL)
|
|
|
+ SET(${option_name} 1)
|
|
|
+ ENDIF()
|
|
|
+
|
|
|
+ LIST(APPEND plugin_subdirs "${plugin_name}")
|
|
|
+ IF(IS_ABSOLUTE ${plugin_name})
|
|
|
+ LIST(APPEND plugin_dirswithoption "${plugin_name}^^${option_name}")
|
|
|
+ ELSE()
|
|
|
+ LIST(APPEND plugin_dirswithoption "${CMAKE_CURRENT_SOURCE_DIR}/${plugin_name}^^${option_name}")
|
|
|
+ ENDIF()
|
|
|
+ ENDFOREACH()
|
|
|
+
|
|
|
+ # Get plugin info from possible previous invocations of this macro for
|
|
|
+ # validation purposes below
|
|
|
+ GET_PROPERTY(previous_plugin_dirswithoption GLOBAL PROPERTY ctkMacroSetupExternalPlugins_dirswithoption)
|
|
|
+
|
|
|
+ # Fill the CTK_EXTERNAL_PLUGIN_LIBRARIES variable with external plug-in target names.
|
|
|
+ # It will be used in ctkMacroValidateBuildOptions to be able to validate agains plug-ins
|
|
|
+ # from external projects.
|
|
|
+ ctkFunctionGetAllPluginTargets(CTK_EXTERNAL_PLUGIN_LIBRARIES)
|
|
|
+
|
|
|
+ ctkFunctionGenerateDGraphInput(${CMAKE_CURRENT_BINARY_DIR}
|
|
|
+ "${plugin_dirswithoption};${previous_plugin_dirswithoption};${MY_APPS}"
|
|
|
+ WITH_EXTERNALS)
|
|
|
+ ctkMacroValidateBuildOptions("${CMAKE_CURRENT_BINARY_DIR}" "${CTK_DGRAPH_EXECUTABLE}"
|
|
|
+ "${plugin_dirswithoption};${previous_plugin_dirswithoption};${MY_APPS}")
|
|
|
+
|
|
|
+ # Record the current set of plug-ins and their option names
|
|
|
+ SET_PROPERTY(GLOBAL APPEND PROPERTY ctkMacroSetupExternalPlugins_dirswithoption ${plugin_dirswithoption})
|
|
|
+
|
|
|
+ # Get the gcc version (GCC_VERSION will be empty if the compiler is not gcc).
|
|
|
+ # This will be used in the ctkMacroBuildPlugin macro to conditionally set compiler flags.
|
|
|
+ ctkFunctionGetGccVersion(${CMAKE_CXX_COMPILER} GCC_VERSION)
|
|
|
+
|
|
|
+ FOREACH(plugin ${plugin_subdirs})
|
|
|
+ IF(${${plugin}_option_name})
|
|
|
+ IF(IS_ABSOLUTE ${plugin})
|
|
|
+ # get last directory component
|
|
|
+ GET_FILENAME_COMPONENT(_dirname ${plugin} NAME)
|
|
|
+ ADD_SUBDIRECTORY(${plugin} private_plugins/${_dirname})
|
|
|
+ ELSE()
|
|
|
+ ADD_SUBDIRECTORY(${plugin})
|
|
|
+ ENDIF()
|
|
|
+ ENDIF()
|
|
|
+ ENDFOREACH()
|
|
|
+
|
|
|
+ENDMACRO()
|
Sascha Zelzer