cmakemain.cxx 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999
  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 "cmConfigure.h" // IWYU pragma: keep
  4. #include <algorithm>
  5. #include <cassert>
  6. #include <climits>
  7. #include <cstdio>
  8. #include <cstring>
  9. #include <iostream>
  10. #include <sstream>
  11. #include <string>
  12. #include <utility>
  13. #include <vector>
  14. #include <cm/memory>
  15. #include <cmext/algorithm>
  16. #include <cm3p/uv.h>
  17. #include "cmCommandLineArgument.h"
  18. #include "cmConsoleBuf.h"
  19. #include "cmDocumentationEntry.h" // IWYU pragma: keep
  20. #include "cmGlobalGenerator.h"
  21. #include "cmMakefile.h"
  22. #include "cmMessageMetadata.h"
  23. #include "cmProperty.h"
  24. #include "cmState.h"
  25. #include "cmStateTypes.h"
  26. #include "cmStringAlgorithms.h"
  27. #include "cmSystemTools.h"
  28. #include "cmake.h"
  29. #include "cmcmd.h"
  30. #ifndef CMAKE_BOOTSTRAP
  31. # include "cmDocumentation.h"
  32. # include "cmDynamicLoader.h"
  33. #endif
  34. #include "cmsys/Encoding.hxx"
  35. #include "cmsys/Terminal.h"
  36. namespace {
  37. #ifndef CMAKE_BOOTSTRAP
  38. const char* cmDocumentationName[][2] = {
  39. { nullptr, " cmake - Cross-Platform Makefile Generator." },
  40. { nullptr, nullptr }
  41. };
  42. const char* cmDocumentationUsage[][2] = {
  43. { nullptr,
  44. " cmake [options] <path-to-source>\n"
  45. " cmake [options] <path-to-existing-build>\n"
  46. " cmake [options] -S <path-to-source> -B <path-to-build>" },
  47. { nullptr,
  48. "Specify a source directory to (re-)generate a build system for "
  49. "it in the current working directory. Specify an existing build "
  50. "directory to re-generate its build system." },
  51. { nullptr, nullptr }
  52. };
  53. const char* cmDocumentationUsageNote[][2] = {
  54. { nullptr, "Run 'cmake --help' for more information." },
  55. { nullptr, nullptr }
  56. };
  57. const char* cmDocumentationOptions[][2] = {
  58. CMAKE_STANDARD_OPTIONS_TABLE,
  59. { "--preset <preset>,--preset=<preset>", "Specify a configure preset." },
  60. { "--list-presets", "List available presets." },
  61. { "-E", "CMake command mode." },
  62. { "-L[A][H]", "List non-advanced cached variables." },
  63. { "--build <dir>", "Build a CMake-generated project binary tree." },
  64. { "--install <dir>", "Install a CMake-generated project binary tree." },
  65. { "--open <dir>", "Open generated project in the associated application." },
  66. { "-N", "View mode only." },
  67. { "-P <file>", "Process script mode." },
  68. { "--find-package", "Legacy pkg-config like mode. Do not use." },
  69. { "--graphviz=[file]",
  70. "Generate graphviz of dependencies, see "
  71. "CMakeGraphVizOptions.cmake for more." },
  72. { "--system-information [file]", "Dump information about this system." },
  73. { "--log-level=<ERROR|WARNING|NOTICE|STATUS|VERBOSE|DEBUG|TRACE>",
  74. "Set the verbosity of messages from CMake files. "
  75. "--loglevel is also accepted for backward compatibility reasons." },
  76. { "--log-context", "Prepend log messages with context, if given" },
  77. { "--debug-trycompile",
  78. "Do not delete the try_compile build tree. Only "
  79. "useful on one try_compile at a time." },
  80. { "--debug-output", "Put cmake in a debug mode." },
  81. { "--debug-find", "Put cmake find in a debug mode." },
  82. { "--trace", "Put cmake in trace mode." },
  83. { "--trace-expand", "Put cmake in trace mode with variable expansion." },
  84. { "--trace-format=<human|json-v1>", "Set the output format of the trace." },
  85. { "--trace-source=<file>",
  86. "Trace only this CMake file/module. Multiple options allowed." },
  87. { "--trace-redirect=<file>",
  88. "Redirect trace output to a file instead of stderr." },
  89. { "--warn-uninitialized", "Warn about uninitialized values." },
  90. { "--no-warn-unused-cli", "Don't warn about command line options." },
  91. { "--check-system-vars",
  92. "Find problems with variable usage in system "
  93. "files." },
  94. # if !defined(CMAKE_BOOTSTRAP)
  95. { "--profiling-format=<fmt>",
  96. "Output data for profiling CMake scripts. Supported formats: "
  97. "google-trace" },
  98. { "--profiling-output=<file>",
  99. "Select an output path for the profiling data enabled through "
  100. "--profiling-format." },
  101. # endif
  102. { nullptr, nullptr }
  103. };
  104. #endif
  105. int do_command(int ac, char const* const* av,
  106. std::unique_ptr<cmConsoleBuf> consoleBuf)
  107. {
  108. std::vector<std::string> args;
  109. args.reserve(ac - 1);
  110. args.emplace_back(av[0]);
  111. cm::append(args, av + 2, av + ac);
  112. return cmcmd::ExecuteCMakeCommand(args, std::move(consoleBuf));
  113. }
  114. cmMakefile* cmakemainGetMakefile(cmake* cm)
  115. {
  116. if (cm && cm->GetDebugOutput()) {
  117. cmGlobalGenerator* gg = cm->GetGlobalGenerator();
  118. if (gg) {
  119. return gg->GetCurrentMakefile();
  120. }
  121. }
  122. return nullptr;
  123. }
  124. std::string cmakemainGetStack(cmake* cm)
  125. {
  126. std::string msg;
  127. cmMakefile* mf = cmakemainGetMakefile(cm);
  128. if (mf) {
  129. msg = mf->FormatListFileStack();
  130. if (!msg.empty()) {
  131. msg = "\n Called from: " + msg;
  132. }
  133. }
  134. return msg;
  135. }
  136. void cmakemainMessageCallback(const std::string& m,
  137. const cmMessageMetadata& md, cmake* cm)
  138. {
  139. cmsysTerminal_cfprintf(md.desiredColor, stderr, "%s", m.c_str());
  140. fflush(stderr); // stderr is buffered in some cases.
  141. std::cerr << cmakemainGetStack(cm) << "\n";
  142. }
  143. void cmakemainProgressCallback(const std::string& m, float prog, cmake* cm)
  144. {
  145. cmMakefile* mf = cmakemainGetMakefile(cm);
  146. std::string dir;
  147. if (mf && cmHasLiteralPrefix(m, "Configuring") && (prog < 0)) {
  148. dir = cmStrCat(' ', mf->GetCurrentSourceDirectory());
  149. } else if (mf && cmHasLiteralPrefix(m, "Generating")) {
  150. dir = cmStrCat(' ', mf->GetCurrentBinaryDirectory());
  151. }
  152. if ((prog < 0) || (!dir.empty())) {
  153. std::cout << "-- " << m << dir << cmakemainGetStack(cm) << std::endl;
  154. }
  155. }
  156. int do_cmake(int ac, char const* const* av)
  157. {
  158. if (cmSystemTools::GetCurrentWorkingDirectory().empty()) {
  159. std::cerr << "Current working directory cannot be established."
  160. << std::endl;
  161. return 1;
  162. }
  163. #ifndef CMAKE_BOOTSTRAP
  164. cmDocumentation doc;
  165. doc.addCMakeStandardDocSections();
  166. if (doc.CheckOptions(ac, av)) {
  167. // Construct and print requested documentation.
  168. cmake hcm(cmake::RoleInternal, cmState::Unknown);
  169. hcm.SetHomeDirectory("");
  170. hcm.SetHomeOutputDirectory("");
  171. hcm.AddCMakePaths();
  172. // the command line args are processed here so that you can do
  173. // -DCMAKE_MODULE_PATH=/some/path and have this value accessible here
  174. std::vector<std::string> args(av, av + ac);
  175. hcm.SetCacheArgs(args);
  176. auto generators = hcm.GetGeneratorsDocumentation();
  177. doc.SetName("cmake");
  178. doc.SetSection("Name", cmDocumentationName);
  179. doc.SetSection("Usage", cmDocumentationUsage);
  180. if (ac == 1) {
  181. doc.AppendSection("Usage", cmDocumentationUsageNote);
  182. }
  183. doc.AppendSection("Generators", generators);
  184. doc.PrependSection("Options", cmDocumentationOptions);
  185. return doc.PrintRequestedDocumentation(std::cout) ? 0 : 1;
  186. }
  187. #else
  188. if (ac == 1) {
  189. std::cout
  190. << "Bootstrap CMake should not be used outside CMake build process."
  191. << std::endl;
  192. return 0;
  193. }
  194. #endif
  195. bool wizard_mode = false;
  196. bool sysinfo = false;
  197. bool list_cached = false;
  198. bool list_all_cached = false;
  199. bool list_help = false;
  200. bool view_only = false;
  201. cmake::WorkingMode workingMode = cmake::NORMAL_MODE;
  202. std::vector<std::string> parsedArgs;
  203. using CommandArgument =
  204. cmCommandLineArgument<bool(std::string const& value)>;
  205. std::vector<CommandArgument> arguments = {
  206. CommandArgument{
  207. "-i", CommandArgument::Values::Zero,
  208. [&wizard_mode](std::string const&) -> bool {
  209. /* clang-format off */
  210. std::cerr <<
  211. "The \"cmake -i\" wizard mode is no longer supported.\n"
  212. "Use the -D option to set cache values on the command line.\n"
  213. "Use cmake-gui or ccmake for an interactive dialog.\n";
  214. /* clang-format on */
  215. wizard_mode = true;
  216. return true;
  217. } },
  218. CommandArgument{ "--system-information", CommandArgument::Values::Zero,
  219. [&](std::string const&) -> bool {
  220. sysinfo = true;
  221. return true;
  222. } },
  223. CommandArgument{ "-N", CommandArgument::Values::Zero,
  224. [&](std::string const&) -> bool {
  225. view_only = true;
  226. return true;
  227. } },
  228. CommandArgument{ "-LAH", CommandArgument::Values::Zero,
  229. [&](std::string const&) -> bool {
  230. list_all_cached = true;
  231. list_help = true;
  232. return true;
  233. } },
  234. CommandArgument{ "-LA", CommandArgument::Values::Zero,
  235. [&](std::string const&) -> bool {
  236. list_all_cached = true;
  237. return true;
  238. } },
  239. CommandArgument{ "-LH", CommandArgument::Values::Zero,
  240. [&](std::string const&) -> bool {
  241. list_cached = true;
  242. list_help = true;
  243. return true;
  244. } },
  245. CommandArgument{ "-L", CommandArgument::Values::Zero,
  246. [&](std::string const&) -> bool {
  247. list_cached = true;
  248. return true;
  249. } },
  250. CommandArgument{ "-P", "No script specified for argument -P",
  251. CommandArgument::Values::One,
  252. CommandArgument::RequiresSeparator::No,
  253. [&](std::string const& value) -> bool {
  254. workingMode = cmake::SCRIPT_MODE;
  255. parsedArgs.emplace_back("-P");
  256. parsedArgs.push_back(value);
  257. return true;
  258. } },
  259. CommandArgument{ "--find-package", CommandArgument::Values::Zero,
  260. [&](std::string const&) -> bool {
  261. workingMode = cmake::FIND_PACKAGE_MODE;
  262. parsedArgs.emplace_back("--find-package");
  263. return true;
  264. } },
  265. CommandArgument{ "--list-presets", CommandArgument::Values::Zero,
  266. [&](std::string const&) -> bool {
  267. workingMode = cmake::HELP_MODE;
  268. parsedArgs.emplace_back("--list-presets");
  269. return true;
  270. } },
  271. };
  272. std::vector<std::string> inputArgs;
  273. inputArgs.reserve(ac);
  274. cm::append(inputArgs, av, av + ac);
  275. for (decltype(inputArgs.size()) i = 0; i < inputArgs.size(); ++i) {
  276. std::string const& arg = inputArgs[i];
  277. bool matched = false;
  278. for (auto const& m : arguments) {
  279. if (m.matches(arg)) {
  280. matched = true;
  281. if (m.parse(arg, i, inputArgs)) {
  282. break;
  283. }
  284. return 1; // failed to parse
  285. }
  286. }
  287. if (!matched) {
  288. parsedArgs.emplace_back(av[i]);
  289. }
  290. }
  291. if (wizard_mode) {
  292. return 1;
  293. }
  294. if (sysinfo) {
  295. cmake cm(cmake::RoleProject, cmState::Project);
  296. cm.SetHomeDirectory("");
  297. cm.SetHomeOutputDirectory("");
  298. int ret = cm.GetSystemInformation(parsedArgs);
  299. return ret;
  300. }
  301. cmake::Role const role =
  302. workingMode == cmake::SCRIPT_MODE ? cmake::RoleScript : cmake::RoleProject;
  303. cmState::Mode mode = cmState::Unknown;
  304. switch (workingMode) {
  305. case cmake::NORMAL_MODE:
  306. case cmake::HELP_MODE:
  307. mode = cmState::Project;
  308. break;
  309. case cmake::SCRIPT_MODE:
  310. mode = cmState::Script;
  311. break;
  312. case cmake::FIND_PACKAGE_MODE:
  313. mode = cmState::FindPackage;
  314. break;
  315. }
  316. cmake cm(role, mode);
  317. cm.SetHomeDirectory("");
  318. cm.SetHomeOutputDirectory("");
  319. cmSystemTools::SetMessageCallback(
  320. [&cm](const std::string& msg, const cmMessageMetadata& md) {
  321. cmakemainMessageCallback(msg, md, &cm);
  322. });
  323. cm.SetProgressCallback([&cm](const std::string& msg, float prog) {
  324. cmakemainProgressCallback(msg, prog, &cm);
  325. });
  326. cm.SetWorkingMode(workingMode);
  327. int res = cm.Run(parsedArgs, view_only);
  328. if (list_cached || list_all_cached) {
  329. std::cout << "-- Cache values" << std::endl;
  330. std::vector<std::string> keys = cm.GetState()->GetCacheEntryKeys();
  331. for (std::string const& k : keys) {
  332. cmStateEnums::CacheEntryType t = cm.GetState()->GetCacheEntryType(k);
  333. if (t != cmStateEnums::INTERNAL && t != cmStateEnums::STATIC &&
  334. t != cmStateEnums::UNINITIALIZED) {
  335. cmProp advancedProp =
  336. cm.GetState()->GetCacheEntryProperty(k, "ADVANCED");
  337. if (list_all_cached || !advancedProp) {
  338. if (list_help) {
  339. cmProp help =
  340. cm.GetState()->GetCacheEntryProperty(k, "HELPSTRING");
  341. std::cout << "// " << (help ? *help : "") << std::endl;
  342. }
  343. std::cout << k << ":" << cmState::CacheEntryTypeToString(t) << "="
  344. << cm.GetState()->GetSafeCacheEntryValue(k) << std::endl;
  345. if (list_help) {
  346. std::cout << std::endl;
  347. }
  348. }
  349. }
  350. }
  351. }
  352. // Always return a non-negative value. Windows tools do not always
  353. // interpret negative return values as errors.
  354. if (res != 0) {
  355. return 1;
  356. }
  357. return 0;
  358. }
  359. #ifndef CMAKE_BOOTSTRAP
  360. int extract_job_number(std::string const& command,
  361. std::string const& jobString)
  362. {
  363. int jobs = -1;
  364. unsigned long numJobs = 0;
  365. if (jobString.empty()) {
  366. jobs = cmake::DEFAULT_BUILD_PARALLEL_LEVEL;
  367. } else if (cmStrToULong(jobString, &numJobs)) {
  368. if (numJobs == 0) {
  369. std::cerr
  370. << "The <jobs> value requires a positive integer argument.\n\n";
  371. } else if (numJobs > INT_MAX) {
  372. std::cerr << "The <jobs> value is too large.\n\n";
  373. } else {
  374. jobs = int(numJobs);
  375. }
  376. } else {
  377. std::cerr << "'" << command << "' invalid number '" << jobString
  378. << "' given.\n\n";
  379. }
  380. return jobs;
  381. }
  382. #endif
  383. int do_build(int ac, char const* const* av)
  384. {
  385. #ifdef CMAKE_BOOTSTRAP
  386. std::cerr << "This cmake does not support --build\n";
  387. return -1;
  388. #else
  389. int jobs = cmake::NO_BUILD_PARALLEL_LEVEL;
  390. std::vector<std::string> targets;
  391. std::string config;
  392. std::string dir;
  393. std::vector<std::string> nativeOptions;
  394. bool nativeOptionsPassed = false;
  395. bool cleanFirst = false;
  396. bool foundClean = false;
  397. bool foundNonClean = false;
  398. bool verbose = cmSystemTools::HasEnv("VERBOSE");
  399. std::string presetName;
  400. bool listPresets = false;
  401. auto jLambda = [&](std::string const& value) -> bool {
  402. jobs = extract_job_number("-j", value);
  403. if (jobs < 0) {
  404. dir.clear();
  405. }
  406. return true;
  407. };
  408. auto parallelLambda = [&](std::string const& value) -> bool {
  409. jobs = extract_job_number("--parallel", value);
  410. if (jobs < 0) {
  411. dir.clear();
  412. }
  413. return true;
  414. };
  415. auto targetLambda = [&](std::string const& value) -> bool {
  416. if (!value.empty()) {
  417. std::vector<std::string> values = cmExpandedList(value);
  418. for (auto const& v : values) {
  419. targets.emplace_back(v);
  420. if (v == "clean") {
  421. foundClean = true;
  422. } else {
  423. foundNonClean = true;
  424. }
  425. }
  426. return true;
  427. }
  428. return false;
  429. };
  430. auto verboseLambda = [&](std::string const&) -> bool {
  431. verbose = true;
  432. return true;
  433. };
  434. using CommandArgument =
  435. cmCommandLineArgument<bool(std::string const& value)>;
  436. std::vector<CommandArgument> arguments = {
  437. CommandArgument{ "--preset", CommandArgument::Values::One,
  438. [&](std::string const& value) -> bool {
  439. presetName = value;
  440. return true;
  441. } },
  442. CommandArgument{ "--list-presets", CommandArgument::Values::Zero,
  443. [&](std::string const&) -> bool {
  444. listPresets = true;
  445. return true;
  446. } },
  447. CommandArgument{ "-j", CommandArgument::Values::ZeroOrOne,
  448. CommandArgument::RequiresSeparator::No, jLambda },
  449. CommandArgument{ "--parallel", CommandArgument::Values::ZeroOrOne,
  450. CommandArgument::RequiresSeparator::No, parallelLambda },
  451. CommandArgument{ "-t", CommandArgument::Values::OneOrMore, targetLambda },
  452. CommandArgument{ "--target", CommandArgument::Values::OneOrMore,
  453. targetLambda },
  454. CommandArgument{ "--config", CommandArgument::Values::One,
  455. [&](std::string const& value) -> bool {
  456. config = value;
  457. return true;
  458. } },
  459. CommandArgument{ "--clean-first", CommandArgument::Values::Zero,
  460. [&](std::string const&) -> bool {
  461. cleanFirst = true;
  462. return true;
  463. } },
  464. CommandArgument{ "-v", CommandArgument::Values::Zero, verboseLambda },
  465. CommandArgument{ "--verbose", CommandArgument::Values::Zero,
  466. verboseLambda },
  467. /* legacy option no-op*/
  468. CommandArgument{ "--use-stderr", CommandArgument::Values::Zero,
  469. [](std::string const&) -> bool { return true; } },
  470. CommandArgument{ "--", CommandArgument::Values::Zero,
  471. [&](std::string const&) -> bool {
  472. nativeOptionsPassed = true;
  473. return true;
  474. } },
  475. };
  476. if (ac >= 3) {
  477. std::vector<std::string> inputArgs;
  478. bool hasPreset = false;
  479. for (int i = 2; i < ac; ++i) {
  480. if (strcmp(av[i], "--list-presets") == 0 ||
  481. cmHasLiteralPrefix(av[i], "--preset=") ||
  482. strcmp(av[i], "--preset") == 0) {
  483. hasPreset = true;
  484. break;
  485. }
  486. }
  487. if (hasPreset) {
  488. inputArgs.reserve(ac - 2);
  489. cm::append(inputArgs, av + 2, av + ac);
  490. } else {
  491. dir = cmSystemTools::CollapseFullPath(av[2]);
  492. inputArgs.reserve(ac - 3);
  493. cm::append(inputArgs, av + 3, av + ac);
  494. }
  495. decltype(inputArgs.size()) i = 0;
  496. for (; i < inputArgs.size() && !nativeOptionsPassed; ++i) {
  497. std::string const& arg = inputArgs[i];
  498. bool matched = false;
  499. bool parsed = false;
  500. for (auto const& m : arguments) {
  501. matched = m.matches(arg);
  502. if (matched) {
  503. parsed = m.parse(arg, i, inputArgs);
  504. break;
  505. }
  506. }
  507. if (!(matched && parsed)) {
  508. dir.clear();
  509. if (!matched) {
  510. std::cerr << "Unknown argument " << arg << std::endl;
  511. }
  512. break;
  513. }
  514. }
  515. if (nativeOptionsPassed) {
  516. cm::append(nativeOptions, inputArgs.begin() + i, inputArgs.end());
  517. }
  518. }
  519. if (foundClean && foundNonClean) {
  520. std::cerr << "Error: Building 'clean' and other targets together "
  521. "is not supported."
  522. << std::endl;
  523. dir.clear();
  524. }
  525. if (jobs == cmake::NO_BUILD_PARALLEL_LEVEL) {
  526. std::string parallel;
  527. if (cmSystemTools::GetEnv("CMAKE_BUILD_PARALLEL_LEVEL", parallel)) {
  528. if (parallel.empty()) {
  529. jobs = cmake::DEFAULT_BUILD_PARALLEL_LEVEL;
  530. } else {
  531. unsigned long numJobs = 0;
  532. if (cmStrToULong(parallel, &numJobs)) {
  533. if (numJobs == 0) {
  534. std::cerr << "The CMAKE_BUILD_PARALLEL_LEVEL environment variable "
  535. "requires a positive integer argument.\n\n";
  536. dir.clear();
  537. } else if (numJobs > INT_MAX) {
  538. std::cerr << "The CMAKE_BUILD_PARALLEL_LEVEL environment variable "
  539. "is too large.\n\n";
  540. dir.clear();
  541. } else {
  542. jobs = int(numJobs);
  543. }
  544. } else {
  545. std::cerr << "'CMAKE_BUILD_PARALLEL_LEVEL' environment variable\n"
  546. << "invalid number '" << parallel << "' given.\n\n";
  547. dir.clear();
  548. }
  549. }
  550. }
  551. }
  552. if (dir.empty() && presetName.empty() && !listPresets) {
  553. /* clang-format off */
  554. std::cerr <<
  555. "Usage: cmake --build <dir> "
  556. " [options] [-- [native-options]]\n"
  557. " cmake --build --preset <preset>"
  558. " [options] [-- [native-options]]\n"
  559. "Options:\n"
  560. " <dir> = Project binary directory to be built.\n"
  561. " --preset <preset>, --preset=<preset>\n"
  562. " = Specify a build preset.\n"
  563. " --list-presets\n"
  564. " = List available build presets.\n"
  565. " --parallel [<jobs>], -j [<jobs>]\n"
  566. " = Build in parallel using the given number of jobs. \n"
  567. " If <jobs> is omitted the native build tool's \n"
  568. " default number is used.\n"
  569. " The CMAKE_BUILD_PARALLEL_LEVEL environment "
  570. "variable\n"
  571. " specifies a default parallel level when this "
  572. "option\n"
  573. " is not given.\n"
  574. " --target <tgt>..., -t <tgt>... \n"
  575. " = Build <tgt> instead of default targets.\n"
  576. " --config <cfg> = For multi-configuration tools, choose <cfg>.\n"
  577. " --clean-first = Build target 'clean' first, then build.\n"
  578. " (To clean only, use --target 'clean'.)\n"
  579. " --verbose, -v = Enable verbose output - if supported - including\n"
  580. " the build commands to be executed. \n"
  581. " -- = Pass remaining options to the native tool.\n"
  582. ;
  583. /* clang-format on */
  584. return 1;
  585. }
  586. cmake cm(cmake::RoleInternal, cmState::Project);
  587. cmSystemTools::SetMessageCallback(
  588. [&cm](const std::string& msg, const cmMessageMetadata& md) {
  589. cmakemainMessageCallback(msg, md, &cm);
  590. });
  591. cm.SetProgressCallback([&cm](const std::string& msg, float prog) {
  592. cmakemainProgressCallback(msg, prog, &cm);
  593. });
  594. return cm.Build(jobs, std::move(dir), std::move(targets), std::move(config),
  595. std::move(nativeOptions), cleanFirst, verbose, presetName,
  596. listPresets);
  597. #endif
  598. }
  599. bool parse_default_directory_permissions(const std::string& permissions,
  600. std::string& parsedPermissionsVar)
  601. {
  602. std::vector<std::string> parsedPermissions;
  603. enum Doing
  604. {
  605. DoingNone,
  606. DoingOwner,
  607. DoingGroup,
  608. DoingWorld,
  609. DoingOwnerAssignment,
  610. DoingGroupAssignment,
  611. DoingWorldAssignment,
  612. };
  613. Doing doing = DoingNone;
  614. auto uniquePushBack = [&parsedPermissions](const std::string& e) {
  615. if (std::find(parsedPermissions.begin(), parsedPermissions.end(), e) ==
  616. parsedPermissions.end()) {
  617. parsedPermissions.push_back(e);
  618. }
  619. };
  620. for (auto const& e : permissions) {
  621. switch (doing) {
  622. case DoingNone:
  623. if (e == 'u') {
  624. doing = DoingOwner;
  625. } else if (e == 'g') {
  626. doing = DoingGroup;
  627. } else if (e == 'o') {
  628. doing = DoingWorld;
  629. } else {
  630. return false;
  631. }
  632. break;
  633. case DoingOwner:
  634. if (e == '=') {
  635. doing = DoingOwnerAssignment;
  636. } else {
  637. return false;
  638. }
  639. break;
  640. case DoingGroup:
  641. if (e == '=') {
  642. doing = DoingGroupAssignment;
  643. } else {
  644. return false;
  645. }
  646. break;
  647. case DoingWorld:
  648. if (e == '=') {
  649. doing = DoingWorldAssignment;
  650. } else {
  651. return false;
  652. }
  653. break;
  654. case DoingOwnerAssignment:
  655. if (e == 'r') {
  656. uniquePushBack("OWNER_READ");
  657. } else if (e == 'w') {
  658. uniquePushBack("OWNER_WRITE");
  659. } else if (e == 'x') {
  660. uniquePushBack("OWNER_EXECUTE");
  661. } else if (e == ',') {
  662. doing = DoingNone;
  663. } else {
  664. return false;
  665. }
  666. break;
  667. case DoingGroupAssignment:
  668. if (e == 'r') {
  669. uniquePushBack("GROUP_READ");
  670. } else if (e == 'w') {
  671. uniquePushBack("GROUP_WRITE");
  672. } else if (e == 'x') {
  673. uniquePushBack("GROUP_EXECUTE");
  674. } else if (e == ',') {
  675. doing = DoingNone;
  676. } else {
  677. return false;
  678. }
  679. break;
  680. case DoingWorldAssignment:
  681. if (e == 'r') {
  682. uniquePushBack("WORLD_READ");
  683. } else if (e == 'w') {
  684. uniquePushBack("WORLD_WRITE");
  685. } else if (e == 'x') {
  686. uniquePushBack("WORLD_EXECUTE");
  687. } else if (e == ',') {
  688. doing = DoingNone;
  689. } else {
  690. return false;
  691. }
  692. break;
  693. }
  694. }
  695. if (doing != DoingOwnerAssignment && doing != DoingGroupAssignment &&
  696. doing != DoingWorldAssignment) {
  697. return false;
  698. }
  699. std::ostringstream oss;
  700. for (auto i = 0u; i < parsedPermissions.size(); i++) {
  701. if (i != 0) {
  702. oss << ";";
  703. }
  704. oss << parsedPermissions[i];
  705. }
  706. parsedPermissionsVar = oss.str();
  707. return true;
  708. }
  709. int do_install(int ac, char const* const* av)
  710. {
  711. #ifdef CMAKE_BOOTSTRAP
  712. std::cerr << "This cmake does not support --install\n";
  713. return -1;
  714. #else
  715. assert(1 < ac);
  716. std::string config;
  717. std::string component;
  718. std::string defaultDirectoryPermissions;
  719. std::string prefix;
  720. std::string dir;
  721. bool strip = false;
  722. bool verbose = cmSystemTools::HasEnv("VERBOSE");
  723. auto verboseLambda = [&](std::string const&) -> bool {
  724. verbose = true;
  725. return true;
  726. };
  727. using CommandArgument =
  728. cmCommandLineArgument<bool(std::string const& value)>;
  729. std::vector<CommandArgument> arguments = {
  730. CommandArgument{ "--config", CommandArgument::Values::One,
  731. [&](std::string const& value) -> bool {
  732. config = value;
  733. return true;
  734. } },
  735. CommandArgument{ "--component", CommandArgument::Values::One,
  736. [&](std::string const& value) -> bool {
  737. component = value;
  738. return true;
  739. } },
  740. CommandArgument{ "--default-directory-permissions",
  741. CommandArgument::Values::One,
  742. [&](std::string const& value) -> bool {
  743. defaultDirectoryPermissions = value;
  744. return true;
  745. } },
  746. CommandArgument{ "--prefix", CommandArgument::Values::One,
  747. [&](std::string const& value) -> bool {
  748. prefix = value;
  749. return true;
  750. } },
  751. CommandArgument{ "--strip", CommandArgument::Values::Zero,
  752. [&](std::string const&) -> bool {
  753. strip = true;
  754. return true;
  755. } },
  756. CommandArgument{ "-v", CommandArgument::Values::Zero, verboseLambda },
  757. CommandArgument{ "--verbose", CommandArgument::Values::Zero,
  758. verboseLambda }
  759. };
  760. if (ac >= 3) {
  761. dir = cmSystemTools::CollapseFullPath(av[2]);
  762. std::vector<std::string> inputArgs;
  763. inputArgs.reserve(ac - 3);
  764. cm::append(inputArgs, av + 3, av + ac);
  765. for (decltype(inputArgs.size()) i = 0; i < inputArgs.size(); ++i) {
  766. std::string const& arg = inputArgs[i];
  767. bool matched = false;
  768. bool parsed = false;
  769. for (auto const& m : arguments) {
  770. matched = m.matches(arg);
  771. if (matched) {
  772. parsed = m.parse(arg, i, inputArgs);
  773. break;
  774. }
  775. }
  776. if (!(matched && parsed)) {
  777. dir.clear();
  778. if (!matched) {
  779. std::cerr << "Unknown argument " << arg << std::endl;
  780. }
  781. break;
  782. }
  783. }
  784. }
  785. if (dir.empty()) {
  786. /* clang-format off */
  787. std::cerr <<
  788. "Usage: cmake --install <dir> [options]\n"
  789. "Options:\n"
  790. " <dir> = Project binary directory to install.\n"
  791. " --config <cfg> = For multi-configuration tools, choose <cfg>.\n"
  792. " --component <comp> = Component-based install. Only install <comp>.\n"
  793. " --default-directory-permissions <permission> \n"
  794. " Default install permission. Use default permission <permission>.\n"
  795. " --prefix <prefix> = The installation prefix CMAKE_INSTALL_PREFIX.\n"
  796. " --strip = Performing install/strip.\n"
  797. " -v --verbose = Enable verbose output.\n"
  798. ;
  799. /* clang-format on */
  800. return 1;
  801. }
  802. cmake cm(cmake::RoleScript, cmState::Script);
  803. cmSystemTools::SetMessageCallback(
  804. [&cm](const std::string& msg, const cmMessageMetadata& md) {
  805. cmakemainMessageCallback(msg, md, &cm);
  806. });
  807. cm.SetProgressCallback([&cm](const std::string& msg, float prog) {
  808. cmakemainProgressCallback(msg, prog, &cm);
  809. });
  810. cm.SetHomeDirectory("");
  811. cm.SetHomeOutputDirectory("");
  812. cm.SetDebugOutputOn(verbose);
  813. cm.SetWorkingMode(cmake::SCRIPT_MODE);
  814. std::vector<std::string> args{ av[0] };
  815. if (!prefix.empty()) {
  816. args.emplace_back("-DCMAKE_INSTALL_PREFIX=" + prefix);
  817. }
  818. if (!component.empty()) {
  819. args.emplace_back("-DCMAKE_INSTALL_COMPONENT=" + component);
  820. }
  821. if (strip) {
  822. args.emplace_back("-DCMAKE_INSTALL_DO_STRIP=1");
  823. }
  824. if (!config.empty()) {
  825. args.emplace_back("-DCMAKE_INSTALL_CONFIG_NAME=" + config);
  826. }
  827. if (!defaultDirectoryPermissions.empty()) {
  828. std::string parsedPermissionsVar;
  829. if (!parse_default_directory_permissions(defaultDirectoryPermissions,
  830. parsedPermissionsVar)) {
  831. std::cerr << "--default-directory-permissions is in incorrect format"
  832. << std::endl;
  833. return 1;
  834. }
  835. args.emplace_back("-DCMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS=" +
  836. parsedPermissionsVar);
  837. }
  838. args.emplace_back("-P");
  839. args.emplace_back(dir + "/cmake_install.cmake");
  840. return cm.Run(args) ? 1 : 0;
  841. #endif
  842. }
  843. int do_open(int ac, char const* const* av)
  844. {
  845. #ifdef CMAKE_BOOTSTRAP
  846. std::cerr << "This cmake does not support --open\n";
  847. return -1;
  848. #else
  849. std::string dir;
  850. enum Doing
  851. {
  852. DoingNone,
  853. DoingDir,
  854. };
  855. Doing doing = DoingDir;
  856. for (int i = 2; i < ac; ++i) {
  857. switch (doing) {
  858. case DoingDir:
  859. dir = cmSystemTools::CollapseFullPath(av[i]);
  860. doing = DoingNone;
  861. break;
  862. default:
  863. std::cerr << "Unknown argument " << av[i] << std::endl;
  864. dir.clear();
  865. break;
  866. }
  867. }
  868. if (dir.empty()) {
  869. std::cerr << "Usage: cmake --open <dir>\n";
  870. return 1;
  871. }
  872. cmake cm(cmake::RoleInternal, cmState::Unknown);
  873. cmSystemTools::SetMessageCallback(
  874. [&cm](const std::string& msg, const cmMessageMetadata& md) {
  875. cmakemainMessageCallback(msg, md, &cm);
  876. });
  877. cm.SetProgressCallback([&cm](const std::string& msg, float prog) {
  878. cmakemainProgressCallback(msg, prog, &cm);
  879. });
  880. return cm.Open(dir, false) ? 0 : 1;
  881. #endif
  882. }
  883. } // namespace
  884. int main(int ac, char const* const* av)
  885. {
  886. cmSystemTools::EnsureStdPipes();
  887. // Replace streambuf so we can output Unicode to console
  888. auto consoleBuf = cm::make_unique<cmConsoleBuf>();
  889. consoleBuf->SetUTF8Pipes();
  890. cmsys::Encoding::CommandLineArguments args =
  891. cmsys::Encoding::CommandLineArguments::Main(ac, av);
  892. ac = args.argc();
  893. av = args.argv();
  894. cmSystemTools::InitializeLibUV();
  895. cmSystemTools::FindCMakeResources(av[0]);
  896. if (ac > 1) {
  897. if (strcmp(av[1], "--build") == 0) {
  898. return do_build(ac, av);
  899. }
  900. if (strcmp(av[1], "--install") == 0) {
  901. return do_install(ac, av);
  902. }
  903. if (strcmp(av[1], "--open") == 0) {
  904. return do_open(ac, av);
  905. }
  906. if (strcmp(av[1], "-E") == 0) {
  907. return do_command(ac, av, std::move(consoleBuf));
  908. }
  909. }
  910. int ret = do_cmake(ac, av);
  911. #ifndef CMAKE_BOOTSTRAP
  912. cmDynamicLoader::FlushCache();
  913. #endif
  914. if (uv_loop_t* loop = uv_default_loop()) {
  915. uv_loop_close(loop);
  916. }
  917. return ret;
  918. }