protocol.hpp

Go to the documentation of this file.

// protocol.hpp — Inspector protocol: message types and JSON encoding
// Modeled on Chrome DevTools Protocol with domain.method naming.
#pragma once
 
#include <cstddef>
#include <cstdint>
#include <string>
#include <string_view>
 
namespace pulp::inspect {

inline constexpr std::size_t kInspectorExtendedMessageBytes =
    16u * 1024u * 1024u;

struct InspectorMessage {
    int64_t id = 0;             
    std::string method;         
    std::string params_json;    
    bool is_error = false;      
    std::string error_code;     
    std::string error_data_json; 
};
 
// ── Encode / Decode ─────────────────────────────────────────────────────

std::string encode_message(const InspectorMessage& msg);

bool decode_message(const std::string& json, InspectorMessage& out);
 
// ── Factory helpers ─────────────────────────────────────────────────────
 
InspectorMessage make_request(int64_t id, std::string method, std::string params_json = "{}");
InspectorMessage make_response(int64_t id, std::string result_json);
InspectorMessage make_error(int64_t id, std::string error_message,
                            std::string error_code = "internal_error",
                            std::string error_data_json = "{}");
InspectorMessage make_event(std::string method, std::string params_json = "{}");
 
// ── Method name constants ───────────────────────────────────────────────
 
namespace methods {
#define PULP_INSPECT_METHOD(symbol, wire_name, capability, kind) \
    inline constexpr auto symbol = wire_name;
#include <pulp/inspect/protocol_methods.inc>
#undef PULP_INSPECT_METHOD
}
 
} // namespace pulp::inspect