cmakemain.cxx 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453
  1. /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. file Copyright.txt or https://cmake.org/licensing for details. */
  3. #include "cmake.h"
  4. #include "cmAlgorithms.h"
  5. #include "cmDocumentationEntry.h"
  6. #include "cmGlobalGenerator.h"
  7. #include "cmMakefile.h"
  8. #include "cmState.h"
  9. #include "cmStateTypes.h"
  10. #include "cmSystemTools.h"
  11. #include "cmcmd.h"
  12. #ifdef CMAKE_BUILD_WITH_CMAKE
  13. #include "cmDocumentation.h"
  14. #include "cmDynamicLoader.h"
  15. #endif
  16. #include "cm_uv.h"
  17. #include "cmsys/Encoding.hxx"
  18. #if defined(_WIN32) && defined(CMAKE_BUILD_WITH_CMAKE)
  19. #include "cmsys/ConsoleBuf.hxx"
  20. #endif
  21. #include <iostream>
  22. #include <string.h>
  23. #include <string>
  24. #include <vector>
  25. #ifdef CMAKE_BUILD_WITH_CMAKE
  26. static const char* cmDocumentationName[][2] = {
  27. { nullptr, " cmake - Cross-Platform Makefile Generator." },
  28. { nullptr, nullptr }
  29. };
  30. static const char* cmDocumentationUsage[][2] = {
  31. { nullptr, " cmake [options] <path-to-source>\n"
  32. " cmake [options] <path-to-existing-build>" },
  33. { nullptr, "Specify a source directory to (re-)generate a build system for "
  34. "it in the current working directory. Specify an existing build "
  35. "directory to re-generate its build system." },
  36. { nullptr, nullptr }
  37. };
  38. static const char* cmDocumentationUsageNote[][2] = {
  39. { nullptr, "Run 'cmake --help' for more information." },
  40. { nullptr, nullptr }
  41. };
  42. #define CMAKE_BUILD_OPTIONS \
  43. " <dir> = Project binary directory to be built.\n" \
  44. " --target <tgt> = Build <tgt> instead of default targets.\n" \
  45. " May only be specified once.\n" \
  46. " --config <cfg> = For multi-configuration tools, choose <cfg>.\n" \
  47. " --clean-first = Build target 'clean' first, then build.\n" \
  48. " (To clean only, use --target 'clean'.)\n" \
  49. " --use-stderr = Ignored. Behavior is default in CMake >= 3.0.\n" \
  50. " -- = Pass remaining options to the native tool.\n"
  51. static const char* cmDocumentationOptions[][2] = {
  52. CMAKE_STANDARD_OPTIONS_TABLE,
  53. { "-E", "CMake command mode." },
  54. { "-L[A][H]", "List non-advanced cached variables." },
  55. { "--build <dir>", "Build a CMake-generated project binary tree." },
  56. { "--open <dir>", "Open generated project in the associated application." },
  57. { "-N", "View mode only." },
  58. { "-P <file>", "Process script mode." },
  59. { "--find-package", "Run in pkg-config like mode." },
  60. { "--graphviz=[file]", "Generate graphviz of dependencies, see "
  61. "CMakeGraphVizOptions.cmake for more." },
  62. { "--system-information [file]", "Dump information about this system." },
  63. { "--debug-trycompile", "Do not delete the try_compile build tree. Only "
  64. "useful on one try_compile at a time." },
  65. { "--debug-output", "Put cmake in a debug mode." },
  66. { "--trace", "Put cmake in trace mode." },
  67. { "--trace-expand", "Put cmake in trace mode with variable expansion." },
  68. { "--trace-source=<file>",
  69. "Trace only this CMake file/module. Multiple options allowed." },
  70. { "--warn-uninitialized", "Warn about uninitialized values." },
  71. { "--warn-unused-vars", "Warn about unused variables." },
  72. { "--no-warn-unused-cli", "Don't warn about command line options." },
  73. { "--check-system-vars", "Find problems with variable usage in system "
  74. "files." },
  75. { nullptr, nullptr }
  76. };
  77. #endif
  78. static int do_command(int ac, char const* const* av)
  79. {
  80. std::vector<std::string> args;
  81. args.reserve(ac - 1);
  82. args.push_back(av[0]);
  83. args.insert(args.end(), av + 2, av + ac);
  84. return cmcmd::ExecuteCMakeCommand(args);
  85. }
  86. int do_cmake(int ac, char const* const* av);
  87. static int do_build(int ac, char const* const* av);
  88. static int do_open(int ac, char const* const* av);
  89. static cmMakefile* cmakemainGetMakefile(void* clientdata)
  90. {
  91. cmake* cm = static_cast<cmake*>(clientdata);
  92. if (cm && cm->GetDebugOutput()) {
  93. cmGlobalGenerator* gg = cm->GetGlobalGenerator();
  94. if (gg) {
  95. return gg->GetCurrentMakefile();
  96. }
  97. }
  98. return nullptr;
  99. }
  100. static std::string cmakemainGetStack(void* clientdata)
  101. {
  102. std::string msg;
  103. cmMakefile* mf = cmakemainGetMakefile(clientdata);
  104. if (mf) {
  105. msg = mf->FormatListFileStack();
  106. if (!msg.empty()) {
  107. msg = "\n Called from: " + msg;
  108. }
  109. }
  110. return msg;
  111. }
  112. static void cmakemainMessageCallback(const char* m, const char* /*unused*/,
  113. bool& /*unused*/, void* clientdata)
  114. {
  115. std::cerr << m << cmakemainGetStack(clientdata) << std::endl << std::flush;
  116. }
  117. static void cmakemainProgressCallback(const char* m, float prog,
  118. void* clientdata)
  119. {
  120. cmMakefile* mf = cmakemainGetMakefile(clientdata);
  121. std::string dir;
  122. if ((mf) && (strstr(m, "Configuring") == m) && (prog < 0)) {
  123. dir = " ";
  124. dir += mf->GetCurrentSourceDirectory();
  125. } else if ((mf) && (strstr(m, "Generating") == m)) {
  126. dir = " ";
  127. dir += mf->GetCurrentBinaryDirectory();
  128. }
  129. if ((prog < 0) || (!dir.empty())) {
  130. std::cout << "-- " << m << dir << cmakemainGetStack(clientdata)
  131. << std::endl;
  132. }
  133. std::cout.flush();
  134. }
  135. int main(int ac, char const* const* av)
  136. {
  137. #if defined(_WIN32) && defined(CMAKE_BUILD_WITH_CMAKE)
  138. // Replace streambuf so we can output Unicode to console
  139. cmsys::ConsoleBuf::Manager consoleOut(std::cout);
  140. consoleOut.SetUTF8Pipes();
  141. cmsys::ConsoleBuf::Manager consoleErr(std::cerr, true);
  142. consoleErr.SetUTF8Pipes();
  143. #endif
  144. cmsys::Encoding::CommandLineArguments args =
  145. cmsys::Encoding::CommandLineArguments::Main(ac, av);
  146. ac = args.argc();
  147. av = args.argv();
  148. cmSystemTools::EnableMSVCDebugHook();
  149. cmSystemTools::InitializeLibUV();
  150. cmSystemTools::FindCMakeResources(av[0]);
  151. if (ac > 1) {
  152. if (strcmp(av[1], "--build") == 0) {
  153. return do_build(ac, av);
  154. }
  155. if (strcmp(av[1], "--open") == 0) {
  156. return do_open(ac, av);
  157. }
  158. if (strcmp(av[1], "-E") == 0) {
  159. return do_command(ac, av);
  160. }
  161. }
  162. int ret = do_cmake(ac, av);
  163. #ifdef CMAKE_BUILD_WITH_CMAKE
  164. cmDynamicLoader::FlushCache();
  165. #endif
  166. uv_loop_close(uv_default_loop());
  167. return ret;
  168. }
  169. int do_cmake(int ac, char const* const* av)
  170. {
  171. if (cmSystemTools::GetCurrentWorkingDirectory().empty()) {
  172. std::cerr << "Current working directory cannot be established."
  173. << std::endl;
  174. return 1;
  175. }
  176. #ifdef CMAKE_BUILD_WITH_CMAKE
  177. cmDocumentation doc;
  178. doc.addCMakeStandardDocSections();
  179. if (doc.CheckOptions(ac, av)) {
  180. // Construct and print requested documentation.
  181. cmake hcm(cmake::RoleInternal);
  182. hcm.SetHomeDirectory("");
  183. hcm.SetHomeOutputDirectory("");
  184. hcm.AddCMakePaths();
  185. // the command line args are processed here so that you can do
  186. // -DCMAKE_MODULE_PATH=/some/path and have this value accessible here
  187. std::vector<std::string> args(av, av + ac);
  188. hcm.SetCacheArgs(args);
  189. std::vector<cmDocumentationEntry> generators;
  190. hcm.GetGeneratorDocumentation(generators);
  191. doc.SetName("cmake");
  192. doc.SetSection("Name", cmDocumentationName);
  193. doc.SetSection("Usage", cmDocumentationUsage);
  194. if (ac == 1) {
  195. doc.AppendSection("Usage", cmDocumentationUsageNote);
  196. }
  197. doc.AppendSection("Generators", generators);
  198. doc.PrependSection("Options", cmDocumentationOptions);
  199. return doc.PrintRequestedDocumentation(std::cout) ? 0 : 1;
  200. }
  201. #else
  202. if (ac == 1) {
  203. std::cout
  204. << "Bootstrap CMake should not be used outside CMake build process."
  205. << std::endl;
  206. return 0;
  207. }
  208. #endif
  209. bool sysinfo = false;
  210. bool list_cached = false;
  211. bool list_all_cached = false;
  212. bool list_help = false;
  213. bool view_only = false;
  214. cmake::WorkingMode workingMode = cmake::NORMAL_MODE;
  215. std::vector<std::string> args;
  216. for (int i = 0; i < ac; ++i) {
  217. if (strcmp(av[i], "-i") == 0) {
  218. /* clang-format off */
  219. std::cerr <<
  220. "The \"cmake -i\" wizard mode is no longer supported.\n"
  221. "Use the -D option to set cache values on the command line.\n"
  222. "Use cmake-gui or ccmake for an interactive dialog.\n";
  223. /* clang-format on */
  224. return 1;
  225. }
  226. if (strcmp(av[i], "--system-information") == 0) {
  227. sysinfo = true;
  228. } else if (strcmp(av[i], "-N") == 0) {
  229. view_only = true;
  230. } else if (strcmp(av[i], "-L") == 0) {
  231. list_cached = true;
  232. } else if (strcmp(av[i], "-LA") == 0) {
  233. list_all_cached = true;
  234. } else if (strcmp(av[i], "-LH") == 0) {
  235. list_cached = true;
  236. list_help = true;
  237. } else if (strcmp(av[i], "-LAH") == 0) {
  238. list_all_cached = true;
  239. list_help = true;
  240. } else if (cmHasLiteralPrefix(av[i], "-P")) {
  241. if (i == ac - 1) {
  242. cmSystemTools::Error("No script specified for argument -P");
  243. } else {
  244. workingMode = cmake::SCRIPT_MODE;
  245. args.push_back(av[i]);
  246. i++;
  247. args.push_back(av[i]);
  248. }
  249. } else if (cmHasLiteralPrefix(av[i], "--find-package")) {
  250. workingMode = cmake::FIND_PACKAGE_MODE;
  251. args.push_back(av[i]);
  252. } else {
  253. args.push_back(av[i]);
  254. }
  255. }
  256. if (sysinfo) {
  257. cmake cm(cmake::RoleProject);
  258. cm.SetHomeDirectory("");
  259. cm.SetHomeOutputDirectory("");
  260. int ret = cm.GetSystemInformation(args);
  261. return ret;
  262. }
  263. cmake::Role const role =
  264. workingMode == cmake::SCRIPT_MODE ? cmake::RoleScript : cmake::RoleProject;
  265. cmake cm(role);
  266. cm.SetHomeDirectory("");
  267. cm.SetHomeOutputDirectory("");
  268. cmSystemTools::SetMessageCallback(cmakemainMessageCallback, &cm);
  269. cm.SetProgressCallback(cmakemainProgressCallback, &cm);
  270. cm.SetWorkingMode(workingMode);
  271. int res = cm.Run(args, view_only);
  272. if (list_cached || list_all_cached) {
  273. std::cout << "-- Cache values" << std::endl;
  274. std::vector<std::string> keys = cm.GetState()->GetCacheEntryKeys();
  275. for (std::string const& k : keys) {
  276. cmStateEnums::CacheEntryType t = cm.GetState()->GetCacheEntryType(k);
  277. if (t != cmStateEnums::INTERNAL && t != cmStateEnums::STATIC &&
  278. t != cmStateEnums::UNINITIALIZED) {
  279. const char* advancedProp =
  280. cm.GetState()->GetCacheEntryProperty(k, "ADVANCED");
  281. if (list_all_cached || !advancedProp) {
  282. if (list_help) {
  283. std::cout << "// "
  284. << cm.GetState()->GetCacheEntryProperty(k, "HELPSTRING")
  285. << std::endl;
  286. }
  287. std::cout << k << ":" << cmState::CacheEntryTypeToString(t) << "="
  288. << cm.GetState()->GetCacheEntryValue(k) << std::endl;
  289. if (list_help) {
  290. std::cout << std::endl;
  291. }
  292. }
  293. }
  294. }
  295. }
  296. // Always return a non-negative value. Windows tools do not always
  297. // interpret negative return values as errors.
  298. if (res != 0) {
  299. return 1;
  300. }
  301. return 0;
  302. }
  303. static int do_build(int ac, char const* const* av)
  304. {
  305. #ifndef CMAKE_BUILD_WITH_CMAKE
  306. std::cerr << "This cmake does not support --build\n";
  307. return -1;
  308. #else
  309. std::string target;
  310. std::string config = "Debug";
  311. std::string dir;
  312. std::vector<std::string> nativeOptions;
  313. bool clean = false;
  314. bool hasTarget = false;
  315. enum Doing
  316. {
  317. DoingNone,
  318. DoingDir,
  319. DoingTarget,
  320. DoingConfig,
  321. DoingNative
  322. };
  323. Doing doing = DoingDir;
  324. for (int i = 2; i < ac; ++i) {
  325. if (doing == DoingNative) {
  326. nativeOptions.push_back(av[i]);
  327. } else if (strcmp(av[i], "--target") == 0) {
  328. if (!hasTarget) {
  329. doing = DoingTarget;
  330. hasTarget = true;
  331. } else {
  332. std::cerr << "'--target' may not be specified more than once.\n\n";
  333. dir.clear();
  334. break;
  335. }
  336. } else if (strcmp(av[i], "--config") == 0) {
  337. doing = DoingConfig;
  338. } else if (strcmp(av[i], "--clean-first") == 0) {
  339. clean = true;
  340. doing = DoingNone;
  341. } else if (strcmp(av[i], "--use-stderr") == 0) {
  342. /* tolerate legacy option */
  343. } else if (strcmp(av[i], "--") == 0) {
  344. doing = DoingNative;
  345. } else {
  346. switch (doing) {
  347. case DoingDir:
  348. dir = cmSystemTools::CollapseFullPath(av[i]);
  349. doing = DoingNone;
  350. break;
  351. case DoingTarget:
  352. target = av[i];
  353. doing = DoingNone;
  354. break;
  355. case DoingConfig:
  356. config = av[i];
  357. doing = DoingNone;
  358. break;
  359. default:
  360. std::cerr << "Unknown argument " << av[i] << std::endl;
  361. dir.clear();
  362. break;
  363. }
  364. }
  365. }
  366. if (dir.empty()) {
  367. /* clang-format off */
  368. std::cerr <<
  369. "Usage: cmake --build <dir> [options] [-- [native-options]]\n"
  370. "Options:\n"
  371. CMAKE_BUILD_OPTIONS
  372. ;
  373. /* clang-format on */
  374. return 1;
  375. }
  376. cmake cm(cmake::RoleInternal);
  377. cmSystemTools::SetMessageCallback(cmakemainMessageCallback, &cm);
  378. cm.SetProgressCallback(cmakemainProgressCallback, &cm);
  379. return cm.Build(dir, target, config, nativeOptions, clean);
  380. #endif
  381. }
  382. static int do_open(int ac, char const* const* av)
  383. {
  384. #ifndef CMAKE_BUILD_WITH_CMAKE
  385. std::cerr << "This cmake does not support --open\n";
  386. return -1;
  387. #else
  388. std::string dir;
  389. enum Doing
  390. {
  391. DoingNone,
  392. DoingDir,
  393. };
  394. Doing doing = DoingDir;
  395. for (int i = 2; i < ac; ++i) {
  396. switch (doing) {
  397. case DoingDir:
  398. dir = cmSystemTools::CollapseFullPath(av[i]);
  399. doing = DoingNone;
  400. break;
  401. default:
  402. std::cerr << "Unknown argument " << av[i] << std::endl;
  403. dir.clear();
  404. break;
  405. }
  406. }
  407. if (dir.empty()) {
  408. std::cerr << "Usage: cmake --open <dir>\n";
  409. return 1;
  410. }
  411. cmake cm(cmake::RoleInternal);
  412. cmSystemTools::SetMessageCallback(cmakemainMessageCallback, &cm);
  413. cm.SetProgressCallback(cmakemainProgressCallback, &cm);
  414. return cm.Open(dir, false) ? 0 : 1;
  415. #endif
  416. }