1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file LICENSE.rst or https://cmake.org/licensing for details. */
#include "cmInstallTargetGenerator.h"
#include <algorithm>
#include <cassert>
#include <functional>
#include <map>
#include <set>
#include <sstream>
#include <utility>
#include <vector>
#include <cm/optional>
#include "cmComputeLinkInformation.h"
#include "cmGeneratorExpression.h"
#include "cmGeneratorTarget.h"
#include "cmGlobalGenerator.h"
#include "cmInstallType.h"
#include "cmLocalGenerator.h"
#include "cmMakefile.h"
#include "cmMessageType.h"
#include "cmOutputConverter.h"
#include "cmPolicies.h"
#include "cmScriptGenerator.h"
#include "cmStateTypes.h"
#include "cmStringAlgorithms.h"
#include "cmSystemTools.h"
#include "cmTarget.h"
#include "cmValue.h"
#include "cmake.h"
namespace {
std::string computeInstallObjectDir(cmGeneratorTarget* gt,
std::string const& config)
{
std::string objectDir = "objects";
if (!config.empty()) {
objectDir += "-";
objectDir += config;
}
objectDir += "/";
objectDir += gt->GetName();
return objectDir;
}
void computeFilesToInstall(
cmInstallTargetGenerator::Files& files,
cmInstallTargetGenerator::NamelinkModeType namelinkMode,
std::string const& fromDirConfig, std::string const& output,
std::string const& library, std::string const& real,
cm::optional<std::function<void(std::string const&)>> GNUToMS = cm::nullopt)
{
bool haveNamelink = false;
auto convert = [&GNUToMS](std::string const& file) {
if (GNUToMS) {
(*GNUToMS)(file);
}
};
// Library link name.
std::string fromName = cmStrCat(fromDirConfig, output);
std::string toName = output;
// Library interface name.
std::string fromSOName;
std::string toSOName;
if (!library.empty() && library != output) {
haveNamelink = true;
fromSOName = cmStrCat(fromDirConfig, library);
toSOName = library;
}
// Library implementation name.
std::string fromRealName;
std::string toRealName;
if (real != output && real != library) {
haveNamelink = true;
fromRealName = cmStrCat(fromDirConfig, real);
toRealName = real;
}
// Add the names based on the current namelink mode.
if (haveNamelink) {
files.NamelinkMode = namelinkMode;
// With a namelink we need to check the mode.
if (namelinkMode == cmInstallTargetGenerator::NamelinkModeOnly) {
// Install the namelink only.
files.From.emplace_back(fromName);
files.To.emplace_back(toName);
convert(output);
} else {
// Install the real file if it has its own name.
if (!fromRealName.empty()) {
files.From.emplace_back(fromRealName);
files.To.emplace_back(toRealName);
convert(real);
}
// Install the soname link if it has its own name.
if (!fromSOName.empty()) {
files.From.emplace_back(fromSOName);
files.To.emplace_back(toSOName);
convert(library);
}
// Install the namelink if it is not to be skipped.
if (namelinkMode != cmInstallTargetGenerator::NamelinkModeSkip) {
files.From.emplace_back(fromName);
files.To.emplace_back(toName);
convert(output);
}
}
} else {
// Without a namelink there will be only one file. Install it
// if this is not a namelink-only rule.
if (namelinkMode != cmInstallTargetGenerator::NamelinkModeOnly) {
files.From.emplace_back(fromName);
files.To.emplace_back(toName);
convert(output);
}
}
}
}
cmInstallTargetGenerator::cmInstallTargetGenerator(
std::string targetName, std::string const& dest, bool implib,
std::string file_permissions, std::vector<std::string> const& configurations,
std::string const& component, MessageLevel message, bool exclude_from_all,
bool optional, cmListFileBacktrace backtrace)
: cmInstallGenerator(dest, configurations, component, message,
exclude_from_all, false, std::move(backtrace))
, TargetName(std::move(targetName))
, FilePermissions(std::move(file_permissions))
, ImportLibrary(implib)
, Optional(optional)
{
this->ActionsPerConfig = true;
this->NamelinkMode = NamelinkModeNone;
this->ImportlinkMode = NamelinkModeNone;
}
cmInstallTargetGenerator::~cmInstallTargetGenerator() = default;
void cmInstallTargetGenerator::GenerateScriptForConfig(
std::ostream& os, std::string const& config, Indent indent)
{
// Compute the list of files to install for this target.
Files files = this->GetFiles(config);
// Skip this rule if no files are to be installed for the target.
if (files.From.empty()) {
return;
}
// Compute the effective install destination.
std::string dest = this->GetDestination(config);
if (!files.ToDir.empty()) {
dest = cmStrCat(dest, '/', files.ToDir);
}
// Tweak files located in the destination directory.
std::string toDir = cmStrCat(ConvertToAbsoluteDestination(dest), '/');
// Add pre-installation tweaks.
if (!files.NoTweak) {
AddTweak(os, indent, config, toDir, files.To,
[this](std::ostream& o, Indent i, std::string const& c,
std::string const& f) {
this->PreReplacementTweaks(o, i, c, f);
});
}
// Write code to install the target file.
char const* no_dir_permissions = nullptr;
char const* no_rename = nullptr;
bool optional = this->Optional || this->ImportLibrary;
std::string literal_args;
if (!files.FromDir.empty()) {
literal_args += " FILES_FROM_DIR \"" + files.FromDir + "\"";
}
if (files.UseSourcePermissions) {
literal_args += " USE_SOURCE_PERMISSIONS";
}
this->AddInstallRule(os, dest, files.Type, files.From, optional,
this->FilePermissions.c_str(), no_dir_permissions,
no_rename, literal_args.c_str(), indent);
// Add post-installation tweaks.
if (!files.NoTweak) {
AddTweak(os, indent, config, toDir, files.To,
[this](std::ostream& o, Indent i, std::string const& c,
std::string const& f) {
this->PostReplacementTweaks(o, i, c, f);
});
}
}
cmInstallTargetGenerator::Files cmInstallTargetGenerator::GetFiles(
std::string const& config) const
{
Files files;
cmStateEnums::TargetType targetType = this->Target->GetType();
switch (targetType) {
case cmStateEnums::EXECUTABLE:
files.Type = cmInstallType_EXECUTABLE;
break;
case cmStateEnums::STATIC_LIBRARY:
files.Type = cmInstallType_STATIC_LIBRARY;
break;
case cmStateEnums::SHARED_LIBRARY:
files.Type = cmInstallType_SHARED_LIBRARY;
break;
case cmStateEnums::MODULE_LIBRARY:
files.Type = cmInstallType_MODULE_LIBRARY;
break;
case cmStateEnums::INTERFACE_LIBRARY:
// Not reachable. We never create a cmInstallTargetGenerator for
// an INTERFACE_LIBRARY.
assert(false &&
"INTERFACE_LIBRARY targets have no installable outputs.");
break;
case cmStateEnums::OBJECT_LIBRARY: {
// Compute all the object files inside this target
std::vector<std::string> objects;
this->Target->GetTargetObjectNames(config, objects);
files.Type = cmInstallType_FILES;
files.NoTweak = true;
files.FromDir = this->Target->GetObjectDirectory(config);
files.ToDir = computeInstallObjectDir(this->Target, config);
for (std::string& obj : objects) {
files.From.emplace_back(obj);
files.To.emplace_back(std::move(obj));
}
return files;
}
case cmStateEnums::UTILITY:
case cmStateEnums::GLOBAL_TARGET:
case cmStateEnums::UNKNOWN_LIBRARY:
this->Target->GetLocalGenerator()->IssueMessage(
MessageType::INTERNAL_ERROR,
"cmInstallTargetGenerator created with non-installable target.");
return files;
}
// Compute the build tree directory from which to copy the target.
std::string fromDirConfig;
if (this->Target->NeedRelinkBeforeInstall(config)) {
fromDirConfig =
cmStrCat(this->Target->GetLocalGenerator()->GetCurrentBinaryDirectory(),
"/CMakeFiles/CMakeRelink.dir/");
} else {
cmStateEnums::ArtifactType artifact = this->ImportLibrary
? cmStateEnums::ImportLibraryArtifact
: cmStateEnums::RuntimeBinaryArtifact;
fromDirConfig =
cmStrCat(this->Target->GetDirectory(config, artifact), '/');
}
if (targetType == cmStateEnums::EXECUTABLE) {
// There is a bug in cmInstallCommand if this fails.
assert(this->NamelinkMode == NamelinkModeNone);
cmGeneratorTarget::Names targetNames =
this->Target->GetExecutableNames(config);
if (this->ImportLibrary) {
std::string from1 = fromDirConfig + targetNames.ImportLibrary;
std::string to1 = targetNames.ImportLibrary;
files.From.emplace_back(std::move(from1));
files.To.emplace_back(std::move(to1));
std::string targetNameImportLib;
if (this->Target->GetImplibGNUtoMS(config, targetNames.ImportLibrary,
targetNameImportLib)) {
files.From.emplace_back(fromDirConfig + targetNameImportLib);
files.To.emplace_back(targetNameImportLib);
}
// An import library looks like a static library.
files.Type = cmInstallType_STATIC_LIBRARY;
} else {
std::string from1 = fromDirConfig + targetNames.Output;
std::string to1 = targetNames.Output;
// Handle OSX Bundles.
if (this->Target->IsAppBundleOnApple()) {
cmMakefile const* mf = this->Target->Target->GetMakefile();
// Get App Bundle Extension
std::string ext;
if (cmValue p = this->Target->GetProperty("BUNDLE_EXTENSION")) {
ext = *p;
} else {
ext = "app";
}
// Install the whole app bundle directory.
files.Type = cmInstallType_DIRECTORY;
files.UseSourcePermissions = true;
from1 += ".";
from1 += ext;
// Tweaks apply to the binary inside the bundle.
to1 += ".";
to1 += ext;
to1 += "/";
if (!mf->PlatformIsAppleEmbedded()) {
to1 += "Contents/MacOS/";
}
to1 += targetNames.Output;
} else {
// Tweaks apply to the real file, so list it first.
if (targetNames.Real != targetNames.Output) {
std::string from2 = fromDirConfig + targetNames.Real;
std::string to2 = targetNames.Real;
files.From.emplace_back(std::move(from2));
files.To.emplace_back(std::move(to2));
}
}
files.From.emplace_back(std::move(from1));
files.To.emplace_back(std::move(to1));
}
} else {
cmGeneratorTarget::Names targetNames =
this->Target->GetLibraryNames(config);
if (this->ImportLibrary) {
// There is a bug in cmInstallCommand if this fails.
assert(this->Target->Makefile->PlatformSupportsAppleTextStubs() ||
this->ImportlinkMode == NamelinkModeNone);
auto GNUToMS = [this, &config, &files,
&fromDirConfig](std::string const& lib) {
std::string importLib;
if (this->Target->GetImplibGNUtoMS(config, lib, importLib)) {
files.From.emplace_back(fromDirConfig + importLib);
files.To.emplace_back(importLib);
}
};
computeFilesToInstall(
files, this->ImportlinkMode, fromDirConfig, targetNames.ImportOutput,
targetNames.ImportLibrary, targetNames.ImportReal, GNUToMS);
// An import library looks like a static library.
files.Type = cmInstallType_STATIC_LIBRARY;
} else if (this->Target->IsFrameworkOnApple()) {
// FIXME: In principle we should be able to
// assert(this->NamelinkMode == NamelinkModeNone);
// but since the current install() command implementation checks
// the FRAMEWORK property immediately instead of delaying until
// generate time, it is possible for project code to set the
// property after calling install(). In such a case, the install()
// command will use the LIBRARY code path and create two install
// generators, one for the namelink component (NamelinkModeOnly)
// and one for the primary artifact component (NamelinkModeSkip).
// Historically this was not diagnosed and resulted in silent
// installation of a framework to the LIBRARY destination.
// Retain that behavior and warn about the case.
switch (this->NamelinkMode) {
case NamelinkModeNone:
// Normal case.
break;
case NamelinkModeOnly:
// Assume the NamelinkModeSkip instance will warn and install.
return files;
case NamelinkModeSkip: {
std::string e = "Target '" + this->Target->GetName() +
"' was changed to a FRAMEWORK sometime after install(). "
"This may result in the wrong install DESTINATION. "
"Set the FRAMEWORK property earlier.";
this->Target->GetGlobalGenerator()->GetCMakeInstance()->IssueMessage(
MessageType::AUTHOR_WARNING, e, this->GetBacktrace());
} break;
}
// Install the whole framework directory.
files.Type = cmInstallType_DIRECTORY;
files.UseSourcePermissions = true;
std::string from1 = fromDirConfig + targetNames.Output;
from1 = cmSystemTools::GetFilenamePath(from1);
// Tweaks apply to the binary inside the bundle.
std::string to1 = targetNames.Real;
files.From.emplace_back(std::move(from1));
files.To.emplace_back(std::move(to1));
} else if (this->Target->IsCFBundleOnApple()) {
// Install the whole app bundle directory.
files.Type = cmInstallType_DIRECTORY;
files.UseSourcePermissions = true;
std::string targetNameBase =
targetNames.Output.substr(0, targetNames.Output.find('/'));
std::string from1 = fromDirConfig + targetNameBase;
std::string to1 = targetNames.Output;
files.From.emplace_back(std::move(from1));
files.To.emplace_back(std::move(to1));
} else if (this->Target->IsArchivedAIXSharedLibrary()) {
// Install only the archive on AIX.
computeFilesToInstall(files, this->NamelinkMode, fromDirConfig,
targetNames.Output, {}, targetNames.Real);
} else {
computeFilesToInstall(files, this->NamelinkMode, fromDirConfig,
targetNames.Output, targetNames.SharedObject,
targetNames.Real);
}
}
// If this fails the above code is buggy.
assert(files.From.size() == files.To.size());
return files;
}
void cmInstallTargetGenerator::GetInstallObjectNames(
std::string const& config, std::vector<std::string>& objects) const
{
this->Target->GetTargetObjectNames(config, objects);
for (std::string& o : objects) {
o = cmStrCat(computeInstallObjectDir(this->Target, config), '/', o);
}
}
std::string cmInstallTargetGenerator::GetDestination(
std::string const& config) const
{
return cmGeneratorExpression::Evaluate(
this->Destination, this->Target->GetLocalGenerator(), config);
}
std::string cmInstallTargetGenerator::GetInstallFilename(
std::string const& config) const
{
NameType nameType = this->ImportLibrary ? NameImplib : NameNormal;
return cmInstallTargetGenerator::GetInstallFilename(this->Target, config,
nameType);
}
std::string cmInstallTargetGenerator::GetInstallFilename(
cmGeneratorTarget const* target, std::string const& config,
NameType nameType)
{
std::string fname;
// Compute the name of the library.
if (target->GetType() == cmStateEnums::EXECUTABLE) {
cmGeneratorTarget::Names targetNames = target->GetExecutableNames(config);
if (nameType == NameImplib) {
// Use the import library name.
if (!target->GetImplibGNUtoMS(config, targetNames.ImportLibrary, fname,
"${CMAKE_IMPORT_LIBRARY_SUFFIX}")) {
fname = targetNames.ImportLibrary;
}
} else if (nameType == NameImplibReal) {
// Use the import library name.
if (!target->GetImplibGNUtoMS(config, targetNames.ImportReal, fname,
"${CMAKE_IMPORT_LIBRARY_SUFFIX}")) {
fname = targetNames.ImportReal;
}
} else if (nameType == NameReal) {
// Use the canonical name.
fname = targetNames.Real;
} else {
// Use the canonical name.
fname = targetNames.Output;
}
} else {
cmGeneratorTarget::Names targetNames = target->GetLibraryNames(config);
if (nameType == NameImplib || nameType == NameImplibReal) {
auto const& importName = nameType == NameImplib
? targetNames.ImportLibrary
: targetNames.ImportReal;
// Use the import library name.
if (!target->GetImplibGNUtoMS(config, importName, fname,
"${CMAKE_IMPORT_LIBRARY_SUFFIX}")) {
fname = importName;
}
} else if (nameType == NameSO) {
// Use the soname.
fname = targetNames.SharedObject;
} else if (nameType == NameReal) {
// Use the real name.
fname = targetNames.Real;
} else {
// Use the canonical name.
fname = targetNames.Output;
}
}
return fname;
}
bool cmInstallTargetGenerator::Compute(cmLocalGenerator* lg)
{
// Lookup this target in the current directory.
this->Target = lg->FindLocalNonAliasGeneratorTarget(this->TargetName);
if (!this->Target) {
// If no local target has been found, find it in the global scope.
this->Target =
lg->GetGlobalGenerator()->FindGeneratorTarget(this->TargetName);
}
return true;
}
void cmInstallTargetGenerator::PreReplacementTweaks(std::ostream& os,
Indent indent,
std::string const& config,
std::string const& file)
{
this->AddRPathCheckRule(os, indent, config, file);
}
void cmInstallTargetGenerator::PostReplacementTweaks(std::ostream& os,
Indent indent,
std::string const& config,
std::string const& file)
{
this->AddInstallNamePatchRule(os, indent, config, file);
this->AddChrpathPatchRule(os, indent, config, file);
this->AddUniversalInstallRule(os, indent, file);
this->AddRanlibRule(os, indent, file);
this->AddStripRule(os, indent, file);
}
void cmInstallTargetGenerator::AddInstallNamePatchRule(
std::ostream& os, Indent indent, std::string const& config,
std::string const& toDestDirPath)
{
if (this->ImportLibrary || this->NamelinkMode == NamelinkModeOnly ||
!(this->Target->GetType() == cmStateEnums::SHARED_LIBRARY ||
this->Target->GetType() == cmStateEnums::MODULE_LIBRARY ||
this->Target->GetType() == cmStateEnums::EXECUTABLE)) {
return;
}
// Fix the install_name settings in installed binaries.
std::string installNameTool =
this->Target->Target->GetMakefile()->GetSafeDefinition(
"CMAKE_INSTALL_NAME_TOOL");
if (installNameTool.empty()) {
return;
}
// Build a map of build-tree install_name to install-tree install_name for
// shared libraries linked to this target.
std::map<std::string, std::string> install_name_remap;
if (cmComputeLinkInformation* cli =
this->Target->GetLinkInformation(config)) {
std::set<cmGeneratorTarget const*> const& sharedLibs =
cli->GetSharedLibrariesLinked();
for (cmGeneratorTarget const* tgt : sharedLibs) {
// The install_name of an imported target does not change.
if (tgt->IsImported()) {
continue;
}
// If the build tree and install tree use different path
// 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(
config, "${CMAKE_INSTALL_PREFIX}");
if (for_build != for_install) {
// The directory portions differ. Append the filename to
// create the mapping.
std::string fname = this->GetInstallFilename(tgt, config, NameSO);
// Map from the build-tree install_name.
for_build += fname;
// Map to the install-tree install_name.
for_install += fname;
// Store the mapping entry.
install_name_remap[for_build] = for_install;
}
}
}
// Edit the install_name of the target itself if necessary.
std::string new_id;
if (this->Target->GetType() == cmStateEnums::SHARED_LIBRARY) {
std::string for_build =
this->Target->GetInstallNameDirForBuildTree(config);
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
// path.
// ...
// for_install = fullDestPath_without_DESTDIR_or_name;
}
// If the install name will change on installation set the new id
// on the installed file.
if (for_build != for_install) {
// Prepare to refer to the install-tree install_name.
new_id = cmStrCat(
for_install, this->GetInstallFilename(this->Target, config, NameSO));
}
}
// Write a rule to run install_name_tool to set the install-tree
// install_name value and references.
if (!new_id.empty() || !install_name_remap.empty()) {
os << indent << "execute_process(COMMAND \"" << installNameTool;
os << "\"";
if (!new_id.empty()) {
os << "\n" << indent << " -id \"" << new_id << "\"";
}
for (auto const& i : install_name_remap) {
os << "\n"
<< indent << " -change \"" << i.first << "\" \"" << i.second << "\"";
}
os << "\n" << indent << " \"" << toDestDirPath << "\")\n";
}
}
void cmInstallTargetGenerator::AddRPathCheckRule(
std::ostream& os, Indent indent, std::string const& config,
std::string const& toDestDirPath)
{
// Skip the chrpath if the target does not need it.
if (this->ImportLibrary || this->NamelinkMode == NamelinkModeOnly ||
!this->Target->IsChrpathUsed(config)) {
return;
}
// Skip if on Apple
if (this->Target->Target->GetMakefile()->IsOn(
"CMAKE_PLATFORM_HAS_INSTALLNAME")) {
return;
}
// Get the link information for this target.
// It can provide the RPATH.
cmComputeLinkInformation* cli = this->Target->GetLinkInformation(config);
if (!cli) {
return;
}
// Write a rule to remove the installed file if its rpath is not the
// new rpath. This is needed for existing build/install trees when
// the installed rpath changes but the file is not rebuilt.
os << indent << "file(RPATH_CHECK\n"
<< indent << " FILE \"" << toDestDirPath << "\"\n";
// CMP0095: ``RPATH`` entries are properly escaped in the intermediary
// CMake install script.
switch (this->Target->GetPolicyStatusCMP0095()) {
case cmPolicies::WARN:
// No author warning needed here, we warn later in
// cmInstallTargetGenerator::AddChrpathPatchRule().
CM_FALLTHROUGH;
case cmPolicies::OLD: {
// Get the install RPATH from the link information.
std::string newRpath = cli->GetChrpathString();
os << indent << " RPATH \"" << newRpath << "\")\n";
break;
}
default: {
// Get the install RPATH from the link information and
// escape any CMake syntax in the install RPATH.
std::string escapedNewRpath =
cmOutputConverter::EscapeForCMake(cli->GetChrpathString());
os << indent << " RPATH " << escapedNewRpath << ")\n";
break;
}
}
}
void cmInstallTargetGenerator::AddChrpathPatchRule(
std::ostream& os, Indent indent, std::string const& config,
std::string const& toDestDirPath)
{
// Skip the chrpath if the target does not need it.
if (this->ImportLibrary || this->NamelinkMode == NamelinkModeOnly ||
!this->Target->IsChrpathUsed(config)) {
return;
}
// Get the link information for this target.
// It can provide the RPATH.
cmComputeLinkInformation* cli = this->Target->GetLinkInformation(config);
if (!cli) {
return;
}
cmMakefile* mf = this->Target->Target->GetMakefile();
if (mf->IsOn("CMAKE_PLATFORM_HAS_INSTALLNAME")) {
// If using install_name_tool, set up the rules to modify the rpaths.
std::string installNameTool =
mf->GetSafeDefinition("CMAKE_INSTALL_NAME_TOOL");
std::vector<std::string> oldRuntimeDirs;
std::vector<std::string> newRuntimeDirs;
cli->GetRPath(oldRuntimeDirs, false);
cli->GetRPath(newRuntimeDirs, true);
std::string darwin_major_version_s =
mf->GetSafeDefinition("DARWIN_MAJOR_VERSION");
std::istringstream ss(darwin_major_version_s);
int darwin_major_version;
ss >> darwin_major_version;
if (!ss.fail() && darwin_major_version <= 9 &&
(!oldRuntimeDirs.empty() || !newRuntimeDirs.empty())) {
std::ostringstream msg;
msg
<< "WARNING: Target \"" << this->Target->GetName()
<< "\" has runtime paths which cannot be changed during install. "
<< "To change runtime paths, OS X version 10.6 or newer is required. "
<< "Therefore, runtime paths will not be changed when installing. "
<< "CMAKE_BUILD_WITH_INSTALL_RPATH may be used to work around"
" this limitation.";
mf->IssueMessage(MessageType::WARNING, msg.str());
} else {
// To be consistent with older versions, runpath changes must be ordered,
// deleted first, then added, *and* the same path must only appear once.
std::map<std::string, std::string> runpath_change;
std::vector<std::string> ordered;
for (std::string const& dir : oldRuntimeDirs) {
// Normalize path and add to map of changes to make
auto iter_inserted = runpath_change.insert(
{ mf->GetGlobalGenerator()->ExpandCFGIntDir(dir, config),
"delete" });
if (iter_inserted.second) {
// Add path to ordered list of changes
ordered.push_back(iter_inserted.first->first);
}
}
for (std::string const& dir : newRuntimeDirs) {
// Normalize path and add to map of changes to make
auto iter_inserted = runpath_change.insert(
{ mf->GetGlobalGenerator()->ExpandCFGIntDir(dir, config), "add" });
if (iter_inserted.second) {
// Add path to ordered list of changes
ordered.push_back(iter_inserted.first->first);
} else if (iter_inserted.first->second != "add") {
// Rpath was requested to be deleted and then later re-added. Drop it
// from the list by marking as an empty value.
iter_inserted.first->second.clear();
}
}
// Remove rpaths that are unchanged (value was set to empty)
ordered.erase(
std::remove_if(ordered.begin(), ordered.end(),
[&runpath_change](std::string const& runpath) {
return runpath_change.find(runpath)->second.empty();
}),
ordered.end());
if (!ordered.empty()) {
os << indent << "execute_process(COMMAND " << installNameTool << "\n";
for (std::string const& runpath : ordered) {
// Either 'add_rpath' or 'delete_rpath' since we've removed empty
// entries
os << indent << " -" << runpath_change.find(runpath)->second
<< "_rpath \"" << runpath << "\"\n";
}
os << indent << " \"" << toDestDirPath << "\")\n";
}
}
} else {
// Construct the original rpath string to be replaced.
std::string oldRpath = cli->GetRPathString(false);
// Get the install RPATH from the link information.
std::string newRpath = cli->GetChrpathString();
// Skip the rule if the paths are identical
if (oldRpath == newRpath) {
return;
}
// Escape any CMake syntax in the RPATHs.
std::string escapedOldRpath = cmOutputConverter::EscapeForCMake(oldRpath);
std::string escapedNewRpath = cmOutputConverter::EscapeForCMake(newRpath);
// Write a rule to run chrpath to set the install-tree RPATH
os << indent << "file(RPATH_CHANGE\n"
<< indent << " FILE \"" << toDestDirPath << "\"\n"
<< indent << " OLD_RPATH " << escapedOldRpath << "\n";
// CMP0095: ``RPATH`` entries are properly escaped in the intermediary
// CMake install script.
switch (this->Target->GetPolicyStatusCMP0095()) {
case cmPolicies::WARN:
this->IssueCMP0095Warning(newRpath);
CM_FALLTHROUGH;
case cmPolicies::OLD:
os << indent << " NEW_RPATH \"" << newRpath << "\"";
break;
default:
os << indent << " NEW_RPATH " << escapedNewRpath;
break;
}
if (this->Target->GetPropertyAsBool("INSTALL_REMOVE_ENVIRONMENT_RPATH")) {
os << "\n" << indent << " INSTALL_REMOVE_ENVIRONMENT_RPATH)\n";
} else {
os << ")\n";
}
}
}
void cmInstallTargetGenerator::AddStripRule(std::ostream& os, Indent indent,
std::string const& toDestDirPath)
{
// don't strip static and import libraries, because it removes the only
// symbol table they have so you can't link to them anymore
if (this->Target->GetType() == cmStateEnums::STATIC_LIBRARY ||
this->ImportLibrary || this->NamelinkMode == NamelinkModeOnly) {
return;
}
// Don't handle OSX Bundles.
if (this->Target->IsApple() &&
this->Target->GetPropertyAsBool("MACOSX_BUNDLE")) {
return;
}
std::string const& strip =
this->Target->Target->GetMakefile()->GetSafeDefinition("CMAKE_STRIP");
if (strip.empty()) {
return;
}
std::string stripArgs;
if (this->Target->IsApple()) {
if (this->Target->GetType() == cmStateEnums::SHARED_LIBRARY ||
this->Target->GetType() == cmStateEnums::MODULE_LIBRARY) {
// Strip tools need '-x' to strip Apple dylibs correctly.
stripArgs = "-x ";
} else if (this->Target->GetType() == cmStateEnums::EXECUTABLE &&
this->Target->GetGlobalGenerator()->GetStripCommandStyle(
strip) == cmGlobalGenerator::StripCommandStyle::Apple) {
// Apple's strip tool needs '-u -r' to strip executables correctly.
stripArgs = "-u -r ";
}
}
os << indent << "if(CMAKE_INSTALL_DO_STRIP)\n";
os << indent << " execute_process(COMMAND \"" << strip << "\" " << stripArgs
<< "\"" << toDestDirPath << "\")\n";
os << indent << "endif()\n";
}
void cmInstallTargetGenerator::AddRanlibRule(std::ostream& os, Indent indent,
std::string const& toDestDirPath)
{
// Static libraries need ranlib on this platform.
if (this->Target->GetType() != cmStateEnums::STATIC_LIBRARY) {
return;
}
// Perform post-installation processing on the file depending
// on its type.
if (!this->Target->IsApple()) {
return;
}
std::string const& ranlib =
this->Target->Target->GetMakefile()->GetRequiredDefinition("CMAKE_RANLIB");
if (ranlib.empty()) {
return;
}
os << indent << "execute_process(COMMAND \"" << ranlib << "\" \""
<< toDestDirPath << "\")\n";
}
void cmInstallTargetGenerator::AddUniversalInstallRule(
std::ostream& os, Indent indent, std::string const& toDestDirPath)
{
cmMakefile const* mf = this->Target->Target->GetMakefile();
if (!mf->PlatformIsAppleEmbedded() || !mf->IsOn("XCODE")) {
return;
}
cmValue xcodeVersion = mf->GetDefinition("XCODE_VERSION");
if (!xcodeVersion ||
cmSystemTools::VersionCompareGreater("6", *xcodeVersion)) {
return;
}
switch (this->Target->GetType()) {
case cmStateEnums::EXECUTABLE:
case cmStateEnums::STATIC_LIBRARY:
case cmStateEnums::SHARED_LIBRARY:
case cmStateEnums::MODULE_LIBRARY:
break;
default:
return;
}
if (!this->Target->Target->GetPropertyAsBool("IOS_INSTALL_COMBINED")) {
return;
}
os << indent << "include(CMakeIOSInstallCombined)\n";
os << indent << "ios_install_combined("
<< "\"" << this->Target->Target->GetName() << "\" "
<< "\"" << toDestDirPath << "\")\n";
}
void cmInstallTargetGenerator::IssueCMP0095Warning(
std::string const& unescapedRpath)
{
// Reduce warning noise to cases where used RPATHs may actually be affected
// by CMP0095. This filter is meant to skip warnings in cases when
// non-curly-braces syntax (e.g. $ORIGIN) or no keyword is used which has
// worked already before CMP0095. We intend to issue a warning in all cases
// with curly-braces syntax, even if the workaround of double-escaping is in
// place, since we deprecate the need for it with CMP0095.
bool const potentially_affected(unescapedRpath.find("${") !=
std::string::npos);
if (potentially_affected) {
std::ostringstream w;
w << cmPolicies::GetPolicyWarning(cmPolicies::CMP0095) << "\n";
w << "RPATH entries for target '" << this->Target->GetName() << "' "
<< "will not be escaped in the intermediary "
<< "cmake_install.cmake script.";
this->Target->GetGlobalGenerator()->GetCMakeInstance()->IssueMessage(
MessageType::AUTHOR_WARNING, w.str(), this->GetBacktrace());
}
}
|