cmInstallCommand.cxx 99 KB

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