Skip to content

[CMake] Add way to parametrize globally where to relocate plugins, projects and applications #5562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fredroy merged 2 commits into from
Aug 28, 2025
Merged

[CMake] Add way to parametrize globally where to relocate plugins, projects and applications #5562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3dd7962
Enable the use of global variable to specify relocatable directory an…
bakpaul Jun 25, 2025
8ded238
Remove debug message
bakpaul Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${ARCHIVE_OUTPUT_DIRECTOR
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${RUNTIME_OUTPUT_DIRECTORY})
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${LIBRARY_OUTPUT_DIRECTORY})

set(SOFA_APPLICATIONS_RELOCATABLE_PATH "applications" CACHE STRING "Relocatable path that will be used ot install applications")
set(SOFA_PLUGINS_RELOCATABLE_PATH "plugins" CACHE STRING "Relocatable path that will be used ot install plugins")
set(SOFA_PROJECTS_RELOCATABLE_PATH "projects" CACHE STRING "Relocatable path that will be used ot install projects")



# Option for packaging
option(SOFA_BUILD_RELEASE_PACKAGE "Run package specific configure" OFF)

Expand Down
84 changes: 66 additions & 18 deletions Sofa/framework/Config/cmake/SofaMacrosInstall.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ include(CMakeParseLibraryList)
# instead of being dispatched in SOFA install directory (between bin, libs, share, ...).
# If not building through SOFA, RELOCATABLE has no effect.
macro(sofa_create_package_with_targets)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE RELOCATABLE_PATH)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES NO_AUTO_RESOURCES_INSTALL)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Expand All @@ -46,6 +46,26 @@ macro(sofa_create_package_with_targets)
list(APPEND child_args INCLUDE_INSTALL_DIR "${ARG_PACKAGE_NAME}")
endif()

if(ARG_RELOCATABLE)
string(TOUPPER "${CMAKE_PROJECT_NAME}_${ARG_RELOCATABLE}_RELOCATABLE_PATH" global_relocatable_path)
if(${global_relocatable_path})
set(plugin_relocatable_path "${${global_relocatable_path}}" )
else()
message(WARNING "sofa_create_package_with_targets(${ARG_PACKAGE_NAME}) Relocatable type ${ARG_RELOCATABLE} is unknown. Either specify one of the following {applications, plugins, projects} or specify a custom RELOCATABLE_PATH")
endif()

if(ARG_RELOCATABLE_PATH)
list(FIND child_args "RELOCATABLE_PATH" relPathNameId)
list(REMOVE_AT child_args ${relPathNameId})
list(INSERT child_args ${relPathNameId} "${plugin_relocatable_path}")
else ()
list(APPEND child_args RELOCATABLE_PATH)
list(APPEND child_args "${plugin_relocatable_path}")
endif ()
endif()



sofa_create_package(${child_args})
sofa_add_targets_to_package(${child_args})
endmacro()
Expand Down Expand Up @@ -79,7 +99,7 @@ endmacro()
# instead of being dispatched in SOFA install directory (between bin, libs, share, ...).
# If not building through SOFA, RELOCATABLE has no effect.
macro(sofa_create_component_in_package_with_targets)
set(oneValueArgs COMPONENT_NAME COMPONENT_VERSION PACKAGE_NAME INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR RELOCATABLE)
set(oneValueArgs COMPONENT_NAME COMPONENT_VERSION PACKAGE_NAME INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR RELOCATABLE RELOCATABLE_PATH)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Expand All @@ -96,6 +116,24 @@ macro(sofa_create_component_in_package_with_targets)
list(APPEND child_args INCLUDE_INSTALL_DIR "${ARG_PACKAGE_NAME}")
endif()

if(ARG_RELOCATABLE)
string(TOUPPER "${CMAKE_PROJECT_NAME}_${ARG_RELOCATABLE}_RELOCATABLE_PATH" global_relocatable_path)
if(${global_relocatable_path})
set(plugin_relocatable_path "${${global_relocatable_path}}" )
else()
message(WARNING "sofa_create_component_in_package_with_targets(${ARG_PACKAGE_NAME}) Relocatable type ${ARG_RELOCATABLE} is unknown. Either specify one of the following {applications, plugins, projects} or specify a custom RELOCATABLE_PATH")
endif()

