cmakemain.cxx 34 KB

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