CMake/Source/cmServerProtocol.h

125 lines
3.1 KiB
C++

/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#pragma once
#include "cmListFileCache.h"
#include "cmake.h"
#if defined(CMAKE_BUILD_WITH_CMAKE)
#include "cm_jsoncpp_writer.h"
#endif
#include <memory>
#include <string>
class cmake;
class cmServer;
class cmServerRequest;
class cmServerResponse
{
public:
explicit cmServerResponse(const cmServerRequest& request);
void SetData(const Json::Value& data);
void SetError(const std::string& message);
bool IsComplete() const;
bool IsError() const;
std::string ErrorMessage() const;
Json::Value Data() const;
const std::string Type;
const std::string Cookie;
private:
enum PayLoad
{
PAYLOAD_UNKNOWN,
PAYLOAD_ERROR,
PAYLOAD_DATA
};
PayLoad m_Payload = PAYLOAD_UNKNOWN;
std::string m_ErrorMessage;
Json::Value m_Data;
};
class cmServerRequest
{
public:
cmServerResponse Reply(const Json::Value& data) const;
cmServerResponse ReportError(const std::string& message) const;
const std::string Type;
const std::string Cookie;
const Json::Value Data;
private:
cmServerRequest(cmServer* server, const std::string& t, const std::string& c,
const Json::Value& d);
void ReportProgress(int min, int current, int max,
const std::string& message) const;
void ReportMessage(const std::string& message,
const std::string& title) const;
cmServer* m_Server;
friend class cmServer;
};
class cmServerProtocol
{
public:
virtual ~cmServerProtocol() {}
virtual std::pair<int, int> ProtocolVersion() const = 0;
virtual bool IsExperimental() const = 0;
virtual const cmServerResponse Process(const cmServerRequest& request) = 0;
bool Activate(cmServer* server, const cmServerRequest& request,
std::string* errorMessage);
void SendSignal(const std::string& name, const Json::Value& data) const;
protected:
cmake* CMakeInstance() const;
// Implement protocol specific activation tasks here. Called from Activate().
virtual bool DoActivate(const cmServerRequest& request,
std::string* errorMessage);
private:
std::unique_ptr<cmake> m_CMakeInstance;
cmServer* m_Server = nullptr; // not owned!
friend class cmServer;
};
class cmServerProtocol1_0 : public cmServerProtocol
{
public:
std::pair<int, int> ProtocolVersion() const override;
bool IsExperimental() const override;
const cmServerResponse Process(const cmServerRequest& request) override;
private:
bool DoActivate(const cmServerRequest& request,
std::string* errorMessage) override;
// Handle requests:
cmServerResponse ProcessCompute(const cmServerRequest& request);
cmServerResponse ProcessConfigure(const cmServerRequest& request);
cmServerResponse ProcessGlobalSettings(const cmServerRequest& request);
cmServerResponse ProcessSetGlobalSettings(const cmServerRequest& request);
enum State
{
STATE_INACTIVE,
STATE_ACTIVE,
STATE_CONFIGURED,
STATE_COMPUTED
};
State m_State = STATE_INACTIVE;
};