cmakemain.cxx 38 KB

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