cmServerProtocol.cxx 23 KB

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