cmInstallCommand.cxx 100 KB

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