UpdateBot: Nightly -> 4.10

2018-10-19T00:43:54Z

Nightly -> 4.10

New page

<noinclude>__TOC__</noinclude>
==Slicer Extension updates==
===Slicer 4.9: Explicit initialization of CMAKE_BUILD_TYPE not needed anymore===

Following [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=26978 r26978], calling <tt>find_package(Slicer REQUIRED)</tt> and <tt>include(${Slicer_USE_FILE})</tt> initializes <tt>CMAKE_BUILD_TYPE</tt> and ensures the variables <tt>CMAKE_BUILD_TYPE</tt> and <tt>CMAKE_CONFIGURATION_TYPES</tt> are passed to all external projects when configuring SuperBuild based extension.

The module <tt>SlicerInitializeBuildType</tt> is automatically included in <tt>UserSlicer</tt>.

===Slicer 4.9: Subversion not required anymore===

Following [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=27060 r27060], Subversion is not required anymore.

===Slicer 4.9: Support EP_GIT_PROTOCOL and use of ExternalProject_SetIfNotDefined for setting GIT_REPOSITORY, GIT_TAG and alike===

Following [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=26957 r26957], extension may use the following convention to define <tt>GIT_REPOSITORY</tt> and <tt>GIT_TAG</tt>, this allows developer to override the value before the first configuration by setting the corresponding environment variable, or by explicitly configuring the project with that variable.

The option <tt>EP_GIT_PROTOCOL</tt> is also already set in <tt>ExternalProjectDependency</tt> module included by Slicer and its value is updated based on the <tt><SUPERBUILD_TOPLEVEL_PROJECT>_USE_GIT_PROTOCOL</tt> option.

<pre>
ExternalProject_SetIfNotDefined(
${CMAKE_PROJECT_NAME}_${proj}_GIT_REPOSITORY
"${EP_GIT_PROTOCOL}://github.com/jcfr/shape4D.git"
QUIET
)

ExternalProject_SetIfNotDefined(
${CMAKE_PROJECT_NAME}_${proj}_GIT_TAG
"12fef84ca2a56feffc59d8159bdadd2ce4a4138e" # slicersalt-2018-01-22-c74c766a4c
QUIET
)
</pre>

See:
* https://cmake-artichoke.readthedocs.io/en/latest/ExternalProjectDependency.html#variable:EP_GIT_PROTOCOL
* https://cmake-artichoke.readthedocs.io/en/latest/ExternalProjectDependency.html#function:ExternalProject_SetIfNotDefined

===Slicer 4.9: Use ExternalProject_AlwaysConfigure to force reconfigure of inner project===

Following [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=26551 r26551], the function <tt>ExternalProject_AlwaysConfigure</tt> may be used to ensure the inner project is always reconfigured.

Using the `BUILD_ALWAYS` option supported by <tt>ExternalProject_Add</tt> will not have the intended effect.

See https://cmake-artichoke.readthedocs.io/en/latest/ExternalProjectDependency.html#function:ExternalProject_AlwaysConfigure

===Slicer 4.9: Specifying external projects to install in SuperBuild extension===

Following [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=27267 r27267] and [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=27232 r27232], the following should be used to ensure
the extension can also be bundled into a Slicer custom application. When bundled, the variable <tt>${EXTENSION_NAME}_CPACK_INSTALL_CMAKE_PROJECTS</tt> is then used to update the application's list of project to install.

<pre>
#-----------------------------------------------------------------------------
set(EXTENSION_CPACK_INSTALL_CMAKE_PROJECTS)
#list(APPEND EXTENSION_CPACK_INSTALL_CMAKE_PROJECTS "${Foo_DIR};Foo;RuntimeLibraries;/")
set(${EXTENSION_NAME}_CPACK_INSTALL_CMAKE_PROJECTS "${EXTENSION_CPACK_INSTALL_CMAKE_PROJECTS}" CACHE STRING "List of external projects to install" FORCE)

#-----------------------------------------------------------------------------
list(APPEND CPACK_INSTALL_CMAKE_PROJECTS "${CMAKE_BINARY_DIR};${EXTENSION_NAME};ALL;/")
list(APPEND CPACK_INSTALL_CMAKE_PROJECTS "${${EXTENSION_NAME}_CPACK_INSTALL_CMAKE_PROJECTS}")
include(${Slicer_EXTENSION_GENERATE_CONFIG})
include(${Slicer_EXTENSION_CPACK})
</pre>

===Slicer 4.9: Generating (Extension)Config.cmake===

Initially introduced in [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=25944 r25944], and later improved in [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=25991 r25991], including <tt>${Slicer_EXTENSION_GENERATE_CONFIG}</tt> ensure a config is generated and allow an extension to import targets from another extension by using <tt>find_package(ExtensionName REQUIRED)</tt>.

<pre>
[...]

include(${Slicer_EXTENSION_GENERATE_CONFIG})
include(${Slicer_EXTENSION_CPACK})
</pre>

===Slicer 4.9: Initializing <projectName>_BUILD_SLICER_EXTENSION option: Standalone vs Slicer extension build===

The following snippet allows to automatically initialize <tt><projectName>_BUILD_SLICER_EXTENSION</tt> to <tt>ON</tt> if <tt>Slicer_DIR</tt> is defined.

<pre>
#-----------------------------------------------------------------------------
# Standalone vs Slicer extension option
#-----------------------------------------------------------------------------

# This option should be named after the project name, it corresponds to the
# option set to ON when the project is build by the Slicer Extension build
# system.

set(_default OFF)
set(_reason "${PROJECT_NAME}_BUILD_SLICER_EXTENSION is ON")
if(NOT DEFINED ${PROJECT_NAME}_BUILD_SLICER_EXTENSION AND DEFINED Slicer_DIR)
set(_default ON)
set(_reason "Slicer_DIR is SET")
endif()

option(${PROJECT_NAME}_BUILD_SLICER_EXTENSION "Build as a Slicer Extension" ${_default})

set(_msg "Checking if building as a Slicer extension")
message(STATUS ${_msg})
if(${PROJECT_NAME}_BUILD_SLICER_EXTENSION)
message(STATUS "${_msg} - yes (${_reason})")
else()
message(STATUS "${_msg} - no (${PROJECT_NAME}_BUILD_SLICER_EXTENSION is OFF)")
endif()
mark_as_superbuild(${PROJECT_NAME}_BUILD_SLICER_EXTENSION:BOOL)
</pre>

Documentation/4.10/Developers/Tutorials/MigrationGuide/SlicerExtension - Revision history

UpdateBot: Nightly -> 4.10