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