| /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying |
| file Copyright.txt or https://cmake.org/licensing for details. */ |
| #include "cmExportInstallFileGenerator.h" |
| |
| #include "cmAlgorithms.h" |
| #include "cmExportSet.h" |
| #include "cmGeneratedFileStream.h" |
| #include "cmGeneratorExpression.h" |
| #include "cmGeneratorTarget.h" |
| #include "cmGlobalGenerator.h" |
| #include "cmInstallExportGenerator.h" |
| #include "cmInstallTargetGenerator.h" |
| #include "cmLocalGenerator.h" |
| #include "cmMakefile.h" |
| #include "cmPolicies.h" |
| #include "cmStateTypes.h" |
| #include "cmSystemTools.h" |
| #include "cmTarget.h" |
| #include "cmTargetExport.h" |
| |
| #include <sstream> |
| #include <utility> |
| |
| class cmExportSetMap; |
| |
| cmExportInstallFileGenerator::cmExportInstallFileGenerator( |
| cmInstallExportGenerator* iegen) |
| : IEGen(iegen) |
| { |
| } |
| |
| std::string cmExportInstallFileGenerator::GetConfigImportFileGlob() |
| { |
| std::string glob = this->FileBase; |
| glob += "-*"; |
| glob += this->FileExt; |
| return glob; |
| } |
| |
| bool cmExportInstallFileGenerator::GenerateMainFile(std::ostream& os) |
| { |
| std::vector<cmTargetExport*> allTargets; |
| { |
| std::string expectedTargets; |
| std::string sep; |
| for (cmTargetExport* te : |
| *this->IEGen->GetExportSet()->GetTargetExports()) { |
| expectedTargets += sep + this->Namespace + te->Target->GetExportName(); |
| sep = " "; |
| if (this->ExportedTargets.insert(te->Target).second) { |
| allTargets.push_back(te); |
| } else { |
| std::ostringstream e; |
| e << "install(EXPORT \"" << this->IEGen->GetExportSet()->GetName() |
| << "\" ...) " |
| << "includes target \"" << te->Target->GetName() |
| << "\" more than once in the export set."; |
| cmSystemTools::Error(e.str().c_str()); |
| return false; |
| } |
| } |
| |
| this->GenerateExpectedTargetsCode(os, expectedTargets); |
| } |
| |
| // Compute the relative import prefix for the file |
| this->GenerateImportPrefix(os); |
| |
| std::vector<std::string> missingTargets; |
| |
| bool require2_8_12 = false; |
| bool require3_0_0 = false; |
| bool require3_1_0 = false; |
| bool requiresConfigFiles = false; |
| // Create all the imported targets. |
| for (cmTargetExport* te : allTargets) { |
| cmGeneratorTarget* gt = te->Target; |
| cmStateEnums::TargetType targetType = this->GetExportTargetType(te); |
| |
| requiresConfigFiles = |
| requiresConfigFiles || targetType != cmStateEnums::INTERFACE_LIBRARY; |
| |
| this->GenerateImportTargetCode(os, gt, targetType); |
| |
| ImportPropertyMap properties; |
| |
| this->PopulateIncludeDirectoriesInterface( |
| te, cmGeneratorExpression::InstallInterface, properties, missingTargets); |
| this->PopulateSourcesInterface(te, cmGeneratorExpression::InstallInterface, |
| properties, missingTargets); |
| this->PopulateInterfaceProperty("INTERFACE_SYSTEM_INCLUDE_DIRECTORIES", gt, |
| cmGeneratorExpression::InstallInterface, |
| properties, missingTargets); |
| this->PopulateInterfaceProperty("INTERFACE_COMPILE_DEFINITIONS", gt, |
| cmGeneratorExpression::InstallInterface, |
| properties, missingTargets); |
| this->PopulateInterfaceProperty("INTERFACE_COMPILE_OPTIONS", gt, |
| cmGeneratorExpression::InstallInterface, |
| properties, missingTargets); |
| this->PopulateInterfaceProperty("INTERFACE_AUTOUIC_OPTIONS", gt, |
| cmGeneratorExpression::InstallInterface, |
| properties, missingTargets); |
| this->PopulateInterfaceProperty("INTERFACE_COMPILE_FEATURES", gt, |
| cmGeneratorExpression::InstallInterface, |
| properties, missingTargets); |
| this->PopulateInterfaceProperty("INTERFACE_LINK_OPTIONS", gt, |
| cmGeneratorExpression::InstallInterface, |
| properties, missingTargets); |
| this->PopulateLinkDirectoriesInterface( |
| te, cmGeneratorExpression::InstallInterface, properties, missingTargets); |
| this->PopulateLinkDependsInterface( |
| te, cmGeneratorExpression::InstallInterface, properties, missingTargets); |
| |
| std::string errorMessage; |
| if (!this->PopulateExportProperties(gt, properties, errorMessage)) { |
| cmSystemTools::Error(errorMessage.c_str()); |
| return false; |
| } |
| |
| const bool newCMP0022Behavior = |
| gt->GetPolicyStatusCMP0022() != cmPolicies::WARN && |
| gt->GetPolicyStatusCMP0022() != cmPolicies::OLD; |
| if (newCMP0022Behavior) { |
| if (this->PopulateInterfaceLinkLibrariesProperty( |
| gt, cmGeneratorExpression::InstallInterface, properties, |
| missingTargets) && |
| !this->ExportOld) { |
| require2_8_12 = true; |
| } |
| } |
| if (targetType == cmStateEnums::INTERFACE_LIBRARY) { |
| require3_0_0 = true; |
| } |
| if (gt->GetProperty("INTERFACE_SOURCES")) { |
| // We can only generate INTERFACE_SOURCES in CMake 3.3, but CMake 3.1 |
| // can consume them. |
| require3_1_0 = true; |
| } |
| |
| this->PopulateInterfaceProperty("INTERFACE_POSITION_INDEPENDENT_CODE", gt, |
| properties); |
| |
| this->PopulateCompatibleInterfaceProperties(gt, properties); |
| |
| this->GenerateInterfaceProperties(gt, os, properties); |
| } |
| |
| if (require3_1_0) { |
| this->GenerateRequiredCMakeVersion(os, "3.1.0"); |
| } else if (require3_0_0) { |
| this->GenerateRequiredCMakeVersion(os, "3.0.0"); |
| } else if (require2_8_12) { |
| this->GenerateRequiredCMakeVersion(os, "2.8.12"); |
| } |
| |
| this->LoadConfigFiles(os); |
| |
| this->CleanupTemporaryVariables(os); |
| this->GenerateImportedFileCheckLoop(os); |
| |
| bool result = true; |
| // Generate an import file for each configuration. |
| // Don't do this if we only export INTERFACE_LIBRARY targets. |
| if (requiresConfigFiles) { |
| for (std::string const& c : this->Configurations) { |
| if (!this->GenerateImportFileConfig(c, missingTargets)) { |
| result = false; |
| } |
| } |
| } |
| |
| this->GenerateMissingTargetsCheckCode(os, missingTargets); |
| |
| return result; |
| } |
| |
| void cmExportInstallFileGenerator::GenerateImportPrefix(std::ostream& os) |
| { |
| // Set an _IMPORT_PREFIX variable for import location properties |
| // to reference if they are relative to the install prefix. |
| std::string installPrefix = |
| this->IEGen->GetLocalGenerator()->GetMakefile()->GetSafeDefinition( |
| "CMAKE_INSTALL_PREFIX"); |
| std::string const& expDest = this->IEGen->GetDestination(); |
| if (cmSystemTools::FileIsFullPath(expDest)) { |
| // The export file is being installed to an absolute path so the |
| // package is not relocatable. Use the configured install prefix. |
| /* clang-format off */ |
| os << |
| "# The installation prefix configured by this project.\n" |
| "set(_IMPORT_PREFIX \"" << installPrefix << "\")\n" |
| "\n"; |
| /* clang-format on */ |
| } else { |
| // Add code to compute the installation prefix relative to the |
| // import file location. |
| std::string absDest = installPrefix + "/" + expDest; |
| std::string absDestS = absDest + "/"; |
| os << "# Compute the installation prefix relative to this file.\n" |
| << "get_filename_component(_IMPORT_PREFIX" |
| << " \"${CMAKE_CURRENT_LIST_FILE}\" PATH)\n"; |
| if (cmHasLiteralPrefix(absDestS, "/lib/") || |
| cmHasLiteralPrefix(absDestS, "/lib64/") || |
| cmHasLiteralPrefix(absDestS, "/libx32/") || |
| cmHasLiteralPrefix(absDestS, "/usr/lib/") || |
| cmHasLiteralPrefix(absDestS, "/usr/lib64/") || |
| cmHasLiteralPrefix(absDestS, "/usr/libx32/")) { |
| // Handle "/usr move" symlinks created by some Linux distros. |
| /* clang-format off */ |
| os << |
| "# Use original install prefix when loaded through a\n" |
| "# cross-prefix symbolic link such as /lib -> /usr/lib.\n" |
| "get_filename_component(_realCurr \"${_IMPORT_PREFIX}\" REALPATH)\n" |
| "get_filename_component(_realOrig \"" << absDest << "\" REALPATH)\n" |
| "if(_realCurr STREQUAL _realOrig)\n" |
| " set(_IMPORT_PREFIX \"" << absDest << "\")\n" |
| "endif()\n" |
| "unset(_realOrig)\n" |
| "unset(_realCurr)\n"; |
| /* clang-format on */ |
| } |
| std::string dest = expDest; |
| while (!dest.empty()) { |
| os << "get_filename_component(_IMPORT_PREFIX \"${_IMPORT_PREFIX}\" " |
| "PATH)\n"; |
| dest = cmSystemTools::GetFilenamePath(dest); |
| } |
| os << "if(_IMPORT_PREFIX STREQUAL \"/\")\n" |
| << " set(_IMPORT_PREFIX \"\")\n" |
| << "endif()\n" |
| << "\n"; |
| } |
| } |
| |
| void cmExportInstallFileGenerator::CleanupTemporaryVariables(std::ostream& os) |
| { |
| /* clang-format off */ |
| os << "# Cleanup temporary variables.\n" |
| << "set(_IMPORT_PREFIX)\n" |
| << "\n"; |
| /* clang-format on */ |
| } |
| |
| void cmExportInstallFileGenerator::LoadConfigFiles(std::ostream& os) |
| { |
| // Now load per-configuration properties for them. |
| /* clang-format off */ |
| os << "# Load information for each installed configuration.\n" |
| << "get_filename_component(_DIR \"${CMAKE_CURRENT_LIST_FILE}\" PATH)\n" |
| << "file(GLOB CONFIG_FILES \"${_DIR}/" |
| << this->GetConfigImportFileGlob() << "\")\n" |
| << "foreach(f ${CONFIG_FILES})\n" |
| << " include(${f})\n" |
| << "endforeach()\n" |
| << "\n"; |
| /* clang-format on */ |
| } |
| |
| 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; |
| } |
| } |
| |
| bool cmExportInstallFileGenerator::GenerateImportFileConfig( |
| const std::string& config, std::vector<std::string>& missingTargets) |
| { |
| // Skip configurations not enabled for this export. |
| if (!this->IEGen->InstallsForConfig(config)) { |
| return true; |
| } |
| |
| // Construct the name of the file to generate. |
| std::string fileName = this->FileDir; |
| fileName += "/"; |
| fileName += this->FileBase; |
| fileName += "-"; |
| if (!config.empty()) { |
| fileName += cmSystemTools::LowerCase(config); |
| } else { |
| fileName += "noconfig"; |
| } |
| fileName += this->FileExt; |
| |
| // Open the output file to generate it. |
| cmGeneratedFileStream exportFileStream(fileName, true); |
| if (!exportFileStream) { |
| std::string se = cmSystemTools::GetLastSystemError(); |
| std::ostringstream e; |
| e << "cannot write to file \"" << fileName << "\": " << se; |
| cmSystemTools::Error(e.str().c_str()); |
| return false; |
| } |
| std::ostream& os = exportFileStream; |
| |
| // Start with the import file header. |
| this->GenerateImportHeaderCode(os, config); |
| |
| // Generate the per-config target information. |
| this->GenerateImportConfig(os, config, missingTargets); |
| |
| // End with the import file footer. |
| this->GenerateImportFooterCode(os); |
| |
| // Record this per-config import file. |
| this->ConfigImportFiles[config] = fileName; |
| |
| return true; |
| } |
| |
| void cmExportInstallFileGenerator::GenerateImportTargetsConfig( |
| std::ostream& os, const std::string& config, std::string const& suffix, |
| std::vector<std::string>& missingTargets) |
| { |
| // Add each target in the set to the export. |
| for (cmTargetExport* te : *this->IEGen->GetExportSet()->GetTargetExports()) { |
| // Collect import properties for this target. |
| if (this->GetExportTargetType(te) == cmStateEnums::INTERFACE_LIBRARY) { |
| continue; |
| } |
| |
| ImportPropertyMap properties; |
| std::set<std::string> importedLocations; |
| |
| this->SetImportLocationProperty(config, suffix, te->ArchiveGenerator, |
| properties, importedLocations); |
| this->SetImportLocationProperty(config, suffix, te->LibraryGenerator, |
| properties, importedLocations); |
| this->SetImportLocationProperty(config, suffix, te->RuntimeGenerator, |
| properties, importedLocations); |
| this->SetImportLocationProperty(config, suffix, te->ObjectsGenerator, |
| properties, importedLocations); |
| this->SetImportLocationProperty(config, suffix, te->FrameworkGenerator, |
| properties, importedLocations); |
| this->SetImportLocationProperty(config, suffix, te->BundleGenerator, |
| properties, importedLocations); |
| |
| // If any file location was set for the target add it to the |
| // import file. |
| if (!properties.empty()) { |
| // Get the rest of the target details. |
| cmGeneratorTarget* gtgt = te->Target; |
| this->SetImportDetailProperties(config, suffix, gtgt, properties, |
| missingTargets); |
| |
| this->SetImportLinkInterface(config, suffix, |
| cmGeneratorExpression::InstallInterface, |
| gtgt, properties, missingTargets); |
| |
| // TODO: PUBLIC_HEADER_LOCATION |
| // This should wait until the build feature propagation stuff |
| // is done. Then this can be a propagated include directory. |
| // this->GenerateImportProperty(config, te->HeaderGenerator, |
| // properties); |
| |
| // Generate code in the export file. |
| this->GenerateImportPropertyCode(os, config, gtgt, properties); |
| this->GenerateImportedFileChecksCode(os, gtgt, properties, |
| importedLocations); |
| } |
| } |
| } |
| |
| void cmExportInstallFileGenerator::SetImportLocationProperty( |
| const std::string& config, std::string const& suffix, |
| cmInstallTargetGenerator* itgen, ImportPropertyMap& properties, |
| std::set<std::string>& importedLocations) |
| { |
| // Skip rules that do not match this configuration. |
| if (!(itgen && itgen->InstallsForConfig(config))) { |
| return; |
| } |
| |
| // Get the target to be installed. |
| cmGeneratorTarget* target = itgen->GetTarget(); |
| |
| // Construct the installed location of the target. |
| std::string dest = itgen->GetDestination(config); |
| std::string value; |
| if (!cmSystemTools::FileIsFullPath(dest)) { |
| // The target is installed relative to the installation prefix. |
| value = "${_IMPORT_PREFIX}/"; |
| } |
| value += dest; |
| value += "/"; |
| |
| if (itgen->IsImportLibrary()) { |
| // Construct the property name. |
| std::string prop = "IMPORTED_IMPLIB"; |
| prop += suffix; |
| |
| // Append the installed file name. |
| value += itgen->GetInstallFilename(target, config, |
| cmInstallTargetGenerator::NameImplib); |
| |
| // Store the property. |
| properties[prop] = value; |
| importedLocations.insert(prop); |
| } else if (itgen->GetTarget()->GetType() == cmStateEnums::OBJECT_LIBRARY) { |
| // Construct the property name. |
| std::string prop = "IMPORTED_OBJECTS"; |
| prop += suffix; |
| |
| // Compute all the object files inside this target and setup |
| // IMPORTED_OBJECTS as a list of object files |
| std::vector<std::string> objects; |
| itgen->GetInstallObjectNames(config, objects); |
| for (std::string& obj : objects) { |
| obj = value + obj; |
| } |
| |
| // Store the property. |
| properties[prop] = cmJoin(objects, ";"); |
| importedLocations.insert(prop); |
| } else { |
| // Construct the property name. |
| std::string prop = "IMPORTED_LOCATION"; |
| prop += suffix; |
| |
| // Append the installed file name. |
| if (target->IsAppBundleOnApple()) { |
| value += itgen->GetInstallFilename(target, config); |
| value += ".app/Contents/MacOS/"; |
| value += itgen->GetInstallFilename(target, config); |
| } else { |
| value += itgen->GetInstallFilename(target, config, |
| cmInstallTargetGenerator::NameReal); |
| } |
| |
| // Store the property. |
| properties[prop] = value; |
| importedLocations.insert(prop); |
| } |
| } |
| |
| cmStateEnums::TargetType cmExportInstallFileGenerator::GetExportTargetType( |
| cmTargetExport const* targetExport) const |
| { |
| cmStateEnums::TargetType targetType = targetExport->Target->GetType(); |
| // An OBJECT library installed with no OBJECTS DESTINATION |
| // is transformed to an INTERFACE library. |
| if (targetType == cmStateEnums::OBJECT_LIBRARY && |
| targetExport->ObjectsGenerator == nullptr) { |
| targetType = cmStateEnums::INTERFACE_LIBRARY; |
| } |
| return targetType; |
| } |
| |
| void cmExportInstallFileGenerator::HandleMissingTarget( |
| std::string& link_libs, std::vector<std::string>& missingTargets, |
| cmGeneratorTarget* depender, cmGeneratorTarget* dependee) |
| { |
| const std::string name = dependee->GetName(); |
| cmGlobalGenerator* gg = dependee->GetLocalGenerator()->GetGlobalGenerator(); |
| std::vector<std::string> namespaces = this->FindNamespaces(gg, name); |
| int targetOccurrences = static_cast<int>(namespaces.size()); |
| if (targetOccurrences == 1) { |
| std::string missingTarget = namespaces[0]; |
| |
| missingTarget += dependee->GetExportName(); |
| link_libs += missingTarget; |
| missingTargets.push_back(std::move(missingTarget)); |
| } else { |
| // All exported targets should be known here and should be unique. |
| // This is probably user-error. |
| this->ComplainAboutMissingTarget(depender, dependee, targetOccurrences); |
| } |
| } |
| |
| std::vector<std::string> cmExportInstallFileGenerator::FindNamespaces( |
| cmGlobalGenerator* gg, const std::string& name) |
| { |
| std::vector<std::string> namespaces; |
| const cmExportSetMap& exportSets = gg->GetExportSets(); |
| |
| for (auto const& expIt : exportSets) { |
| const cmExportSet* exportSet = expIt.second; |
| std::vector<cmTargetExport*> const* targets = |
| exportSet->GetTargetExports(); |
| |
| bool containsTarget = false; |
| for (cmTargetExport* target : *targets) { |
| if (name == target->TargetName) { |
| containsTarget = true; |
| break; |
| } |
| } |
| |
| if (containsTarget) { |
| std::vector<cmInstallExportGenerator const*> const* installs = |
| exportSet->GetInstallations(); |
| for (cmInstallExportGenerator const* install : *installs) { |
| namespaces.push_back(install->GetNamespace()); |
| } |
| } |
| } |
| |
| return namespaces; |
| } |
| |
| void cmExportInstallFileGenerator::ComplainAboutMissingTarget( |
| cmGeneratorTarget* depender, cmGeneratorTarget* dependee, int occurrences) |
| { |
| std::ostringstream e; |
| e << "install(EXPORT \"" << this->IEGen->GetExportSet()->GetName() |
| << "\" ...) " |
| << "includes target \"" << depender->GetName() |
| << "\" which requires target \"" << dependee->GetName() << "\" "; |
| if (occurrences == 0) { |
| e << "that is not in the export set."; |
| } else { |
| e << "that is not in this export set, but " << occurrences |
| << " times in others."; |
| } |
| cmSystemTools::Error(e.str().c_str()); |
| } |
| |
| std::string cmExportInstallFileGenerator::InstallNameDir( |
| 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(); |
| } |
| |
| return install_name_dir; |
| } |
