cmakemain.cxx 33 KB

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