cmExportBuildFileGenerator.cxx 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  1. /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. file Copyright.txt or https://cmake.org/licensing for details. */
  3. #include "cmExportBuildFileGenerator.h"
  4. #include "cmAlgorithms.h"
  5. #include "cmExportSet.h"
  6. #include "cmGeneratorExpression.h"
  7. #include "cmGeneratorTarget.h"
  8. #include "cmGlobalGenerator.h"
  9. #include "cmLocalGenerator.h"
  10. #include "cmMakefile.h"
  11. #include "cmPolicies.h"
  12. #include "cmStateTypes.h"
  13. #include "cmSystemTools.h"
  14. #include "cmTarget.h"
  15. #include "cmTargetExport.h"
  16. #include "cmake.h"
  17. #include <algorithm>
  18. #include <map>
  19. #include <set>
  20. #include <sstream>
  21. #include <utility>
  22. class cmSourceFile;
  23. cmExportBuildFileGenerator::cmExportBuildFileGenerator()
  24. {
  25. this->LG = nullptr;
  26. this->ExportSet = nullptr;
  27. }
  28. void cmExportBuildFileGenerator::Compute(cmLocalGenerator* lg)
  29. {
  30. this->LG = lg;
  31. if (this->ExportSet) {
  32. this->ExportSet->Compute(lg);
  33. }
  34. }
  35. bool cmExportBuildFileGenerator::GenerateMainFile(std::ostream& os)
  36. {
  37. {
  38. std::string expectedTargets;
  39. std::string sep;
  40. std::vector<std::string> targets;
  41. this->GetTargets(targets);
  42. for (std::string const& tei : targets) {
  43. cmGeneratorTarget* te = this->LG->FindGeneratorTargetToUse(tei);
  44. expectedTargets += sep + this->Namespace + te->GetExportName();
  45. sep = " ";
  46. if (this->ExportedTargets.insert(te).second) {
  47. this->Exports.push_back(te);
  48. } else {
  49. std::ostringstream e;
  50. e << "given target \"" << te->GetName() << "\" more than once.";
  51. this->LG->GetGlobalGenerator()->GetCMakeInstance()->IssueMessage(
  52. cmake::FATAL_ERROR, e.str(),
  53. this->LG->GetMakefile()->GetBacktrace());
  54. return false;
  55. }
  56. if (te->GetType() == cmStateEnums::INTERFACE_LIBRARY) {
  57. this->GenerateRequiredCMakeVersion(os, "3.0.0");
  58. }
  59. }
  60. this->GenerateExpectedTargetsCode(os, expectedTargets);
  61. }
  62. std::vector<std::string> missingTargets;
  63. // Create all the imported targets.
  64. for (cmGeneratorTarget* gte : this->Exports) {
  65. this->GenerateImportTargetCode(os, gte);
  66. gte->Target->AppendBuildInterfaceIncludes();
  67. ImportPropertyMap properties;
  68. this->PopulateInterfaceProperty("INTERFACE_INCLUDE_DIRECTORIES", gte,
  69. cmGeneratorExpression::BuildInterface,
  70. properties, missingTargets);
  71. this->PopulateInterfaceProperty("INTERFACE_SOURCES", gte,
  72. cmGeneratorExpression::BuildInterface,
  73. properties, missingTargets);
  74. this->PopulateInterfaceProperty("INTERFACE_COMPILE_DEFINITIONS", gte,
  75. cmGeneratorExpression::BuildInterface,
  76. properties, missingTargets);
  77. this->PopulateInterfaceProperty("INTERFACE_COMPILE_OPTIONS", gte,
  78. cmGeneratorExpression::BuildInterface,
  79. properties, missingTargets);
  80. this->PopulateInterfaceProperty("INTERFACE_AUTOUIC_OPTIONS", gte,
  81. cmGeneratorExpression::BuildInterface,
  82. properties, missingTargets);
  83. this->PopulateInterfaceProperty("INTERFACE_COMPILE_FEATURES", gte,
  84. cmGeneratorExpression::BuildInterface,
  85. properties, missingTargets);
  86. this->PopulateInterfaceProperty("INTERFACE_POSITION_INDEPENDENT_CODE", gte,
  87. properties);
  88. const bool newCMP0022Behavior =
  89. gte->GetPolicyStatusCMP0022() != cmPolicies::WARN &&
  90. gte->GetPolicyStatusCMP0022() != cmPolicies::OLD;
  91. if (newCMP0022Behavior) {
  92. this->PopulateInterfaceLinkLibrariesProperty(
  93. gte, cmGeneratorExpression::BuildInterface, properties,
  94. missingTargets);
  95. }
  96. this->PopulateCompatibleInterfaceProperties(gte, properties);
  97. this->GenerateInterfaceProperties(gte, os, properties);
  98. }
  99. // Generate import file content for each configuration.
  100. for (std::string const& c : this->Configurations) {
  101. this->GenerateImportConfig(os, c, missingTargets);
  102. }
  103. this->GenerateMissingTargetsCheckCode(os, missingTargets);
  104. return true;
  105. }
  106. void cmExportBuildFileGenerator::GenerateImportTargetsConfig(
  107. std::ostream& os, const std::string& config, std::string const& suffix,
  108. std::vector<std::string>& missingTargets)
  109. {
  110. for (cmGeneratorTarget* target : this->Exports) {
  111. // Collect import properties for this target.
  112. ImportPropertyMap properties;
  113. if (target->GetType() != cmStateEnums::INTERFACE_LIBRARY) {
  114. this->SetImportLocationProperty(config, suffix, target, properties);
  115. }
  116. if (!properties.empty()) {
  117. // Get the rest of the target details.
  118. if (target->GetType() != cmStateEnums::INTERFACE_LIBRARY) {
  119. this->SetImportDetailProperties(config, suffix, target, properties,
  120. missingTargets);
  121. this->SetImportLinkInterface(config, suffix,
  122. cmGeneratorExpression::BuildInterface,
  123. target, properties, missingTargets);
  124. }
  125. // TOOD: PUBLIC_HEADER_LOCATION
  126. // This should wait until the build feature propagation stuff
  127. // is done. Then this can be a propagated include directory.
  128. // this->GenerateImportProperty(config, te->HeaderGenerator,
  129. // properties);
  130. // Generate code in the export file.
  131. this->GenerateImportPropertyCode(os, config, target, properties);
  132. }
  133. }
  134. }
  135. void cmExportBuildFileGenerator::SetExportSet(cmExportSet* exportSet)
  136. {
  137. this->ExportSet = exportSet;
  138. }
  139. void cmExportBuildFileGenerator::SetImportLocationProperty(
  140. const std::string& config, std::string const& suffix,
  141. cmGeneratorTarget* target, ImportPropertyMap& properties)
  142. {
  143. // Get the makefile in which to lookup target information.
  144. cmMakefile* mf = target->Makefile;
  145. if (target->GetType() == cmStateEnums::OBJECT_LIBRARY) {
  146. std::string prop = "IMPORTED_OBJECTS";
  147. prop += suffix;
  148. // Compute all the object files inside this target and setup
  149. // IMPORTED_OBJECTS as a list of object files
  150. std::vector<cmSourceFile const*> objectSources;
  151. target->GetObjectSources(objectSources, config);
  152. std::string const obj_dir = target->GetObjectDirectory(config);
  153. std::vector<std::string> objects;
  154. for (cmSourceFile const* sf : objectSources) {
  155. const std::string& obj = target->GetObjectName(sf);
  156. objects.push_back(obj_dir + obj);
  157. }
  158. // Store the property.
  159. properties[prop] = cmJoin(objects, ";");
  160. } else {
  161. // Add the main target file.
  162. {
  163. std::string prop = "IMPORTED_LOCATION";
  164. prop += suffix;
  165. std::string value;
  166. if (target->IsAppBundleOnApple()) {
  167. value =
  168. target->GetFullPath(config, cmStateEnums::RuntimeBinaryArtifact);
  169. } else {
  170. value = target->GetFullPath(config,
  171. cmStateEnums::RuntimeBinaryArtifact, true);
  172. }
  173. properties[prop] = value;
  174. }
  175. // Add the import library for windows DLLs.
  176. if (target->HasImportLibrary() &&
  177. mf->GetDefinition("CMAKE_IMPORT_LIBRARY_SUFFIX")) {
  178. std::string prop = "IMPORTED_IMPLIB";
  179. prop += suffix;
  180. std::string value =
  181. target->GetFullPath(config, cmStateEnums::ImportLibraryArtifact);
  182. target->GetImplibGNUtoMS(value, value, "${CMAKE_IMPORT_LIBRARY_SUFFIX}");
  183. properties[prop] = value;
  184. }
  185. }
  186. }
  187. void cmExportBuildFileGenerator::HandleMissingTarget(
  188. std::string& link_libs, std::vector<std::string>& missingTargets,
  189. cmGeneratorTarget* depender, cmGeneratorTarget* dependee)
  190. {
  191. // The target is not in the export.
  192. if (!this->AppendMode) {
  193. const std::string name = dependee->GetName();
  194. cmGlobalGenerator* gg =
  195. dependee->GetLocalGenerator()->GetGlobalGenerator();
  196. std::vector<std::string> namespaces = this->FindNamespaces(gg, name);
  197. int targetOccurrences = static_cast<int>(namespaces.size());
  198. if (targetOccurrences == 1) {
  199. std::string missingTarget = namespaces[0];
  200. missingTarget += dependee->GetExportName();
  201. link_libs += missingTarget;
  202. missingTargets.push_back(std::move(missingTarget));
  203. return;
  204. }
  205. // We are not appending, so all exported targets should be
  206. // known here. This is probably user-error.
  207. this->ComplainAboutMissingTarget(depender, dependee, targetOccurrences);
  208. }
  209. // Assume the target will be exported by another command.
  210. // Append it with the export namespace.
  211. link_libs += this->Namespace;
  212. link_libs += dependee->GetExportName();
  213. }
  214. void cmExportBuildFileGenerator::GetTargets(
  215. std::vector<std::string>& targets) const
  216. {
  217. if (this->ExportSet) {
  218. for (cmTargetExport* te : *this->ExportSet->GetTargetExports()) {
  219. targets.push_back(te->TargetName);
  220. }
  221. return;
  222. }
  223. targets = this->Targets;
  224. }
  225. std::vector<std::string> cmExportBuildFileGenerator::FindNamespaces(
  226. cmGlobalGenerator* gg, const std::string& name)
  227. {
  228. std::vector<std::string> namespaces;
  229. std::map<std::string, cmExportBuildFileGenerator*>& exportSets =
  230. gg->GetBuildExportSets();
  231. for (auto const& exp : exportSets) {
  232. const cmExportBuildFileGenerator* exportSet = exp.second;
  233. std::vector<std::string> targets;
  234. exportSet->GetTargets(targets);
  235. if (std::find(targets.begin(), targets.end(), name) != targets.end()) {
  236. namespaces.push_back(exportSet->GetNamespace());
  237. }
  238. }
  239. return namespaces;
  240. }
  241. void cmExportBuildFileGenerator::ComplainAboutMissingTarget(
  242. cmGeneratorTarget* depender, cmGeneratorTarget* dependee, int occurrences)
  243. {
  244. if (cmSystemTools::GetErrorOccuredFlag()) {
  245. return;
  246. }
  247. std::ostringstream e;
  248. e << "export called with target \"" << depender->GetName()
  249. << "\" which requires target \"" << dependee->GetName() << "\" ";
  250. if (occurrences == 0) {
  251. e << "that is not in the export set.\n";
  252. } else {
  253. e << "that is not in this export set, but " << occurrences
  254. << " times in others.\n";
  255. }
  256. e << "If the required target is not easy to reference in this call, "
  257. << "consider using the APPEND option with multiple separate calls.";
  258. this->LG->GetGlobalGenerator()->GetCMakeInstance()->IssueMessage(
  259. cmake::FATAL_ERROR, e.str(), this->LG->GetMakefile()->GetBacktrace());
  260. }
  261. std::string cmExportBuildFileGenerator::InstallNameDir(
  262. cmGeneratorTarget* target, const std::string& config)
  263. {
  264. std::string install_name_dir;
  265. cmMakefile* mf = target->Target->GetMakefile();
  266. if (mf->IsOn("CMAKE_PLATFORM_HAS_INSTALLNAME")) {
  267. install_name_dir = target->GetInstallNameDirForBuildTree(config);
  268. }
  269. return install_name_dir;
  270. }