Commit ce740851 authored by Brad King's avatar Brad King Committed by Kitware Robot
Browse files

Merge topic 'install-name-dir-genex'

a0e2e0ca Help: Add documentation and release notes for INSTALL_NAME_DIR genex
deeab72a Tests: Add tests for INSTALL_NAME_DIR
3c85f11f INSTALL_NAME_DIR: Add support for generator expressions
2ec1156b

 Refactor: Generalize cmExportInstallFileGenerator::ReplaceInstallPrefix()
Acked-by: Kitware Robot's avatarKitware Robot <kwrobot@kitware.com>
Merge-request: !3989
parents 0ff5bdd4 a0e2e0ca
......@@ -596,7 +596,8 @@ Target-Dependent Queries
requirement.
``$<INSTALL_PREFIX>``
Content of the install prefix when the target is exported via
:command:`install(EXPORT)` and empty otherwise.
:command:`install(EXPORT)`, or when evaluated in
:prop_tgt:`INSTALL_NAME_DIR`, and empty otherwise.
Output-Related Expressions
--------------------------
......
......@@ -10,3 +10,7 @@ installed targets.
This property is initialized by the value of the variable
:variable:`CMAKE_INSTALL_NAME_DIR` if it is set when a target is
created.
This property supports :manual:`generator expressions <cmake-generator-expressions(7)>`.
In particular, the ``$<INSTALL_PREFIX>`` generator expression can be used to set the
directory relative to the install-time prefix.
install-name-dir-genex
----------------------
* The :prop_tgt:`INSTALL_NAME_DIR` target property now supports
:manual:`generator expressions <cmake-generator-expressions(7)>`.
In particular, the ``$<INSTALL_PREFIX>`` generator expression can
be used to set the directory relative to the install-time prefix.
......@@ -258,15 +258,7 @@ void cmExportInstallFileGenerator::LoadConfigFiles(std::ostream& os)
void cmExportInstallFileGenerator::ReplaceInstallPrefix(std::string& input)
{
std::string::size_type pos = 0;
std::string::size_type lastPos = pos;
while ((pos = input.find("$<INSTALL_PREFIX>", lastPos)) !=
std::string::npos) {
std::string::size_type endPos = pos + sizeof("$<INSTALL_PREFIX>") - 1;
input.replace(pos, endPos - pos, "${_IMPORT_PREFIX}");
lastPos = endPos;
}
cmGeneratorExpression::ReplaceInstallPrefix(input, "${_IMPORT_PREFIX}");
}
bool cmExportInstallFileGenerator::GenerateImportFileConfig(
......@@ -525,13 +517,14 @@ void cmExportInstallFileGenerator::ComplainAboutMissingTarget(
}
std::string cmExportInstallFileGenerator::InstallNameDir(
cmGeneratorTarget* target, const std::string& /*config*/)
cmGeneratorTarget* target, const std::string& config)
{
std::string install_name_dir;
cmMakefile* mf = target->Target->GetMakefile();
if (mf->IsOn("CMAKE_PLATFORM_HAS_INSTALLNAME")) {
install_name_dir = target->GetInstallNameDirForInstallTree();
install_name_dir =
target->GetInstallNameDirForInstallTree(config, "${_IMPORT_PREFIX}");
}
return install_name_dir;
......
......@@ -385,6 +385,20 @@ bool cmGeneratorExpression::IsValidTargetName(const std::string& input)
return targetNameValidator.find(input);
}
void cmGeneratorExpression::ReplaceInstallPrefix(
std::string& input, const std::string& replacement)
{
std::string::size_type pos = 0;
std::string::size_type lastPos = pos;
while ((pos = input.find("$<INSTALL_PREFIX>", lastPos)) !=
std::string::npos) {
std::string::size_type endPos = pos + sizeof("$<INSTALL_PREFIX>") - 1;
input.replace(pos, endPos - pos, replacement);
lastPos = endPos;
}
}
void cmCompiledGeneratorExpression::GetMaxLanguageStandard(
const cmGeneratorTarget* tgt, std::map<std::string, std::string>& mapping)
{
......
......@@ -87,6 +87,9 @@ public:
return input != nullptr && input[0] == '$' && input[1] == '<';
}
static void ReplaceInstallPrefix(std::string& input,
const std::string& replacement);
private:
cmListFileBacktrace Backtrace;
};
......
......@@ -2125,7 +2125,9 @@ std::string cmGeneratorTarget::GetInstallNameDirForBuildTree(
// If building directly for installation then the build tree install_name
// is the same as the install tree.
if (this->MacOSXUseInstallNameDir()) {
return this->GetInstallNameDirForInstallTree();
std::string installPrefix =
this->Makefile->GetSafeDefinition("CMAKE_INSTALL_PREFIX");
return this->GetInstallNameDirForInstallTree(config, installPrefix);
}
// Use the build tree directory for the target.
......@@ -2143,7 +2145,8 @@ std::string cmGeneratorTarget::GetInstallNameDirForBuildTree(
return "";
}
std::string cmGeneratorTarget::GetInstallNameDirForInstallTree() const
std::string cmGeneratorTarget::GetInstallNameDirForInstallTree(
const std::string& config, const std::string& installPrefix) const
{
if (this->Makefile->IsOn("CMAKE_PLATFORM_HAS_INSTALLNAME")) {
std::string dir;
......@@ -2151,7 +2154,13 @@ std::string cmGeneratorTarget::GetInstallNameDirForInstallTree() const
if (this->CanGenerateInstallNameDir(INSTALL_NAME_FOR_INSTALL)) {
if (install_name_dir && *install_name_dir) {
dir = cmStrCat(install_name_dir, '/');
dir = install_name_dir;
cmGeneratorExpression::ReplaceInstallPrefix(dir, installPrefix);
dir =
cmGeneratorExpression::Evaluate(dir, this->LocalGenerator, config);
if (!dir.empty()) {
dir = cmStrCat(dir, '/');
}
}
}
if (!install_name_dir) {
......
......@@ -276,7 +276,8 @@ public:
/** Return the install name directory for the target in the
* install tree. For example: "\@rpath/" or "\@loader_path/". */
std::string GetInstallNameDirForInstallTree() const;
std::string GetInstallNameDirForInstallTree(
const std::string& config, const std::string& installPrefix) const;
cmListFileBacktrace GetBacktrace() const;
......
......@@ -554,7 +554,8 @@ void cmInstallTargetGenerator::AddInstallNamePatchRule(
// components of the install_name field then we need to create a
// mapping to be applied after installation.
std::string for_build = tgt->GetInstallNameDirForBuildTree(config);
std::string for_install = tgt->GetInstallNameDirForInstallTree();
std::string for_install = tgt->GetInstallNameDirForInstallTree(
config, "${CMAKE_INSTALL_PREFIX}");
if (for_build != for_install) {
// The directory portions differ. Append the filename to
// create the mapping.
......@@ -577,7 +578,8 @@ void cmInstallTargetGenerator::AddInstallNamePatchRule(
if (this->Target->GetType() == cmStateEnums::SHARED_LIBRARY) {
std::string for_build =
this->Target->GetInstallNameDirForBuildTree(config);
std::string for_install = this->Target->GetInstallNameDirForInstallTree();
std::string for_install = this->Target->GetInstallNameDirForInstallTree(
config, "${CMAKE_INSTALL_PREFIX}");
if (this->Target->IsFrameworkOnApple() && for_install.empty()) {
// Frameworks seem to have an id corresponding to their own full
......
......@@ -290,6 +290,9 @@ add_RunCMake_test(set_property)
add_RunCMake_test(string)
add_RunCMake_test(test_include_dirs)
add_RunCMake_test(BundleUtilities)
if(APPLE)
add_RunCMake_test(INSTALL_NAME_DIR)
endif()
function(add_RunCMake_test_try_compile)
if(CMAKE_VERSION VERSION_LESS 3.9.20170907 AND "x${CMAKE_CXX_COMPILER_ID}" STREQUAL "xMSVC")
......
cmake_minimum_required(VERSION 3.16)
project(${RunCMake_TEST} NONE)
include(${CMAKE_CURRENT_LIST_DIR}/INSTALL_NAME_DIR.cmake)
include(${RunCMake_TEST}.cmake)
function(add_install_name_dir_libraries install_name_dir)
add_library(build_dir SHARED test.c)
add_library(install_dir SHARED test.c)
if(NOT install_name_dir STREQUAL "NONE")
set_target_properties(build_dir install_dir PROPERTIES
INSTALL_NAME_DIR "${install_name_dir}"
)
endif()
set_target_properties(install_dir PROPERTIES
BUILD_WITH_INSTALL_NAME_DIR TRUE
)
install(TARGETS build_dir install_dir EXPORT InstallNameDirTest DESTINATION lib)
install(EXPORT InstallNameDirTest DESTINATION lib/cmake/InstallNameDirTest FILE InstallNameDirTest-targets.cmake)
file(GENERATE OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/targets.txt" CONTENT "$<TARGET_FILE:build_dir>\n$<TARGET_FILE:install_dir>\n" CONDITION $<CONFIG:Debug>)
endfunction()
cmake_minimum_required(VERSION 3.16)
include(RunCMake)
function(run_install_test case)
set(RunCMake_TEST_BINARY_DIR ${RunCMake_BINARY_DIR}/${case}-build)
set(RunCMake_TEST_NO_CLEAN 1)
set(RunCMake_TEST_OPTIONS -DCMAKE_BUILD_TYPE:STRING=Debug "-DCMAKE_INSTALL_PREFIX:PATH=${RunCMake_TEST_BINARY_DIR}/fake_install")
file(REMOVE_RECURSE "${RunCMake_TEST_BINARY_DIR}")
file(MAKE_DIRECTORY "${RunCMake_TEST_BINARY_DIR}")
run_cmake(${case})
run_cmake_command(${case}-build ${CMAKE_COMMAND} --build . --config Debug)
run_cmake_command(${case}-install ${CMAKE_COMMAND} --install . --config Debug --prefix "${RunCMake_TEST_BINARY_DIR}/real_install")
endfunction()
find_program(OTOOL_COMMAND otool)
function(check_install_name_dir file expected)
execute_process(COMMAND ${OTOOL_COMMAND} -l ${file} RESULT_VARIABLE _result OUTPUT_VARIABLE _output)
if(_result)
string(APPEND RunCMake_TEST_FAILED "Could not run otool on ${file}\n")
elseif(_output MATCHES "cmd LC_ID_DYLIB\n[^\n]*\n *name ([^\n]*) \\(offset [0-9]+\\)\n")
set(_install_name "${CMAKE_MATCH_1}")
if(NOT _install_name MATCHES "${expected}")
string(APPEND RunCMake_TEST_FAILED "Install name of ${file} did not match ${expected} (actual: ${_install_name})\n")
endif()
else()
string(APPEND RunCMake_TEST_FAILED "otool did not print install name for ${file}\n")
endif()
set(RunCMake_TEST_FAILED "${RunCMake_TEST_FAILED}" PARENT_SCOPE)
endfunction()
function(check_imported_soname contents target expected)
if(contents MATCHES "set_target_properties\\(${target} PROPERTIES\n[^\n]*\n *IMPORTED_SONAME_DEBUG \"([^\n]*)\"\n")
set(_soname "${CMAKE_MATCH_1}")
set(_regex "^${expected}lib${target}\\.dylib$")
if(NOT _soname MATCHES "${_regex}")
string(APPEND RunCMake_TEST_FAILED "Target ${target}'s IMPORTED_SONAME_DEBUG did not match ${_regex} (actual: ${_soname})\n")
endif()
else()
string(APPEND RunCMake_TEST_FAILED "Could not find IMPORTED_SONAME_DEBUG for target ${target} in package config file\n")
endif()
set(RunCMake_TEST_FAILED "${RunCMake_TEST_FAILED}" PARENT_SCOPE)
endfunction()
function(check_libraries fake_install real_install soname_prefix)
file(STRINGS "${RunCMake_TEST_BINARY_DIR}/targets.txt" _targets)
list(GET _targets 0 _build_dir)
list(GET _targets 1 _install_dir)
check_install_name_dir("${_build_dir}" "^@rpath/libbuild_dir\\.dylib$")
check_install_name_dir("${_install_dir}" "^${fake_install}libinstall_dir\\.dylib$")
check_install_name_dir("${RunCMake_TEST_BINARY_DIR}/real_install/lib/libbuild_dir.dylib" "^${real_install}libbuild_dir\\.dylib$")
check_install_name_dir("${RunCMake_TEST_BINARY_DIR}/real_install/lib/libinstall_dir.dylib" "^${real_install}libinstall_dir\\.dylib$")
file(READ "${RunCMake_TEST_BINARY_DIR}/real_install/lib/cmake/InstallNameDirTest/InstallNameDirTest-targets-debug.cmake" _targets)
check_imported_soname("${_targets}" build_dir "${soname_prefix}")
check_imported_soname("${_targets}" install_dir "${soname_prefix}")
set(RunCMake_TEST_FAILED "${RunCMake_TEST_FAILED}" PARENT_SCOPE)
endfunction()
run_install_test(none)
run_install_test(empty)
run_install_test(simple)
run_install_test(simple_genex)
run_install_test(prefix_genex)
run_install_test(empty_genex)
enable_language(C)
add_install_name_dir_libraries("")
enable_language(C)
add_install_name_dir_libraries($<0:/usr/local/lib>)
check_libraries(@rpath/ @rpath/ @rpath/)
enable_language(C)
add_install_name_dir_libraries(NONE)
check_libraries(
".*/Tests/RunCMake/INSTALL_NAME_DIR/prefix_genex-build/fake_install/lib/"
".*/Tests/RunCMake/INSTALL_NAME_DIR/prefix_genex-build/real_install/lib/"
# "$" has to be escaped twice because of its significance in regexes.
"\\\${_IMPORT_PREFIX}/lib/"
)
enable_language(C)
add_install_name_dir_libraries($<1:$<INSTALL_PREFIX>/lib>)
check_libraries(/usr/local/lib/ /usr/local/lib/ /usr/local/lib/)
enable_language(C)
add_install_name_dir_libraries(/usr/local/lib)
check_libraries(/usr/local/lib/ /usr/local/lib/ /usr/local/lib/)
enable_language(C)
add_install_name_dir_libraries($<1:/usr/local/lib>)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment