hertog/godot-module-template
Template
2
1
Fork 1
Code Issues 2 Pull requests 2 Projects Releases Packages Wiki Activity Actions

feat: modules moved and engine moved to submodule

Browse source
This commit is contained in:
Jan van der Weide 2025-04-12 18:40:44 +02:00
parent dfb5e645cd
commit c33d2130cc
5136 changed files with 225275 additions and 64485 deletions
Download patch file Download diff file Expand all files Collapse all files

41
engine/modules/jsonrpc/jsonrpc.compat.inc Normal file
View file

@ -0,0 +1,41 @@
/**************************************************************************/
/* jsonrpc.compat.inc */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#ifndef DISABLE_DEPRECATED
void JSONRPC::_set_scope_bind_compat_104890(const String &p_scope, Object *p_obj) {
ERR_PRINT("JSONRPC::set_scope is not supported anymore. Upgrade to JSONRPC::set_method.");
}
void JSONRPC::_bind_compatibility_methods() {
ClassDB::bind_compatibility_method(D_METHOD("set_scope", "scope", "target"), &JSONRPC::_set_scope_bind_compat_104890);
}
#endif

53
engine/modules/jsonrpc/jsonrpc.cpp
View file

@ -29,6 +29,7 @@
/**************************************************************************/
#include "jsonrpc.h"
#include "jsonrpc.compat.inc"
#include "core/io/json.h"
@ -39,7 +40,7 @@ JSONRPC::~JSONRPC() {
}
void JSONRPC::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_scope", "scope", "target"), &JSONRPC::set_scope);
ClassDB::bind_method(D_METHOD("set_method", "name", "callback"), &JSONRPC::set_method);
ClassDB::bind_method(D_METHOD("process_action", "action", "recurse"), &JSONRPC::process_action, DEFVAL(false));
ClassDB::bind_method(D_METHOD("process_string", "action"), &JSONRPC::process_string);
@ -99,9 +100,6 @@ Variant JSONRPC::process_action(const Variant &p_action, bool p_process_arr_elem
if (p_action.get_type() == Variant::DICTIONARY) {
Dictionary dict = p_action;
String method = dict.get("method", "");
if (method.begins_with("$/")) {
return ret;
}
Array args;
if (dict.has("params")) {
@ -113,14 +111,11 @@ Variant JSONRPC::process_action(const Variant &p_action, bool p_process_arr_elem
}
}
Object *object = this;
if (method_scopes.has(method.get_base_dir())) {
object = method_scopes[method.get_base_dir()];
method = method.get_file();
}
/// A Notification is a Request object without an "id" member.
bool is_notification = !dict.has("id");
Variant id;
if (dict.has("id")) {
if (!is_notification) {
id = dict["id"];
// Account for implementations that discern between int and float on the json serialization level, by using an int if there is a .0 fraction. See #100914
@ -129,25 +124,35 @@ Variant JSONRPC::process_action(const Variant &p_action, bool p_process_arr_elem
}
}
if (object == nullptr || !object->has_method(method)) {
ret = make_response_error(JSONRPC::METHOD_NOT_FOUND, "Method not found: " + method, id);
if (methods.has(method)) {
Variant call_ret = methods[method].callv(args);
ret = make_response(call_ret, id);
} else {
Variant call_ret = object->callv(method, args);
if (id.get_type() != Variant::NIL) {
ret = make_response(call_ret, id);
}
ret = make_response_error(JSONRPC::METHOD_NOT_FOUND, "Method not found: " + method, id);
}
/// The Server MUST NOT reply to a Notification
if (is_notification) {
ret = Variant();
}
} else if (p_action.get_type() == Variant::ARRAY && p_process_arr_elements) {
Array arr = p_action;
int size = arr.size();
if (size) {
if (!arr.is_empty()) {
Array arr_ret;
for (int i = 0; i < size; i++) {
const Variant &var = arr.get(i);
arr_ret.push_back(process_action(var));
for (const Variant &var : arr) {
Variant res = process_action(var);
if (res.get_type() != Variant::NIL) {
arr_ret.push_back(res);
}
}
/// If there are no Response objects contained within the Response array as it is to be sent to the client, the server MUST NOT return an empty Array and should return nothing at all.
if (!arr_ret.is_empty()) {
ret = arr_ret;
}
ret = arr_ret;
} else {
/// If the batch rpc call itself fails to be recognized ... as an Array with at least one value, the response from the Server MUST be a single Response object.
ret = make_response_error(JSONRPC::INVALID_REQUEST, "Invalid Request");
}
} else {
@ -175,6 +180,6 @@ String JSONRPC::process_string(const String &p_input) {
return ret.to_json_string();
}
void JSONRPC::set_scope(const String &p_scope, Object *p_obj) {
method_scopes[p_scope] = p_obj;
void JSONRPC::set_method(const String &p_name, const Callable &p_callback) {
methods[p_name] = p_callback;
}

14
engine/modules/jsonrpc/jsonrpc.h
View file

@ -28,8 +28,7 @@
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#ifndef JSONRPC_H
#define JSONRPC_H
#pragma once
#include "core/object/class_db.h"
#include "core/variant/variant.h"
@ -37,11 +36,16 @@
class JSONRPC : public Object {
GDCLASS(JSONRPC, Object)
HashMap<String, Object *> method_scopes;
HashMap<String, Callable> methods;
protected:
static void _bind_methods();
#ifndef DISABLE_DEPRECATED
void _set_scope_bind_compat_104890(const String &p_scope, Object *p_obj);
static void _bind_compatibility_methods();
#endif
public:
JSONRPC();
~JSONRPC();
@ -62,9 +66,7 @@ public:
Variant process_action(const Variant &p_action, bool p_process_arr_elements = false);
String process_string(const String &p_input);
void set_scope(const String &p_scope, Object *p_obj);
void set_method(const String &p_name, const Callable &p_callback);
};
VARIANT_ENUM_CAST(JSONRPC::ErrorCode);
#endif // JSONRPC_H

5
engine/modules/jsonrpc/register_types.h
View file

@ -28,12 +28,9 @@
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#ifndef JSONRPC_REGISTER_TYPES_H
#define JSONRPC_REGISTER_TYPES_H
#pragma once
#include "modules/register_module_types.h"
void initialize_jsonrpc_module(ModuleInitializationLevel p_level);
void uninitialize_jsonrpc_module(ModuleInitializationLevel p_level);
#endif // JSONRPC_REGISTER_TYPES_H

10
engine/modules/jsonrpc/tests/test_jsonrpc.cpp
View file

@ -57,10 +57,6 @@ String TestClassJSONRPC::something(const String &p_in) {
return p_in + ", please";
}
void TestClassJSONRPC::_bind_methods() {
ClassDB::bind_method(D_METHOD("something", "in"), &TestClassJSONRPC::something);
}
void test_process_action(const Variant &p_in, const Variant &p_expected, bool p_process_array_elements) {
TestClassJSONRPC json_rpc = TestClassJSONRPC();
const Variant &observed = json_rpc.process_action(p_in, p_process_array_elements);
@ -83,4 +79,10 @@ void test_process_action_bad_method(const Dictionary &p_in) {
check_error_no_method(out_dict);
}
void test_no_response(const Variant &p_in) {
TestClassJSONRPC json_rpc = TestClassJSONRPC();
const Variant &res = json_rpc.process_action(p_in, true);
CHECK(res.get_type() == Variant::NIL);
}
} // namespace TestJSONRPC

82
engine/modules/jsonrpc/tests/test_jsonrpc.h
View file

@ -28,8 +28,7 @@
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#ifndef TEST_JSONRPC_H
#define TEST_JSONRPC_H
#pragma once
#include "tests/test_macros.h"
#include "tests/test_utils.h"
@ -47,6 +46,7 @@ TEST_CASE("[JSONRPC] process_action invalid") {
check_invalid(json_rpc.process_action(1234));
check_invalid(json_rpc.process_action(false));
check_invalid(json_rpc.process_action(3.14159));
check_invalid(json_rpc.process_action(Array()));
}
void check_invalid_string(const String &p_str);
@ -58,23 +58,21 @@ TEST_CASE("[JSONRPC] process_string invalid") {
check_invalid_string(json_rpc.process_string("1234"));
check_invalid_string(json_rpc.process_string("false"));
check_invalid_string(json_rpc.process_string("3.14159"));
check_invalid_string(json_rpc.process_string("[]"));
}
class TestClassJSONRPC : public JSONRPC {
GDCLASS(TestClassJSONRPC, JSONRPC)
public:
String something(const String &p_in);
TestClassJSONRPC() {
set_method("something", callable_mp(this, &TestClassJSONRPC::something));
}
protected:
static void _bind_methods();
String something(const String &p_in);
};
void test_process_action(const Variant &p_in, const Variant &p_expected, bool p_process_array_elements = false);
TEST_CASE("[JSONRPC] process_action Dictionary") {
ClassDB::register_class<TestClassJSONRPC>();
Dictionary in_dict = Dictionary();
in_dict["method"] = "something";
in_dict["id"] = "ID";
@ -129,11 +127,73 @@ void test_process_action_bad_method(const Dictionary &p_in);
TEST_CASE("[JSONRPC] process_action bad method") {
Dictionary in_dict;
in_dict["id"] = 1;
in_dict["method"] = "nothing";
test_process_action_bad_method(in_dict);
}
} // namespace TestJSONRPC
void test_no_response(const Variant &p_in);
#endif // TEST_JSONRPC_H
TEST_CASE("[JSONRPC] process_action notification") {
Dictionary in_dict = Dictionary();
in_dict["method"] = "something";
in_dict["params"] = "yes";
test_no_response(in_dict);
}
TEST_CASE("[JSONRPC] process_action notification bad method") {
Dictionary in_dict;
in_dict["method"] = "nothing";
test_no_response(in_dict);
}
TEST_CASE("[JSONRPC] process_action notification batch") {
Array in;
Dictionary in_1;
in_1["method"] = "something";
in_1["params"] = "more";
in.push_back(in_1);
Dictionary in_2;
in_2["method"] = "something";
in_2["params"] = "yes";
in.push_back(in_2);
test_no_response(in);
}
TEST_CASE("[JSONRPC] mixed batch") {
Array in;
Dictionary in_1;
in_1["method"] = "something";
in_1["id"] = 1;
in_1["params"] = "more";
in.push_back(in_1);
Dictionary in_2;
in_2["method"] = "something";
in_2["id"] = 2;
in_2["params"] = "yes";
in.push_back(in_2);
Dictionary in_3;
in_3["method"] = "something";
in_3["params"] = "yes";
in.push_back(in_3);
Array expected;
Dictionary expected_1;
expected_1["jsonrpc"] = "2.0";
expected_1["id"] = 1;
expected_1["result"] = "more, please";
expected.push_back(expected_1);
Dictionary expected_2;
expected_2["jsonrpc"] = "2.0";
expected_2["id"] = 2;
expected_2["result"] = "yes, please";
expected.push_back(expected_2);
test_process_action(in, expected, true);
}
} // namespace TestJSONRPC