if(ARG_RELOCATABLE_PATH)
list(FIND child_args "RELOCATABLE_PATH" relPathNameId)
list(REMOVE_AT child_args ${relPathNameId})
list(INSERT child_args ${relPathNameId} "${plugin_relocatable_path}")
else ()
list(APPEND child_args RELOCATABLE_PATH)
list(APPEND child_args "${plugin_relocatable_path}")
endif ()
endif()

# Calling sofa_create_package like sofa_create_package_with_targets does
# but with different values for PACKAGE_NAME and PACKAGE_VERSION
# and a new PACKAGE_PARENT argument.
Expand Down Expand Up @@ -146,7 +184,7 @@ endmacro()
#
# check_required_components(Foo Qux)
macro(sofa_create_package)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION PACKAGE_PARENT INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION PACKAGE_PARENT INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE RELOCATABLE_PATH)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Expand All @@ -158,6 +196,15 @@ macro(sofa_create_package)
endif()
endforeach()

if(ARG_RELOCATABLE AND NOT ARG_RELOCATABLE_PATH)
string(TOUPPER "${CMAKE_PROJECT_NAME}_${ARG_RELOCATABLE}_RELOCATABLE_PATH" global_relocatable_path)
if(${global_relocatable_path})
set(ARG_RELOCATABLE_PATH "${${global_relocatable_path}}" )
else()
message(WARNING "sofa_create_component_in_package_with_targets(${ARG_PACKAGE_NAME}) Relocatable type ${ARG_RELOCATABLE} is unknown. Either specify one of the following {applications, plugins, projects} or specify a custom RELOCATABLE_PATH")
endif()
endif()

# Optional subpackage/namespace
set(package_install_dir ${ARG_PACKAGE_NAME})
set(package_namespace "")
Expand All @@ -184,7 +231,7 @@ macro(sofa_create_package)
"### Expanded from \@PACKAGE_GUARD\@ by SofaMacrosInstall.cmake ###" "\n"
"include_guard()" "\n"
)
if(ARG_RELOCATABLE)
if(ARG_RELOCATABLE_PATH)
string(CONCAT PACKAGE_GUARD ${PACKAGE_GUARD}
"list(APPEND CMAKE_LIBRARY_PATH \"\${CMAKE_CURRENT_LIST_DIR}/../../../bin\")" "\n"
"list(APPEND CMAKE_LIBRARY_PATH \"\${CMAKE_CURRENT_LIST_DIR}/../../../lib\")" "\n"
Expand All @@ -204,8 +251,8 @@ macro(sofa_create_package)
)
install(FILES "${CMAKE_BINARY_DIR}/lib/cmake/${ARG_PACKAGE_NAME}Config.cmake" DESTINATION "lib/cmake/${package_install_dir}" COMPONENT headers)

if(ARG_RELOCATABLE)
sofa_set_project_install_relocatable(${package_install_dir} ${CMAKE_CURRENT_BINARY_DIR} ${ARG_RELOCATABLE})
if(ARG_RELOCATABLE_PATH)
sofa_set_project_install_relocatable(${package_install_dir} ${CMAKE_CURRENT_BINARY_DIR} ${ARG_RELOCATABLE_PATH})
endif()

sofa_install_git_infos(${ARG_PACKAGE_NAME} ${CMAKE_CURRENT_SOURCE_DIR})
Expand All @@ -224,7 +271,7 @@ endmacro()
# Use AUTO_SET_TARGET_PROPERTIES to enable default properties setting
# on all targets (see sofa_auto_set_target_properties).
macro(sofa_add_targets_to_package)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE OPTIMIZE_BUILD_DIR)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE_PATH RELOCATABLE OPTIMIZE_BUILD_DIR)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES NO_AUTO_RESOURCES_INSTALL)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Expand Down Expand Up @@ -304,7 +351,7 @@ endfunction()
# - INCLUDE_DIRECTORIES: if not already set, add as PUBLIC include dirs
# 2 BUILD_INTERFACE (source dir and build dir) and 1 INSTALL_INTERFACE (install dir)
macro(sofa_auto_set_target_properties)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE RELOCATABLE_PATH)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Expand All @@ -327,7 +374,7 @@ endmacro()


