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