cmInstallCommand.cxx 94 KB

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