cmInstallCommand.cxx 90 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432
  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 "cmInstallCommand.h"
  4. #include <algorithm>
  5. #include <cassert>
  6. #include <cstddef>
  7. #include <iterator>
  8. #include <map>
  9. #include <set>
  10. #include <sstream>
  11. #include <utility>
  12. #include <cm/memory>
  13. #include <cm/string_view>
  14. #include <cmext/string_view>
  15. #include "cmsys/Glob.hxx"
  16. #include "cmArgumentParser.h"
  17. #include "cmExecutionStatus.h"
  18. #include "cmExportSet.h"
  19. #include "cmFileSet.h"
  20. #include "cmGeneratorExpression.h"
  21. #include "cmGlobalGenerator.h"
  22. #include "cmInstallCommandArguments.h"
  23. #include "cmInstallDirectoryGenerator.h"
  24. #include "cmInstallExportGenerator.h"
  25. #include "cmInstallFileSetGenerator.h"
  26. #include "cmInstallFilesGenerator.h"
  27. #include "cmInstallGenerator.h"
  28. #include "cmInstallGetRuntimeDependenciesGenerator.h"
  29. #include "cmInstallImportedRuntimeArtifactsGenerator.h"
  30. #include "cmInstallRuntimeDependencySet.h"
  31. #include "cmInstallRuntimeDependencySetGenerator.h"
  32. #include "cmInstallScriptGenerator.h"
  33. #include "cmInstallTargetGenerator.h"
  34. #include "cmListFileCache.h"
  35. #include "cmMakefile.h"
  36. #include "cmMessageType.h"
  37. #include "cmPolicies.h"
  38. #include "cmRange.h"
  39. #include "cmRuntimeDependencyArchive.h"
  40. #include "cmStateTypes.h"
  41. #include "cmStringAlgorithms.h"
  42. #include "cmSubcommandTable.h"
  43. #include "cmSystemTools.h"
  44. #include "cmTarget.h"
  45. #include "cmTargetExport.h"
  46. #include "cmValue.h"
  47. namespace {
  48. struct RuntimeDependenciesArgs
  49. {
  50. std::vector<std::string> Directories;
  51. std::vector<std::string> PreIncludeRegexes;
  52. std::vector<std::string> PreExcludeRegexes;
  53. std::vector<std::string> PostIncludeRegexes;
  54. std::vector<std::string> PostExcludeRegexes;
  55. std::vector<std::string> PostIncludeFiles;
  56. std::vector<std::string> PostExcludeFiles;
  57. };
  58. auto const RuntimeDependenciesArgHelper =
  59. cmArgumentParser<RuntimeDependenciesArgs>{}
  60. .Bind("DIRECTORIES"_s, &RuntimeDependenciesArgs::Directories)
  61. .Bind("PRE_INCLUDE_REGEXES"_s, &RuntimeDependenciesArgs::PreIncludeRegexes)
  62. .Bind("PRE_EXCLUDE_REGEXES"_s, &RuntimeDependenciesArgs::PreExcludeRegexes)
  63. .Bind("POST_INCLUDE_REGEXES"_s,
  64. &RuntimeDependenciesArgs::PostIncludeRegexes)
  65. .Bind("POST_EXCLUDE_REGEXES"_s,
  66. &RuntimeDependenciesArgs::PostExcludeRegexes)
  67. .Bind("POST_INCLUDE_FILES"_s, &RuntimeDependenciesArgs::PostIncludeFiles)
  68. .Bind("POST_EXCLUDE_FILES"_s, &RuntimeDependenciesArgs::PostExcludeFiles);
  69. class Helper
  70. {
  71. public:
  72. Helper(cmExecutionStatus& status)
  73. : Status(status)
  74. , Makefile(&status.GetMakefile())
  75. {
  76. this->DefaultComponentName = this->Makefile->GetSafeDefinition(
  77. "CMAKE_INSTALL_DEFAULT_COMPONENT_NAME");
  78. if (this->DefaultComponentName.empty()) {
  79. this->DefaultComponentName = "Unspecified";
  80. }
  81. }
  82. void SetError(std::string const& err) { this->Status.SetError(err); }
  83. bool MakeFilesFullPath(const char* modeName,
  84. const std::vector<std::string>& relFiles,
  85. std::vector<std::string>& absFiles);
  86. bool MakeFilesFullPath(const char* modeName, const std::string& basePath,
  87. const std::vector<std::string>& relFiles,
  88. std::vector<std::string>& absFiles);
  89. bool CheckCMP0006(bool& failure) const;
  90. std::string GetDestination(const cmInstallCommandArguments* args,
  91. const std::string& varName,
  92. const std::string& guess) const;
  93. std::string GetRuntimeDestination(
  94. const cmInstallCommandArguments* args) const;
  95. std::string GetSbinDestination(const cmInstallCommandArguments* args) const;
  96. std::string GetArchiveDestination(
  97. const cmInstallCommandArguments* args) const;
  98. std::string GetLibraryDestination(
  99. const cmInstallCommandArguments* args) const;
  100. std::string GetIncludeDestination(
  101. const cmInstallCommandArguments* args) const;
  102. std::string GetSysconfDestination(
  103. const cmInstallCommandArguments* args) const;
  104. std::string GetSharedStateDestination(
  105. const cmInstallCommandArguments* args) const;
  106. std::string GetLocalStateDestination(
  107. const cmInstallCommandArguments* args) const;
  108. std::string GetRunStateDestination(
  109. const cmInstallCommandArguments* args) const;
  110. std::string GetDataRootDestination(
  111. const cmInstallCommandArguments* args) const;
  112. std::string GetDataDestination(const cmInstallCommandArguments* args) const;
  113. std::string GetInfoDestination(const cmInstallCommandArguments* args) const;
  114. std::string GetLocaleDestination(
  115. const cmInstallCommandArguments* args) const;
  116. std::string GetManDestination(const cmInstallCommandArguments* args) const;
  117. std::string GetDocDestination(const cmInstallCommandArguments* args) const;
  118. std::string GetDestinationForType(const cmInstallCommandArguments* args,
  119. const std::string& type) const;
  120. cmExecutionStatus& Status;
  121. cmMakefile* Makefile;
  122. std::string DefaultComponentName;
  123. };
  124. std::unique_ptr<cmInstallTargetGenerator> CreateInstallTargetGenerator(
  125. cmTarget& target, const cmInstallCommandArguments& args, bool impLib,
  126. cmListFileBacktrace const& backtrace, const std::string& destination,
  127. bool forceOpt = false, bool namelink = false)
  128. {
  129. cmInstallGenerator::MessageLevel message =
  130. cmInstallGenerator::SelectMessageLevel(target.GetMakefile());
  131. target.SetHaveInstallRule(true);
  132. const std::string& component =
  133. namelink ? args.GetNamelinkComponent() : args.GetComponent();
  134. auto g = cm::make_unique<cmInstallTargetGenerator>(
  135. target.GetName(), destination, impLib, args.GetPermissions(),
  136. args.GetConfigurations(), component, message, args.GetExcludeFromAll(),
  137. args.GetOptional() || forceOpt, backtrace);
  138. target.AddInstallGenerator(g.get());
  139. return g;
  140. }
  141. std::unique_ptr<cmInstallTargetGenerator> CreateInstallTargetGenerator(
  142. cmTarget& target, const cmInstallCommandArguments& args, bool impLib,
  143. cmListFileBacktrace const& backtrace, bool forceOpt = false,
  144. bool namelink = false)
  145. {
  146. return CreateInstallTargetGenerator(target, args, impLib, backtrace,
  147. args.GetDestination(), forceOpt,
  148. namelink);
  149. }
  150. std::unique_ptr<cmInstallFilesGenerator> CreateInstallFilesGenerator(
  151. cmMakefile* mf, const std::vector<std::string>& absFiles,
  152. const cmInstallCommandArguments& args, bool programs,
  153. const std::string& destination)
  154. {
  155. cmInstallGenerator::MessageLevel message =
  156. cmInstallGenerator::SelectMessageLevel(mf);
  157. return cm::make_unique<cmInstallFilesGenerator>(
  158. absFiles, destination, programs, args.GetPermissions(),
  159. args.GetConfigurations(), args.GetComponent(), message,
  160. args.GetExcludeFromAll(), args.GetRename(), args.GetOptional(),
  161. mf->GetBacktrace());
  162. }
  163. std::unique_ptr<cmInstallFilesGenerator> CreateInstallFilesGenerator(
  164. cmMakefile* mf, const std::vector<std::string>& absFiles,
  165. const cmInstallCommandArguments& args, bool programs)
  166. {
  167. return CreateInstallFilesGenerator(mf, absFiles, args, programs,
  168. args.GetDestination());
  169. }
  170. std::unique_ptr<cmInstallFileSetGenerator> CreateInstallFileSetGenerator(
  171. Helper& helper, cmTarget& target, cmFileSet* fileSet,
  172. const std::string& destination, const cmInstallCommandArguments& args)
  173. {
  174. cmInstallGenerator::MessageLevel message =
  175. cmInstallGenerator::SelectMessageLevel(helper.Makefile);
  176. return cm::make_unique<cmInstallFileSetGenerator>(
  177. target.GetName(), fileSet, destination, args.GetPermissions(),
  178. args.GetConfigurations(), args.GetComponent(), message,
  179. args.GetExcludeFromAll(), args.GetOptional(),
  180. helper.Makefile->GetBacktrace());
  181. }
  182. void AddInstallRuntimeDependenciesGenerator(
  183. Helper& helper, cmInstallRuntimeDependencySet* runtimeDependencySet,
  184. const cmInstallCommandArguments& runtimeArgs,
  185. const cmInstallCommandArguments& libraryArgs,
  186. const cmInstallCommandArguments& frameworkArgs,
  187. RuntimeDependenciesArgs runtimeDependenciesArgs, bool& installsRuntime,
  188. bool& installsLibrary, bool& installsFramework)
  189. {
  190. bool dllPlatform =
  191. !helper.Makefile->GetSafeDefinition("CMAKE_IMPORT_LIBRARY_SUFFIX").empty();
  192. bool apple =
  193. helper.Makefile->GetSafeDefinition("CMAKE_HOST_SYSTEM_NAME") == "Darwin";
  194. auto const& runtimeDependenciesArgsRef =
  195. dllPlatform ? runtimeArgs : libraryArgs;
  196. std::vector<std::string> configurations =
  197. runtimeDependenciesArgsRef.GetConfigurations();
  198. if (apple) {
  199. std::copy(frameworkArgs.GetConfigurations().begin(),
  200. frameworkArgs.GetConfigurations().end(),
  201. std::back_inserter(configurations));
  202. }
  203. // Create file(GET_RUNTIME_DEPENDENCIES) generator.
  204. auto getRuntimeDependenciesGenerator =
  205. cm::make_unique<cmInstallGetRuntimeDependenciesGenerator>(
  206. runtimeDependencySet, std::move(runtimeDependenciesArgs.Directories),
  207. std::move(runtimeDependenciesArgs.PreIncludeRegexes),
  208. std::move(runtimeDependenciesArgs.PreExcludeRegexes),
  209. std::move(runtimeDependenciesArgs.PostIncludeRegexes),
  210. std::move(runtimeDependenciesArgs.PostExcludeRegexes),
  211. std::move(runtimeDependenciesArgs.PostIncludeFiles),
  212. std::move(runtimeDependenciesArgs.PostExcludeFiles),
  213. runtimeDependenciesArgsRef.GetComponent(),
  214. apple ? frameworkArgs.GetComponent() : "", true, "_CMAKE_DEPS",
  215. "_CMAKE_RPATH", configurations,
  216. cmInstallGenerator::SelectMessageLevel(helper.Makefile),
  217. runtimeDependenciesArgsRef.GetExcludeFromAll() &&
  218. (apple ? frameworkArgs.GetExcludeFromAll() : true),
  219. helper.Makefile->GetBacktrace());
  220. helper.Makefile->AddInstallGenerator(
  221. std::move(getRuntimeDependenciesGenerator));
  222. // Create the library dependencies generator.
  223. auto libraryRuntimeDependenciesGenerator =
  224. cm::make_unique<cmInstallRuntimeDependencySetGenerator>(
  225. cmInstallRuntimeDependencySetGenerator::DependencyType::Library,
  226. runtimeDependencySet, std::vector<std::string>{}, true, std::string{},
  227. true, "_CMAKE_DEPS", "_CMAKE_RPATH", "_CMAKE_TMP",
  228. dllPlatform ? helper.GetRuntimeDestination(&runtimeArgs)
  229. : helper.GetLibraryDestination(&libraryArgs),
  230. runtimeDependenciesArgsRef.GetConfigurations(),
  231. runtimeDependenciesArgsRef.GetComponent(),
  232. runtimeDependenciesArgsRef.GetPermissions(),
  233. cmInstallGenerator::SelectMessageLevel(helper.Makefile),
  234. runtimeDependenciesArgsRef.GetExcludeFromAll(),
  235. helper.Makefile->GetBacktrace());
  236. helper.Makefile->AddInstallGenerator(
  237. std::move(libraryRuntimeDependenciesGenerator));
  238. if (dllPlatform) {
  239. installsRuntime = true;
  240. } else {
  241. installsLibrary = true;
  242. }
  243. if (apple) {
  244. // Create the framework dependencies generator.
  245. auto frameworkRuntimeDependenciesGenerator =
  246. cm::make_unique<cmInstallRuntimeDependencySetGenerator>(
  247. cmInstallRuntimeDependencySetGenerator::DependencyType::Framework,
  248. runtimeDependencySet, std::vector<std::string>{}, true, std::string{},
  249. true, "_CMAKE_DEPS", "_CMAKE_RPATH", "_CMAKE_TMP",
  250. frameworkArgs.GetDestination(), frameworkArgs.GetConfigurations(),
  251. frameworkArgs.GetComponent(), frameworkArgs.GetPermissions(),
  252. cmInstallGenerator::SelectMessageLevel(helper.Makefile),
  253. frameworkArgs.GetExcludeFromAll(), helper.Makefile->GetBacktrace());
  254. helper.Makefile->AddInstallGenerator(
  255. std::move(frameworkRuntimeDependenciesGenerator));
  256. installsFramework = true;
  257. }
  258. }
  259. std::set<std::string> const allowedTypes{
  260. "BIN", "SBIN", "LIB", "INCLUDE", "SYSCONF",
  261. "SHAREDSTATE", "LOCALSTATE", "RUNSTATE", "DATA", "INFO",
  262. "LOCALE", "MAN", "DOC",
  263. };
  264. template <typename T>
  265. bool AddBundleExecutable(Helper& helper,
  266. cmInstallRuntimeDependencySet* runtimeDependencySet,
  267. T&& bundleExecutable)
  268. {
  269. if (!runtimeDependencySet->AddBundleExecutable(bundleExecutable)) {
  270. helper.SetError(
  271. "A runtime dependency set may only have one bundle executable.");
  272. return false;
  273. }
  274. return true;
  275. }
  276. bool HandleScriptMode(std::vector<std::string> const& args,
  277. cmExecutionStatus& status)
  278. {
  279. Helper helper(status);
  280. std::string component = helper.DefaultComponentName;
  281. int componentCount = 0;
  282. bool doing_script = false;
  283. bool doing_code = false;
  284. bool exclude_from_all = false;
  285. bool all_components = false;
  286. // Scan the args once for COMPONENT. Only allow one.
  287. //
  288. for (size_t i = 0; i < args.size(); ++i) {
  289. if (args[i] == "COMPONENT" && i + 1 < args.size()) {
  290. ++componentCount;
  291. ++i;
  292. component = args[i];
  293. }
  294. if (args[i] == "EXCLUDE_FROM_ALL") {
  295. exclude_from_all = true;
  296. } else if (args[i] == "ALL_COMPONENTS") {
  297. all_components = true;
  298. }
  299. }
  300. if (componentCount > 1) {
  301. status.SetError("given more than one COMPONENT for the SCRIPT or CODE "
  302. "signature of the INSTALL command. "
  303. "Use multiple INSTALL commands with one COMPONENT each.");
  304. return false;
  305. }
  306. if (all_components && componentCount == 1) {
  307. status.SetError("ALL_COMPONENTS and COMPONENT are mutually exclusive");
  308. return false;
  309. }
  310. // Scan the args again, this time adding install generators each time we
  311. // encounter a SCRIPT or CODE arg:
  312. //
  313. for (std::string const& arg : args) {
  314. if (arg == "SCRIPT") {
  315. doing_script = true;
  316. doing_code = false;
  317. } else if (arg == "CODE") {
  318. doing_script = false;
  319. doing_code = true;
  320. } else if (arg == "COMPONENT") {
  321. doing_script = false;
  322. doing_code = false;
  323. } else if (doing_script) {
  324. doing_script = false;
  325. std::string script = arg;
  326. if (!cmSystemTools::FileIsFullPath(script)) {
  327. script =
  328. cmStrCat(helper.Makefile->GetCurrentSourceDirectory(), '/', arg);
  329. }
  330. if (cmSystemTools::FileIsDirectory(script)) {
  331. status.SetError("given a directory as value of SCRIPT argument.");
  332. return false;
  333. }
  334. helper.Makefile->AddInstallGenerator(
  335. cm::make_unique<cmInstallScriptGenerator>(
  336. script, false, component, exclude_from_all, all_components,
  337. helper.Makefile->GetBacktrace()));
  338. } else if (doing_code) {
  339. doing_code = false;
  340. std::string const& code = arg;
  341. helper.Makefile->AddInstallGenerator(
  342. cm::make_unique<cmInstallScriptGenerator>(
  343. code, true, component, exclude_from_all, all_components,
  344. helper.Makefile->GetBacktrace()));
  345. }
  346. }
  347. if (doing_script) {
  348. status.SetError("given no value for SCRIPT argument.");
  349. return false;
  350. }
  351. if (doing_code) {
  352. status.SetError("given no value for CODE argument.");
  353. return false;
  354. }
  355. // Tell the global generator about any installation component names
  356. // specified.
  357. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(component);
  358. return true;
  359. }
  360. bool HandleTargetsMode(std::vector<std::string> const& args,
  361. cmExecutionStatus& status)
  362. {
  363. Helper helper(status);
  364. // This is the TARGETS mode.
  365. std::vector<cmTarget*> targets;
  366. struct ArgVectors
  367. {
  368. std::vector<std::string> Archive;
  369. std::vector<std::string> Library;
  370. std::vector<std::string> Runtime;
  371. std::vector<std::string> Object;
  372. std::vector<std::string> Framework;
  373. std::vector<std::string> Bundle;
  374. std::vector<std::string> Includes;
  375. std::vector<std::string> PrivateHeader;
  376. std::vector<std::string> PublicHeader;
  377. std::vector<std::string> Resource;
  378. std::vector<std::vector<std::string>> FileSets;
  379. };
  380. static auto const argHelper =
  381. cmArgumentParser<ArgVectors>{}
  382. .Bind("ARCHIVE"_s, &ArgVectors::Archive)
  383. .Bind("LIBRARY"_s, &ArgVectors::Library)
  384. .Bind("RUNTIME"_s, &ArgVectors::Runtime)
  385. .Bind("OBJECTS"_s, &ArgVectors::Object)
  386. .Bind("FRAMEWORK"_s, &ArgVectors::Framework)
  387. .Bind("BUNDLE"_s, &ArgVectors::Bundle)
  388. .Bind("INCLUDES"_s, &ArgVectors::Includes)
  389. .Bind("PRIVATE_HEADER"_s, &ArgVectors::PrivateHeader)
  390. .Bind("PUBLIC_HEADER"_s, &ArgVectors::PublicHeader)
  391. .Bind("RESOURCE"_s, &ArgVectors::Resource)
  392. .Bind("FILE_SET"_s, &ArgVectors::FileSets);
  393. std::vector<std::string> genericArgVector;
  394. ArgVectors const argVectors = argHelper.Parse(args, &genericArgVector);
  395. // now parse the generic args (i.e. the ones not specialized on LIBRARY/
  396. // ARCHIVE, RUNTIME etc. (see above)
  397. // These generic args also contain the targets and the export stuff
  398. std::vector<std::string> targetList;
  399. std::string exports;
  400. std::vector<std::string> runtimeDependenciesArgVector;
  401. std::string runtimeDependencySetArg;
  402. std::vector<std::string> unknownArgs;
  403. std::vector<std::string> parsedArgs;
  404. cmInstallCommandArguments genericArgs(helper.DefaultComponentName);
  405. genericArgs.Bind("TARGETS"_s, targetList);
  406. genericArgs.Bind("EXPORT"_s, exports);
  407. genericArgs.Bind("RUNTIME_DEPENDENCIES"_s, runtimeDependenciesArgVector);
  408. genericArgs.Bind("RUNTIME_DEPENDENCY_SET"_s, runtimeDependencySetArg);
  409. genericArgs.Parse(genericArgVector, &unknownArgs, nullptr, &parsedArgs);
  410. bool success = genericArgs.Finalize();
  411. bool withRuntimeDependencies =
  412. std::find(parsedArgs.begin(), parsedArgs.end(), "RUNTIME_DEPENDENCIES") !=
  413. parsedArgs.end();
  414. RuntimeDependenciesArgs runtimeDependenciesArgs =
  415. RuntimeDependenciesArgHelper.Parse(runtimeDependenciesArgVector,
  416. &unknownArgs);
  417. cmInstallCommandArguments archiveArgs(helper.DefaultComponentName);
  418. cmInstallCommandArguments libraryArgs(helper.DefaultComponentName);
  419. cmInstallCommandArguments runtimeArgs(helper.DefaultComponentName);
  420. cmInstallCommandArguments objectArgs(helper.DefaultComponentName);
  421. cmInstallCommandArguments frameworkArgs(helper.DefaultComponentName);
  422. cmInstallCommandArguments bundleArgs(helper.DefaultComponentName);
  423. cmInstallCommandArguments privateHeaderArgs(helper.DefaultComponentName);
  424. cmInstallCommandArguments publicHeaderArgs(helper.DefaultComponentName);
  425. cmInstallCommandArguments resourceArgs(helper.DefaultComponentName);
  426. cmInstallCommandIncludesArgument includesArgs;
  427. std::vector<cmInstallCommandFileSetArguments> fileSetArgs(
  428. argVectors.FileSets.size(), { helper.DefaultComponentName });
  429. // now parse the args for specific parts of the target (e.g. LIBRARY,
  430. // RUNTIME, ARCHIVE etc.
  431. archiveArgs.Parse(argVectors.Archive, &unknownArgs);
  432. libraryArgs.Parse(argVectors.Library, &unknownArgs);
  433. runtimeArgs.Parse(argVectors.Runtime, &unknownArgs);
  434. objectArgs.Parse(argVectors.Object, &unknownArgs);
  435. frameworkArgs.Parse(argVectors.Framework, &unknownArgs);
  436. bundleArgs.Parse(argVectors.Bundle, &unknownArgs);
  437. privateHeaderArgs.Parse(argVectors.PrivateHeader, &unknownArgs);
  438. publicHeaderArgs.Parse(argVectors.PublicHeader, &unknownArgs);
  439. resourceArgs.Parse(argVectors.Resource, &unknownArgs);
  440. includesArgs.Parse(&argVectors.Includes, &unknownArgs);
  441. for (std::size_t i = 0; i < argVectors.FileSets.size(); i++) {
  442. // We have to create a separate object for the parsing because
  443. // cmArgumentParser<void>::Bind() binds to a specific address, but the
  444. // objects in the vector can move around. So we parse in an object with a
  445. // fixed address and then copy the data into the vector.
  446. cmInstallCommandFileSetArguments fileSetArg(helper.DefaultComponentName);
  447. fileSetArg.Parse(argVectors.FileSets[i], &unknownArgs);
  448. fileSetArgs[i] = std::move(fileSetArg);
  449. }
  450. if (!unknownArgs.empty()) {
  451. // Unknown argument.
  452. status.SetError(
  453. cmStrCat("TARGETS given unknown argument \"", unknownArgs[0], "\"."));
  454. return false;
  455. }
  456. // apply generic args
  457. archiveArgs.SetGenericArguments(&genericArgs);
  458. libraryArgs.SetGenericArguments(&genericArgs);
  459. runtimeArgs.SetGenericArguments(&genericArgs);
  460. objectArgs.SetGenericArguments(&genericArgs);
  461. frameworkArgs.SetGenericArguments(&genericArgs);
  462. bundleArgs.SetGenericArguments(&genericArgs);
  463. privateHeaderArgs.SetGenericArguments(&genericArgs);
  464. publicHeaderArgs.SetGenericArguments(&genericArgs);
  465. resourceArgs.SetGenericArguments(&genericArgs);
  466. for (auto& fileSetArg : fileSetArgs) {
  467. fileSetArg.SetGenericArguments(&genericArgs);
  468. }
  469. success = success && archiveArgs.Finalize();
  470. success = success && libraryArgs.Finalize();
  471. success = success && runtimeArgs.Finalize();
  472. success = success && objectArgs.Finalize();
  473. success = success && frameworkArgs.Finalize();
  474. success = success && bundleArgs.Finalize();
  475. success = success && privateHeaderArgs.Finalize();
  476. success = success && publicHeaderArgs.Finalize();
  477. success = success && resourceArgs.Finalize();
  478. for (auto& fileSetArg : fileSetArgs) {
  479. success = success && fileSetArg.Finalize();
  480. }
  481. if (!success) {
  482. return false;
  483. }
  484. // Enforce argument rules too complex to specify for the
  485. // general-purpose parser.
  486. if (archiveArgs.GetNamelinkOnly() || runtimeArgs.GetNamelinkOnly() ||
  487. objectArgs.GetNamelinkOnly() || frameworkArgs.GetNamelinkOnly() ||
  488. bundleArgs.GetNamelinkOnly() || privateHeaderArgs.GetNamelinkOnly() ||
  489. publicHeaderArgs.GetNamelinkOnly() || resourceArgs.GetNamelinkOnly() ||
  490. std::any_of(fileSetArgs.begin(), fileSetArgs.end(),
  491. [](const cmInstallCommandFileSetArguments& fileSetArg)
  492. -> bool { return fileSetArg.GetNamelinkOnly(); })) {
  493. status.SetError(
  494. "TARGETS given NAMELINK_ONLY option not in LIBRARY group. "
  495. "The NAMELINK_ONLY option may be specified only following LIBRARY.");
  496. return false;
  497. }
  498. if (archiveArgs.GetNamelinkSkip() || runtimeArgs.GetNamelinkSkip() ||
  499. objectArgs.GetNamelinkSkip() || frameworkArgs.GetNamelinkSkip() ||
  500. bundleArgs.GetNamelinkSkip() || privateHeaderArgs.GetNamelinkSkip() ||
  501. publicHeaderArgs.GetNamelinkSkip() || resourceArgs.GetNamelinkSkip() ||
  502. std::any_of(fileSetArgs.begin(), fileSetArgs.end(),
  503. [](const cmInstallCommandFileSetArguments& fileSetArg)
  504. -> bool { return fileSetArg.GetNamelinkSkip(); })) {
  505. status.SetError(
  506. "TARGETS given NAMELINK_SKIP option not in LIBRARY group. "
  507. "The NAMELINK_SKIP option may be specified only following LIBRARY.");
  508. return false;
  509. }
  510. if (archiveArgs.HasNamelinkComponent() ||
  511. runtimeArgs.HasNamelinkComponent() ||
  512. objectArgs.HasNamelinkComponent() ||
  513. frameworkArgs.HasNamelinkComponent() ||
  514. bundleArgs.HasNamelinkComponent() ||
  515. privateHeaderArgs.HasNamelinkComponent() ||
  516. publicHeaderArgs.HasNamelinkComponent() ||
  517. resourceArgs.HasNamelinkComponent() ||
  518. std::any_of(fileSetArgs.begin(), fileSetArgs.end(),
  519. [](const cmInstallCommandFileSetArguments& fileSetArg)
  520. -> bool { return fileSetArg.HasNamelinkComponent(); })) {
  521. status.SetError(
  522. "TARGETS given NAMELINK_COMPONENT option not in LIBRARY group. "
  523. "The NAMELINK_COMPONENT option may be specified only following "
  524. "LIBRARY.");
  525. return false;
  526. }
  527. if (libraryArgs.GetNamelinkOnly() && libraryArgs.GetNamelinkSkip()) {
  528. status.SetError("TARGETS given NAMELINK_ONLY and NAMELINK_SKIP. "
  529. "At most one of these two options may be specified.");
  530. return false;
  531. }
  532. if (!genericArgs.GetType().empty() || !archiveArgs.GetType().empty() ||
  533. !libraryArgs.GetType().empty() || !runtimeArgs.GetType().empty() ||
  534. !objectArgs.GetType().empty() || !frameworkArgs.GetType().empty() ||
  535. !bundleArgs.GetType().empty() || !privateHeaderArgs.GetType().empty() ||
  536. !publicHeaderArgs.GetType().empty() || !resourceArgs.GetType().empty() ||
  537. std::any_of(fileSetArgs.begin(), fileSetArgs.end(),
  538. [](const cmInstallCommandFileSetArguments& fileSetArg)
  539. -> bool { return !fileSetArg.GetType().empty(); })) {
  540. status.SetError(
  541. "TARGETS given TYPE option. The TYPE option may only be specified in "
  542. " install(FILES) and install(DIRECTORIES).");
  543. return false;
  544. }
  545. if (std::any_of(fileSetArgs.begin(), fileSetArgs.end(),
  546. [](const cmInstallCommandFileSetArguments& fileSetArg)
  547. -> bool { return fileSetArg.GetFileSet().empty(); })) {
  548. status.SetError("TARGETS given FILE_SET option without file set name.");
  549. return false;
  550. }
  551. cmInstallRuntimeDependencySet* runtimeDependencySet = nullptr;
  552. if (withRuntimeDependencies) {
  553. if (!runtimeDependencySetArg.empty()) {
  554. status.SetError("TARGETS cannot have both RUNTIME_DEPENDENCIES and "
  555. "RUNTIME_DEPENDENCY_SET.");
  556. return false;
  557. }
  558. auto system = helper.Makefile->GetSafeDefinition("CMAKE_HOST_SYSTEM_NAME");
  559. if (!cmRuntimeDependencyArchive::PlatformSupportsRuntimeDependencies(
  560. system)) {
  561. status.SetError(
  562. cmStrCat("TARGETS RUNTIME_DEPENDENCIES is not supported on system \"",
  563. system, '"'));
  564. return false;
  565. }
  566. if (helper.Makefile->IsOn("CMAKE_CROSSCOMPILING")) {
  567. status.SetError("TARGETS RUNTIME_DEPENDENCIES is not supported "
  568. "when cross-compiling.");
  569. return false;
  570. }
  571. if (helper.Makefile->GetSafeDefinition("CMAKE_HOST_SYSTEM_NAME") ==
  572. "Darwin" &&
  573. frameworkArgs.GetDestination().empty()) {
  574. status.SetError(
  575. "TARGETS RUNTIME_DEPENDENCIES given no FRAMEWORK DESTINATION");
  576. return false;
  577. }
  578. runtimeDependencySet = helper.Makefile->GetGlobalGenerator()
  579. ->CreateAnonymousRuntimeDependencySet();
  580. } else if (!runtimeDependencySetArg.empty()) {
  581. auto system = helper.Makefile->GetSafeDefinition("CMAKE_HOST_SYSTEM_NAME");
  582. if (!cmRuntimeDependencyArchive::PlatformSupportsRuntimeDependencies(
  583. system)) {
  584. status.SetError(cmStrCat(
  585. "TARGETS RUNTIME_DEPENDENCY_SET is not supported on system \"", system,
  586. '"'));
  587. return false;
  588. }
  589. runtimeDependencySet =
  590. helper.Makefile->GetGlobalGenerator()->GetNamedRuntimeDependencySet(
  591. runtimeDependencySetArg);
  592. }
  593. // Select the mode for installing symlinks to versioned shared libraries.
  594. cmInstallTargetGenerator::NamelinkModeType namelinkMode =
  595. cmInstallTargetGenerator::NamelinkModeNone;
  596. if (libraryArgs.GetNamelinkOnly()) {
  597. namelinkMode = cmInstallTargetGenerator::NamelinkModeOnly;
  598. } else if (libraryArgs.GetNamelinkSkip()) {
  599. namelinkMode = cmInstallTargetGenerator::NamelinkModeSkip;
  600. }
  601. // Check if there is something to do.
  602. if (targetList.empty()) {
  603. return true;
  604. }
  605. for (std::string const& tgt : targetList) {
  606. if (helper.Makefile->IsAlias(tgt)) {
  607. status.SetError(
  608. cmStrCat("TARGETS given target \"", tgt, "\" which is an alias."));
  609. return false;
  610. }
  611. // Lookup this target in the current directory.
  612. cmTarget* target = helper.Makefile->FindLocalNonAliasTarget(tgt);
  613. if (!target) {
  614. // If no local target has been found, find it in the global scope.
  615. cmTarget* const global_target =
  616. helper.Makefile->GetGlobalGenerator()->FindTarget(tgt, true);
  617. if (global_target && !global_target->IsImported()) {
  618. target = global_target;
  619. }
  620. }
  621. if (target) {
  622. // Found the target. Check its type.
  623. if (target->GetType() != cmStateEnums::EXECUTABLE &&
  624. target->GetType() != cmStateEnums::STATIC_LIBRARY &&
  625. target->GetType() != cmStateEnums::SHARED_LIBRARY &&
  626. target->GetType() != cmStateEnums::MODULE_LIBRARY &&
  627. target->GetType() != cmStateEnums::OBJECT_LIBRARY &&
  628. target->GetType() != cmStateEnums::INTERFACE_LIBRARY) {
  629. status.SetError(
  630. cmStrCat("TARGETS given target \"", tgt,
  631. "\" which is not an executable, library, or module."));
  632. return false;
  633. }
  634. // Store the target in the list to be installed.
  635. targets.push_back(target);
  636. } else {
  637. // Did not find the target.
  638. status.SetError(
  639. cmStrCat("TARGETS given target \"", tgt, "\" which does not exist."));
  640. return false;
  641. }
  642. }
  643. // Keep track of whether we will be performing an installation of
  644. // any files of the given type.
  645. bool installsArchive = false;
  646. bool installsLibrary = false;
  647. bool installsNamelink = false;
  648. bool installsRuntime = false;
  649. bool installsObject = false;
  650. bool installsFramework = false;
  651. bool installsBundle = false;
  652. bool installsPrivateHeader = false;
  653. bool installsPublicHeader = false;
  654. bool installsResource = false;
  655. std::vector<bool> installsFileSet(fileSetArgs.size(), false);
  656. // Generate install script code to install the given targets.
  657. for (cmTarget* ti : targets) {
  658. // Handle each target type.
  659. cmTarget& target = *ti;
  660. std::unique_ptr<cmInstallTargetGenerator> archiveGenerator;
  661. std::unique_ptr<cmInstallTargetGenerator> libraryGenerator;
  662. std::unique_ptr<cmInstallTargetGenerator> namelinkGenerator;
  663. std::unique_ptr<cmInstallTargetGenerator> runtimeGenerator;
  664. std::unique_ptr<cmInstallTargetGenerator> objectGenerator;
  665. std::unique_ptr<cmInstallTargetGenerator> frameworkGenerator;
  666. std::unique_ptr<cmInstallTargetGenerator> bundleGenerator;
  667. std::unique_ptr<cmInstallFilesGenerator> privateHeaderGenerator;
  668. std::unique_ptr<cmInstallFilesGenerator> publicHeaderGenerator;
  669. std::unique_ptr<cmInstallFilesGenerator> resourceGenerator;
  670. std::vector<std::unique_ptr<cmInstallFileSetGenerator>> fileSetGenerators;
  671. // Avoid selecting default destinations for PUBLIC_HEADER and
  672. // PRIVATE_HEADER if any artifacts are specified.
  673. bool artifactsSpecified = false;
  674. // Track whether this is a namelink-only rule.
  675. bool namelinkOnly = false;
  676. auto addTargetExport = [&]() -> bool {
  677. // Add this install rule to an export if one was specified.
  678. if (!exports.empty()) {
  679. auto interfaceFileSets = target.GetAllInterfaceFileSets();
  680. if (std::any_of(
  681. interfaceFileSets.begin(), interfaceFileSets.end(),
  682. [=](const std::string& name) -> bool {
  683. return !std::any_of(
  684. fileSetArgs.begin(), fileSetArgs.end(),
  685. [=](const cmInstallCommandFileSetArguments& fileSetArg)
  686. -> bool { return fileSetArg.GetFileSet() == name; });
  687. })) {
  688. status.SetError(cmStrCat(
  689. "TARGETS target ", target.GetName(),
  690. " is exported but not all of its file sets are installed"));
  691. return false;
  692. }
  693. auto te = cm::make_unique<cmTargetExport>();
  694. te->TargetName = target.GetName();
  695. te->ArchiveGenerator = archiveGenerator.get();
  696. te->BundleGenerator = bundleGenerator.get();
  697. te->FrameworkGenerator = frameworkGenerator.get();
  698. te->HeaderGenerator = publicHeaderGenerator.get();
  699. te->LibraryGenerator = libraryGenerator.get();
  700. te->RuntimeGenerator = runtimeGenerator.get();
  701. te->ObjectsGenerator = objectGenerator.get();
  702. for (auto const& gen : fileSetGenerators) {
  703. te->FileSetGenerators[gen->GetFileSet()] = gen.get();
  704. }
  705. target.AddInstallIncludeDirectories(
  706. *te, cmMakeRange(includesArgs.GetIncludeDirs()));
  707. te->NamelinkOnly = namelinkOnly;
  708. helper.Makefile->GetGlobalGenerator()
  709. ->GetExportSets()[exports]
  710. .AddTargetExport(std::move(te));
  711. }
  712. return true;
  713. };
  714. switch (target.GetType()) {
  715. case cmStateEnums::SHARED_LIBRARY: {
  716. // Shared libraries are handled differently on DLL and non-DLL
  717. // platforms. All windows platforms are DLL platforms including
  718. // cygwin. Currently no other platform is a DLL platform.
  719. if (target.IsDLLPlatform()) {
  720. // When in namelink only mode skip all libraries on Windows.
  721. if (namelinkMode == cmInstallTargetGenerator::NamelinkModeOnly) {
  722. namelinkOnly = true;
  723. if (!addTargetExport()) {
  724. return false;
  725. }
  726. continue;
  727. }
  728. // This is a DLL platform.
  729. if (!archiveArgs.GetDestination().empty()) {
  730. // The import library uses the ARCHIVE properties.
  731. archiveGenerator = CreateInstallTargetGenerator(
  732. target, archiveArgs, true, helper.Makefile->GetBacktrace());
  733. artifactsSpecified = true;
  734. }
  735. if (!runtimeArgs.GetDestination().empty()) {
  736. // The DLL uses the RUNTIME properties.
  737. runtimeGenerator = CreateInstallTargetGenerator(
  738. target, runtimeArgs, false, helper.Makefile->GetBacktrace());
  739. artifactsSpecified = true;
  740. }
  741. if (!archiveGenerator && !runtimeGenerator) {
  742. archiveGenerator = CreateInstallTargetGenerator(
  743. target, archiveArgs, true, helper.Makefile->GetBacktrace(),
  744. helper.GetArchiveDestination(nullptr));
  745. runtimeGenerator = CreateInstallTargetGenerator(
  746. target, runtimeArgs, false, helper.Makefile->GetBacktrace(),
  747. helper.GetRuntimeDestination(nullptr));
  748. }
  749. if (runtimeDependencySet && runtimeGenerator) {
  750. runtimeDependencySet->AddLibrary(runtimeGenerator.get());
  751. }
  752. } else {
  753. // This is a non-DLL platform.
  754. // If it is marked with FRAMEWORK property use the FRAMEWORK set of
  755. // INSTALL properties. Otherwise, use the LIBRARY properties.
  756. if (target.IsFrameworkOnApple()) {
  757. // When in namelink only mode skip frameworks.
  758. if (namelinkMode == cmInstallTargetGenerator::NamelinkModeOnly) {
  759. namelinkOnly = true;
  760. if (!addTargetExport()) {
  761. return false;
  762. }
  763. continue;
  764. }
  765. // Use the FRAMEWORK properties.
  766. if (!frameworkArgs.GetDestination().empty()) {
  767. frameworkGenerator = CreateInstallTargetGenerator(
  768. target, frameworkArgs, false, helper.Makefile->GetBacktrace());
  769. } else {
  770. status.SetError(
  771. cmStrCat("TARGETS given no FRAMEWORK DESTINATION for shared "
  772. "library FRAMEWORK target \"",
  773. target.GetName(), "\"."));
  774. return false;
  775. }
  776. } else {
  777. // The shared library uses the LIBRARY properties.
  778. if (!libraryArgs.GetDestination().empty()) {
  779. artifactsSpecified = true;
  780. }
  781. if (namelinkMode != cmInstallTargetGenerator::NamelinkModeOnly) {
  782. libraryGenerator = CreateInstallTargetGenerator(
  783. target, libraryArgs, false, helper.Makefile->GetBacktrace(),
  784. helper.GetLibraryDestination(&libraryArgs));
  785. libraryGenerator->SetNamelinkMode(
  786. cmInstallTargetGenerator::NamelinkModeSkip);
  787. }
  788. if (namelinkMode != cmInstallTargetGenerator::NamelinkModeSkip) {
  789. namelinkGenerator = CreateInstallTargetGenerator(
  790. target, libraryArgs, false, helper.Makefile->GetBacktrace(),
  791. helper.GetLibraryDestination(&libraryArgs), false, true);
  792. namelinkGenerator->SetNamelinkMode(
  793. cmInstallTargetGenerator::NamelinkModeOnly);
  794. }
  795. namelinkOnly =
  796. (namelinkMode == cmInstallTargetGenerator::NamelinkModeOnly);
  797. }
  798. if (runtimeDependencySet && libraryGenerator) {
  799. runtimeDependencySet->AddLibrary(libraryGenerator.get());
  800. }
  801. }
  802. } break;
  803. case cmStateEnums::STATIC_LIBRARY: {
  804. // If it is marked with FRAMEWORK property use the FRAMEWORK set of
  805. // INSTALL properties. Otherwise, use the LIBRARY properties.
  806. if (target.IsFrameworkOnApple()) {
  807. // When in namelink only mode skip frameworks.
  808. if (namelinkMode == cmInstallTargetGenerator::NamelinkModeOnly) {
  809. namelinkOnly = true;
  810. if (!addTargetExport()) {
  811. return false;
  812. }
  813. continue;
  814. }
  815. // Use the FRAMEWORK properties.
  816. if (!frameworkArgs.GetDestination().empty()) {
  817. frameworkGenerator = CreateInstallTargetGenerator(
  818. target, frameworkArgs, false, helper.Makefile->GetBacktrace());
  819. } else {
  820. status.SetError(
  821. cmStrCat("TARGETS given no FRAMEWORK DESTINATION for static "
  822. "library FRAMEWORK target \"",
  823. target.GetName(), "\"."));
  824. return false;
  825. }
  826. } else {
  827. // Static libraries use ARCHIVE properties.
  828. if (!archiveArgs.GetDestination().empty()) {
  829. artifactsSpecified = true;
  830. }
  831. archiveGenerator = CreateInstallTargetGenerator(
  832. target, archiveArgs, false, helper.Makefile->GetBacktrace(),
  833. helper.GetArchiveDestination(&archiveArgs));
  834. }
  835. } break;
  836. case cmStateEnums::MODULE_LIBRARY: {
  837. // Modules use LIBRARY properties.
  838. if (!libraryArgs.GetDestination().empty()) {
  839. libraryGenerator = CreateInstallTargetGenerator(
  840. target, libraryArgs, false, helper.Makefile->GetBacktrace());
  841. libraryGenerator->SetNamelinkMode(namelinkMode);
  842. namelinkOnly =
  843. (namelinkMode == cmInstallTargetGenerator::NamelinkModeOnly);
  844. if (runtimeDependencySet) {
  845. runtimeDependencySet->AddModule(libraryGenerator.get());
  846. }
  847. } else {
  848. status.SetError(
  849. cmStrCat("TARGETS given no LIBRARY DESTINATION for module "
  850. "target \"",
  851. target.GetName(), "\"."));
  852. return false;
  853. }
  854. } break;
  855. case cmStateEnums::OBJECT_LIBRARY: {
  856. // Objects use OBJECT properties.
  857. if (!objectArgs.GetDestination().empty()) {
  858. // Verify that we know where the objects are to install them.
  859. std::string reason;
  860. if (!helper.Makefile->GetGlobalGenerator()
  861. ->HasKnownObjectFileLocation(&reason)) {
  862. status.SetError(
  863. cmStrCat("TARGETS given OBJECT library \"", target.GetName(),
  864. "\" whose objects may not be installed", reason, "."));
  865. return false;
  866. }
  867. objectGenerator = CreateInstallTargetGenerator(
  868. target, objectArgs, false, helper.Makefile->GetBacktrace());
  869. } else {
  870. // Installing an OBJECT library without a destination transforms
  871. // it to an INTERFACE library. It installs no files but can be
  872. // exported.
  873. }
  874. } break;
  875. case cmStateEnums::EXECUTABLE: {
  876. if (target.IsAppBundleOnApple()) {
  877. // Application bundles use the BUNDLE properties.
  878. if (!bundleArgs.GetDestination().empty()) {
  879. bundleGenerator = CreateInstallTargetGenerator(
  880. target, bundleArgs, false, helper.Makefile->GetBacktrace());
  881. } else if (!runtimeArgs.GetDestination().empty()) {
  882. bool failure = false;
  883. if (helper.CheckCMP0006(failure)) {
  884. // For CMake 2.4 compatibility fallback to the RUNTIME
  885. // properties.
  886. bundleGenerator = CreateInstallTargetGenerator(
  887. target, runtimeArgs, false, helper.Makefile->GetBacktrace());
  888. } else if (failure) {
  889. return false;
  890. }
  891. }
  892. if (!bundleGenerator) {
  893. status.SetError(cmStrCat("TARGETS given no BUNDLE DESTINATION for "
  894. "MACOSX_BUNDLE executable target \"",
  895. target.GetName(), "\"."));
  896. return false;
  897. }
  898. if (runtimeDependencySet) {
  899. if (!AddBundleExecutable(helper, runtimeDependencySet,
  900. bundleGenerator.get())) {
  901. return false;
  902. }
  903. }
  904. } else {
  905. // Executables use the RUNTIME properties.
  906. if (!runtimeArgs.GetDestination().empty()) {
  907. artifactsSpecified = true;
  908. }
  909. runtimeGenerator = CreateInstallTargetGenerator(
  910. target, runtimeArgs, false, helper.Makefile->GetBacktrace(),
  911. helper.GetRuntimeDestination(&runtimeArgs));
  912. if (runtimeDependencySet) {
  913. runtimeDependencySet->AddExecutable(runtimeGenerator.get());
  914. }
  915. }
  916. // On DLL platforms an executable may also have an import
  917. // library. Install it to the archive destination if it
  918. // exists.
  919. if ((target.IsDLLPlatform() || target.IsAIX()) &&
  920. !archiveArgs.GetDestination().empty() &&
  921. target.IsExecutableWithExports()) {
  922. // The import library uses the ARCHIVE properties.
  923. artifactsSpecified = true;
  924. archiveGenerator = CreateInstallTargetGenerator(
  925. target, archiveArgs, true, helper.Makefile->GetBacktrace(), true);
  926. }
  927. } break;
  928. case cmStateEnums::INTERFACE_LIBRARY:
  929. // Nothing to do. An INTERFACE_LIBRARY can be installed, but the
  930. // only effect of that is to make it exportable. It installs no
  931. // other files itself.
  932. default:
  933. // This should never happen due to the above type check.
  934. // Ignore the case.
  935. break;
  936. }
  937. // These well-known sets of files are installed *automatically* for
  938. // FRAMEWORK SHARED library targets on the Mac as part of installing the
  939. // FRAMEWORK. For other target types or on other platforms, they are not
  940. // installed automatically and so we need to create install files
  941. // generators for them.
  942. bool createInstallGeneratorsForTargetFileSets = true;
  943. if (target.IsFrameworkOnApple()) {
  944. createInstallGeneratorsForTargetFileSets = false;
  945. }
  946. if (createInstallGeneratorsForTargetFileSets && !namelinkOnly) {
  947. cmValue files = target.GetProperty("PRIVATE_HEADER");
  948. if (cmNonempty(files)) {
  949. std::vector<std::string> relFiles = cmExpandedList(*files);
  950. std::vector<std::string> absFiles;
  951. if (!helper.MakeFilesFullPath("PRIVATE_HEADER", relFiles, absFiles)) {
  952. return false;
  953. }
  954. // Create the files install generator.
  955. if (!artifactsSpecified ||
  956. !privateHeaderArgs.GetDestination().empty()) {
  957. privateHeaderGenerator = CreateInstallFilesGenerator(
  958. helper.Makefile, absFiles, privateHeaderArgs, false,
  959. helper.GetIncludeDestination(&privateHeaderArgs));
  960. } else {
  961. std::ostringstream e;
  962. e << "Target " << target.GetName() << " has "
  963. << "PRIVATE_HEADER files but no PRIVATE_HEADER DESTINATION.";
  964. helper.Makefile->IssueMessage(MessageType::AUTHOR_WARNING, e.str());
  965. }
  966. }
  967. files = target.GetProperty("PUBLIC_HEADER");
  968. if (cmNonempty(files)) {
  969. std::vector<std::string> relFiles = cmExpandedList(*files);
  970. std::vector<std::string> absFiles;
  971. if (!helper.MakeFilesFullPath("PUBLIC_HEADER", relFiles, absFiles)) {
  972. return false;
  973. }
  974. // Create the files install generator.
  975. if (!artifactsSpecified ||
  976. !publicHeaderArgs.GetDestination().empty()) {
  977. publicHeaderGenerator = CreateInstallFilesGenerator(
  978. helper.Makefile, absFiles, publicHeaderArgs, false,
  979. helper.GetIncludeDestination(&publicHeaderArgs));
  980. } else {
  981. std::ostringstream e;
  982. e << "Target " << target.GetName() << " has "
  983. << "PUBLIC_HEADER files but no PUBLIC_HEADER DESTINATION.";
  984. helper.Makefile->IssueMessage(MessageType::AUTHOR_WARNING, e.str());
  985. }
  986. }
  987. files = target.GetProperty("RESOURCE");
  988. if (cmNonempty(files)) {
  989. std::vector<std::string> relFiles = cmExpandedList(*files);
  990. std::vector<std::string> absFiles;
  991. if (!helper.MakeFilesFullPath("RESOURCE", relFiles, absFiles)) {
  992. return false;
  993. }
  994. // Create the files install generator.
  995. if (!resourceArgs.GetDestination().empty()) {
  996. resourceGenerator = CreateInstallFilesGenerator(
  997. helper.Makefile, absFiles, resourceArgs, false);
  998. } else if (!target.IsAppBundleOnApple()) {
  999. helper.Makefile->IssueMessage(
  1000. MessageType::AUTHOR_WARNING,
  1001. cmStrCat("Target ", target.GetName(),
  1002. " has RESOURCE files but no RESOURCE DESTINATION."));
  1003. }
  1004. }
  1005. }
  1006. if (!namelinkOnly) {
  1007. for (std::size_t i = 0; i < fileSetArgs.size(); i++) {
  1008. auto* fileSet = target.GetFileSet(fileSetArgs[i].GetFileSet());
  1009. auto interfaceFileSetEntries = cmExpandedList(target.GetSafeProperty(
  1010. cmTarget::GetInterfaceFileSetsPropertyName(fileSet->GetType())));
  1011. if (fileSet &&
  1012. std::find(
  1013. interfaceFileSetEntries.begin(), interfaceFileSetEntries.end(),
  1014. fileSetArgs[i].GetFileSet()) != interfaceFileSetEntries.end()) {
  1015. std::string destination;
  1016. if (fileSet->GetType() == "HEADERS"_s) {
  1017. destination = helper.GetIncludeDestination(&fileSetArgs[i]);
  1018. } else {
  1019. destination = fileSetArgs[i].GetDestination();
  1020. if (destination.empty()) {
  1021. status.SetError(
  1022. cmStrCat("TARGETS given no FILE_SET DESTINATION for target \"",
  1023. target.GetName(), "\" file set \"",
  1024. fileSet->GetName(), "\"."));
  1025. return false;
  1026. }
  1027. }
  1028. fileSetGenerators.push_back(CreateInstallFileSetGenerator(
  1029. helper, target, fileSet, destination, fileSetArgs[i]));
  1030. installsFileSet[i] = true;
  1031. }
  1032. }
  1033. }
  1034. // Add this install rule to an export if one was specified.
  1035. if (!addTargetExport()) {
  1036. return false;
  1037. }
  1038. // Keep track of whether we're installing anything in each category
  1039. installsArchive = installsArchive || archiveGenerator;
  1040. installsLibrary = installsLibrary || libraryGenerator;
  1041. installsNamelink = installsNamelink || namelinkGenerator;
  1042. installsRuntime = installsRuntime || runtimeGenerator;
  1043. installsObject = installsObject || objectGenerator;
  1044. installsFramework = installsFramework || frameworkGenerator;
  1045. installsBundle = installsBundle || bundleGenerator;
  1046. installsPrivateHeader = installsPrivateHeader || privateHeaderGenerator;
  1047. installsPublicHeader = installsPublicHeader || publicHeaderGenerator;
  1048. installsResource = installsResource || resourceGenerator;
  1049. helper.Makefile->AddInstallGenerator(std::move(archiveGenerator));
  1050. helper.Makefile->AddInstallGenerator(std::move(libraryGenerator));
  1051. helper.Makefile->AddInstallGenerator(std::move(namelinkGenerator));
  1052. helper.Makefile->AddInstallGenerator(std::move(runtimeGenerator));
  1053. helper.Makefile->AddInstallGenerator(std::move(objectGenerator));
  1054. helper.Makefile->AddInstallGenerator(std::move(frameworkGenerator));
  1055. helper.Makefile->AddInstallGenerator(std::move(bundleGenerator));
  1056. helper.Makefile->AddInstallGenerator(std::move(privateHeaderGenerator));
  1057. helper.Makefile->AddInstallGenerator(std::move(publicHeaderGenerator));
  1058. helper.Makefile->AddInstallGenerator(std::move(resourceGenerator));
  1059. for (auto& gen : fileSetGenerators) {
  1060. helper.Makefile->AddInstallGenerator(std::move(gen));
  1061. }
  1062. }
  1063. if (withRuntimeDependencies && !runtimeDependencySet->Empty()) {
  1064. AddInstallRuntimeDependenciesGenerator(
  1065. helper, runtimeDependencySet, runtimeArgs, libraryArgs, frameworkArgs,
  1066. std::move(runtimeDependenciesArgs), installsRuntime, installsLibrary,
  1067. installsFramework);
  1068. }
  1069. // Tell the global generator about any installation component names
  1070. // specified
  1071. if (installsArchive) {
  1072. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1073. archiveArgs.GetComponent());
  1074. }
  1075. if (installsLibrary) {
  1076. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1077. libraryArgs.GetComponent());
  1078. }
  1079. if (installsNamelink) {
  1080. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1081. libraryArgs.GetNamelinkComponent());
  1082. }
  1083. if (installsRuntime) {
  1084. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1085. runtimeArgs.GetComponent());
  1086. }
  1087. if (installsObject) {
  1088. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1089. objectArgs.GetComponent());
  1090. }
  1091. if (installsFramework) {
  1092. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1093. frameworkArgs.GetComponent());
  1094. }
  1095. if (installsBundle) {
  1096. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1097. bundleArgs.GetComponent());
  1098. }
  1099. if (installsPrivateHeader) {
  1100. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1101. privateHeaderArgs.GetComponent());
  1102. }
  1103. if (installsPublicHeader) {
  1104. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1105. publicHeaderArgs.GetComponent());
  1106. }
  1107. if (installsResource) {
  1108. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1109. resourceArgs.GetComponent());
  1110. }
  1111. for (std::size_t i = 0; i < fileSetArgs.size(); i++) {
  1112. if (installsFileSet[i]) {
  1113. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1114. fileSetArgs[i].GetComponent());
  1115. }
  1116. }
  1117. return true;
  1118. }
  1119. bool HandleImportedRuntimeArtifactsMode(std::vector<std::string> const& args,
  1120. cmExecutionStatus& status)
  1121. {
  1122. Helper helper(status);
  1123. // This is the IMPORTED_RUNTIME_ARTIFACTS mode.
  1124. std::vector<cmTarget*> targets;
  1125. struct ArgVectors
  1126. {
  1127. std::vector<std::string> Library;
  1128. std::vector<std::string> Runtime;
  1129. std::vector<std::string> Framework;
  1130. std::vector<std::string> Bundle;
  1131. };
  1132. static auto const argHelper = cmArgumentParser<ArgVectors>{}
  1133. .Bind("LIBRARY"_s, &ArgVectors::Library)
  1134. .Bind("RUNTIME"_s, &ArgVectors::Runtime)
  1135. .Bind("FRAMEWORK"_s, &ArgVectors::Framework)
  1136. .Bind("BUNDLE"_s, &ArgVectors::Bundle);
  1137. std::vector<std::string> genericArgVector;
  1138. ArgVectors const argVectors = argHelper.Parse(args, &genericArgVector);
  1139. // now parse the generic args (i.e. the ones not specialized on LIBRARY,
  1140. // RUNTIME etc. (see above)
  1141. std::vector<std::string> targetList;
  1142. std::string runtimeDependencySetArg;
  1143. std::vector<std::string> unknownArgs;
  1144. cmInstallCommandArguments genericArgs(helper.DefaultComponentName);
  1145. genericArgs.Bind("IMPORTED_RUNTIME_ARTIFACTS"_s, targetList)
  1146. .Bind("RUNTIME_DEPENDENCY_SET"_s, runtimeDependencySetArg);
  1147. genericArgs.Parse(genericArgVector, &unknownArgs);
  1148. bool success = genericArgs.Finalize();
  1149. cmInstallCommandArguments libraryArgs(helper.DefaultComponentName);
  1150. cmInstallCommandArguments runtimeArgs(helper.DefaultComponentName);
  1151. cmInstallCommandArguments frameworkArgs(helper.DefaultComponentName);
  1152. cmInstallCommandArguments bundleArgs(helper.DefaultComponentName);
  1153. // now parse the args for specific parts of the target (e.g. LIBRARY,
  1154. // RUNTIME etc.
  1155. libraryArgs.Parse(argVectors.Library, &unknownArgs);
  1156. runtimeArgs.Parse(argVectors.Runtime, &unknownArgs);
  1157. frameworkArgs.Parse(argVectors.Framework, &unknownArgs);
  1158. bundleArgs.Parse(argVectors.Bundle, &unknownArgs);
  1159. if (!unknownArgs.empty()) {
  1160. // Unknown argument.
  1161. status.SetError(
  1162. cmStrCat("IMPORTED_RUNTIME_ARTIFACTS given unknown argument \"",
  1163. unknownArgs[0], "\"."));
  1164. return false;
  1165. }
  1166. // apply generic args
  1167. libraryArgs.SetGenericArguments(&genericArgs);
  1168. runtimeArgs.SetGenericArguments(&genericArgs);
  1169. frameworkArgs.SetGenericArguments(&genericArgs);
  1170. bundleArgs.SetGenericArguments(&genericArgs);
  1171. success = success && libraryArgs.Finalize();
  1172. success = success && runtimeArgs.Finalize();
  1173. success = success && frameworkArgs.Finalize();
  1174. success = success && bundleArgs.Finalize();
  1175. if (!success) {
  1176. return false;
  1177. }
  1178. cmInstallRuntimeDependencySet* runtimeDependencySet = nullptr;
  1179. if (!runtimeDependencySetArg.empty()) {
  1180. auto system = helper.Makefile->GetSafeDefinition("CMAKE_HOST_SYSTEM_NAME");
  1181. if (!cmRuntimeDependencyArchive::PlatformSupportsRuntimeDependencies(
  1182. system)) {
  1183. status.SetError(
  1184. cmStrCat("IMPORTED_RUNTIME_ARTIFACTS RUNTIME_DEPENDENCY_SET is not "
  1185. "supported on system \"",
  1186. system, '"'));
  1187. return false;
  1188. }
  1189. runtimeDependencySet =
  1190. helper.Makefile->GetGlobalGenerator()->GetNamedRuntimeDependencySet(
  1191. runtimeDependencySetArg);
  1192. }
  1193. // Check if there is something to do.
  1194. if (targetList.empty()) {
  1195. return true;
  1196. }
  1197. for (std::string const& tgt : targetList) {
  1198. if (helper.Makefile->IsAlias(tgt)) {
  1199. status.SetError(cmStrCat("IMPORTED_RUNTIME_ARTIFACTS given target \"",
  1200. tgt, "\" which is an alias."));
  1201. return false;
  1202. }
  1203. // Lookup this target in the current directory.
  1204. cmTarget* target = helper.Makefile->FindTargetToUse(tgt);
  1205. if (!target || !target->IsImported()) {
  1206. // If no local target has been found, find it in the global scope.
  1207. cmTarget* const global_target =
  1208. helper.Makefile->GetGlobalGenerator()->FindTarget(tgt, true);
  1209. if (global_target && global_target->IsImported()) {
  1210. target = global_target;
  1211. }
  1212. }
  1213. if (target) {
  1214. // Found the target. Check its type.
  1215. if (target->GetType() != cmStateEnums::EXECUTABLE &&
  1216. target->GetType() != cmStateEnums::SHARED_LIBRARY &&
  1217. target->GetType() != cmStateEnums::MODULE_LIBRARY) {
  1218. status.SetError(
  1219. cmStrCat("IMPORTED_RUNTIME_ARTIFACTS given target \"", tgt,
  1220. "\" which is not an executable, library, or module."));
  1221. return false;
  1222. }
  1223. // Store the target in the list to be installed.
  1224. targets.push_back(target);
  1225. } else {
  1226. // Did not find the target.
  1227. status.SetError(cmStrCat("IMPORTED_RUNTIME_ARTIFACTS given target \"",
  1228. tgt, "\" which does not exist."));
  1229. return false;
  1230. }
  1231. }
  1232. // Keep track of whether we will be performing an installation of
  1233. // any files of the given type.
  1234. bool installsLibrary = false;
  1235. bool installsRuntime = false;
  1236. bool installsFramework = false;
  1237. bool installsBundle = false;
  1238. auto const createInstallGenerator =
  1239. [helper](cmTarget& target, const cmInstallCommandArguments& typeArgs,
  1240. const std::string& destination)
  1241. -> std::unique_ptr<cmInstallImportedRuntimeArtifactsGenerator> {
  1242. return cm::make_unique<cmInstallImportedRuntimeArtifactsGenerator>(
  1243. target.GetName(), destination, typeArgs.GetPermissions(),
  1244. typeArgs.GetConfigurations(), typeArgs.GetComponent(),
  1245. cmInstallGenerator::SelectMessageLevel(helper.Makefile),
  1246. typeArgs.GetExcludeFromAll(), typeArgs.GetOptional(),
  1247. helper.Makefile->GetBacktrace());
  1248. };
  1249. // Generate install script code to install the given targets.
  1250. for (cmTarget* ti : targets) {
  1251. // Handle each target type.
  1252. cmTarget& target = *ti;
  1253. std::unique_ptr<cmInstallImportedRuntimeArtifactsGenerator>
  1254. libraryGenerator;
  1255. std::unique_ptr<cmInstallImportedRuntimeArtifactsGenerator>
  1256. runtimeGenerator;
  1257. std::unique_ptr<cmInstallImportedRuntimeArtifactsGenerator>
  1258. frameworkGenerator;
  1259. std::unique_ptr<cmInstallImportedRuntimeArtifactsGenerator>
  1260. bundleGenerator;
  1261. switch (target.GetType()) {
  1262. case cmStateEnums::SHARED_LIBRARY:
  1263. if (target.IsDLLPlatform()) {
  1264. runtimeGenerator = createInstallGenerator(
  1265. target, runtimeArgs, helper.GetRuntimeDestination(&runtimeArgs));
  1266. if (runtimeDependencySet) {
  1267. runtimeDependencySet->AddLibrary(runtimeGenerator.get());
  1268. }
  1269. } else if (target.IsFrameworkOnApple()) {
  1270. if (frameworkArgs.GetDestination().empty()) {
  1271. status.SetError(cmStrCat("IMPORTED_RUNTIME_ARTIFACTS given no "
  1272. "FRAMEWORK DESTINATION for shared "
  1273. "library FRAMEWORK target \"",
  1274. target.GetName(), "\"."));
  1275. return false;
  1276. }
  1277. frameworkGenerator = createInstallGenerator(
  1278. target, frameworkArgs, frameworkArgs.GetDestination());
  1279. if (runtimeDependencySet) {
  1280. runtimeDependencySet->AddLibrary(frameworkGenerator.get());
  1281. }
  1282. } else {
  1283. libraryGenerator = createInstallGenerator(
  1284. target, libraryArgs, helper.GetLibraryDestination(&libraryArgs));
  1285. if (runtimeDependencySet) {
  1286. runtimeDependencySet->AddLibrary(libraryGenerator.get());
  1287. }
  1288. }
  1289. break;
  1290. case cmStateEnums::MODULE_LIBRARY:
  1291. libraryGenerator = createInstallGenerator(
  1292. target, libraryArgs, helper.GetLibraryDestination(&libraryArgs));
  1293. if (runtimeDependencySet) {
  1294. runtimeDependencySet->AddModule(libraryGenerator.get());
  1295. }
  1296. break;
  1297. case cmStateEnums::EXECUTABLE:
  1298. if (target.IsAppBundleOnApple()) {
  1299. if (bundleArgs.GetDestination().empty()) {
  1300. status.SetError(
  1301. cmStrCat("IMPORTED_RUNTIME_ARTIFACTS given no BUNDLE "
  1302. "DESTINATION for MACOSX_BUNDLE executable target \"",
  1303. target.GetName(), "\"."));
  1304. return false;
  1305. }
  1306. bundleGenerator = createInstallGenerator(
  1307. target, bundleArgs, bundleArgs.GetDestination());
  1308. if (runtimeDependencySet) {
  1309. if (!AddBundleExecutable(helper, runtimeDependencySet,
  1310. bundleGenerator.get())) {
  1311. return false;
  1312. }
  1313. }
  1314. } else {
  1315. runtimeGenerator = createInstallGenerator(
  1316. target, runtimeArgs, helper.GetRuntimeDestination(&runtimeArgs));
  1317. if (runtimeDependencySet) {
  1318. runtimeDependencySet->AddExecutable(runtimeGenerator.get());
  1319. }
  1320. }
  1321. break;
  1322. default:
  1323. assert(false && "This should never happen");
  1324. break;
  1325. }
  1326. // Keep track of whether we're installing anything in each category
  1327. installsLibrary = installsLibrary || libraryGenerator;
  1328. installsRuntime = installsRuntime || runtimeGenerator;
  1329. installsFramework = installsFramework || frameworkGenerator;
  1330. installsBundle = installsBundle || bundleGenerator;
  1331. helper.Makefile->AddInstallGenerator(std::move(libraryGenerator));
  1332. helper.Makefile->AddInstallGenerator(std::move(runtimeGenerator));
  1333. helper.Makefile->AddInstallGenerator(std::move(frameworkGenerator));
  1334. helper.Makefile->AddInstallGenerator(std::move(bundleGenerator));
  1335. }
  1336. // Tell the global generator about any installation component names
  1337. // specified
  1338. if (installsLibrary) {
  1339. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1340. libraryArgs.GetComponent());
  1341. }
  1342. if (installsRuntime) {
  1343. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1344. runtimeArgs.GetComponent());
  1345. }
  1346. if (installsFramework) {
  1347. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1348. frameworkArgs.GetComponent());
  1349. }
  1350. if (installsBundle) {
  1351. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1352. bundleArgs.GetComponent());
  1353. }
  1354. return true;
  1355. }
  1356. bool HandleFilesMode(std::vector<std::string> const& args,
  1357. cmExecutionStatus& status)
  1358. {
  1359. Helper helper(status);
  1360. // This is the FILES mode.
  1361. bool programs = (args[0] == "PROGRAMS");
  1362. cmInstallCommandArguments ica(helper.DefaultComponentName);
  1363. std::vector<std::string> files;
  1364. ica.Bind(programs ? "PROGRAMS"_s : "FILES"_s, files);
  1365. std::vector<std::string> unknownArgs;
  1366. ica.Parse(args, &unknownArgs);
  1367. if (!unknownArgs.empty()) {
  1368. // Unknown argument.
  1369. status.SetError(
  1370. cmStrCat(args[0], " given unknown argument \"", unknownArgs[0], "\"."));
  1371. return false;
  1372. }
  1373. std::string type = ica.GetType();
  1374. if (!type.empty() && allowedTypes.count(type) == 0) {
  1375. status.SetError(
  1376. cmStrCat(args[0], " given non-type \"", type, "\" with TYPE argument."));
  1377. return false;
  1378. }
  1379. const std::vector<std::string>& filesVector = files;
  1380. // Check if there is something to do.
  1381. if (filesVector.empty()) {
  1382. return true;
  1383. }
  1384. if (!ica.GetRename().empty() && filesVector.size() > 1) {
  1385. // The rename option works only with one file.
  1386. status.SetError(
  1387. cmStrCat(args[0], " given RENAME option with more than one file."));
  1388. return false;
  1389. }
  1390. std::vector<std::string> absFiles;
  1391. if (!helper.MakeFilesFullPath(args[0].c_str(), filesVector, absFiles)) {
  1392. return false;
  1393. }
  1394. cmPolicies::PolicyStatus policyStatus =
  1395. helper.Makefile->GetPolicyStatus(cmPolicies::CMP0062);
  1396. cmGlobalGenerator* gg = helper.Makefile->GetGlobalGenerator();
  1397. for (std::string const& file : filesVector) {
  1398. if (gg->IsExportedTargetsFile(file)) {
  1399. const char* modal = nullptr;
  1400. std::ostringstream e;
  1401. MessageType messageType = MessageType::AUTHOR_WARNING;
  1402. switch (policyStatus) {
  1403. case cmPolicies::WARN:
  1404. e << cmPolicies::GetPolicyWarning(cmPolicies::CMP0062) << "\n";
  1405. modal = "should";
  1406. CM_FALLTHROUGH;
  1407. case cmPolicies::OLD:
  1408. break;
  1409. case cmPolicies::REQUIRED_IF_USED:
  1410. case cmPolicies::REQUIRED_ALWAYS:
  1411. case cmPolicies::NEW:
  1412. modal = "may";
  1413. messageType = MessageType::FATAL_ERROR;
  1414. break;
  1415. }
  1416. if (modal) {
  1417. e << "The file\n " << file
  1418. << "\nwas generated by the export() "
  1419. "command. It "
  1420. << modal
  1421. << " not be installed with the "
  1422. "install() command. Use the install(EXPORT) mechanism "
  1423. "instead. See the cmake-packages(7) manual for more.\n";
  1424. helper.Makefile->IssueMessage(messageType, e.str());
  1425. if (messageType == MessageType::FATAL_ERROR) {
  1426. return false;
  1427. }
  1428. }
  1429. }
  1430. }
  1431. if (!ica.Finalize()) {
  1432. return false;
  1433. }
  1434. if (!type.empty() && !ica.GetDestination().empty()) {
  1435. status.SetError(cmStrCat(args[0],
  1436. " given both TYPE and DESTINATION arguments. "
  1437. "You may only specify one."));
  1438. return false;
  1439. }
  1440. std::string destination = helper.GetDestinationForType(&ica, type);
  1441. if (destination.empty()) {
  1442. // A destination is required.
  1443. status.SetError(cmStrCat(args[0], " given no DESTINATION!"));
  1444. return false;
  1445. }
  1446. // Create the files install generator.
  1447. helper.Makefile->AddInstallGenerator(CreateInstallFilesGenerator(
  1448. helper.Makefile, absFiles, ica, programs, destination));
  1449. // Tell the global generator about any installation component names
  1450. // specified.
  1451. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1452. ica.GetComponent());
  1453. return true;
  1454. }
  1455. bool HandleDirectoryMode(std::vector<std::string> const& args,
  1456. cmExecutionStatus& status)
  1457. {
  1458. Helper helper(status);
  1459. enum Doing
  1460. {
  1461. DoingNone,
  1462. DoingDirs,
  1463. DoingDestination,
  1464. DoingPattern,
  1465. DoingRegex,
  1466. DoingPermsFile,
  1467. DoingPermsDir,
  1468. DoingPermsMatch,
  1469. DoingConfigurations,
  1470. DoingComponent,
  1471. DoingType
  1472. };
  1473. Doing doing = DoingDirs;
  1474. bool in_match_mode = false;
  1475. bool optional = false;
  1476. bool exclude_from_all = false;
  1477. bool message_never = false;
  1478. std::vector<std::string> dirs;
  1479. const std::string* destination = nullptr;
  1480. std::string permissions_file;
  1481. std::string permissions_dir;
  1482. std::vector<std::string> configurations;
  1483. std::string component = helper.DefaultComponentName;
  1484. std::string literal_args;
  1485. std::string type;
  1486. for (unsigned int i = 1; i < args.size(); ++i) {
  1487. if (args[i] == "DESTINATION") {
  1488. if (in_match_mode) {
  1489. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1490. "\" after PATTERN or REGEX."));
  1491. return false;
  1492. }
  1493. // Switch to setting the destination property.
  1494. doing = DoingDestination;
  1495. } else if (args[i] == "TYPE") {
  1496. if (in_match_mode) {
  1497. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1498. "\" after PATTERN or REGEX."));
  1499. return false;
  1500. }
  1501. // Switch to setting the type.
  1502. doing = DoingType;
  1503. } else if (args[i] == "OPTIONAL") {
  1504. if (in_match_mode) {
  1505. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1506. "\" after PATTERN or REGEX."));
  1507. return false;
  1508. }
  1509. // Mark the rule as optional.
  1510. optional = true;
  1511. doing = DoingNone;
  1512. } else if (args[i] == "MESSAGE_NEVER") {
  1513. if (in_match_mode) {
  1514. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1515. "\" after PATTERN or REGEX."));
  1516. return false;
  1517. }
  1518. // Mark the rule as quiet.
  1519. message_never = true;
  1520. doing = DoingNone;
  1521. } else if (args[i] == "PATTERN") {
  1522. // Switch to a new pattern match rule.
  1523. doing = DoingPattern;
  1524. in_match_mode = true;
  1525. } else if (args[i] == "REGEX") {
  1526. // Switch to a new regex match rule.
  1527. doing = DoingRegex;
  1528. in_match_mode = true;
  1529. } else if (args[i] == "EXCLUDE") {
  1530. // Add this property to the current match rule.
  1531. if (!in_match_mode || doing == DoingPattern || doing == DoingRegex) {
  1532. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1533. "\" before a PATTERN or REGEX is given."));
  1534. return false;
  1535. }
  1536. literal_args += " EXCLUDE";
  1537. doing = DoingNone;
  1538. } else if (args[i] == "PERMISSIONS") {
  1539. if (!in_match_mode) {
  1540. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1541. "\" before a PATTERN or REGEX is given."));
  1542. return false;
  1543. }
  1544. // Switch to setting the current match permissions property.
  1545. literal_args += " PERMISSIONS";
  1546. doing = DoingPermsMatch;
  1547. } else if (args[i] == "FILE_PERMISSIONS") {
  1548. if (in_match_mode) {
  1549. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1550. "\" after PATTERN or REGEX."));
  1551. return false;
  1552. }
  1553. // Switch to setting the file permissions property.
  1554. doing = DoingPermsFile;
  1555. } else if (args[i] == "DIRECTORY_PERMISSIONS") {
  1556. if (in_match_mode) {
  1557. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1558. "\" after PATTERN or REGEX."));
  1559. return false;
  1560. }
  1561. // Switch to setting the directory permissions property.
  1562. doing = DoingPermsDir;
  1563. } else if (args[i] == "USE_SOURCE_PERMISSIONS") {
  1564. if (in_match_mode) {
  1565. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1566. "\" after PATTERN or REGEX."));
  1567. return false;
  1568. }
  1569. // Add this option literally.
  1570. literal_args += " USE_SOURCE_PERMISSIONS";
  1571. doing = DoingNone;
  1572. } else if (args[i] == "FILES_MATCHING") {
  1573. if (in_match_mode) {
  1574. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1575. "\" after PATTERN or REGEX."));
  1576. return false;
  1577. }
  1578. // Add this option literally.
  1579. literal_args += " FILES_MATCHING";
  1580. doing = DoingNone;
  1581. } else if (args[i] == "CONFIGURATIONS") {
  1582. if (in_match_mode) {
  1583. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1584. "\" after PATTERN or REGEX."));
  1585. return false;
  1586. }
  1587. // Switch to setting the configurations property.
  1588. doing = DoingConfigurations;
  1589. } else if (args[i] == "COMPONENT") {
  1590. if (in_match_mode) {
  1591. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1592. "\" after PATTERN or REGEX."));
  1593. return false;
  1594. }
  1595. // Switch to setting the component property.
  1596. doing = DoingComponent;
  1597. } else if (args[i] == "EXCLUDE_FROM_ALL") {
  1598. if (in_match_mode) {
  1599. status.SetError(cmStrCat(args[0], " does not allow \"", args[i],
  1600. "\" after PATTERN or REGEX."));
  1601. return false;
  1602. }
  1603. exclude_from_all = true;
  1604. doing = DoingNone;
  1605. } else if (doing == DoingDirs) {
  1606. // Convert this directory to a full path.
  1607. std::string dir = args[i];
  1608. std::string::size_type gpos = cmGeneratorExpression::Find(dir);
  1609. if (gpos != 0 && !cmSystemTools::FileIsFullPath(dir)) {
  1610. dir =
  1611. cmStrCat(helper.Makefile->GetCurrentSourceDirectory(), '/', args[i]);
  1612. }
  1613. // Make sure the name is a directory.
  1614. if (cmSystemTools::FileExists(dir) &&
  1615. !cmSystemTools::FileIsDirectory(dir)) {
  1616. status.SetError(cmStrCat(args[0], " given non-directory \"", args[i],
  1617. "\" to install."));
  1618. return false;
  1619. }
  1620. // Store the directory for installation.
  1621. dirs.push_back(std::move(dir));
  1622. } else if (doing == DoingConfigurations) {
  1623. configurations.push_back(args[i]);
  1624. } else if (doing == DoingDestination) {
  1625. destination = &args[i];
  1626. doing = DoingNone;
  1627. } else if (doing == DoingType) {
  1628. if (allowedTypes.count(args[i]) == 0) {
  1629. status.SetError(cmStrCat(args[0], " given non-type \"", args[i],
  1630. "\" with TYPE argument."));
  1631. return false;
  1632. }
  1633. type = args[i];
  1634. doing = DoingNone;
  1635. } else if (doing == DoingPattern) {
  1636. // Convert the pattern to a regular expression. Require a
  1637. // leading slash and trailing end-of-string in the matched
  1638. // string to make sure the pattern matches only whole file
  1639. // names.
  1640. literal_args += " REGEX \"/";
  1641. std::string regex = cmsys::Glob::PatternToRegex(args[i], false);
  1642. cmSystemTools::ReplaceString(regex, "\\", "\\\\");
  1643. literal_args += regex;
  1644. literal_args += "$\"";
  1645. doing = DoingNone;
  1646. } else if (doing == DoingRegex) {
  1647. literal_args += " REGEX \"";
  1648. // Match rules are case-insensitive on some platforms.
  1649. #if defined(_WIN32) || defined(__APPLE__)
  1650. std::string regex = cmSystemTools::LowerCase(args[i]);
  1651. #else
  1652. std::string regex = args[i];
  1653. #endif
  1654. cmSystemTools::ReplaceString(regex, "\\", "\\\\");
  1655. literal_args += regex;
  1656. literal_args += "\"";
  1657. doing = DoingNone;
  1658. } else if (doing == DoingComponent) {
  1659. component = args[i];
  1660. doing = DoingNone;
  1661. } else if (doing == DoingPermsFile) {
  1662. // Check the requested permission.
  1663. if (!cmInstallCommandArguments::CheckPermissions(args[i],
  1664. permissions_file)) {
  1665. status.SetError(cmStrCat(args[0], " given invalid file permission \"",
  1666. args[i], "\"."));
  1667. return false;
  1668. }
  1669. } else if (doing == DoingPermsDir) {
  1670. // Check the requested permission.
  1671. if (!cmInstallCommandArguments::CheckPermissions(args[i],
  1672. permissions_dir)) {
  1673. status.SetError(cmStrCat(
  1674. args[0], " given invalid directory permission \"", args[i], "\"."));
  1675. return false;
  1676. }
  1677. } else if (doing == DoingPermsMatch) {
  1678. // Check the requested permission.
  1679. if (!cmInstallCommandArguments::CheckPermissions(args[i],
  1680. literal_args)) {
  1681. status.SetError(
  1682. cmStrCat(args[0], " given invalid permission \"", args[i], "\"."));
  1683. return false;
  1684. }
  1685. } else {
  1686. // Unknown argument.
  1687. status.SetError(
  1688. cmStrCat(args[0], " given unknown argument \"", args[i], "\"."));
  1689. return false;
  1690. }
  1691. }
  1692. // Support installing an empty directory.
  1693. if (dirs.empty() && destination) {
  1694. dirs.emplace_back();
  1695. }
  1696. // Check if there is something to do.
  1697. if (dirs.empty()) {
  1698. return true;
  1699. }
  1700. std::string destinationStr;
  1701. if (!destination) {
  1702. if (type.empty()) {
  1703. // A destination is required.
  1704. status.SetError(cmStrCat(args[0], " given no DESTINATION!"));
  1705. return false;
  1706. }
  1707. destinationStr = helper.GetDestinationForType(nullptr, type);
  1708. destination = &destinationStr;
  1709. } else if (!type.empty()) {
  1710. status.SetError(cmStrCat(args[0],
  1711. " given both TYPE and DESTINATION "
  1712. "arguments. You may only specify one."));
  1713. return false;
  1714. }
  1715. cmInstallGenerator::MessageLevel message =
  1716. cmInstallGenerator::SelectMessageLevel(helper.Makefile, message_never);
  1717. // Create the directory install generator.
  1718. helper.Makefile->AddInstallGenerator(
  1719. cm::make_unique<cmInstallDirectoryGenerator>(
  1720. dirs, *destination, permissions_file, permissions_dir, configurations,
  1721. component, message, exclude_from_all, literal_args, optional,
  1722. helper.Makefile->GetBacktrace()));
  1723. // Tell the global generator about any installation component names
  1724. // specified.
  1725. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(component);
  1726. return true;
  1727. }
  1728. bool HandleExportAndroidMKMode(std::vector<std::string> const& args,
  1729. cmExecutionStatus& status)
  1730. {
  1731. #ifndef CMAKE_BOOTSTRAP
  1732. Helper helper(status);
  1733. // This is the EXPORT mode.
  1734. cmInstallCommandArguments ica(helper.DefaultComponentName);
  1735. std::string exp;
  1736. std::string name_space;
  1737. bool exportOld = false;
  1738. std::string filename;
  1739. ica.Bind("EXPORT_ANDROID_MK"_s, exp);
  1740. ica.Bind("NAMESPACE"_s, name_space);
  1741. ica.Bind("EXPORT_LINK_INTERFACE_LIBRARIES"_s, exportOld);
  1742. ica.Bind("FILE"_s, filename);
  1743. std::vector<std::string> unknownArgs;
  1744. ica.Parse(args, &unknownArgs);
  1745. if (!unknownArgs.empty()) {
  1746. // Unknown argument.
  1747. status.SetError(
  1748. cmStrCat(args[0], " given unknown argument \"", unknownArgs[0], "\"."));
  1749. return false;
  1750. }
  1751. if (!ica.Finalize()) {
  1752. return false;
  1753. }
  1754. // Make sure there is a destination.
  1755. if (ica.GetDestination().empty()) {
  1756. // A destination is required.
  1757. status.SetError(cmStrCat(args[0], " given no DESTINATION!"));
  1758. return false;
  1759. }
  1760. // Check the file name.
  1761. std::string fname = filename;
  1762. if (fname.find_first_of(":/\\") != std::string::npos) {
  1763. status.SetError(cmStrCat(args[0], " given invalid export file name \"",
  1764. fname,
  1765. "\". The FILE argument may not contain a path. "
  1766. "Specify the path in the DESTINATION argument."));
  1767. return false;
  1768. }
  1769. // Check the file extension.
  1770. if (!fname.empty() &&
  1771. cmSystemTools::GetFilenameLastExtension(fname) != ".mk") {
  1772. status.SetError(cmStrCat(
  1773. args[0], " given invalid export file name \"", fname,
  1774. R"(". The FILE argument must specify a name ending in ".mk".)"));
  1775. return false;
  1776. }
  1777. if (fname.find_first_of(":/\\") != std::string::npos) {
  1778. status.SetError(
  1779. cmStrCat(args[0], " given export name \"", exp,
  1780. "\". "
  1781. "This name cannot be safely converted to a file name. "
  1782. "Specify a different export name or use the FILE option to set "
  1783. "a file name explicitly."));
  1784. return false;
  1785. }
  1786. // Use the default name
  1787. if (fname.empty()) {
  1788. fname = "Android.mk";
  1789. }
  1790. cmExportSet& exportSet =
  1791. helper.Makefile->GetGlobalGenerator()->GetExportSets()[exp];
  1792. cmInstallGenerator::MessageLevel message =
  1793. cmInstallGenerator::SelectMessageLevel(helper.Makefile);
  1794. // Create the export install generator.
  1795. helper.Makefile->AddInstallGenerator(
  1796. cm::make_unique<cmInstallExportGenerator>(
  1797. &exportSet, ica.GetDestination(), ica.GetPermissions(),
  1798. ica.GetConfigurations(), ica.GetComponent(), message,
  1799. ica.GetExcludeFromAll(), fname, name_space, exportOld, true,
  1800. helper.Makefile->GetBacktrace()));
  1801. return true;
  1802. #else
  1803. static_cast<void>(args);
  1804. status.SetError("EXPORT_ANDROID_MK not supported in bootstrap cmake");
  1805. return false;
  1806. #endif
  1807. }
  1808. bool HandleExportMode(std::vector<std::string> const& args,
  1809. cmExecutionStatus& status)
  1810. {
  1811. Helper helper(status);
  1812. // This is the EXPORT mode.
  1813. cmInstallCommandArguments ica(helper.DefaultComponentName);
  1814. std::string exp;
  1815. std::string name_space;
  1816. bool exportOld = false;
  1817. std::string filename;
  1818. ica.Bind("EXPORT"_s, exp);
  1819. ica.Bind("NAMESPACE"_s, name_space);
  1820. ica.Bind("EXPORT_LINK_INTERFACE_LIBRARIES"_s, exportOld);
  1821. ica.Bind("FILE"_s, filename);
  1822. std::vector<std::string> unknownArgs;
  1823. ica.Parse(args, &unknownArgs);
  1824. if (!unknownArgs.empty()) {
  1825. // Unknown argument.
  1826. status.SetError(
  1827. cmStrCat(args[0], " given unknown argument \"", unknownArgs[0], "\"."));
  1828. return false;
  1829. }
  1830. if (!ica.Finalize()) {
  1831. return false;
  1832. }
  1833. // Make sure there is a destination.
  1834. if (ica.GetDestination().empty()) {
  1835. // A destination is required.
  1836. status.SetError(cmStrCat(args[0], " given no DESTINATION!"));
  1837. return false;
  1838. }
  1839. // Check the file name.
  1840. std::string fname = filename;
  1841. if (fname.find_first_of(":/\\") != std::string::npos) {
  1842. status.SetError(cmStrCat(args[0], " given invalid export file name \"",
  1843. fname,
  1844. "\". "
  1845. "The FILE argument may not contain a path. "
  1846. "Specify the path in the DESTINATION argument."));
  1847. return false;
  1848. }
  1849. // Check the file extension.
  1850. if (!fname.empty() &&
  1851. cmSystemTools::GetFilenameLastExtension(fname) != ".cmake") {
  1852. status.SetError(
  1853. cmStrCat(args[0], " given invalid export file name \"", fname,
  1854. "\". "
  1855. "The FILE argument must specify a name ending in \".cmake\"."));
  1856. return false;
  1857. }
  1858. // Construct the file name.
  1859. if (fname.empty()) {
  1860. fname = cmStrCat(exp, ".cmake");
  1861. if (fname.find_first_of(":/\\") != std::string::npos) {
  1862. status.SetError(cmStrCat(
  1863. args[0], " given export name \"", exp,
  1864. "\". "
  1865. "This name cannot be safely converted to a file name. "
  1866. "Specify a different export name or use the FILE option to set "
  1867. "a file name explicitly."));
  1868. return false;
  1869. }
  1870. }
  1871. cmExportSet& exportSet =
  1872. helper.Makefile->GetGlobalGenerator()->GetExportSets()[exp];
  1873. if (exportOld) {
  1874. for (auto const& te : exportSet.GetTargetExports()) {
  1875. cmTarget* tgt =
  1876. helper.Makefile->GetGlobalGenerator()->FindTarget(te->TargetName);
  1877. const bool newCMP0022Behavior =
  1878. (tgt && tgt->GetPolicyStatusCMP0022() != cmPolicies::WARN &&
  1879. tgt->GetPolicyStatusCMP0022() != cmPolicies::OLD);
  1880. if (!newCMP0022Behavior) {
  1881. status.SetError(cmStrCat(
  1882. "INSTALL(EXPORT) given keyword \""
  1883. "EXPORT_LINK_INTERFACE_LIBRARIES\", but target \"",
  1884. te->TargetName, "\" does not have policy CMP0022 set to NEW."));
  1885. return false;
  1886. }
  1887. }
  1888. }
  1889. cmInstallGenerator::MessageLevel message =
  1890. cmInstallGenerator::SelectMessageLevel(helper.Makefile);
  1891. // Create the export install generator.
  1892. helper.Makefile->AddInstallGenerator(
  1893. cm::make_unique<cmInstallExportGenerator>(
  1894. &exportSet, ica.GetDestination(), ica.GetPermissions(),
  1895. ica.GetConfigurations(), ica.GetComponent(), message,
  1896. ica.GetExcludeFromAll(), fname, name_space, exportOld, false,
  1897. helper.Makefile->GetBacktrace()));
  1898. return true;
  1899. }
  1900. bool HandleRuntimeDependencySetMode(std::vector<std::string> const& args,
  1901. cmExecutionStatus& status)
  1902. {
  1903. Helper helper(status);
  1904. auto system = helper.Makefile->GetSafeDefinition("CMAKE_HOST_SYSTEM_NAME");
  1905. if (!cmRuntimeDependencyArchive::PlatformSupportsRuntimeDependencies(
  1906. system)) {
  1907. status.SetError(cmStrCat(
  1908. "RUNTIME_DEPENDENCY_SET is not supported on system \"", system, '"'));
  1909. return false;
  1910. }
  1911. // This is the RUNTIME_DEPENDENCY_SET mode.
  1912. cmInstallRuntimeDependencySet* runtimeDependencySet;
  1913. struct ArgVectors
  1914. {
  1915. std::vector<std::string> Library;
  1916. std::vector<std::string> Runtime;
  1917. std::vector<std::string> Framework;
  1918. };
  1919. static auto const argHelper = cmArgumentParser<ArgVectors>{}
  1920. .Bind("LIBRARY"_s, &ArgVectors::Library)
  1921. .Bind("RUNTIME"_s, &ArgVectors::Runtime)
  1922. .Bind("FRAMEWORK"_s, &ArgVectors::Framework);
  1923. std::vector<std::string> genericArgVector;
  1924. ArgVectors const argVectors = argHelper.Parse(args, &genericArgVector);
  1925. // now parse the generic args (i.e. the ones not specialized on LIBRARY,
  1926. // RUNTIME, FRAMEWORK etc. (see above)
  1927. // These generic args also contain the runtime dependency set
  1928. std::string runtimeDependencySetArg;
  1929. std::vector<std::string> runtimeDependencyArgVector;
  1930. std::vector<std::string> parsedArgs;
  1931. cmInstallCommandArguments genericArgs(helper.DefaultComponentName);
  1932. genericArgs.Bind("RUNTIME_DEPENDENCY_SET"_s, runtimeDependencySetArg);
  1933. genericArgs.Parse(genericArgVector, &runtimeDependencyArgVector, nullptr,
  1934. &parsedArgs);
  1935. bool success = genericArgs.Finalize();
  1936. cmInstallCommandArguments libraryArgs(helper.DefaultComponentName);
  1937. cmInstallCommandArguments runtimeArgs(helper.DefaultComponentName);
  1938. cmInstallCommandArguments frameworkArgs(helper.DefaultComponentName);
  1939. // Now also parse the file(GET_RUNTIME_DEPENDENCY) args
  1940. std::vector<std::string> unknownArgs;
  1941. auto runtimeDependencyArgs = RuntimeDependenciesArgHelper.Parse(
  1942. runtimeDependencyArgVector, &unknownArgs);
  1943. // now parse the args for specific parts of the target (e.g. LIBRARY,
  1944. // RUNTIME, FRAMEWORK etc.
  1945. libraryArgs.Parse(argVectors.Library, &unknownArgs);
  1946. runtimeArgs.Parse(argVectors.Runtime, &unknownArgs);
  1947. frameworkArgs.Parse(argVectors.Framework, &unknownArgs);
  1948. libraryArgs.SetGenericArguments(&genericArgs);
  1949. runtimeArgs.SetGenericArguments(&genericArgs);
  1950. frameworkArgs.SetGenericArguments(&genericArgs);
  1951. success = success && libraryArgs.Finalize();
  1952. success = success && runtimeArgs.Finalize();
  1953. success = success && frameworkArgs.Finalize();
  1954. if (!success) {
  1955. return false;
  1956. }
  1957. if (!unknownArgs.empty()) {
  1958. helper.SetError(
  1959. cmStrCat("RUNTIME_DEPENDENCY_SET given unknown argument \"",
  1960. unknownArgs.front(), "\"."));
  1961. return false;
  1962. }
  1963. if (runtimeDependencySetArg.empty()) {
  1964. helper.SetError(
  1965. "RUNTIME_DEPENDENCY_SET not given a runtime dependency set.");
  1966. return false;
  1967. }
  1968. runtimeDependencySet =
  1969. helper.Makefile->GetGlobalGenerator()->GetNamedRuntimeDependencySet(
  1970. runtimeDependencySetArg);
  1971. bool installsRuntime = false;
  1972. bool installsLibrary = false;
  1973. bool installsFramework = false;
  1974. AddInstallRuntimeDependenciesGenerator(
  1975. helper, runtimeDependencySet, runtimeArgs, libraryArgs, frameworkArgs,
  1976. std::move(runtimeDependencyArgs), installsRuntime, installsLibrary,
  1977. installsFramework);
  1978. // Tell the global generator about any installation component names
  1979. // specified
  1980. if (installsLibrary) {
  1981. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1982. libraryArgs.GetComponent());
  1983. }
  1984. if (installsRuntime) {
  1985. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1986. runtimeArgs.GetComponent());
  1987. }
  1988. if (installsFramework) {
  1989. helper.Makefile->GetGlobalGenerator()->AddInstallComponent(
  1990. frameworkArgs.GetComponent());
  1991. }
  1992. return true;
  1993. }
  1994. bool Helper::MakeFilesFullPath(const char* modeName,
  1995. const std::vector<std::string>& relFiles,
  1996. std::vector<std::string>& absFiles)
  1997. {
  1998. return this->MakeFilesFullPath(
  1999. modeName, this->Makefile->GetCurrentSourceDirectory(), relFiles, absFiles);
  2000. }
  2001. bool Helper::MakeFilesFullPath(const char* modeName,
  2002. const std::string& basePath,
  2003. const std::vector<std::string>& relFiles,
  2004. std::vector<std::string>& absFiles)
  2005. {
  2006. for (std::string const& relFile : relFiles) {
  2007. std::string file = relFile;
  2008. std::string::size_type gpos = cmGeneratorExpression::Find(file);
  2009. if (gpos != 0 && !cmSystemTools::FileIsFullPath(file)) {
  2010. file = cmStrCat(basePath, '/', relFile);
  2011. }
  2012. // Make sure the file is not a directory.
  2013. if (gpos == std::string::npos && !cmSystemTools::FileIsSymlink(file) &&
  2014. cmSystemTools::FileIsDirectory(file)) {
  2015. this->SetError(
  2016. cmStrCat(modeName, " given directory \"", relFile, "\" to install."));
  2017. return false;
  2018. }
  2019. // Store the file for installation.
  2020. absFiles.push_back(std::move(file));
  2021. }
  2022. return true;
  2023. }
  2024. bool Helper::CheckCMP0006(bool& failure) const
  2025. {
  2026. switch (this->Makefile->GetPolicyStatus(cmPolicies::CMP0006)) {
  2027. case cmPolicies::WARN:
  2028. this->Makefile->IssueMessage(
  2029. MessageType::AUTHOR_WARNING,
  2030. cmPolicies::GetPolicyWarning(cmPolicies::CMP0006));
  2031. CM_FALLTHROUGH;
  2032. case cmPolicies::OLD:
  2033. // OLD behavior is to allow compatibility
  2034. return true;
  2035. case cmPolicies::NEW:
  2036. // NEW behavior is to disallow compatibility
  2037. break;
  2038. case cmPolicies::REQUIRED_IF_USED:
  2039. case cmPolicies::REQUIRED_ALWAYS:
  2040. failure = true;
  2041. this->Makefile->IssueMessage(
  2042. MessageType::FATAL_ERROR,
  2043. cmPolicies::GetRequiredPolicyError(cmPolicies::CMP0006));
  2044. break;
  2045. }
  2046. return false;
  2047. }
  2048. std::string Helper::GetDestination(const cmInstallCommandArguments* args,
  2049. const std::string& varName,
  2050. const std::string& guess) const
  2051. {
  2052. if (args && !args->GetDestination().empty()) {
  2053. return args->GetDestination();
  2054. }
  2055. std::string val = this->Makefile->GetSafeDefinition(varName);
  2056. if (!val.empty()) {
  2057. return val;
  2058. }
  2059. return guess;
  2060. }
  2061. std::string Helper::GetRuntimeDestination(
  2062. const cmInstallCommandArguments* args) const
  2063. {
  2064. return this->GetDestination(args, "CMAKE_INSTALL_BINDIR", "bin");
  2065. }
  2066. std::string Helper::GetSbinDestination(
  2067. const cmInstallCommandArguments* args) const
  2068. {
  2069. return this->GetDestination(args, "CMAKE_INSTALL_SBINDIR", "sbin");
  2070. }
  2071. std::string Helper::GetArchiveDestination(
  2072. const cmInstallCommandArguments* args) const
  2073. {
  2074. return this->GetDestination(args, "CMAKE_INSTALL_LIBDIR", "lib");
  2075. }
  2076. std::string Helper::GetLibraryDestination(
  2077. const cmInstallCommandArguments* args) const
  2078. {
  2079. return this->GetDestination(args, "CMAKE_INSTALL_LIBDIR", "lib");
  2080. }
  2081. std::string Helper::GetIncludeDestination(
  2082. const cmInstallCommandArguments* args) const
  2083. {
  2084. return this->GetDestination(args, "CMAKE_INSTALL_INCLUDEDIR", "include");
  2085. }
  2086. std::string Helper::GetSysconfDestination(
  2087. const cmInstallCommandArguments* args) const
  2088. {
  2089. return this->GetDestination(args, "CMAKE_INSTALL_SYSCONFDIR", "etc");
  2090. }
  2091. std::string Helper::GetSharedStateDestination(
  2092. const cmInstallCommandArguments* args) const
  2093. {
  2094. return this->GetDestination(args, "CMAKE_INSTALL_SHAREDSTATEDIR", "com");
  2095. }
  2096. std::string Helper::GetLocalStateDestination(
  2097. const cmInstallCommandArguments* args) const
  2098. {
  2099. return this->GetDestination(args, "CMAKE_INSTALL_LOCALSTATEDIR", "var");
  2100. }
  2101. std::string Helper::GetRunStateDestination(
  2102. const cmInstallCommandArguments* args) const
  2103. {
  2104. return this->GetDestination(args, "CMAKE_INSTALL_RUNSTATEDIR",
  2105. this->GetLocalStateDestination(nullptr) +
  2106. "/run");
  2107. }
  2108. std::string Helper::GetDataRootDestination(
  2109. const cmInstallCommandArguments* args) const
  2110. {
  2111. return this->GetDestination(args, "CMAKE_INSTALL_DATAROOTDIR", "share");
  2112. }
  2113. std::string Helper::GetDataDestination(
  2114. const cmInstallCommandArguments* args) const
  2115. {
  2116. return this->GetDestination(args, "CMAKE_INSTALL_DATADIR",
  2117. this->GetDataRootDestination(nullptr));
  2118. }
  2119. std::string Helper::GetInfoDestination(
  2120. const cmInstallCommandArguments* args) const
  2121. {
  2122. return this->GetDestination(args, "CMAKE_INSTALL_INFODIR",
  2123. this->GetDataRootDestination(nullptr) + "/info");
  2124. }
  2125. std::string Helper::GetLocaleDestination(
  2126. const cmInstallCommandArguments* args) const
  2127. {
  2128. return this->GetDestination(args, "CMAKE_INSTALL_LOCALEDIR",
  2129. this->GetDataRootDestination(nullptr) +
  2130. "/locale");
  2131. }
  2132. std::string Helper::GetManDestination(
  2133. const cmInstallCommandArguments* args) const
  2134. {
  2135. return this->GetDestination(args, "CMAKE_INSTALL_MANDIR",
  2136. this->GetDataRootDestination(nullptr) + "/man");
  2137. }
  2138. std::string Helper::GetDocDestination(
  2139. const cmInstallCommandArguments* args) const
  2140. {
  2141. return this->GetDestination(args, "CMAKE_INSTALL_DOCDIR",
  2142. this->GetDataRootDestination(nullptr) + "/doc");
  2143. }
  2144. std::string Helper::GetDestinationForType(
  2145. const cmInstallCommandArguments* args, const std::string& type) const
  2146. {
  2147. if (args && !args->GetDestination().empty()) {
  2148. return args->GetDestination();
  2149. }
  2150. if (type == "BIN") {
  2151. return this->GetRuntimeDestination(nullptr);
  2152. }
  2153. if (type == "SBIN") {
  2154. return this->GetSbinDestination(nullptr);
  2155. }
  2156. if (type == "SYSCONF") {
  2157. return this->GetSysconfDestination(nullptr);
  2158. }
  2159. if (type == "SHAREDSTATE") {
  2160. return this->GetSharedStateDestination(nullptr);
  2161. }
  2162. if (type == "LOCALSTATE") {
  2163. return this->GetLocalStateDestination(nullptr);
  2164. }
  2165. if (type == "RUNSTATE") {
  2166. return this->GetRunStateDestination(nullptr);
  2167. }
  2168. if (type == "LIB") {
  2169. return this->GetLibraryDestination(nullptr);
  2170. }
  2171. if (type == "INCLUDE") {
  2172. return this->GetIncludeDestination(nullptr);
  2173. }
  2174. if (type == "DATA") {
  2175. return this->GetDataDestination(nullptr);
  2176. }
  2177. if (type == "INFO") {
  2178. return this->GetInfoDestination(nullptr);
  2179. }
  2180. if (type == "LOCALE") {
  2181. return this->GetLocaleDestination(nullptr);
  2182. }
  2183. if (type == "MAN") {
  2184. return this->GetManDestination(nullptr);
  2185. }
  2186. if (type == "DOC") {
  2187. return this->GetDocDestination(nullptr);
  2188. }
  2189. return "";
  2190. }
  2191. } // namespace
  2192. bool cmInstallCommand(std::vector<std::string> const& args,
  2193. cmExecutionStatus& status)
  2194. {
  2195. // Allow calling with no arguments so that arguments may be built up
  2196. // using a variable that may be left empty.
  2197. if (args.empty()) {
  2198. return true;
  2199. }
  2200. // Enable the install target.
  2201. status.GetMakefile().GetGlobalGenerator()->EnableInstallTarget();
  2202. static cmSubcommandTable const subcommand{
  2203. { "SCRIPT"_s, HandleScriptMode },
  2204. { "CODE"_s, HandleScriptMode },
  2205. { "TARGETS"_s, HandleTargetsMode },
  2206. { "IMPORTED_RUNTIME_ARTIFACTS"_s, HandleImportedRuntimeArtifactsMode },
  2207. { "FILES"_s, HandleFilesMode },
  2208. { "PROGRAMS"_s, HandleFilesMode },
  2209. { "DIRECTORY"_s, HandleDirectoryMode },
  2210. { "EXPORT"_s, HandleExportMode },
  2211. { "EXPORT_ANDROID_MK"_s, HandleExportAndroidMKMode },
  2212. { "RUNTIME_DEPENDENCY_SET"_s, HandleRuntimeDependencySetMode },
  2213. };
  2214. return subcommand(args[0], args, status);
  2215. }