cmGlobalNinjaGenerator.h 25 KB

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