cmServerProtocol.cxx 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758
  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 "cmServerProtocol.h"
  4. #include "cmExternalMakefileProjectGenerator.h"
  5. #include "cmFileMonitor.h"
  6. #include "cmGlobalGenerator.h"
  7. #include "cmJsonObjectDictionary.h"
  8. #include "cmJsonObjects.h"
  9. #include "cmMessageType.h"
  10. #include "cmServer.h"
  11. #include "cmServerDictionary.h"
  12. #include "cmState.h"
  13. #include "cmSystemTools.h"
  14. #include "cm_uv.h"
  15. #include "cmake.h"
  16. #include <algorithm>
  17. #include <cassert>
  18. #include <functional>
  19. #include <string>
  20. #include <utility>
  21. #include <vector>
  22. #include "cm_memory.hxx"
  23. // Get rid of some windows macros:
  24. #undef max
  25. namespace {
  26. std::vector<std::string> toStringList(const Json::Value& in)
  27. {
  28. std::vector<std::string> result;
  29. for (auto const& it : in) {
  30. result.push_back(it.asString());
  31. }
  32. return result;
  33. }
  34. } // namespace
  35. cmServerRequest::cmServerRequest(cmServer* server, cmConnection* connection,
  36. std::string t, std::string c, Json::Value d)
  37. : Type(std::move(t))
  38. , Cookie(std::move(c))
  39. , Data(std::move(d))
  40. , Connection(connection)
  41. , m_Server(server)
  42. {
  43. }
  44. void cmServerRequest::ReportProgress(int min, int current, int max,
  45. const std::string& message) const
  46. {
  47. this->m_Server->WriteProgress(*this, min, current, max, message);
  48. }
  49. void cmServerRequest::ReportMessage(const std::string& message,
  50. const std::string& title) const
  51. {
  52. m_Server->WriteMessage(*this, message, title);
  53. }
  54. cmServerResponse cmServerRequest::Reply(const Json::Value& data) const
  55. {
  56. cmServerResponse response(*this);
  57. response.SetData(data);
  58. return response;
  59. }
  60. cmServerResponse cmServerRequest::ReportError(const std::string& message) const
  61. {
  62. cmServerResponse response(*this);
  63. response.SetError(message);
  64. return response;
  65. }
  66. cmServerResponse::cmServerResponse(const cmServerRequest& request)
  67. : Type(request.Type)
  68. , Cookie(request.Cookie)
  69. {
  70. }
  71. void cmServerResponse::SetData(const Json::Value& data)
  72. {
  73. assert(this->m_Payload == PAYLOAD_UNKNOWN);
  74. if (!data[kCOOKIE_KEY].isNull() || !data[kTYPE_KEY].isNull()) {
  75. this->SetError("Response contains cookie or type field.");
  76. return;
  77. }
  78. this->m_Payload = PAYLOAD_DATA;
  79. this->m_Data = data;
  80. }
  81. void cmServerResponse::SetError(const std::string& message)
  82. {
  83. assert(this->m_Payload == PAYLOAD_UNKNOWN);
  84. this->m_Payload = PAYLOAD_ERROR;
  85. this->m_ErrorMessage = message;
  86. }
  87. bool cmServerResponse::IsComplete() const
  88. {
  89. return this->m_Payload != PAYLOAD_UNKNOWN;
  90. }
  91. bool cmServerResponse::IsError() const
  92. {
  93. assert(this->m_Payload != PAYLOAD_UNKNOWN);
  94. return this->m_Payload == PAYLOAD_ERROR;
  95. }
  96. std::string cmServerResponse::ErrorMessage() const
  97. {
  98. if (this->m_Payload == PAYLOAD_ERROR) {
  99. return this->m_ErrorMessage;
  100. }
  101. return std::string();
  102. }
  103. Json::Value cmServerResponse::Data() const
  104. {
  105. assert(this->m_Payload != PAYLOAD_UNKNOWN);
  106. return this->m_Data;
  107. }
  108. bool cmServerProtocol::Activate(cmServer* server,
  109. const cmServerRequest& request,
  110. std::string* errorMessage)
  111. {
  112. assert(server);
  113. this->m_Server = server;
  114. this->m_CMakeInstance =
  115. cm::make_unique<cmake>(cmake::RoleProject, cmState::Project);
  116. const bool result = this->DoActivate(request, errorMessage);
  117. if (!result) {
  118. this->m_CMakeInstance = nullptr;
  119. }
  120. return result;
  121. }
  122. cmFileMonitor* cmServerProtocol::FileMonitor() const
  123. {
  124. return this->m_Server ? this->m_Server->FileMonitor() : nullptr;
  125. }
  126. void cmServerProtocol::SendSignal(const std::string& name,
  127. const Json::Value& data) const
  128. {
  129. if (this->m_Server) {
  130. this->m_Server->WriteSignal(name, data);
  131. }
  132. }
  133. cmake* cmServerProtocol::CMakeInstance() const
  134. {
  135. return this->m_CMakeInstance.get();
  136. }
  137. bool cmServerProtocol::DoActivate(const cmServerRequest& /*request*/,
  138. std::string* /*errorMessage*/)
  139. {
  140. return true;
  141. }
  142. std::pair<int, int> cmServerProtocol1::ProtocolVersion() const
  143. {
  144. return std::make_pair(1, 2);
  145. }
  146. static void setErrorMessage(std::string* errorMessage, const std::string& text)
  147. {
  148. if (errorMessage) {
  149. *errorMessage = text;
  150. }
  151. }
  152. static bool getOrTestHomeDirectory(cmState* state, std::string& value,
  153. std::string* errorMessage)
  154. {
  155. const std::string cachedValue =
  156. std::string(state->GetCacheEntryValue("CMAKE_HOME_DIRECTORY"));
  157. if (value.empty()) {
  158. value = cachedValue;
  159. return true;
  160. }
  161. const std::string suffix = "/CMakeLists.txt";
  162. const std::string cachedValueCML = cachedValue + suffix;
  163. const std::string valueCML = value + suffix;
  164. if (!cmSystemTools::SameFile(valueCML, cachedValueCML)) {
  165. setErrorMessage(errorMessage,
  166. std::string("\"CMAKE_HOME_DIRECTORY\" is set but "
  167. "incompatible with configured "
  168. "source directory value."));
  169. return false;
  170. }
  171. return true;
  172. }
  173. static bool getOrTestValue(cmState* state, const std::string& key,
  174. std::string& value,
  175. const std::string& keyDescription,
  176. std::string* errorMessage)
  177. {
  178. const char* entry = state->GetCacheEntryValue(key);
  179. const std::string cachedValue =
  180. entry == nullptr ? std::string() : std::string(entry);
  181. if (value.empty()) {
  182. value = cachedValue;
  183. }
  184. if (!cachedValue.empty() && cachedValue != value) {
  185. setErrorMessage(errorMessage,
  186. std::string("\"") + key +
  187. "\" is set but incompatible with configured " +
  188. keyDescription + " value.");
  189. return false;
  190. }
  191. return true;
  192. }
  193. bool cmServerProtocol1::DoActivate(const cmServerRequest& request,
  194. std::string* errorMessage)
  195. {
  196. std::string sourceDirectory = request.Data[kSOURCE_DIRECTORY_KEY].asString();
  197. std::string buildDirectory = request.Data[kBUILD_DIRECTORY_KEY].asString();
  198. std::string generator = request.Data[kGENERATOR_KEY].asString();
  199. std::string extraGenerator = request.Data[kEXTRA_GENERATOR_KEY].asString();
  200. std::string toolset = request.Data[kTOOLSET_KEY].asString();
  201. std::string platform = request.Data[kPLATFORM_KEY].asString();
  202. // normalize source and build directory
  203. if (!sourceDirectory.empty()) {
  204. sourceDirectory = cmSystemTools::CollapseFullPath(sourceDirectory);
  205. cmSystemTools::ConvertToUnixSlashes(sourceDirectory);
  206. }
  207. if (!buildDirectory.empty()) {
  208. buildDirectory = cmSystemTools::CollapseFullPath(buildDirectory);
  209. cmSystemTools::ConvertToUnixSlashes(buildDirectory);
  210. }
  211. if (buildDirectory.empty()) {
  212. setErrorMessage(errorMessage,
  213. std::string("\"") + kBUILD_DIRECTORY_KEY +
  214. "\" is missing.");
  215. return false;
  216. }
  217. cmake* cm = CMakeInstance();
  218. if (cmSystemTools::PathExists(buildDirectory)) {
  219. if (!cmSystemTools::FileIsDirectory(buildDirectory)) {
  220. setErrorMessage(errorMessage,
  221. std::string("\"") + kBUILD_DIRECTORY_KEY +
  222. "\" exists but is not a directory.");
  223. return false;
  224. }
  225. const std::string cachePath = cmake::FindCacheFile(buildDirectory);
  226. if (cm->LoadCache(cachePath)) {
  227. cmState* state = cm->GetState();
  228. // Check generator:
  229. if (!getOrTestValue(state, "CMAKE_GENERATOR", generator, "generator",
  230. errorMessage)) {
  231. return false;
  232. }
  233. // check extra generator:
  234. if (!getOrTestValue(state, "CMAKE_EXTRA_GENERATOR", extraGenerator,
  235. "extra generator", errorMessage)) {
  236. return false;
  237. }
  238. // check sourcedir:
  239. if (!getOrTestHomeDirectory(state, sourceDirectory, errorMessage)) {
  240. return false;
  241. }
  242. // check toolset:
  243. if (!getOrTestValue(state, "CMAKE_GENERATOR_TOOLSET", toolset, "toolset",
  244. errorMessage)) {
  245. return false;
  246. }
  247. // check platform:
  248. if (!getOrTestValue(state, "CMAKE_GENERATOR_PLATFORM", platform,
  249. "platform", errorMessage)) {
  250. return false;
  251. }
  252. }
  253. }
  254. if (sourceDirectory.empty()) {
  255. setErrorMessage(errorMessage,
  256. std::string("\"") + kSOURCE_DIRECTORY_KEY +
  257. "\" is unset but required.");
  258. return false;
  259. }
  260. if (!cmSystemTools::FileIsDirectory(sourceDirectory)) {
  261. setErrorMessage(errorMessage,
  262. std::string("\"") + kSOURCE_DIRECTORY_KEY +
  263. "\" is not a directory.");
  264. return false;
  265. }
  266. if (generator.empty()) {
  267. setErrorMessage(errorMessage,
  268. std::string("\"") + kGENERATOR_KEY +
  269. "\" is unset but required.");
  270. return false;
  271. }
  272. std::vector<cmake::GeneratorInfo> generators;
  273. cm->GetRegisteredGenerators(generators);
  274. auto baseIt = std::find_if(generators.begin(), generators.end(),
  275. [&generator](const cmake::GeneratorInfo& info) {
  276. return info.name == generator;
  277. });
  278. if (baseIt == generators.end()) {
  279. setErrorMessage(errorMessage,
  280. std::string("Generator \"") + generator +
  281. "\" not supported.");
  282. return false;
  283. }
  284. auto extraIt = std::find_if(
  285. generators.begin(), generators.end(),
  286. [&generator, &extraGenerator](const cmake::GeneratorInfo& info) {
  287. return info.baseName == generator && info.extraName == extraGenerator;
  288. });
  289. if (extraIt == generators.end()) {
  290. setErrorMessage(errorMessage,
  291. std::string("The combination of generator \"" + generator +
  292. "\" and extra generator \"" + extraGenerator +
  293. "\" is not supported."));
  294. return false;
  295. }
  296. if (!extraIt->supportsToolset && !toolset.empty()) {
  297. setErrorMessage(errorMessage,
  298. std::string("Toolset was provided but is not supported by "
  299. "the requested generator."));
  300. return false;
  301. }
  302. if (!extraIt->supportsPlatform && !platform.empty()) {
  303. setErrorMessage(errorMessage,
  304. std::string("Platform was provided but is not supported "
  305. "by the requested generator."));
  306. return false;
  307. }
  308. this->GeneratorInfo =
  309. GeneratorInformation(generator, extraGenerator, toolset, platform,
  310. sourceDirectory, buildDirectory);
  311. this->m_State = STATE_ACTIVE;
  312. return true;
  313. }
  314. void cmServerProtocol1::HandleCMakeFileChanges(const std::string& path,
  315. int event, int status)
  316. {
  317. assert(status == 0);
  318. static_cast<void>(status);
  319. if (!m_isDirty) {
  320. m_isDirty = true;
  321. SendSignal(kDIRTY_SIGNAL, Json::objectValue);
  322. }
  323. Json::Value obj = Json::objectValue;
  324. obj[kPATH_KEY] = path;
  325. Json::Value properties = Json::arrayValue;
  326. if (event & UV_RENAME) {
  327. properties.append(kRENAME_PROPERTY_VALUE);
  328. }
  329. if (event & UV_CHANGE) {
  330. properties.append(kCHANGE_PROPERTY_VALUE);
  331. }
  332. obj[kPROPERTIES_KEY] = properties;
  333. SendSignal(kFILE_CHANGE_SIGNAL, obj);
  334. }
  335. cmServerResponse cmServerProtocol1::Process(const cmServerRequest& request)
  336. {
  337. assert(this->m_State >= STATE_ACTIVE);
  338. if (request.Type == kCACHE_TYPE) {
  339. return this->ProcessCache(request);
  340. }
  341. if (request.Type == kCMAKE_INPUTS_TYPE) {
  342. return this->ProcessCMakeInputs(request);
  343. }
  344. if (request.Type == kCODE_MODEL_TYPE) {
  345. return this->ProcessCodeModel(request);
  346. }
  347. if (request.Type == kCOMPUTE_TYPE) {
  348. return this->ProcessCompute(request);
  349. }
  350. if (request.Type == kCONFIGURE_TYPE) {
  351. return this->ProcessConfigure(request);
  352. }
  353. if (request.Type == kFILESYSTEM_WATCHERS_TYPE) {
  354. return this->ProcessFileSystemWatchers(request);
  355. }
  356. if (request.Type == kGLOBAL_SETTINGS_TYPE) {
  357. return this->ProcessGlobalSettings(request);
  358. }
  359. if (request.Type == kSET_GLOBAL_SETTINGS_TYPE) {
  360. return this->ProcessSetGlobalSettings(request);
  361. }
  362. if (request.Type == kCTEST_INFO_TYPE) {
  363. return this->ProcessCTests(request);
  364. }
  365. return request.ReportError("Unknown command!");
  366. }
  367. bool cmServerProtocol1::IsExperimental() const
  368. {
  369. return true;
  370. }
  371. cmServerResponse cmServerProtocol1::ProcessCache(
  372. const cmServerRequest& request)
  373. {
  374. cmState* state = this->CMakeInstance()->GetState();
  375. Json::Value result = Json::objectValue;
  376. std::vector<std::string> allKeys = state->GetCacheEntryKeys();
  377. Json::Value list = Json::arrayValue;
  378. std::vector<std::string> keys = toStringList(request.Data[kKEYS_KEY]);
  379. if (keys.empty()) {
  380. keys = allKeys;
  381. } else {
  382. for (auto const& i : keys) {
  383. if (std::find(allKeys.begin(), allKeys.end(), i) == allKeys.end()) {
  384. return request.ReportError("Key \"" + i + "\" not found in cache.");
  385. }
  386. }
  387. }
  388. std::sort(keys.begin(), keys.end());
  389. for (auto const& key : keys) {
  390. Json::Value entry = Json::objectValue;
  391. entry[kKEY_KEY] = key;
  392. entry[kTYPE_KEY] =
  393. cmState::CacheEntryTypeToString(state->GetCacheEntryType(key));
  394. entry[kVALUE_KEY] = state->GetCacheEntryValue(key);
  395. Json::Value props = Json::objectValue;
  396. bool haveProperties = false;
  397. for (auto const& prop : state->GetCacheEntryPropertyList(key)) {
  398. haveProperties = true;
  399. props[prop] = state->GetCacheEntryProperty(key, prop);
  400. }
  401. if (haveProperties) {
  402. entry[kPROPERTIES_KEY] = props;
  403. }
  404. list.append(entry);
  405. }
  406. result[kCACHE_KEY] = list;
  407. return request.Reply(result);
  408. }
  409. cmServerResponse cmServerProtocol1::ProcessCMakeInputs(
  410. const cmServerRequest& request)
  411. {
  412. if (this->m_State < STATE_CONFIGURED) {
  413. return request.ReportError("This instance was not yet configured.");
  414. }
  415. const cmake* cm = this->CMakeInstance();
  416. const std::string cmakeRootDir = cmSystemTools::GetCMakeRoot();
  417. const std::string& sourceDir = cm->GetHomeDirectory();
  418. Json::Value result = Json::objectValue;
  419. result[kSOURCE_DIRECTORY_KEY] = sourceDir;
  420. result[kCMAKE_ROOT_DIRECTORY_KEY] = cmakeRootDir;
  421. result[kBUILD_FILES_KEY] = cmDumpCMakeInputs(cm);
  422. return request.Reply(result);
  423. }
  424. cmServerResponse cmServerProtocol1::ProcessCodeModel(
  425. const cmServerRequest& request)
  426. {
  427. if (this->m_State != STATE_COMPUTED) {
  428. return request.ReportError("No build system was generated yet.");
  429. }
  430. return request.Reply(cmDumpCodeModel(this->CMakeInstance()));
  431. }
  432. cmServerResponse cmServerProtocol1::ProcessCompute(
  433. const cmServerRequest& request)
  434. {
  435. if (this->m_State > STATE_CONFIGURED) {
  436. return request.ReportError("This build system was already generated.");
  437. }
  438. if (this->m_State < STATE_CONFIGURED) {
  439. return request.ReportError("This project was not configured yet.");
  440. }
  441. cmake* cm = this->CMakeInstance();
  442. int ret = cm->Generate();
  443. if (ret < 0) {
  444. return request.ReportError("Failed to compute build system.");
  445. }
  446. m_State = STATE_COMPUTED;
  447. return request.Reply(Json::Value());
  448. }
  449. cmServerResponse cmServerProtocol1::ProcessConfigure(
  450. const cmServerRequest& request)
  451. {
  452. if (this->m_State == STATE_INACTIVE) {
  453. return request.ReportError("This instance is inactive.");
  454. }
  455. FileMonitor()->StopMonitoring();
  456. std::string errorMessage;
  457. cmake* cm = this->CMakeInstance();
  458. this->GeneratorInfo.SetupGenerator(cm, &errorMessage);
  459. if (!errorMessage.empty()) {
  460. return request.ReportError(errorMessage);
  461. }
  462. // Make sure the types of cacheArguments matches (if given):
  463. std::vector<std::string> cacheArgs = { "unused" };
  464. bool cacheArgumentsError = false;
  465. const Json::Value passedArgs = request.Data[kCACHE_ARGUMENTS_KEY];
  466. if (!passedArgs.isNull()) {
  467. if (passedArgs.isString()) {
  468. cacheArgs.push_back(passedArgs.asString());
  469. } else if (passedArgs.isArray()) {
  470. for (auto const& arg : passedArgs) {
  471. if (!arg.isString()) {
  472. cacheArgumentsError = true;
  473. break;
  474. }
  475. cacheArgs.push_back(arg.asString());
  476. }
  477. } else {
  478. cacheArgumentsError = true;
  479. }
  480. }
  481. if (cacheArgumentsError) {
  482. request.ReportError(
  483. "cacheArguments must be unset, a string or an array of strings.");
  484. }
  485. std::string sourceDir = cm->GetHomeDirectory();
  486. const std::string buildDir = cm->GetHomeOutputDirectory();
  487. cmGlobalGenerator* gg = cm->GetGlobalGenerator();
  488. if (buildDir.empty()) {
  489. return request.ReportError("No build directory set via Handshake.");
  490. }
  491. if (cm->LoadCache(buildDir)) {
  492. // build directory has been set up before
  493. const std::string* cachedSourceDir =
  494. cm->GetState()->GetInitializedCacheValue("CMAKE_HOME_DIRECTORY");
  495. if (!cachedSourceDir) {
  496. return request.ReportError("No CMAKE_HOME_DIRECTORY found in cache.");
  497. }
  498. if (sourceDir.empty()) {
  499. sourceDir = *cachedSourceDir;
  500. cm->SetHomeDirectory(sourceDir);
  501. }
  502. const std::string* cachedGenerator =
  503. cm->GetState()->GetInitializedCacheValue("CMAKE_GENERATOR");
  504. if (cachedGenerator) {
  505. if (gg && gg->GetName() != *cachedGenerator) {
  506. return request.ReportError("Configured generator does not match with "
  507. "CMAKE_GENERATOR found in cache.");
  508. }
  509. }
  510. } else {
  511. // build directory has not been set up before
  512. if (sourceDir.empty()) {
  513. return request.ReportError("No sourceDirectory set via "
  514. "setGlobalSettings and no cache found in "
  515. "buildDirectory.");
  516. }
  517. }
  518. cmSystemTools::ResetErrorOccuredFlag(); // Reset error state
  519. if (cm->AddCMakePaths() != 1) {
  520. return request.ReportError("Failed to set CMake paths.");
  521. }
  522. if (!cm->SetCacheArgs(cacheArgs)) {
  523. return request.ReportError("cacheArguments could not be set.");
  524. }
  525. int ret = cm->Configure();
  526. cm->IssueMessage(
  527. MessageType::DEPRECATION_WARNING,
  528. "The 'cmake-server(7)' is deprecated. "
  529. "Please port clients to use the 'cmake-file-api(7)' instead.");
  530. if (ret < 0) {
  531. return request.ReportError("Configuration failed.");
  532. }
  533. std::vector<std::string> toWatchList;
  534. cmGetCMakeInputs(gg, std::string(), buildDir, nullptr, &toWatchList,
  535. nullptr);
  536. FileMonitor()->MonitorPaths(toWatchList,
  537. [this](const std::string& p, int e, int s) {
  538. this->HandleCMakeFileChanges(p, e, s);
  539. });
  540. m_State = STATE_CONFIGURED;
  541. m_isDirty = false;
  542. return request.Reply(Json::Value());
  543. }
  544. cmServerResponse cmServerProtocol1::ProcessGlobalSettings(
  545. const cmServerRequest& request)
  546. {
  547. cmake* cm = this->CMakeInstance();
  548. Json::Value obj = Json::objectValue;
  549. // Capabilities information:
  550. obj[kCAPABILITIES_KEY] = cm->ReportCapabilitiesJson();
  551. obj[kDEBUG_OUTPUT_KEY] = cm->GetDebugOutput();
  552. obj[kTRACE_KEY] = cm->GetTrace();
  553. obj[kTRACE_EXPAND_KEY] = cm->GetTraceExpand();
  554. obj[kWARN_UNINITIALIZED_KEY] = cm->GetWarnUninitialized();
  555. obj[kWARN_UNUSED_KEY] = cm->GetWarnUnused();
  556. obj[kWARN_UNUSED_CLI_KEY] = cm->GetWarnUnusedCli();
  557. obj[kCHECK_SYSTEM_VARS_KEY] = cm->GetCheckSystemVars();
  558. obj[kSOURCE_DIRECTORY_KEY] = this->GeneratorInfo.SourceDirectory;
  559. obj[kBUILD_DIRECTORY_KEY] = this->GeneratorInfo.BuildDirectory;
  560. // Currently used generator:
  561. obj[kGENERATOR_KEY] = this->GeneratorInfo.GeneratorName;
  562. obj[kEXTRA_GENERATOR_KEY] = this->GeneratorInfo.ExtraGeneratorName;
  563. return request.Reply(obj);
  564. }
  565. static void setBool(const cmServerRequest& request, const std::string& key,
  566. std::function<void(bool)> const& setter)
  567. {
  568. if (request.Data[key].isNull()) {
  569. return;
  570. }
  571. setter(request.Data[key].asBool());
  572. }
  573. cmServerResponse cmServerProtocol1::ProcessSetGlobalSettings(
  574. const cmServerRequest& request)
  575. {
  576. const std::vector<std::string> boolValues = {
  577. kDEBUG_OUTPUT_KEY, kTRACE_KEY, kTRACE_EXPAND_KEY,
  578. kWARN_UNINITIALIZED_KEY, kWARN_UNUSED_KEY, kWARN_UNUSED_CLI_KEY,
  579. kCHECK_SYSTEM_VARS_KEY
  580. };
  581. for (std::string const& i : boolValues) {
  582. if (!request.Data[i].isNull() && !request.Data[i].isBool()) {
  583. return request.ReportError("\"" + i +
  584. "\" must be unset or a bool value.");
  585. }
  586. }
  587. cmake* cm = this->CMakeInstance();
  588. setBool(request, kDEBUG_OUTPUT_KEY,
  589. [cm](bool e) { cm->SetDebugOutputOn(e); });
  590. setBool(request, kTRACE_KEY, [cm](bool e) { cm->SetTrace(e); });
  591. setBool(request, kTRACE_EXPAND_KEY, [cm](bool e) { cm->SetTraceExpand(e); });
  592. setBool(request, kWARN_UNINITIALIZED_KEY,
  593. [cm](bool e) { cm->SetWarnUninitialized(e); });
  594. setBool(request, kWARN_UNUSED_KEY, [cm](bool e) { cm->SetWarnUnused(e); });
  595. setBool(request, kWARN_UNUSED_CLI_KEY,
  596. [cm](bool e) { cm->SetWarnUnusedCli(e); });
  597. setBool(request, kCHECK_SYSTEM_VARS_KEY,
  598. [cm](bool e) { cm->SetCheckSystemVars(e); });
  599. return request.Reply(Json::Value());
  600. }
  601. cmServerResponse cmServerProtocol1::ProcessFileSystemWatchers(
  602. const cmServerRequest& request)
  603. {
  604. const cmFileMonitor* const fm = FileMonitor();
  605. Json::Value result = Json::objectValue;
  606. Json::Value files = Json::arrayValue;
  607. for (auto const& f : fm->WatchedFiles()) {
  608. files.append(f);
  609. }
  610. Json::Value directories = Json::arrayValue;
  611. for (auto const& d : fm->WatchedDirectories()) {
  612. directories.append(d);
  613. }
  614. result[kWATCHED_FILES_KEY] = files;
  615. result[kWATCHED_DIRECTORIES_KEY] = directories;
  616. return request.Reply(result);
  617. }
  618. cmServerResponse cmServerProtocol1::ProcessCTests(
  619. const cmServerRequest& request)
  620. {
  621. if (this->m_State < STATE_COMPUTED) {
  622. return request.ReportError("This instance was not yet computed.");
  623. }
  624. return request.Reply(cmDumpCTestInfo(this->CMakeInstance()));
  625. }
  626. cmServerProtocol1::GeneratorInformation::GeneratorInformation(
  627. std::string generatorName, std::string extraGeneratorName,
  628. std::string toolset, std::string platform, std::string sourceDirectory,
  629. std::string buildDirectory)
  630. : GeneratorName(std::move(generatorName))
  631. , ExtraGeneratorName(std::move(extraGeneratorName))
  632. , Toolset(std::move(toolset))
  633. , Platform(std::move(platform))
  634. , SourceDirectory(std::move(sourceDirectory))
  635. , BuildDirectory(std::move(buildDirectory))
  636. {
  637. }
  638. void cmServerProtocol1::GeneratorInformation::SetupGenerator(
  639. cmake* cm, std::string* errorMessage)
  640. {
  641. const std::string fullGeneratorName =
  642. cmExternalMakefileProjectGenerator::CreateFullGeneratorName(
  643. GeneratorName, ExtraGeneratorName);
  644. cm->SetHomeDirectory(SourceDirectory);
  645. cm->SetHomeOutputDirectory(BuildDirectory);
  646. cmGlobalGenerator* gg = cm->CreateGlobalGenerator(fullGeneratorName);
  647. if (!gg) {
  648. setErrorMessage(
  649. errorMessage,
  650. std::string("Could not set up the requested combination of \"") +
  651. kGENERATOR_KEY + "\" and \"" + kEXTRA_GENERATOR_KEY + "\"");
  652. return;
  653. }
  654. cm->SetGlobalGenerator(gg);
  655. cm->SetGeneratorToolset(Toolset);
  656. cm->SetGeneratorPlatform(Platform);
  657. }