cmInstallCommand.cxx 90 KB

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