cmakemain.cxx 34 KB

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