cmakemain.cxx 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158
  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(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(cmState::Role::Project);
  330. int ret = cm.GetSystemInformation(parsedArgs);
  331. return ret;
  332. }
  333. cmState::Role role = cmState::Role::Internal;
  334. switch (workingMode) {
  335. case cmake::NORMAL_MODE:
  336. case cmake::HELP_MODE:
  337. role = cmState::Role::Project;
  338. break;
  339. case cmake::SCRIPT_MODE:
  340. role = cmState::Role::Script;
  341. break;
  342. case cmake::FIND_PACKAGE_MODE:
  343. role = cmState::Role::FindPackage;
  344. break;
  345. }
  346. cmake cm(role);
  347. cmSystemTools::SetMessageCallback(
  348. [&cm](std::string const& msg, cmMessageMetadata const& md) {
  349. cmakemainMessageCallback(msg, md, &cm);
  350. });
  351. cm.SetProgressCallback([&cm](std::string const& msg, float prog) {
  352. cmakemainProgressCallback(msg, prog, &cm);
  353. });
  354. cm.SetWorkingMode(workingMode);
  355. int res = cm.Run(parsedArgs, view_only);
  356. if (list_cached || list_all_cached) {
  357. std::cout << "-- Cache values" << std::endl;
  358. std::vector<std::string> keys = cm.GetState()->GetCacheEntryKeys();
  359. cmsys::RegularExpression regex_var_name;
  360. if (!filter_var_name.empty()) {
  361. regex_var_name.compile(filter_var_name);
  362. }
  363. for (std::string const& k : keys) {
  364. if (regex_var_name.is_valid() && !regex_var_name.find(k)) {
  365. continue;
  366. }
  367. cmStateEnums::CacheEntryType t = cm.GetState()->GetCacheEntryType(k);
  368. if (t != cmStateEnums::INTERNAL && t != cmStateEnums::STATIC &&
  369. t != cmStateEnums::UNINITIALIZED) {
  370. cmValue advancedProp =
  371. cm.GetState()->GetCacheEntryProperty(k, "ADVANCED");
  372. if (list_all_cached || !advancedProp) {
  373. if (list_help) {
  374. cmValue help =
  375. cm.GetState()->GetCacheEntryProperty(k, "HELPSTRING");
  376. std::cout << "// " << (help ? *help : "") << std::endl;
  377. }
  378. std::cout << k << ":" << cmState::CacheEntryTypeToString(t) << "="
  379. << cm.GetState()->GetSafeCacheEntryValue(k) << std::endl;
  380. if (list_help) {
  381. std::cout << std::endl;
  382. }
  383. }
  384. }
  385. }
  386. }
  387. // Always return a non-negative value (except exit code from SCRIPT_MODE).
  388. // Windows tools do not always interpret negative return values as errors.
  389. if (res != 0) {
  390. auto scriptModeExitCode =
  391. cm.HasScriptModeExitCode() ? cm.GetScriptModeExitCode() : 0;
  392. res = scriptModeExitCode ? scriptModeExitCode : 1;
  393. #ifdef CMake_ENABLE_DEBUGGER
  394. cm.StopDebuggerIfNeeded(res);
  395. #endif
  396. return res;
  397. }
  398. #ifdef CMake_ENABLE_DEBUGGER
  399. cm.StopDebuggerIfNeeded(0);
  400. #endif
  401. return 0;
  402. }
  403. #ifndef CMAKE_BOOTSTRAP
  404. int extract_job_number(std::string const& command,
  405. std::string const& jobString)
  406. {
  407. int jobs = -1;
  408. unsigned long numJobs = 0;
  409. if (jobString.empty()) {
  410. jobs = cmake::DEFAULT_BUILD_PARALLEL_LEVEL;
  411. } else if (cmStrToULong(jobString, &numJobs)) {
  412. if (numJobs == 0) {
  413. std::cerr
  414. << "The <jobs> value requires a positive integer argument.\n\n";
  415. } else if (numJobs > INT_MAX) {
  416. std::cerr << "The <jobs> value is too large.\n\n";
  417. } else {
  418. jobs = static_cast<int>(numJobs);
  419. }
  420. } else {
  421. std::cerr << "'" << command << "' invalid number '" << jobString
  422. << "' given.\n\n";
  423. }
  424. return jobs;
  425. }
  426. std::function<bool(std::string const&)> extract_job_number_lambda_builder(
  427. std::string& dir, int& jobs, std::string const& flag)
  428. {
  429. return [&dir, &jobs, flag](std::string const& value) -> bool {
  430. jobs = extract_job_number(flag, value);
  431. if (jobs < 0) {
  432. dir.clear();
  433. }
  434. return true;
  435. };
  436. };
  437. #endif
  438. int do_build(int ac, char const* const* av)
  439. {
  440. #ifdef CMAKE_BOOTSTRAP
  441. std::cerr << "This cmake does not support --build\n";
  442. return -1;
  443. #else
  444. int jobs = cmake::NO_BUILD_PARALLEL_LEVEL;
  445. std::vector<std::string> targets;
  446. std::string config;
  447. std::string dir;
  448. std::vector<std::string> nativeOptions;
  449. bool nativeOptionsPassed = false;
  450. bool cleanFirst = false;
  451. bool foundClean = false;
  452. bool foundNonClean = false;
  453. PackageResolveMode resolveMode = PackageResolveMode::Default;
  454. bool verbose = cmSystemTools::HasEnv("VERBOSE");
  455. std::string presetName;
  456. bool listPresets = false;
  457. auto jLambda = extract_job_number_lambda_builder(dir, jobs, "-j");
  458. auto parallelLambda =
  459. extract_job_number_lambda_builder(dir, jobs, "--parallel");
  460. auto targetLambda = [&](std::string const& value) -> bool {
  461. if (!value.empty()) {
  462. cmList values{ value };
  463. for (auto const& v : values) {
  464. targets.emplace_back(v);
  465. if (v == "clean") {
  466. foundClean = true;
  467. } else {
  468. foundNonClean = true;
  469. }
  470. }
  471. return true;
  472. }
  473. return false;
  474. };
  475. auto resolvePackagesLambda = [&](std::string const& value) -> bool {
  476. std::string v = value;
  477. std::transform(v.begin(), v.end(), v.begin(), ::tolower);
  478. if (v == "on") {
  479. resolveMode = PackageResolveMode::Force;
  480. } else if (v == "only") {
  481. resolveMode = PackageResolveMode::OnlyResolve;
  482. } else if (v == "off") {
  483. resolveMode = PackageResolveMode::Disable;
  484. } else {
  485. return false;
  486. }
  487. return true;
  488. };
  489. auto verboseLambda = [&](std::string const&) -> bool {
  490. verbose = true;
  491. return true;
  492. };
  493. using CommandArgument =
  494. cmCommandLineArgument<bool(std::string const& value)>;
  495. std::vector<CommandArgument> arguments = {
  496. CommandArgument{ "--preset", CommandArgument::Values::One,
  497. CommandArgument::setToValue(presetName) },
  498. CommandArgument{ "--list-presets", CommandArgument::Values::Zero,
  499. CommandArgument::setToTrue(listPresets) },
  500. CommandArgument{ "-j", CommandArgument::Values::ZeroOrOne,
  501. CommandArgument::RequiresSeparator::No, jLambda },
  502. CommandArgument{ "--parallel", CommandArgument::Values::ZeroOrOne,
  503. CommandArgument::RequiresSeparator::No, parallelLambda },
  504. CommandArgument{ "-t", CommandArgument::Values::OneOrMore, targetLambda },
  505. CommandArgument{ "--target", CommandArgument::Values::OneOrMore,
  506. targetLambda },
  507. CommandArgument{ "--config", CommandArgument::Values::One,
  508. CommandArgument::setToValue(config) },
  509. CommandArgument{ "--clean-first", CommandArgument::Values::Zero,
  510. CommandArgument::setToTrue(cleanFirst) },
  511. CommandArgument{ "--resolve-package-references",
  512. CommandArgument::Values::One, resolvePackagesLambda },
  513. CommandArgument{ "-v", CommandArgument::Values::Zero, verboseLambda },
  514. CommandArgument{ "--verbose", CommandArgument::Values::Zero,
  515. verboseLambda },
  516. /* legacy option no-op*/
  517. CommandArgument{ "--use-stderr", CommandArgument::Values::Zero,
  518. [](std::string const&) -> bool { return true; } },
  519. CommandArgument{ "--", CommandArgument::Values::Zero,
  520. CommandArgument::setToTrue(nativeOptionsPassed) },
  521. };
  522. if (ac >= 3) {
  523. std::vector<std::string> inputArgs;
  524. inputArgs.reserve(ac - 2);
  525. cm::append(inputArgs, av + 2, av + ac);
  526. decltype(inputArgs.size()) i = 0;
  527. for (; i < inputArgs.size() && !nativeOptionsPassed; ++i) {
  528. std::string const& arg = inputArgs[i];
  529. bool matched = false;
  530. bool parsed = false;
  531. for (auto const& m : arguments) {
  532. matched = m.matches(arg);
  533. if (matched) {
  534. parsed = m.parse(arg, i, inputArgs);
  535. break;
  536. }
  537. }
  538. if (!matched && i == 0) {
  539. dir = cmSystemTools::ToNormalizedPathOnDisk(arg);
  540. matched = true;
  541. parsed = true;
  542. }
  543. if (!(matched && parsed)) {
  544. dir.clear();
  545. if (!matched) {
  546. std::cerr << "Unknown argument " << arg << std::endl;
  547. }
  548. break;
  549. }
  550. }
  551. if (nativeOptionsPassed) {
  552. cm::append(nativeOptions, inputArgs.begin() + i, inputArgs.end());
  553. }
  554. }
  555. if (foundClean && foundNonClean) {
  556. std::cerr << "Error: Building 'clean' and other targets together "
  557. "is not supported."
  558. << std::endl;
  559. dir.clear();
  560. }
  561. if (jobs == cmake::NO_BUILD_PARALLEL_LEVEL) {
  562. std::string parallel;
  563. if (cmSystemTools::GetEnv("CMAKE_BUILD_PARALLEL_LEVEL", parallel)) {
  564. if (parallel.empty()) {
  565. jobs = cmake::DEFAULT_BUILD_PARALLEL_LEVEL;
  566. } else {
  567. unsigned long numJobs = 0;
  568. if (cmStrToULong(parallel, &numJobs)) {
  569. if (numJobs == 0) {
  570. std::cerr << "The CMAKE_BUILD_PARALLEL_LEVEL environment variable "
  571. "requires a positive integer argument.\n\n";
  572. dir.clear();
  573. } else if (numJobs > INT_MAX) {
  574. std::cerr << "The CMAKE_BUILD_PARALLEL_LEVEL environment variable "
  575. "is too large.\n\n";
  576. dir.clear();
  577. } else {
  578. jobs = static_cast<int>(numJobs);
  579. }
  580. } else {
  581. std::cerr << "'CMAKE_BUILD_PARALLEL_LEVEL' environment variable\n"
  582. << "invalid number '" << parallel << "' given.\n\n";
  583. dir.clear();
  584. }
  585. }
  586. }
  587. }
  588. if (dir.empty() && presetName.empty() && !listPresets) {
  589. /* clang-format off */
  590. std::cerr <<
  591. "Usage: cmake --build <dir> "
  592. " [options] [-- [native-options]]\n"
  593. " cmake --build --preset <preset>"
  594. " [options] [-- [native-options]]\n"
  595. "Options:\n"
  596. " <dir> = Project binary directory to be built.\n"
  597. " --preset <preset>, --preset=<preset>\n"
  598. " = Specify a build preset.\n"
  599. " --list-presets[=<type>]\n"
  600. " = List available build presets.\n"
  601. " --parallel [<jobs>], -j [<jobs>]\n"
  602. " = Build in parallel using the given number of jobs. \n"
  603. " If <jobs> is omitted the native build tool's \n"
  604. " default number is used.\n"
  605. " The CMAKE_BUILD_PARALLEL_LEVEL environment "
  606. "variable\n"
  607. " specifies a default parallel level when this "
  608. "option\n"
  609. " is not given.\n"
  610. " -t <tgt>..., --target <tgt>...\n"
  611. " = Build <tgt> instead of default targets.\n"
  612. " --config <cfg> = For multi-configuration tools, choose <cfg>.\n"
  613. " --clean-first = Build target 'clean' first, then build.\n"
  614. " (To clean only, use --target 'clean'.)\n"
  615. " --resolve-package-references={on|only|off}\n"
  616. " = Restore/resolve package references during build.\n"
  617. " -v, --verbose = Enable verbose output - if supported - including\n"
  618. " the build commands to be executed. \n"
  619. " -- = Pass remaining options to the native tool.\n"
  620. ;
  621. /* clang-format on */
  622. return 1;
  623. }
  624. cmake cm(cmState::Role::Internal);
  625. cmSystemTools::SetMessageCallback(
  626. [&cm](std::string const& msg, cmMessageMetadata const& md) {
  627. cmakemainMessageCallback(msg, md, &cm);
  628. });
  629. cm.SetProgressCallback([&cm](std::string const& msg, float prog) {
  630. cmakemainProgressCallback(msg, prog, &cm);
  631. });
  632. cmBuildOptions buildOptions(cleanFirst, false, resolveMode);
  633. std::vector<std::string> cmd;
  634. cm::append(cmd, av, av + ac);
  635. return cm.Build(jobs, dir, std::move(targets), std::move(config),
  636. std::move(nativeOptions), buildOptions, verbose, presetName,
  637. listPresets, cmd);
  638. #endif
  639. }
  640. bool parse_default_directory_permissions(std::string const& permissions,
  641. std::string& parsedPermissionsVar)
  642. {
  643. std::vector<std::string> parsedPermissions;
  644. enum Doing
  645. {
  646. DoingNone,
  647. DoingOwner,
  648. DoingGroup,
  649. DoingWorld,
  650. DoingOwnerAssignment,
  651. DoingGroupAssignment,
  652. DoingWorldAssignment,
  653. };
  654. Doing doing = DoingNone;
  655. auto uniquePushBack = [&parsedPermissions](std::string const& e) {
  656. if (std::find(parsedPermissions.begin(), parsedPermissions.end(), e) ==
  657. parsedPermissions.end()) {
  658. parsedPermissions.push_back(e);
  659. }
  660. };
  661. for (auto const& e : permissions) {
  662. switch (doing) {
  663. case DoingNone:
  664. if (e == 'u') {
  665. doing = DoingOwner;
  666. } else if (e == 'g') {
  667. doing = DoingGroup;
  668. } else if (e == 'o') {
  669. doing = DoingWorld;
  670. } else {
  671. return false;
  672. }
  673. break;
  674. case DoingOwner:
  675. if (e == '=') {
  676. doing = DoingOwnerAssignment;
  677. } else {
  678. return false;
  679. }
  680. break;
  681. case DoingGroup:
  682. if (e == '=') {
  683. doing = DoingGroupAssignment;
  684. } else {
  685. return false;
  686. }
  687. break;
  688. case DoingWorld:
  689. if (e == '=') {
  690. doing = DoingWorldAssignment;
  691. } else {
  692. return false;
  693. }
  694. break;
  695. case DoingOwnerAssignment:
  696. if (e == 'r') {
  697. uniquePushBack("OWNER_READ");
  698. } else if (e == 'w') {
  699. uniquePushBack("OWNER_WRITE");
  700. } else if (e == 'x') {
  701. uniquePushBack("OWNER_EXECUTE");
  702. } else if (e == ',') {
  703. doing = DoingNone;
  704. } else {
  705. return false;
  706. }
  707. break;
  708. case DoingGroupAssignment:
  709. if (e == 'r') {
  710. uniquePushBack("GROUP_READ");
  711. } else if (e == 'w') {
  712. uniquePushBack("GROUP_WRITE");
  713. } else if (e == 'x') {
  714. uniquePushBack("GROUP_EXECUTE");
  715. } else if (e == ',') {
  716. doing = DoingNone;
  717. } else {
  718. return false;
  719. }
  720. break;
  721. case DoingWorldAssignment:
  722. if (e == 'r') {
  723. uniquePushBack("WORLD_READ");
  724. } else if (e == 'w') {
  725. uniquePushBack("WORLD_WRITE");
  726. } else if (e == 'x') {
  727. uniquePushBack("WORLD_EXECUTE");
  728. } else if (e == ',') {
  729. doing = DoingNone;
  730. } else {
  731. return false;
  732. }
  733. break;
  734. }
  735. }
  736. if (doing != DoingOwnerAssignment && doing != DoingGroupAssignment &&
  737. doing != DoingWorldAssignment) {
  738. return false;
  739. }
  740. std::ostringstream oss;
  741. for (auto i = 0u; i < parsedPermissions.size(); i++) {
  742. if (i != 0) {
  743. oss << ';';
  744. }
  745. oss << parsedPermissions[i];
  746. }
  747. parsedPermissionsVar = oss.str();
  748. return true;
  749. }
  750. int do_install(int ac, char const* const* av)
  751. {
  752. #ifdef CMAKE_BOOTSTRAP
  753. std::cerr << "This cmake does not support --install\n";
  754. return -1;
  755. #else
  756. assert(1 < ac);
  757. std::string config;
  758. std::string component;
  759. std::string defaultDirectoryPermissions;
  760. std::string prefix;
  761. std::string dir;
  762. int jobs = 0;
  763. bool strip = false;
  764. bool verbose = cmSystemTools::HasEnv("VERBOSE");
  765. auto jLambda = extract_job_number_lambda_builder(dir, jobs, "-j");
  766. auto parallelLambda =
  767. extract_job_number_lambda_builder(dir, jobs, "--parallel");
  768. auto verboseLambda = [&](std::string const&) -> bool {
  769. verbose = true;
  770. return true;
  771. };
  772. using CommandArgument =
  773. cmCommandLineArgument<bool(std::string const& value)>;
  774. std::vector<CommandArgument> arguments = {
  775. CommandArgument{ "--config", CommandArgument::Values::One,
  776. CommandArgument::setToValue(config) },
  777. CommandArgument{ "--component", CommandArgument::Values::One,
  778. CommandArgument::setToValue(component) },
  779. CommandArgument{
  780. "--default-directory-permissions", CommandArgument::Values::One,
  781. CommandArgument::setToValue(defaultDirectoryPermissions) },
  782. CommandArgument{ "-j", CommandArgument::Values::One, jLambda },
  783. CommandArgument{ "--parallel", CommandArgument::Values::One,
  784. parallelLambda },
  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::ToNormalizedPathOnDisk(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. " -j <jobs> --parallel <jobs>\n"
  829. " Build in parallel using the given number of jobs. \n"
  830. " The CMAKE_INSTALL_PARALLEL_LEVEL environment variable\n"
  831. " specifies a default parallel level when this option is not given.\n"
  832. " --prefix <prefix> = The installation prefix CMAKE_INSTALL_PREFIX.\n"
  833. " --strip = Performing install/strip.\n"
  834. " -v --verbose = Enable verbose output.\n"
  835. ;
  836. /* clang-format on */
  837. return 1;
  838. }
  839. std::vector<std::string> args{ av[0] };
  840. if (!prefix.empty()) {
  841. args.emplace_back("-DCMAKE_INSTALL_PREFIX=" + prefix);
  842. }
  843. if (!component.empty()) {
  844. args.emplace_back("-DCMAKE_INSTALL_COMPONENT=" + component);
  845. }
  846. if (strip) {
  847. args.emplace_back("-DCMAKE_INSTALL_DO_STRIP=1");
  848. }
  849. if (!defaultDirectoryPermissions.empty()) {
  850. std::string parsedPermissionsVar;
  851. if (!parse_default_directory_permissions(defaultDirectoryPermissions,
  852. parsedPermissionsVar)) {
  853. std::cerr << "--default-directory-permissions is in incorrect format"
  854. << std::endl;
  855. return 1;
  856. }
  857. args.emplace_back("-DCMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS=" +
  858. parsedPermissionsVar);
  859. }
  860. args.emplace_back("-P");
  861. cmInstrumentation instrumentation(dir);
  862. auto handler = cmInstallScriptHandler(dir, component, config, args);
  863. int ret = 0;
  864. if (!jobs && handler.IsParallel()) {
  865. jobs = 1;
  866. auto envvar = cmSystemTools::GetEnvVar("CMAKE_INSTALL_PARALLEL_LEVEL");
  867. if (envvar.has_value()) {
  868. jobs = extract_job_number("", envvar.value());
  869. if (jobs < 1) {
  870. std::cerr << "Value of CMAKE_INSTALL_PARALLEL_LEVEL environment"
  871. " variable must be a positive integer.\n";
  872. return 1;
  873. }
  874. }
  875. }
  876. auto doInstall = [&handler, &verbose, &jobs, &instrumentation]() -> int {
  877. int ret_ = 0;
  878. if (handler.IsParallel()) {
  879. ret_ = handler.Install(jobs, instrumentation);
  880. } else {
  881. for (auto const& script : handler.GetScripts()) {
  882. std::vector<std::string> cmd = script.command;
  883. cmake cm(cmState::Role::Script);
  884. cmSystemTools::SetMessageCallback(
  885. [&cm](std::string const& msg, cmMessageMetadata const& md) {
  886. cmakemainMessageCallback(msg, md, &cm);
  887. });
  888. cm.SetProgressCallback([&cm](std::string const& msg, float prog) {
  889. cmakemainProgressCallback(msg, prog, &cm);
  890. });
  891. cm.SetDebugOutputOn(verbose);
  892. cm.SetWorkingMode(cmake::SCRIPT_MODE);
  893. ret_ = int(bool(cm.Run(cmd)));
  894. }
  895. }
  896. return int(ret_ > 0);
  897. };
  898. std::vector<std::string> cmd;
  899. cm::append(cmd, av, av + ac);
  900. ret = instrumentation.InstrumentCommand(
  901. "cmakeInstall", cmd, [doInstall]() { return doInstall(); });
  902. instrumentation.CollectTimingData(
  903. cmInstrumentationQuery::Hook::PostCMakeInstall);
  904. return ret;
  905. #endif
  906. }
  907. int do_workflow(int ac, char const* const* av)
  908. {
  909. #ifdef CMAKE_BOOTSTRAP
  910. std::cerr << "This cmake does not support --workflow\n";
  911. return -1;
  912. #else
  913. using WorkflowListPresets = cmake::WorkflowListPresets;
  914. using WorkflowFresh = cmake::WorkflowFresh;
  915. std::string presetName;
  916. auto listPresets = WorkflowListPresets::No;
  917. auto fresh = WorkflowFresh::No;
  918. using CommandArgument =
  919. cmCommandLineArgument<bool(std::string const& value)>;
  920. std::vector<CommandArgument> arguments = {
  921. CommandArgument{ "--preset", CommandArgument::Values::One,
  922. CommandArgument::setToValue(presetName) },
  923. CommandArgument{ "--list-presets", CommandArgument::Values::Zero,
  924. [&listPresets](std::string const&) -> bool {
  925. listPresets = WorkflowListPresets::Yes;
  926. return true;
  927. } },
  928. CommandArgument{ "--fresh", CommandArgument::Values::Zero,
  929. [&fresh](std::string const&) -> bool {
  930. fresh = WorkflowFresh::Yes;
  931. return true;
  932. } },
  933. };
  934. std::vector<std::string> inputArgs;
  935. inputArgs.reserve(ac - 2);
  936. cm::append(inputArgs, av + 2, av + ac);
  937. decltype(inputArgs.size()) i = 0;
  938. for (; i < inputArgs.size(); ++i) {
  939. std::string const& arg = inputArgs[i];
  940. bool matched = false;
  941. bool parsed = false;
  942. for (auto const& m : arguments) {
  943. matched = m.matches(arg);
  944. if (matched) {
  945. parsed = m.parse(arg, i, inputArgs);
  946. break;
  947. }
  948. }
  949. if (!matched && i == 0) {
  950. inputArgs.insert(inputArgs.begin(), "--preset");
  951. matched = true;
  952. parsed = arguments[0].parse("--preset", i, inputArgs);
  953. }
  954. if (!(matched && parsed)) {
  955. if (!matched) {
  956. presetName.clear();
  957. listPresets = WorkflowListPresets::No;
  958. std::cerr << "Unknown argument " << arg << std::endl;
  959. }
  960. break;
  961. }
  962. }
  963. if (presetName.empty() && listPresets == WorkflowListPresets::No) {
  964. /* clang-format off */
  965. std::cerr <<
  966. "Usage: cmake --workflow <options>\n"
  967. "Options:\n"
  968. " --preset <preset> = Workflow preset to execute.\n"
  969. " --list-presets = List available workflow presets.\n"
  970. " --fresh = Configure a fresh build tree, removing any "
  971. "existing cache file.\n"
  972. ;
  973. /* clang-format on */
  974. return 1;
  975. }
  976. cmake cm(cmState::Role::Internal);
  977. cmSystemTools::SetMessageCallback(
  978. [&cm](std::string const& msg, cmMessageMetadata const& md) {
  979. cmakemainMessageCallback(msg, md, &cm);
  980. });
  981. cm.SetProgressCallback([&cm](std::string const& msg, float prog) {
  982. cmakemainProgressCallback(msg, prog, &cm);
  983. });
  984. return cm.Workflow(presetName, listPresets, fresh);
  985. #endif
  986. }
  987. int do_open(int ac, char const* const* av)
  988. {
  989. #ifdef CMAKE_BOOTSTRAP
  990. std::cerr << "This cmake does not support --open\n";
  991. return -1;
  992. #else
  993. std::string dir;
  994. enum Doing
  995. {
  996. DoingNone,
  997. DoingDir,
  998. };
  999. Doing doing = DoingDir;
  1000. for (int i = 2; i < ac; ++i) {
  1001. switch (doing) {
  1002. case DoingDir:
  1003. dir = cmSystemTools::ToNormalizedPathOnDisk(av[i]);
  1004. doing = DoingNone;
  1005. break;
  1006. default:
  1007. std::cerr << "Unknown argument " << av[i] << std::endl;
  1008. dir.clear();
  1009. break;
  1010. }
  1011. }
  1012. if (dir.empty()) {
  1013. std::cerr << "Usage: cmake --open <dir>\n";
  1014. return 1;
  1015. }
  1016. cmake cm(cmState::Role::Internal);
  1017. cmSystemTools::SetMessageCallback(
  1018. [&cm](std::string const& msg, cmMessageMetadata const& md) {
  1019. cmakemainMessageCallback(msg, md, &cm);
  1020. });
  1021. cm.SetProgressCallback([&cm](std::string const& msg, float prog) {
  1022. cmakemainProgressCallback(msg, prog, &cm);
  1023. });
  1024. return cm.Open(dir, cmake::DryRun::No) ? 0 : 1;
  1025. #endif
  1026. }
  1027. } // namespace
  1028. int main(int ac, char const* const* av)
  1029. {
  1030. cm::optional<cm::StdIo::Console> console = cm::StdIo::Console();
  1031. cmsys::Encoding::CommandLineArguments args =
  1032. cmsys::Encoding::CommandLineArguments::Main(ac, av);
  1033. ac = args.argc();
  1034. av = args.argv();
  1035. cmSystemTools::InitializeLibUV();
  1036. cmSystemTools::FindCMakeResources(av[0]);
  1037. if (ac > 1) {
  1038. if (strcmp(av[1], "--build") == 0) {
  1039. return do_build(ac, av);
  1040. }
  1041. if (strcmp(av[1], "--install") == 0) {
  1042. return do_install(ac, av);
  1043. }
  1044. if (strcmp(av[1], "--open") == 0) {
  1045. return do_open(ac, av);
  1046. }
  1047. if (strcmp(av[1], "--workflow") == 0) {
  1048. return do_workflow(ac, av);
  1049. }
  1050. if (strcmp(av[1], "-E") == 0) {
  1051. return do_command(ac, av, std::move(console));
  1052. }
  1053. if (strcmp(av[1], "--print-config-dir") == 0) {
  1054. std::cout << cmSystemTools::ConvertToOutputPath(
  1055. cmSystemTools::GetCMakeConfigDirectory().value_or(
  1056. std::string()))
  1057. << std::endl;
  1058. return 0;
  1059. }
  1060. }
  1061. int ret = do_cmake(ac, av);
  1062. if (uv_loop_t* loop = uv_default_loop()) {
  1063. uv_loop_close(loop);
  1064. }
  1065. return ret;
  1066. }