cmGlobalNinjaGenerator.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758
  1. /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. file Copyright.txt or https://cmake.org/licensing for details. */
  3. #pragma once
  4. #include "cmConfigure.h" // IWYU pragma: keep
  5. #include <iosfwd>
  6. #include <map>
  7. #include <memory>
  8. #include <set>
  9. #include <string>
  10. #include <unordered_map>
  11. #include <unordered_set>
  12. #include <utility>
  13. #include <vector>
  14. #include <cm/optional>
  15. #include "cm_codecvt_Encoding.hxx"
  16. #include "cmBuildOptions.h"
  17. #include "cmGeneratedFileStream.h"
  18. #include "cmGlobalCommonGenerator.h"
  19. #include "cmGlobalGeneratorFactory.h"
  20. #include "cmNinjaTypes.h"
  21. #include "cmPolicies.h"
  22. #include "cmStringAlgorithms.h"
  23. #include "cmTransformDepfile.h"
  24. class cmCustomCommand;
  25. class cmGeneratorTarget;
  26. class cmLinkLineComputer;
  27. class cmLocalGenerator;
  28. class cmMakefile;
  29. class cmOutputConverter;
  30. class cmStateDirectory;
  31. class cmake;
  32. struct cmCxxModuleExportInfo;
  33. /**
  34. * \class cmGlobalNinjaGenerator
  35. * \brief Write a build.ninja file.
  36. *
  37. * The main differences between this generator and the UnixMakefile
  38. * generator family are:
  39. * - We don't care about VERBOSE variable or RULE_MESSAGES property since
  40. * it is handle by Ninja's -v option.
  41. * - We don't care about computing any progress status since Ninja manages
  42. * it itself.
  43. * - We generate one build.ninja and one rules.ninja per project.
  44. * - We try to minimize the number of generated rules: one per target and
  45. * language.
  46. * - We use Ninja special variable $in and $out to produce nice output.
  47. * - We extensively use Ninja variable overloading system to minimize the
  48. * number of generated rules.
  49. */
  50. class cmGlobalNinjaGenerator : public cmGlobalCommonGenerator
  51. {
  52. public:
  53. /// The default name of Ninja's build file. Typically: build.ninja.
  54. static const char* NINJA_BUILD_FILE;
  55. /// The default name of Ninja's rules file. Typically: rules.ninja.
  56. /// It is included in the main build.ninja file.
  57. static const char* NINJA_RULES_FILE;
  58. /// The indentation string used when generating Ninja's build file.
  59. static const char* INDENT;
  60. /// The shell command used for a no-op.
  61. static std::string const SHELL_NOOP;
  62. /// Write @a count times INDENT level to output stream @a os.
  63. static void Indent(std::ostream& os, int count);
  64. /// Write a divider in the given output stream @a os.
  65. static void WriteDivider(std::ostream& os);
  66. static std::string EncodeRuleName(std::string const& name);
  67. std::string& EncodeLiteral(std::string& lit) override;
  68. std::string GetEncodedLiteral(const std::string& lit);
  69. std::string EncodePath(const std::string& path);
  70. std::unique_ptr<cmLinkLineComputer> CreateLinkLineComputer(
  71. cmOutputConverter* outputConverter,
  72. cmStateDirectory const& stateDir) const override;
  73. /**
  74. * Write the given @a comment to the output stream @a os. It
  75. * handles new line character properly.
  76. */
  77. static void WriteComment(std::ostream& os, const std::string& comment);
  78. /**
  79. * Utilized by the generator factory to determine if this generator
  80. * supports toolsets.
  81. */
  82. static bool SupportsToolset() { return false; }
  83. /**
  84. * Utilized by the generator factory to determine if this generator
  85. * supports platforms.
  86. */
  87. static bool SupportsPlatform() { return false; }
  88. bool IsIPOSupported() const override { return true; }
  89. /**
  90. * Write a build statement @a build to @a os.
  91. * @warning no escaping of any kind is done here.
  92. */
  93. void WriteBuild(std::ostream& os, cmNinjaBuild const& build,
  94. int cmdLineLimit = 0, bool* usedResponseFile = nullptr);
  95. class CCOutputs
  96. {
  97. cmGlobalNinjaGenerator* GG;
  98. public:
  99. CCOutputs(cmGlobalNinjaGenerator* gg)
  100. : GG(gg)
  101. {
  102. }
  103. void Add(std::vector<std::string> const& outputs);
  104. cmNinjaDeps ExplicitOuts;
  105. cmNinjaDeps WorkDirOuts;
  106. };
  107. void WriteCustomCommandBuild(std::string const& command,
  108. std::string const& description,
  109. std::string const& comment,
  110. std::string const& depfile,
  111. std::string const& pool, bool uses_terminal,
  112. bool restat, std::string const& config,
  113. CCOutputs outputs,
  114. cmNinjaDeps explicitDeps = cmNinjaDeps(),
  115. cmNinjaDeps orderOnlyDeps = cmNinjaDeps());
  116. void WriteMacOSXContentBuild(std::string input, std::string output,
  117. const std::string& config);
  118. /**
  119. * Write a rule statement to @a os.
  120. * @warning no escaping of any kind is done here.
  121. */
  122. static void WriteRule(std::ostream& os, cmNinjaRule const& rule);
  123. /**
  124. * Write a variable named @a name to @a os with value @a value and an
  125. * optional @a comment. An @a indent level can be specified.
  126. * @warning no escaping of any kind is done here.
  127. */
  128. static void WriteVariable(std::ostream& os, const std::string& name,
  129. const std::string& value,
  130. const std::string& comment = "", int indent = 0);
  131. /**
  132. * Write an include statement including @a filename with an optional
  133. * @a comment to the @a os stream.
  134. */
  135. static void WriteInclude(std::ostream& os, const std::string& filename,
  136. const std::string& comment = "");
  137. /**
  138. * Write a default target statement specifying @a targets as
  139. * the default targets.
  140. */
  141. static void WriteDefault(std::ostream& os, const cmNinjaDeps& targets,
  142. const std::string& comment = "");
  143. bool IsGCCOnWindows() const { return this->UsingGCCOnWindows; }
  144. void MarkAsGCCOnWindows() { this->UsingGCCOnWindows = true; }
  145. cmGlobalNinjaGenerator(cmake* cm);
  146. static std::unique_ptr<cmGlobalGeneratorFactory> NewFactory()
  147. {
  148. return std::unique_ptr<cmGlobalGeneratorFactory>(
  149. new cmGlobalGeneratorSimpleFactory<cmGlobalNinjaGenerator>());
  150. }
  151. std::unique_ptr<cmLocalGenerator> CreateLocalGenerator(
  152. cmMakefile* mf) override;
  153. std::string GetName() const override
  154. {
  155. return cmGlobalNinjaGenerator::GetActualName();
  156. }
  157. static std::string GetActualName() { return "Ninja"; }
  158. bool IsNinja() const override { return true; }
  159. /** Get encoding used by generator for ninja files */
  160. codecvt_Encoding GetMakefileEncoding() const override;
  161. static cmDocumentationEntry GetDocumentation();
  162. void EnableLanguage(std::vector<std::string> const& languages,
  163. cmMakefile* mf, bool optional) override;
  164. std::vector<GeneratedMakeCommand> GenerateBuildCommand(
  165. const std::string& makeProgram, const std::string& projectName,
  166. const std::string& projectDir, std::vector<std::string> const& targetNames,
  167. const std::string& config, int jobs, bool verbose,
  168. const cmBuildOptions& buildOptions = cmBuildOptions(),
  169. std::vector<std::string> const& makeOptions =
  170. std::vector<std::string>()) override;
  171. // Setup target names
  172. const char* GetAllTargetName() const override { return "all"; }
  173. const char* GetInstallTargetName() const override { return "install"; }
  174. const char* GetInstallLocalTargetName() const override
  175. {
  176. return "install/local";
  177. }
  178. const char* GetInstallStripTargetName() const override
  179. {
  180. return "install/strip";
  181. }
  182. const char* GetTestTargetName() const override { return "test"; }
  183. const char* GetPackageTargetName() const override { return "package"; }
  184. const char* GetPackageSourceTargetName() const override
  185. {
  186. return "package_source";
  187. }
  188. const char* GetRebuildCacheTargetName() const override
  189. {
  190. return "rebuild_cache";
  191. }
  192. const char* GetCleanTargetName() const override { return "clean"; }
  193. bool SupportsCustomCommandDepfile() const override { return true; }
  194. cm::optional<cmDepfileFormat> DepfileFormat() const override
  195. {
  196. return cmDepfileFormat::GccDepfile;
  197. }
  198. bool SupportsLinkerDependencyFile() const override { return true; }
  199. virtual cmGeneratedFileStream* GetImplFileStream(
  200. const std::string& /*config*/) const
  201. {
  202. return this->BuildFileStream.get();
  203. }
  204. virtual cmGeneratedFileStream* GetConfigFileStream(
  205. const std::string& /*config*/) const
  206. {
  207. return this->BuildFileStream.get();
  208. }
  209. virtual cmGeneratedFileStream* GetDefaultFileStream() const
  210. {
  211. return this->BuildFileStream.get();
  212. }
  213. virtual cmGeneratedFileStream* GetCommonFileStream() const
  214. {
  215. return this->BuildFileStream.get();
  216. }
  217. cmGeneratedFileStream* GetRulesFileStream() const
  218. {
  219. return this->RulesFileStream.get();
  220. }
  221. std::string const& ConvertToNinjaPath(const std::string& path) const;
  222. std::string ConvertToNinjaAbsPath(std::string path) const;
  223. struct MapToNinjaPathImpl
  224. {
  225. cmGlobalNinjaGenerator* GG;
  226. MapToNinjaPathImpl(cmGlobalNinjaGenerator* gg)
  227. : GG(gg)
  228. {
  229. }
  230. std::string operator()(std::string const& path) const
  231. {
  232. return this->GG->ConvertToNinjaPath(path);
  233. }
  234. };
  235. MapToNinjaPathImpl MapToNinjaPath() { return { this }; }
  236. #ifdef _WIN32
  237. std::string const& GetComspec() const { return this->Comspec; }
  238. #endif
  239. // -- Additional clean files
  240. void AddAdditionalCleanFile(std::string fileName, const std::string& config);
  241. const char* GetAdditionalCleanTargetName() const
  242. {
  243. return "CMakeFiles/clean.additional";
  244. }
  245. static const char* GetByproductsForCleanTargetName()
  246. {
  247. return "CMakeFiles/cmake_byproducts_for_clean_target";
  248. }
  249. void AddCXXCompileCommand(const std::string& commandLine,
  250. const std::string& sourceFile,
  251. const std::string& objPath);
  252. /**
  253. * Add a rule to the generated build system.
  254. * Call WriteRule() behind the scene but perform some check before like:
  255. * - Do not add twice the same rule.
  256. */
  257. void AddRule(cmNinjaRule const& rule);
  258. bool HasRule(const std::string& name);
  259. void AddCustomCommandRule();
  260. void AddMacOSXContentRule();
  261. bool HasCustomCommandOutput(const std::string& output)
  262. {
  263. return this->CustomCommandOutputs.find(output) !=
  264. this->CustomCommandOutputs.end();
  265. }
  266. /// Called when we have seen the given custom command. Returns true
  267. /// if we has seen it before.
  268. bool SeenCustomCommand(cmCustomCommand const* cc, const std::string& config)
  269. {
  270. return !this->Configs[config].CustomCommands.insert(cc).second;
  271. }
  272. /// Called when we have seen the given custom command output.
  273. void SeenCustomCommandOutput(const std::string& output)
  274. {
  275. this->CustomCommandOutputs.insert(output);
  276. // We don't need the assumed dependencies anymore, because we have
  277. // an output.
  278. this->AssumedSourceDependencies.erase(output);
  279. }
  280. void AddAssumedSourceDependencies(const std::string& source,
  281. const cmNinjaDeps& deps)
  282. {
  283. std::set<std::string>& ASD = this->AssumedSourceDependencies[source];
  284. // Because we may see the same source file multiple times (same source
  285. // specified in multiple targets), compute the union of any assumed
  286. // dependencies.
  287. ASD.insert(deps.begin(), deps.end());
  288. }
  289. virtual std::string OrderDependsTargetForTarget(
  290. cmGeneratorTarget const* target, const std::string& config) const;
  291. virtual std::string OrderDependsTargetForTargetPrivate(
  292. cmGeneratorTarget const* target, const std::string& config) const;
  293. void AppendTargetOutputs(cmGeneratorTarget const* target,
  294. cmNinjaDeps& outputs, const std::string& config,
  295. cmNinjaTargetDepends depends) const;
  296. void AppendTargetDepends(cmGeneratorTarget const* target,
  297. cmNinjaDeps& outputs, const std::string& config,
  298. const std::string& fileConfig,
  299. cmNinjaTargetDepends depends);
  300. void AppendTargetDependsClosure(cmGeneratorTarget const* target,
  301. std::unordered_set<std::string>& outputs,
  302. const std::string& config,
  303. const std::string& fileConfig,
  304. bool genexOutput, bool omit_self = true);
  305. void AppendDirectoryForConfig(const std::string& prefix,
  306. const std::string& config,
  307. const std::string& suffix,
  308. std::string& dir) override;
  309. virtual void AppendNinjaFileArgument(GeneratedMakeCommand& /*command*/,
  310. const std::string& /*config*/) const
  311. {
  312. }
  313. virtual void AddRebuildManifestOutputs(cmNinjaDeps& outputs) const
  314. {
  315. outputs.push_back(this->NinjaOutputPath(NINJA_BUILD_FILE));
  316. }
  317. int GetRuleCmdLength(const std::string& name)
  318. {
  319. return this->RuleCmdLength[name];
  320. }
  321. void AddTargetAlias(const std::string& alias, cmGeneratorTarget* target,
  322. const std::string& config);
  323. void ComputeTargetObjectDirectory(cmGeneratorTarget* gt) const override;
  324. // Ninja generator uses 'deps' and 'msvc_deps_prefix' introduced in 1.3
  325. static std::string RequiredNinjaVersion() { return "1.3"; }
  326. static std::string RequiredNinjaVersionForConsolePool() { return "1.5"; }
  327. static std::string RequiredNinjaVersionForImplicitOuts() { return "1.7"; }
  328. static std::string RequiredNinjaVersionForManifestRestat() { return "1.8"; }
  329. static std::string RequiredNinjaVersionForMultilineDepfile()
  330. {
  331. return "1.9";
  332. }
  333. static std::string RequiredNinjaVersionForDyndepsCxx() { return "1.11"; }
  334. static std::string RequiredNinjaVersionForDyndepsFortran() { return "1.10"; }
  335. static std::string RequiredNinjaVersionForRestatTool() { return "1.10"; }
  336. static std::string RequiredNinjaVersionForUnconditionalRecompactTool()
  337. {
  338. return "1.10";
  339. }
  340. static std::string RequiredNinjaVersionForMultipleOutputs()
  341. {
  342. return "1.10";
  343. }
  344. static std::string RequiredNinjaVersionForMetadataOnRegeneration()
  345. {
  346. return "1.10.2";
  347. }
  348. static std::string RequiredNinjaVersionForCodePage() { return "1.11"; }
  349. bool SupportsDirectConsole() const override;
  350. bool SupportsImplicitOuts() const;
  351. bool SupportsManifestRestat() const;
  352. bool SupportsMultilineDepfile() const;
  353. std::string NinjaOutputPath(std::string const& path) const;
  354. bool HasOutputPathPrefix() const { return !this->OutputPathPrefix.empty(); }
  355. void StripNinjaOutputPathPrefixAsSuffix(std::string& path);
  356. bool WriteDyndepFile(
  357. std::string const& dir_top_src, std::string const& dir_top_bld,
  358. std::string const& dir_cur_src, std::string const& dir_cur_bld,
  359. std::string const& arg_dd, std::vector<std::string> const& arg_ddis,
  360. std::string const& module_dir,
  361. std::vector<std::string> const& linked_target_dirs,
  362. std::string const& arg_lang, std::string const& arg_modmapfmt,
  363. cmCxxModuleExportInfo const& export_info);
  364. virtual std::string BuildAlias(const std::string& alias,
  365. const std::string& /*config*/) const
  366. {
  367. return alias;
  368. }
  369. virtual std::string ConfigDirectory(const std::string& /*config*/) const
  370. {
  371. return "";
  372. }
  373. cmNinjaDeps& GetByproductsForCleanTarget()
  374. {
  375. return this->ByproductsForCleanTarget;
  376. }
  377. cmNinjaDeps& GetByproductsForCleanTarget(const std::string& config)
  378. {
  379. return this->Configs[config].ByproductsForCleanTarget;
  380. }
  381. bool EnableCrossConfigBuild() const;
  382. std::set<std::string> GetCrossConfigs(const std::string& config) const;
  383. const std::set<std::string>& GetDefaultConfigs() const
  384. {
  385. return this->DefaultConfigs;
  386. }
  387. const std::set<std::string>& GetPerConfigUtilityTargets() const
  388. {
  389. return this->PerConfigUtilityTargets;
  390. }
  391. void AddPerConfigUtilityTarget(const std::string& name)
  392. {
  393. this->PerConfigUtilityTargets.insert(name);
  394. }
  395. bool IsSingleConfigUtility(cmGeneratorTarget const* target) const;
  396. bool CheckCxxModuleSupport(CxxModuleSupportQuery query) override;
  397. protected:
  398. void Generate() override;
  399. bool CheckALLOW_DUPLICATE_CUSTOM_TARGETS() const override { return true; }
  400. virtual bool OpenBuildFileStreams();
  401. virtual void CloseBuildFileStreams();
  402. bool OpenFileStream(std::unique_ptr<cmGeneratedFileStream>& stream,
  403. const std::string& name);
  404. static cm::optional<std::set<std::string>> ListSubsetWithAll(
  405. const std::set<std::string>& all, const std::set<std::string>& defaults,
  406. const std::vector<std::string>& items);
  407. std::set<std::string> CrossConfigs;
  408. std::set<std::string> DefaultConfigs;
  409. std::string DefaultFileConfig;
  410. private:
  411. bool FindMakeProgram(cmMakefile* mf) override;
  412. void CheckNinjaFeatures();
  413. void CheckNinjaCodePage();
  414. bool CheckLanguages(std::vector<std::string> const& languages,
  415. cmMakefile* mf) const override;
  416. bool CheckFortran(cmMakefile* mf) const;
  417. bool CheckISPC(cmMakefile* mf) const;
  418. void CloseCompileCommandsStream();
  419. bool OpenRulesFileStream();
  420. void CloseRulesFileStream();
  421. void CleanMetaData();
  422. /// Write the common disclaimer text at the top of each build file.
  423. void WriteDisclaimer(std::ostream& os) const;
  424. void WriteAssumedSourceDependencies();
  425. void WriteTargetAliases(std::ostream& os);
  426. void WriteFolderTargets(std::ostream& os);
  427. void WriteUnknownExplicitDependencies(std::ostream& os);
  428. void WriteBuiltinTargets(std::ostream& os);
  429. void WriteTargetDefault(std::ostream& os);
  430. void WriteTargetRebuildManifest(std::ostream& os);
  431. bool WriteTargetCleanAdditional(std::ostream& os);
  432. void WriteTargetClean(std::ostream& os);
  433. void WriteTargetHelp(std::ostream& os);
  434. void ComputeTargetDependsClosure(
  435. cmGeneratorTarget const* target,
  436. std::set<cmGeneratorTarget const*>& depends);
  437. std::string CMakeCmd() const;
  438. std::string NinjaCmd() const;
  439. /// The file containing the build statement. (the relationship of the
  440. /// compilation DAG).
  441. std::unique_ptr<cmGeneratedFileStream> BuildFileStream;
  442. /// The file containing the rule statements. (The action attached to each
  443. /// edge of the compilation DAG).
  444. std::unique_ptr<cmGeneratedFileStream> RulesFileStream;
  445. std::unique_ptr<cmGeneratedFileStream> CompileCommandsStream;
  446. /// The set of rules added to the generated build system.
  447. std::unordered_set<std::string> Rules;
  448. /// Length of rule command, used by rsp file evaluation
  449. std::unordered_map<std::string, int> RuleCmdLength;
  450. bool UsingGCCOnWindows = false;
  451. /// The set of custom command outputs we have seen.
  452. std::set<std::string> CustomCommandOutputs;
  453. /// Whether we are collecting known build outputs and needed
  454. /// dependencies to determine unknown dependencies.
  455. bool ComputingUnknownDependencies = false;
  456. cmPolicies::PolicyStatus PolicyCMP0058 = cmPolicies::WARN;
  457. /// The combined explicit dependencies of custom build commands
  458. std::set<std::string> CombinedCustomCommandExplicitDependencies;
  459. /// When combined with CombinedCustomCommandExplicitDependencies it allows
  460. /// us to detect the set of explicit dependencies that have
  461. std::set<std::string> CombinedBuildOutputs;
  462. /// The mapping from source file to assumed dependencies.
  463. std::map<std::string, std::set<std::string>> AssumedSourceDependencies;
  464. /// Utility targets which have per-config outputs
  465. std::set<std::string> PerConfigUtilityTargets;
  466. struct TargetAlias
  467. {
  468. cmGeneratorTarget* GeneratorTarget;
  469. std::string Config;
  470. };
  471. using TargetAliasMap = std::map<std::string, TargetAlias>;
  472. TargetAliasMap TargetAliases;
  473. TargetAliasMap DefaultTargetAliases;
  474. /// the local cache for calls to ConvertToNinjaPath
  475. mutable std::unordered_map<std::string, std::string> ConvertToNinjaPathCache;
  476. std::string NinjaCommand;
  477. std::string NinjaVersion;
  478. bool NinjaSupportsConsolePool = false;
  479. bool NinjaSupportsImplicitOuts = false;
  480. bool NinjaSupportsManifestRestat = false;
  481. bool NinjaSupportsMultilineDepfile = false;
  482. bool NinjaSupportsDyndepsCxx = false;
  483. bool NinjaSupportsDyndepsFortran = false;
  484. bool NinjaSupportsRestatTool = false;
  485. bool NinjaSupportsUnconditionalRecompactTool = false;
  486. bool NinjaSupportsMultipleOutputs = false;
  487. bool NinjaSupportsMetadataOnRegeneration = false;
  488. bool NinjaSupportsCodePage = false;
  489. codecvt_Encoding NinjaExpectedEncoding = codecvt_Encoding::None;
  490. #ifdef _WIN32
  491. // Windows Command shell.
  492. std::string Comspec;
  493. #endif
  494. bool DiagnosedCxxModuleNinjaSupport = false;
  495. void InitOutputPathPrefix();
  496. std::string OutputPathPrefix;
  497. std::string TargetAll;
  498. std::string CMakeCacheFile;
  499. struct ByConfig
  500. {
  501. std::set<std::string> AdditionalCleanFiles;
  502. /// The set of custom commands we have seen.
  503. std::set<cmCustomCommand const*> CustomCommands;
  504. struct TargetDependsClosureKey
  505. {
  506. cmGeneratorTarget const* Target;
  507. std::string Config;
  508. bool GenexOutput;
  509. };
  510. std::map<TargetDependsClosureKey, std::unordered_set<std::string>>
  511. TargetDependsClosures;
  512. TargetAliasMap TargetAliases;
  513. cmNinjaDeps ByproductsForCleanTarget;
  514. };
  515. std::map<std::string, ByConfig> Configs;
  516. cmNinjaDeps ByproductsForCleanTarget;
  517. friend bool operator==(const ByConfig::TargetDependsClosureKey& lhs,
  518. const ByConfig::TargetDependsClosureKey& rhs);
  519. friend bool operator!=(const ByConfig::TargetDependsClosureKey& lhs,
  520. const ByConfig::TargetDependsClosureKey& rhs);
  521. friend bool operator<(const ByConfig::TargetDependsClosureKey& lhs,
  522. const ByConfig::TargetDependsClosureKey& rhs);
  523. friend bool operator>(const ByConfig::TargetDependsClosureKey& lhs,
  524. const ByConfig::TargetDependsClosureKey& rhs);
  525. friend bool operator<=(const ByConfig::TargetDependsClosureKey& lhs,
  526. const ByConfig::TargetDependsClosureKey& rhs);
  527. friend bool operator>=(const ByConfig::TargetDependsClosureKey& lhs,
  528. const ByConfig::TargetDependsClosureKey& rhs);
  529. };
  530. class cmGlobalNinjaMultiGenerator : public cmGlobalNinjaGenerator
  531. {
  532. public:
  533. /// The default name of Ninja's common file. Typically: common.ninja.
  534. static const char* NINJA_COMMON_FILE;
  535. /// The default file extension to use for per-config Ninja files.
  536. static const char* NINJA_FILE_EXTENSION;
  537. cmGlobalNinjaMultiGenerator(cmake* cm);
  538. bool IsMultiConfig() const override { return true; }
  539. static std::unique_ptr<cmGlobalGeneratorFactory> NewFactory()
  540. {
  541. return std::unique_ptr<cmGlobalGeneratorFactory>(
  542. new cmGlobalGeneratorSimpleFactory<cmGlobalNinjaMultiGenerator>());
  543. }
  544. static cmDocumentationEntry GetDocumentation();
  545. std::string GetName() const override
  546. {
  547. return cmGlobalNinjaMultiGenerator::GetActualName();
  548. }
  549. static std::string GetActualName() { return "Ninja Multi-Config"; }
  550. std::string BuildAlias(const std::string& alias,
  551. const std::string& config) const override
  552. {
  553. if (config.empty()) {
  554. return alias;
  555. }
  556. return cmStrCat(alias, ":", config);
  557. }
  558. std::string ConfigDirectory(const std::string& config) const override
  559. {
  560. if (!config.empty()) {
  561. return cmStrCat('/', config);
  562. }
  563. return "";
  564. }
  565. const char* GetCMakeCFGIntDir() const override { return "${CONFIGURATION}"; }
  566. std::string ExpandCFGIntDir(const std::string& str,
  567. const std::string& config) const override;
  568. cmGeneratedFileStream* GetImplFileStream(
  569. const std::string& config) const override
  570. {
  571. return this->ImplFileStreams.at(config).get();
  572. }
  573. cmGeneratedFileStream* GetConfigFileStream(
  574. const std::string& config) const override
  575. {
  576. return this->ConfigFileStreams.at(config).get();
  577. }
  578. cmGeneratedFileStream* GetDefaultFileStream() const override
  579. {
  580. return this->DefaultFileStream.get();
  581. }
  582. cmGeneratedFileStream* GetCommonFileStream() const override
  583. {
  584. return this->CommonFileStream.get();
  585. }
  586. void AppendNinjaFileArgument(GeneratedMakeCommand& command,
  587. const std::string& config) const override;
  588. static std::string GetNinjaImplFilename(const std::string& config);
  589. static std::string GetNinjaConfigFilename(const std::string& config);
  590. void AddRebuildManifestOutputs(cmNinjaDeps& outputs) const override;
  591. void GetQtAutoGenConfigs(std::vector<std::string>& configs) const override;
  592. bool InspectConfigTypeVariables() override;
  593. std::string GetDefaultBuildConfig() const override;
  594. bool SupportsDefaultBuildType() const override { return true; }
  595. bool SupportsCrossConfigs() const override { return true; }
  596. bool SupportsDefaultConfigs() const override { return true; }
  597. std::string OrderDependsTargetForTarget(
  598. cmGeneratorTarget const* target, const std::string& config) const override;
  599. std::string OrderDependsTargetForTargetPrivate(
  600. cmGeneratorTarget const* target, const std::string& config) const override;
  601. protected:
  602. bool OpenBuildFileStreams() override;
  603. void CloseBuildFileStreams() override;
  604. private:
  605. std::map<std::string, std::unique_ptr<cmGeneratedFileStream>>
  606. ImplFileStreams;
  607. std::map<std::string, std::unique_ptr<cmGeneratedFileStream>>
  608. ConfigFileStreams;
  609. std::unique_ptr<cmGeneratedFileStream> CommonFileStream;
  610. std::unique_ptr<cmGeneratedFileStream> DefaultFileStream;
  611. };