cmInstallCommand.cxx 95 KB

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