cmakemain.cxx 35 KB

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