cmInstallCommand.cxx 102 KB

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