cmakemain.cxx 33 KB

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