cmakemain.cxx 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083
  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 (except exit code from SCRIPT_MODE).
  359. // Windows tools do not always interpret negative return values as errors.
  360. if (res != 0) {
  361. auto scriptModeExitCode =
  362. cm.HasScriptModeExitCode() ? cm.GetScriptModeExitCode() : 0;
  363. res = scriptModeExitCode ? scriptModeExitCode : 1;
  364. #ifdef CMake_ENABLE_DEBUGGER
  365. cm.StopDebuggerIfNeeded(res);
  366. #endif
  367. return res;
  368. }
  369. #ifdef CMake_ENABLE_DEBUGGER
  370. cm.StopDebuggerIfNeeded(0);
  371. #endif
  372. return 0;
  373. }
  374. #ifndef CMAKE_BOOTSTRAP
  375. int extract_job_number(std::string const& command,
  376. std::string const& jobString)
  377. {
  378. int jobs = -1;
  379. unsigned long numJobs = 0;
  380. if (jobString.empty()) {
  381. jobs = cmake::DEFAULT_BUILD_PARALLEL_LEVEL;
  382. } else if (cmStrToULong(jobString, &numJobs)) {
  383. if (numJobs == 0) {
  384. std::cerr
  385. << "The <jobs> value requires a positive integer argument.\n\n";
  386. } else if (numJobs > INT_MAX) {
  387. std::cerr << "The <jobs> value is too large.\n\n";
  388. } else {
  389. jobs = static_cast<int>(numJobs);
  390. }
  391. } else {
  392. std::cerr << "'" << command << "' invalid number '" << jobString
  393. << "' given.\n\n";
  394. }
  395. return jobs;
  396. }
  397. #endif
  398. int do_build(int ac, char const* const* av)
  399. {
  400. #ifdef CMAKE_BOOTSTRAP
  401. std::cerr << "This cmake does not support --build\n";
  402. return -1;
  403. #else
  404. int jobs = cmake::NO_BUILD_PARALLEL_LEVEL;
  405. std::vector<std::string> targets;
  406. std::string config;
  407. std::string dir;
  408. std::vector<std::string> nativeOptions;
  409. bool nativeOptionsPassed = false;
  410. bool cleanFirst = false;
  411. bool foundClean = false;
  412. bool foundNonClean = false;
  413. PackageResolveMode resolveMode = PackageResolveMode::Default;
  414. bool verbose = cmSystemTools::HasEnv("VERBOSE");
  415. std::string presetName;
  416. bool listPresets = false;
  417. auto jLambda = [&](std::string const& value) -> bool {
  418. jobs = extract_job_number("-j", value);
  419. if (jobs < 0) {
  420. dir.clear();
  421. }
  422. return true;
  423. };
  424. auto parallelLambda = [&](std::string const& value) -> bool {
  425. jobs = extract_job_number("--parallel", value);
  426. if (jobs < 0) {
  427. dir.clear();
  428. }
  429. return true;
  430. };
  431. auto targetLambda = [&](std::string const& value) -> bool {
  432. if (!value.empty()) {
  433. cmList values{ value };
  434. for (auto const& v : values) {
  435. targets.emplace_back(v);
  436. if (v == "clean") {
  437. foundClean = true;
  438. } else {
  439. foundNonClean = true;
  440. }
  441. }
  442. return true;
  443. }
  444. return false;
  445. };
  446. auto resolvePackagesLambda = [&](std::string const& value) -> bool {
  447. std::string v = value;
  448. std::transform(v.begin(), v.end(), v.begin(), ::tolower);
  449. if (v == "on") {
  450. resolveMode = PackageResolveMode::Force;
  451. } else if (v == "only") {
  452. resolveMode = PackageResolveMode::OnlyResolve;
  453. } else if (v == "off") {
  454. resolveMode = PackageResolveMode::Disable;
  455. } else {
  456. return false;
  457. }
  458. return true;
  459. };
  460. auto verboseLambda = [&](std::string const&) -> bool {
  461. verbose = true;
  462. return true;
  463. };
  464. using CommandArgument =
  465. cmCommandLineArgument<bool(std::string const& value)>;
  466. std::vector<CommandArgument> arguments = {
  467. CommandArgument{ "--preset", CommandArgument::Values::One,
  468. CommandArgument::setToValue(presetName) },
  469. CommandArgument{ "--list-presets", CommandArgument::Values::Zero,
  470. CommandArgument::setToTrue(listPresets) },
  471. CommandArgument{ "-j", CommandArgument::Values::ZeroOrOne,
  472. CommandArgument::RequiresSeparator::No, jLambda },
  473. CommandArgument{ "--parallel", CommandArgument::Values::ZeroOrOne,
  474. CommandArgument::RequiresSeparator::No, parallelLambda },
  475. CommandArgument{ "-t", CommandArgument::Values::OneOrMore, targetLambda },
  476. CommandArgument{ "--target", CommandArgument::Values::OneOrMore,
  477. targetLambda },
  478. CommandArgument{ "--config", CommandArgument::Values::One,
  479. CommandArgument::setToValue(config) },
  480. CommandArgument{ "--clean-first", CommandArgument::Values::Zero,
  481. CommandArgument::setToTrue(cleanFirst) },
  482. CommandArgument{ "--resolve-package-references",
  483. CommandArgument::Values::One, resolvePackagesLambda },
  484. CommandArgument{ "-v", CommandArgument::Values::Zero, verboseLambda },
  485. CommandArgument{ "--verbose", CommandArgument::Values::Zero,
  486. verboseLambda },
  487. /* legacy option no-op*/
  488. CommandArgument{ "--use-stderr", CommandArgument::Values::Zero,
  489. [](std::string const&) -> bool { return true; } },
  490. CommandArgument{ "--", CommandArgument::Values::Zero,
  491. CommandArgument::setToTrue(nativeOptionsPassed) },
  492. };
  493. if (ac >= 3) {
  494. std::vector<std::string> inputArgs;
  495. inputArgs.reserve(ac - 2);
  496. cm::append(inputArgs, av + 2, av + ac);
  497. decltype(inputArgs.size()) i = 0;
  498. for (; i < inputArgs.size() && !nativeOptionsPassed; ++i) {
  499. std::string const& arg = inputArgs[i];
  500. bool matched = false;
  501. bool parsed = false;
  502. for (auto const& m : arguments) {
  503. matched = m.matches(arg);
  504. if (matched) {
  505. parsed = m.parse(arg, i, inputArgs);
  506. break;
  507. }
  508. }
  509. if (!matched && i == 0) {
  510. dir = cmSystemTools::CollapseFullPath(arg);
  511. matched = true;
  512. parsed = true;
  513. }
  514. if (!(matched && parsed)) {
  515. dir.clear();
  516. if (!matched) {
  517. std::cerr << "Unknown argument " << arg << std::endl;
  518. }
  519. break;
  520. }
  521. }
  522. if (nativeOptionsPassed) {
  523. cm::append(nativeOptions, inputArgs.begin() + i, inputArgs.end());
  524. }
  525. }
  526. if (foundClean && foundNonClean) {
  527. std::cerr << "Error: Building 'clean' and other targets together "
  528. "is not supported."
  529. << std::endl;
  530. dir.clear();
  531. }
  532. if (jobs == cmake::NO_BUILD_PARALLEL_LEVEL) {
  533. std::string parallel;
  534. if (cmSystemTools::GetEnv("CMAKE_BUILD_PARALLEL_LEVEL", parallel)) {
  535. if (parallel.empty()) {
  536. jobs = cmake::DEFAULT_BUILD_PARALLEL_LEVEL;
  537. } else {
  538. unsigned long numJobs = 0;
  539. if (cmStrToULong(parallel, &numJobs)) {
  540. if (numJobs == 0) {
  541. std::cerr << "The CMAKE_BUILD_PARALLEL_LEVEL environment variable "
  542. "requires a positive integer argument.\n\n";
  543. dir.clear();
  544. } else if (numJobs > INT_MAX) {
  545. std::cerr << "The CMAKE_BUILD_PARALLEL_LEVEL environment variable "
  546. "is too large.\n\n";
  547. dir.clear();
  548. } else {
  549. jobs = static_cast<int>(numJobs);
  550. }
  551. } else {
  552. std::cerr << "'CMAKE_BUILD_PARALLEL_LEVEL' environment variable\n"
  553. << "invalid number '" << parallel << "' given.\n\n";
  554. dir.clear();
  555. }
  556. }
  557. }
  558. }
  559. if (dir.empty() && presetName.empty() && !listPresets) {
  560. /* clang-format off */
  561. std::cerr <<
  562. "Usage: cmake --build <dir> "
  563. " [options] [-- [native-options]]\n"
  564. " cmake --build --preset <preset>"
  565. " [options] [-- [native-options]]\n"
  566. "Options:\n"
  567. " <dir> = Project binary directory to be built.\n"
  568. " --preset <preset>, --preset=<preset>\n"
  569. " = Specify a build preset.\n"
  570. " --list-presets[=<type>]\n"
  571. " = List available build presets.\n"
  572. " --parallel [<jobs>], -j [<jobs>]\n"
  573. " = Build in parallel using the given number of jobs. \n"
  574. " If <jobs> is omitted the native build tool's \n"
  575. " default number is used.\n"
  576. " The CMAKE_BUILD_PARALLEL_LEVEL environment "
  577. "variable\n"
  578. " specifies a default parallel level when this "
  579. "option\n"
  580. " is not given.\n"
  581. " -t <tgt>..., --target <tgt>...\n"
  582. " = Build <tgt> instead of default targets.\n"
  583. " --config <cfg> = For multi-configuration tools, choose <cfg>.\n"
  584. " --clean-first = Build target 'clean' first, then build.\n"
  585. " (To clean only, use --target 'clean'.)\n"
  586. " --resolve-package-references={on|only|off}\n"
  587. " = Restore/resolve package references during build.\n"
  588. " -v, --verbose = Enable verbose output - if supported - including\n"
  589. " the build commands to be executed. \n"
  590. " -- = Pass remaining options to the native tool.\n"
  591. ;
  592. /* clang-format on */
  593. return 1;
  594. }
  595. cmake cm(cmake::RoleInternal, cmState::Project);
  596. cmSystemTools::SetMessageCallback(
  597. [&cm](const std::string& msg, const cmMessageMetadata& md) {
  598. cmakemainMessageCallback(msg, md, &cm);
  599. });
  600. cm.SetProgressCallback([&cm](const std::string& msg, float prog) {
  601. cmakemainProgressCallback(msg, prog, &cm);
  602. });
  603. cmBuildOptions buildOptions(cleanFirst, false, resolveMode);
  604. return cm.Build(jobs, std::move(dir), std::move(targets), std::move(config),
  605. std::move(nativeOptions), buildOptions, verbose, presetName,
  606. listPresets);
  607. #endif
  608. }
  609. bool parse_default_directory_permissions(const std::string& permissions,
  610. std::string& parsedPermissionsVar)
  611. {
  612. std::vector<std::string> parsedPermissions;
  613. enum Doing
  614. {
  615. DoingNone,
  616. DoingOwner,
  617. DoingGroup,
  618. DoingWorld,
  619. DoingOwnerAssignment,
  620. DoingGroupAssignment,
  621. DoingWorldAssignment,
  622. };
  623. Doing doing = DoingNone;
  624. auto uniquePushBack = [&parsedPermissions](const std::string& e) {
  625. if (std::find(parsedPermissions.begin(), parsedPermissions.end(), e) ==
  626. parsedPermissions.end()) {
  627. parsedPermissions.push_back(e);
  628. }
  629. };
  630. for (auto const& e : permissions) {
  631. switch (doing) {
  632. case DoingNone:
  633. if (e == 'u') {
  634. doing = DoingOwner;
  635. } else if (e == 'g') {
  636. doing = DoingGroup;
  637. } else if (e == 'o') {
  638. doing = DoingWorld;
  639. } else {
  640. return false;
  641. }
  642. break;
  643. case DoingOwner:
  644. if (e == '=') {
  645. doing = DoingOwnerAssignment;
  646. } else {
  647. return false;
  648. }
  649. break;
  650. case DoingGroup:
  651. if (e == '=') {
  652. doing = DoingGroupAssignment;
  653. } else {
  654. return false;
  655. }
  656. break;
  657. case DoingWorld:
  658. if (e == '=') {
  659. doing = DoingWorldAssignment;
  660. } else {
  661. return false;
  662. }
  663. break;
  664. case DoingOwnerAssignment:
  665. if (e == 'r') {
  666. uniquePushBack("OWNER_READ");
  667. } else if (e == 'w') {
  668. uniquePushBack("OWNER_WRITE");
  669. } else if (e == 'x') {
  670. uniquePushBack("OWNER_EXECUTE");
  671. } else if (e == ',') {
  672. doing = DoingNone;
  673. } else {
  674. return false;
  675. }
  676. break;
  677. case DoingGroupAssignment:
  678. if (e == 'r') {
  679. uniquePushBack("GROUP_READ");
  680. } else if (e == 'w') {
  681. uniquePushBack("GROUP_WRITE");
  682. } else if (e == 'x') {
  683. uniquePushBack("GROUP_EXECUTE");
  684. } else if (e == ',') {
  685. doing = DoingNone;
  686. } else {
  687. return false;
  688. }
  689. break;
  690. case DoingWorldAssignment:
  691. if (e == 'r') {
  692. uniquePushBack("WORLD_READ");
  693. } else if (e == 'w') {
  694. uniquePushBack("WORLD_WRITE");
  695. } else if (e == 'x') {
  696. uniquePushBack("WORLD_EXECUTE");
  697. } else if (e == ',') {
  698. doing = DoingNone;
  699. } else {
  700. return false;
  701. }
  702. break;
  703. }
  704. }
  705. if (doing != DoingOwnerAssignment && doing != DoingGroupAssignment &&
  706. doing != DoingWorldAssignment) {
  707. return false;
  708. }
  709. std::ostringstream oss;
  710. for (auto i = 0u; i < parsedPermissions.size(); i++) {
  711. if (i != 0) {
  712. oss << ";";
  713. }
  714. oss << parsedPermissions[i];
  715. }
  716. parsedPermissionsVar = oss.str();
  717. return true;
  718. }
  719. int do_install(int ac, char const* const* av)
  720. {
  721. #ifdef CMAKE_BOOTSTRAP
  722. std::cerr << "This cmake does not support --install\n";
  723. return -1;
  724. #else
  725. assert(1 < ac);
  726. std::string config;
  727. std::string component;
  728. std::string defaultDirectoryPermissions;
  729. std::string prefix;
  730. std::string dir;
  731. bool strip = false;
  732. bool verbose = cmSystemTools::HasEnv("VERBOSE");
  733. auto verboseLambda = [&](std::string const&) -> bool {
  734. verbose = true;
  735. return true;
  736. };
  737. using CommandArgument =
  738. cmCommandLineArgument<bool(std::string const& value)>;
  739. std::vector<CommandArgument> arguments = {
  740. CommandArgument{ "--config", CommandArgument::Values::One,
  741. CommandArgument::setToValue(config) },
  742. CommandArgument{ "--component", CommandArgument::Values::One,
  743. CommandArgument::setToValue(component) },
  744. CommandArgument{
  745. "--default-directory-permissions", CommandArgument::Values::One,
  746. CommandArgument::setToValue(defaultDirectoryPermissions) },
  747. CommandArgument{ "--prefix", CommandArgument::Values::One,
  748. CommandArgument::setToValue(prefix) },
  749. CommandArgument{ "--strip", CommandArgument::Values::Zero,
  750. CommandArgument::setToTrue(strip) },
  751. CommandArgument{ "-v", CommandArgument::Values::Zero, verboseLambda },
  752. CommandArgument{ "--verbose", CommandArgument::Values::Zero,
  753. verboseLambda }
  754. };
  755. if (ac >= 3) {
  756. dir = cmSystemTools::CollapseFullPath(av[2]);
  757. std::vector<std::string> inputArgs;
  758. inputArgs.reserve(ac - 3);
  759. cm::append(inputArgs, av + 3, av + ac);
  760. for (decltype(inputArgs.size()) i = 0; i < inputArgs.size(); ++i) {
  761. std::string const& arg = inputArgs[i];
  762. bool matched = false;
  763. bool parsed = false;
  764. for (auto const& m : arguments) {
  765. matched = m.matches(arg);
  766. if (matched) {
  767. parsed = m.parse(arg, i, inputArgs);
  768. break;
  769. }
  770. }
  771. if (!(matched && parsed)) {
  772. dir.clear();
  773. if (!matched) {
  774. std::cerr << "Unknown argument " << arg << std::endl;
  775. }
  776. break;
  777. }
  778. }
  779. }
  780. if (dir.empty()) {
  781. /* clang-format off */
  782. std::cerr <<
  783. "Usage: cmake --install <dir> [options]\n"
  784. "Options:\n"
  785. " <dir> = Project binary directory to install.\n"
  786. " --config <cfg> = For multi-configuration tools, choose <cfg>.\n"
  787. " --component <comp> = Component-based install. Only install <comp>.\n"
  788. " --default-directory-permissions <permission> \n"
  789. " Default install permission. Use default permission <permission>.\n"
  790. " --prefix <prefix> = The installation prefix CMAKE_INSTALL_PREFIX.\n"
  791. " --strip = Performing install/strip.\n"
  792. " -v --verbose = Enable verbose output.\n"
  793. ;
  794. /* clang-format on */
  795. return 1;
  796. }
  797. cmake cm(cmake::RoleScript, cmState::Script);
  798. cmSystemTools::SetMessageCallback(
  799. [&cm](const std::string& msg, const cmMessageMetadata& md) {
  800. cmakemainMessageCallback(msg, md, &cm);
  801. });
  802. cm.SetProgressCallback([&cm](const std::string& msg, float prog) {
  803. cmakemainProgressCallback(msg, prog, &cm);
  804. });
  805. cm.SetHomeDirectory("");
  806. cm.SetHomeOutputDirectory("");
  807. cm.SetDebugOutputOn(verbose);
  808. cm.SetWorkingMode(cmake::SCRIPT_MODE);
  809. std::vector<std::string> args{ av[0] };
  810. if (!prefix.empty()) {
  811. args.emplace_back("-DCMAKE_INSTALL_PREFIX=" + prefix);
  812. }
  813. if (!component.empty()) {
  814. args.emplace_back("-DCMAKE_INSTALL_COMPONENT=" + component);
  815. }
  816. if (strip) {
  817. args.emplace_back("-DCMAKE_INSTALL_DO_STRIP=1");
  818. }
  819. if (!config.empty()) {
  820. args.emplace_back("-DCMAKE_INSTALL_CONFIG_NAME=" + config);
  821. }
  822. if (!defaultDirectoryPermissions.empty()) {
  823. std::string parsedPermissionsVar;
  824. if (!parse_default_directory_permissions(defaultDirectoryPermissions,
  825. parsedPermissionsVar)) {
  826. std::cerr << "--default-directory-permissions is in incorrect format"
  827. << std::endl;
  828. return 1;
  829. }
  830. args.emplace_back("-DCMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS=" +
  831. parsedPermissionsVar);
  832. }
  833. args.emplace_back("-P");
  834. args.emplace_back(dir + "/cmake_install.cmake");
  835. return cm.Run(args) ? 1 : 0;
  836. #endif
  837. }
  838. int do_workflow(int ac, char const* const* av)
  839. {
  840. #ifdef CMAKE_BOOTSTRAP
  841. std::cerr << "This cmake does not support --workflow\n";
  842. return -1;
  843. #else
  844. using WorkflowListPresets = cmake::WorkflowListPresets;
  845. using WorkflowFresh = cmake::WorkflowFresh;
  846. std::string presetName;
  847. auto listPresets = WorkflowListPresets::No;
  848. auto fresh = WorkflowFresh::No;
  849. using CommandArgument =
  850. cmCommandLineArgument<bool(std::string const& value)>;
  851. std::vector<CommandArgument> arguments = {
  852. CommandArgument{ "--preset", CommandArgument::Values::One,
  853. CommandArgument::setToValue(presetName) },
  854. CommandArgument{ "--list-presets", CommandArgument::Values::Zero,
  855. [&listPresets](const std::string&) -> bool {
  856. listPresets = WorkflowListPresets::Yes;
  857. return true;
  858. } },
  859. CommandArgument{ "--fresh", CommandArgument::Values::Zero,
  860. [&fresh](const std::string&) -> bool {
  861. fresh = WorkflowFresh::Yes;
  862. return true;
  863. } },
  864. };
  865. std::vector<std::string> inputArgs;
  866. inputArgs.reserve(ac - 2);
  867. cm::append(inputArgs, av + 2, av + ac);
  868. decltype(inputArgs.size()) i = 0;
  869. for (; i < inputArgs.size(); ++i) {
  870. std::string const& arg = inputArgs[i];
  871. bool matched = false;
  872. bool parsed = false;
  873. for (auto const& m : arguments) {
  874. matched = m.matches(arg);
  875. if (matched) {
  876. parsed = m.parse(arg, i, inputArgs);
  877. break;
  878. }
  879. }
  880. if (!(matched && parsed)) {
  881. if (!matched) {
  882. presetName.clear();
  883. listPresets = WorkflowListPresets::No;
  884. std::cerr << "Unknown argument " << arg << std::endl;
  885. }
  886. break;
  887. }
  888. }
  889. if (presetName.empty() && listPresets == WorkflowListPresets::No) {
  890. /* clang-format off */
  891. std::cerr <<
  892. "Usage: cmake --workflow [options]\n"
  893. "Options:\n"
  894. " --preset <preset> = Workflow preset to execute.\n"
  895. " --list-presets = List available workflow presets.\n"
  896. " --fresh = Configure a fresh build tree, removing any "
  897. "existing cache file.\n"
  898. ;
  899. /* clang-format on */
  900. return 1;
  901. }
  902. cmake cm(cmake::RoleInternal, cmState::Project);
  903. cmSystemTools::SetMessageCallback(
  904. [&cm](const std::string& msg, const cmMessageMetadata& md) {
  905. cmakemainMessageCallback(msg, md, &cm);
  906. });
  907. cm.SetProgressCallback([&cm](const std::string& msg, float prog) {
  908. cmakemainProgressCallback(msg, prog, &cm);
  909. });
  910. return cm.Workflow(presetName, listPresets, fresh);
  911. #endif
  912. }
  913. int do_open(int ac, char const* const* av)
  914. {
  915. #ifdef CMAKE_BOOTSTRAP
  916. std::cerr << "This cmake does not support --open\n";
  917. return -1;
  918. #else
  919. std::string dir;
  920. enum Doing
  921. {
  922. DoingNone,
  923. DoingDir,
  924. };
  925. Doing doing = DoingDir;
  926. for (int i = 2; i < ac; ++i) {
  927. switch (doing) {
  928. case DoingDir:
  929. dir = cmSystemTools::CollapseFullPath(av[i]);
  930. doing = DoingNone;
  931. break;
  932. default:
  933. std::cerr << "Unknown argument " << av[i] << std::endl;
  934. dir.clear();
  935. break;
  936. }
  937. }
  938. if (dir.empty()) {
  939. std::cerr << "Usage: cmake --open <dir>\n";
  940. return 1;
  941. }
  942. cmake cm(cmake::RoleInternal, cmState::Unknown);
  943. cmSystemTools::SetMessageCallback(
  944. [&cm](const std::string& msg, const cmMessageMetadata& md) {
  945. cmakemainMessageCallback(msg, md, &cm);
  946. });
  947. cm.SetProgressCallback([&cm](const std::string& msg, float prog) {
  948. cmakemainProgressCallback(msg, prog, &cm);
  949. });
  950. return cm.Open(dir, false) ? 0 : 1;
  951. #endif
  952. }
  953. } // namespace
  954. int main(int ac, char const* const* av)
  955. {
  956. cmSystemTools::EnsureStdPipes();
  957. // Replace streambuf so we can output Unicode to console
  958. auto consoleBuf = cm::make_unique<cmConsoleBuf>();
  959. consoleBuf->SetUTF8Pipes();
  960. cmsys::Encoding::CommandLineArguments args =
  961. cmsys::Encoding::CommandLineArguments::Main(ac, av);
  962. ac = args.argc();
  963. av = args.argv();
  964. cmSystemTools::InitializeLibUV();
  965. cmSystemTools::FindCMakeResources(av[0]);
  966. if (ac > 1) {
  967. if (strcmp(av[1], "--build") == 0) {
  968. return do_build(ac, av);
  969. }
  970. if (strcmp(av[1], "--install") == 0) {
  971. return do_install(ac, av);
  972. }
  973. if (strcmp(av[1], "--open") == 0) {
  974. return do_open(ac, av);
  975. }
  976. if (strcmp(av[1], "--workflow") == 0) {
  977. return do_workflow(ac, av);
  978. }
  979. if (strcmp(av[1], "-E") == 0) {
  980. return do_command(ac, av, std::move(consoleBuf));
  981. }
  982. }
  983. int ret = do_cmake(ac, av);
  984. #ifndef CMAKE_BOOTSTRAP
  985. cmDynamicLoader::FlushCache();
  986. #endif
  987. if (uv_loop_t* loop = uv_default_loop()) {
  988. uv_loop_close(loop);
  989. }
  990. return ret;
  991. }