macro(sofa_auto_set_target_version)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE RELOCATABLE_PATH)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Expand Down Expand Up @@ -383,7 +430,7 @@ endmacro()


macro(sofa_auto_set_target_compile_definitions)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE RELOCATABLE_PATH)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Expand Down Expand Up @@ -422,7 +469,7 @@ endmacro()


macro(sofa_auto_set_target_include_directories)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE RELOCATABLE_PATH)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Expand Down Expand Up @@ -481,7 +528,7 @@ macro(sofa_auto_set_target_include_directories)
target_include_directories(${target} ${TARGET_VISIBILITY} "$<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/include/${ARG_PACKAGE_NAME}>")
endif()

if(ARG_RELOCATABLE)
if(ARG_RELOCATABLE_PATH)
if(NOT "\$<INSTALL_INTERFACE:include>" IN_LIST target_include_dirs)
target_include_directories(${target} ${TARGET_VISIBILITY} "$<INSTALL_INTERFACE:include>")
endif()
Expand All @@ -501,10 +548,11 @@ endmacro()


macro(sofa_auto_set_target_rpath)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE RELOCATABLE_PATH)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})

# Required arguments
foreach(arg ARG_TARGETS)
if("${${arg}}" STREQUAL "")
Expand Down Expand Up @@ -539,7 +587,7 @@ macro(sofa_auto_set_target_rpath)
get_target_property(dep_reloc_install_dir ${dep} "RELOCATABLE_INSTALL_DIR")
if(dep_reloc_install_dir)
# the dependency is relocatable
if(ARG_RELOCATABLE)
if(ARG_RELOCATABLE_PATH)
# current target is relocatable
list(APPEND target_rpath
"$ORIGIN/../../../${dep_reloc_install_dir}/lib"
Expand All @@ -558,7 +606,7 @@ macro(sofa_auto_set_target_rpath)
endif()
else()
# the dependency is NOT relocatable
if(ARG_RELOCATABLE)
if(ARG_RELOCATABLE_PATH)
# current target is relocatable
list(APPEND target_rpath
"$ORIGIN/../../../lib"
Expand Down Expand Up @@ -587,7 +635,7 @@ endmacro()
# INCLUDE_INSTALL_DIR <include_install_dir>
# Directory in which headers will be copied into <CMAKE_INSTALL_PREFIX>/include/<include_install_dir>
macro(sofa_install_targets_in_package)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE OPTIMIZE_BUILD_DIR)
set(oneValueArgs PACKAGE_NAME PACKAGE_VERSION INCLUDE_ROOT_DIR INCLUDE_INSTALL_DIR INCLUDE_SOURCE_DIR EXAMPLE_INSTALL_DIR RELOCATABLE RELOCATABLE_PATH OPTIMIZE_BUILD_DIR)
set(multiValueArgs TARGETS)
set(optionalArgs AUTO_SET_TARGET_PROPERTIES NO_AUTO_RESOURCES_INSTALL)
cmake_parse_arguments("ARG" "${optionalArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Expand Down Expand Up @@ -663,7 +711,7 @@ macro(sofa_install_targets_in_package)
endif()

# Finalize dirs
if(ARG_RELOCATABLE)
if(ARG_RELOCATABLE_PATH)
set(header_install_dir "include/${header_relative_dir_for_build}")
else()
# headers install-dir tree = headers build-dir tree
Expand Down Expand Up @@ -707,7 +755,7 @@ macro(sofa_install_targets_in_package)
file(GLOB txt_files "*.txt" RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} LIST_DIRECTORIES false)
list(FILTER txt_files EXCLUDE REGEX "CMakeLists.txt")
file(GLOB md_files "*.md" RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} LIST_DIRECTORIES false)
if(ARG_RELOCATABLE)
if(ARG_RELOCATABLE_PATH)
set(info_install_dir ".")
else()
set(info_install_dir "include/${ARG_INCLUDE_INSTALL_DIR}")
Expand Down