cmakemain.cxx 34 KB

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