cmakemain.cxx 31 KB

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