mirror of
https://github.com/Kitware/CMake.git
synced 2026-05-24 09:09:43 -05:00
Evan Wilde
e301cbffcc
Add the ability to modify the environment of the various steps running as part of an external project build. This specifically adds the ability to set them on the configure , build , install, and test steps, as well as exposing the `ENVIRONMENT_MODIFICATION` keyword arguments to `ExternalProject_Add_Step`, allowing customization of the environment of custom steps. The values of the environment variable respect the `LIST_SEPARATOR`. Fixes: #26963
103 lines
2.9 KiB
CMake
103 lines
2.9 KiB
CMake
include(ExternalProject)
|
|
|
|
#
|
|
## Set environment variables on custom commands
|
|
#
|
|
|
|
# Comma list-separator
|
|
set(ScriptPath "${CMAKE_CURRENT_SOURCE_DIR}/EnvVars/EchoVar.cmake")
|
|
ExternalProject_Add(CustomCommandEnvVars
|
|
DOWNLOAD_COMMAND ""
|
|
UPDATE_COMMAND ""
|
|
PATCH_COMMAND ""
|
|
LIST_SEPARATOR ,
|
|
CONFIGURE_COMMAND "${CMAKE_COMMAND}" -P ${ScriptPath}
|
|
COMMAND "${CMAKE_COMMAND}" -DVARNAME=Stage -P ${ScriptPath}
|
|
COMMAND "${CMAKE_COMMAND}" -DVARNAME=ListVar -P ${ScriptPath}
|
|
CONFIGURE_ENVIRONMENT_MODIFICATION
|
|
Stage=set:config
|
|
ListVar=set:4,5,6
|
|
ListSeparator=set:,
|
|
BUILD_COMMAND "${CMAKE_COMMAND}" -P ${ScriptPath}
|
|
BUILD_ENVIRONMENT_MODIFICATION
|
|
Stage=set:build
|
|
ListVar=set:4,5,6
|
|
ListSeparator=set:,
|
|
INSTALL_COMMAND "${CMAKE_COMMAND}" -P ${ScriptPath}
|
|
INSTALL_ENVIRONMENT_MODIFICATION
|
|
InstallVar=set:install
|
|
Stage=set:install
|
|
ListVar=set:4,5,6
|
|
ListSeparator=set:,
|
|
TEST_COMMAND "${CMAKE_COMMAND}" -P ${ScriptPath}
|
|
TEST_ENVIRONMENT_MODIFICATION
|
|
Stage=set:test
|
|
ListVar=set:4,5,6
|
|
ListSeparator=set:,)
|
|
|
|
ExternalProject_Add_Step(CustomCommandEnvVars custom
|
|
DEPENDERS configure
|
|
COMMAND "${CMAKE_COMMAND}" -DVARNAME=CustomVar -P ${ScriptPath}
|
|
COMMAND "${CMAKE_COMMAND}" -DVARNAME=CustomVar2 -P ${ScriptPath}
|
|
COMMAND "${CMAKE_COMMAND}" -P ${ScriptPath}
|
|
ENVIRONMENT_MODIFICATION
|
|
CustomVar=set:custom
|
|
CustomVar2=set:custom2
|
|
Stage=set:custom
|
|
ListVar=set:1,2,3
|
|
ListSeparator=set:,)
|
|
|
|
#
|
|
## Set environment variables on the default commands
|
|
#
|
|
|
|
# No list separator
|
|
ExternalProject_Add(DefaultCommandEnvVars
|
|
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/EnvVars"
|
|
DOWNLOAD_COMMAND ""
|
|
UPDATE_COMMAND ""
|
|
PATCH_COMMAND ""
|
|
DEPENDS CustomCommandEnvVars
|
|
CMAKE_ARGS
|
|
-DVARIABLE=ConfigVar
|
|
CONFIGURE_ENVIRONMENT_MODIFICATION
|
|
ConfigVar=set:config
|
|
ListVar=set:7,8,9
|
|
ListSeparator=set:,
|
|
BUILD_ENVIRONMENT_MODIFICATION
|
|
Stage=set:build
|
|
ListVar=set:7,8,9,10
|
|
ListSeparator=set:,
|
|
INSTALL_COMMAND "" # empty install command should not show up
|
|
INSTALL_ENVIRONMENT_MODIFICATION
|
|
Stage=set:install
|
|
Separator=set:,)
|
|
|
|
# Using `:` as a list separator on Windows does not work as it replaces the `:`
|
|
# between the drive letter and the filepath with `;`.
|
|
if(NOT WIN32)
|
|
# Ensure that using `:` as a list-separator does not break setting environment
|
|
# variables
|
|
ExternalProject_Add(DefaultCommandListSepEnvVars
|
|
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/EnvVars"
|
|
DOWNLOAD_COMMAND ""
|
|
UPDATE_COMMAND ""
|
|
PATCH_COMMAND ""
|
|
DEPENDS DefaultCommandEnvVars
|
|
LIST_SEPARATOR :
|
|
CMAKE_ARGS
|
|
-DVARIABLE=ConfigVar
|
|
CONFIGURE_ENVIRONMENT_MODIFICATION
|
|
ConfigVar=set:config
|
|
ListVar=set:10:11:12
|
|
ListSeparator=set::
|
|
BUILD_ENVIRONMENT_MODIFICATION
|
|
Stage=set:build
|
|
ListVar=set:10:11:12
|
|
ListSeparator=set::
|
|
INSTALL_ENVIRONMENT_MODIFICATION
|
|
Stage=set:install
|
|
ListSeparator=set::
|
|
ListVar=set:10:11:12:13)
|
|
endif()
|