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

feat: godot-engine-source-4.3-stable

Browse source
This commit is contained in:
Jan van der Weide 2025-01-17 16:36:38 +01:00
parent c59a7dcade
commit 7125d019b5
11149 changed files with 5070401 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
engine/modules/jsonrpc/SCsub Normal file
View file

@ -0,0 +1,14 @@
#!/usr/bin/env python
Import("env")
Import("env_modules")
env_jsonrpc = env_modules.Clone()
env_jsonrpc.add_source_files(env.modules_sources, "*.cpp")
if env["tests"]:
env_jsonrpc.Append(CPPDEFINES=["TESTS_ENABLED"])
env_jsonrpc.add_source_files(env.modules_sources, "./tests/*.cpp")
if env["disable_exceptions"]:
env_jsonrpc.Append(CPPDEFINES=["DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS"])

6
engine/modules/jsonrpc/config.py Normal file
View file

@ -0,0 +1,6 @@
def can_build(env, platform):
return True
def configure(env):
pass

175
engine/modules/jsonrpc/jsonrpc.cpp Normal file
View file

@ -0,0 +1,175 @@
/**************************************************************************/
/* jsonrpc.cpp */
/**************************************************************************/
/* 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. */
/**************************************************************************/
#include "jsonrpc.h"
#include "core/io/json.h"
JSONRPC::JSONRPC() {
}
JSONRPC::~JSONRPC() {
}
void JSONRPC::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_scope", "scope", "target"), &JSONRPC::set_scope);
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);
ClassDB::bind_method(D_METHOD("make_request", "method", "params", "id"), &JSONRPC::make_request);
ClassDB::bind_method(D_METHOD("make_response", "result", "id"), &JSONRPC::make_response);
ClassDB::bind_method(D_METHOD("make_notification", "method", "params"), &JSONRPC::make_notification);
ClassDB::bind_method(D_METHOD("make_response_error", "code", "message", "id"), &JSONRPC::make_response_error, DEFVAL(Variant()));
BIND_ENUM_CONSTANT(PARSE_ERROR);
BIND_ENUM_CONSTANT(INVALID_REQUEST);
BIND_ENUM_CONSTANT(METHOD_NOT_FOUND);
BIND_ENUM_CONSTANT(INVALID_PARAMS);
BIND_ENUM_CONSTANT(INTERNAL_ERROR);
}
Dictionary JSONRPC::make_response_error(int p_code, const String &p_message, const Variant &p_id) const {
Dictionary dict;
dict["jsonrpc"] = "2.0";
Dictionary err;
err["code"] = p_code;
err["message"] = p_message;
dict["error"] = err;
dict["id"] = p_id;
return dict;
}
Dictionary JSONRPC::make_response(const Variant &p_value, const Variant &p_id) {
Dictionary dict;
dict["jsonrpc"] = "2.0";
dict["id"] = p_id;
dict["result"] = p_value;
return dict;
}
Dictionary JSONRPC::make_notification(const String &p_method, const Variant &p_params) {
Dictionary dict;
dict["jsonrpc"] = "2.0";
dict["method"] = p_method;
dict["params"] = p_params;
return dict;
}
Dictionary JSONRPC::make_request(const String &p_method, const Variant &p_params, const Variant &p_id) {
Dictionary dict;
dict["jsonrpc"] = "2.0";
dict["method"] = p_method;
dict["params"] = p_params;
dict["id"] = p_id;
return dict;
}
Variant JSONRPC::process_action(const Variant &p_action, bool p_process_arr_elements) {
Variant ret;
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")) {
Variant params = dict.get("params", Variant());
if (params.get_type() == Variant::ARRAY) {
args = params;
} else {
args.push_back(params);
}
}
Object *object = this;
if (method_scopes.has(method.get_base_dir())) {
object = method_scopes[method.get_base_dir()];
method = method.get_file();
}
Variant id;
if (dict.has("id")) {
id = dict["id"];
}
if (object == nullptr || !object->has_method(method)) {
ret = make_response_error(JSONRPC::METHOD_NOT_FOUND, "Method not found: " + method, id);
} else {
Variant call_ret = object->callv(method, args);
if (id.get_type() != Variant::NIL) {
ret = make_response(call_ret, id);
}
}
} else if (p_action.get_type() == Variant::ARRAY && p_process_arr_elements) {
Array arr = p_action;
int size = arr.size();
if (size) {
Array arr_ret;
for (int i = 0; i < size; i++) {
const Variant &var = arr.get(i);
arr_ret.push_back(process_action(var));
}
ret = arr_ret;
} else {
ret = make_response_error(JSONRPC::INVALID_REQUEST, "Invalid Request");
}
} else {
ret = make_response_error(JSONRPC::INVALID_REQUEST, "Invalid Request");
}
return ret;
}
String JSONRPC::process_string(const String &p_input) {
if (p_input.is_empty()) {
return String();
}
Variant ret;
JSON json;
if (json.parse(p_input) == OK) {
ret = process_action(json.get_data(), true);
} else {
ret = make_response_error(JSONRPC::PARSE_ERROR, "Parse error");
}
if (ret.get_type() == Variant::NIL) {
return "";
}
return ret.to_json_string();
}
void JSONRPC::set_scope(const String &p_scope, Object *p_obj) {
method_scopes[p_scope] = p_obj;
}

70
engine/modules/jsonrpc/jsonrpc.h Normal file
View file

@ -0,0 +1,70 @@
/**************************************************************************/
/* jsonrpc.h */
/**************************************************************************/
/* 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 JSONRPC_H
#define JSONRPC_H
#include "core/object/class_db.h"
#include "core/variant/variant.h"
class JSONRPC : public Object {
GDCLASS(JSONRPC, Object)
HashMap<String, Object *> method_scopes;
protected:
static void _bind_methods();
public:
JSONRPC();
~JSONRPC();
enum ErrorCode {
PARSE_ERROR = -32700,
INVALID_REQUEST = -32600,
METHOD_NOT_FOUND = -32601,
INVALID_PARAMS = -32602,
INTERNAL_ERROR = -32603,
};
Dictionary make_response_error(int p_code, const String &p_message, const Variant &p_id = Variant()) const;
Dictionary make_response(const Variant &p_value, const Variant &p_id);
Dictionary make_notification(const String &p_method, const Variant &p_params);
Dictionary make_request(const String &p_method, const Variant &p_params, const Variant &p_id);
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);
};
VARIANT_ENUM_CAST(JSONRPC::ErrorCode);
#endif // JSONRPC_H

49
engine/modules/jsonrpc/register_types.cpp Normal file
View file

@ -0,0 +1,49 @@
/**************************************************************************/
/* register_types.cpp */
/**************************************************************************/
/* 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. */
/**************************************************************************/
#include "register_types.h"
#include "jsonrpc.h"
#include "core/object/class_db.h"
void initialize_jsonrpc_module(ModuleInitializationLevel p_level) {
if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) {
return;
}
GDREGISTER_CLASS(JSONRPC);
}
void uninitialize_jsonrpc_module(ModuleInitializationLevel p_level) {
if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) {
return;
}
}

39
engine/modules/jsonrpc/register_types.h Normal file
View file

@ -0,0 +1,39 @@
/**************************************************************************/
/* register_types.h */
/**************************************************************************/
/* 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 JSONRPC_REGISTER_TYPES_H
#define JSONRPC_REGISTER_TYPES_H
#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

86
engine/modules/jsonrpc/tests/test_jsonrpc.cpp Normal file
View file

@ -0,0 +1,86 @@
/**************************************************************************/
/* test_jsonrpc.cpp */
/**************************************************************************/
/* 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. */
/**************************************************************************/
#include "test_jsonrpc.h"
#include "core/io/json.h"
namespace TestJSONRPC {
void check_error_code(const Dictionary &p_dict, const JSONRPC::ErrorCode &p_code) {
CHECK(p_dict["jsonrpc"] == "2.0");
REQUIRE(p_dict.has("error"));
const Dictionary &err_body = p_dict["error"];
const int &code = err_body["code"];
CHECK(code == p_code);
}
void check_invalid(const Dictionary &p_dict) {
check_error_code(p_dict, JSONRPC::INVALID_REQUEST);
}
void check_invalid_string(const String &p_str) {
JSON json;
REQUIRE(json.parse(p_str) == OK);
const Dictionary &dict = json.get_data();
check_invalid(dict);
}
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);
CHECK(observed == p_expected);
}
void test_process_string(const String &p_in, const String &p_expected) {
TestClassJSONRPC json_rpc = TestClassJSONRPC();
const String &out_str = json_rpc.process_string(p_in);
CHECK(out_str == p_expected);
}
void check_error_no_method(const Dictionary &p_dict) {
check_error_code(p_dict, JSONRPC::METHOD_NOT_FOUND);
}
void test_process_action_bad_method(const Dictionary &p_in) {
TestClassJSONRPC json_rpc = TestClassJSONRPC();
const Dictionary &out_dict = json_rpc.process_action(p_in);
check_error_no_method(out_dict);
}
} // namespace TestJSONRPC

139
engine/modules/jsonrpc/tests/test_jsonrpc.h Normal file
View file

@ -0,0 +1,139 @@
/**************************************************************************/
/* test_jsonrpc.h */
/**************************************************************************/
/* 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 TEST_JSONRPC_H
#define TEST_JSONRPC_H
#include "tests/test_macros.h"
#include "tests/test_utils.h"
#include "../jsonrpc.h"
namespace TestJSONRPC {
void check_invalid(const Dictionary &p_dict);
TEST_CASE("[JSONRPC] process_action invalid") {
JSONRPC json_rpc = JSONRPC();
check_invalid(json_rpc.process_action("String is invalid"));
check_invalid(json_rpc.process_action(1234));
check_invalid(json_rpc.process_action(false));
check_invalid(json_rpc.process_action(3.14159));
}
void check_invalid_string(const String &p_str);
TEST_CASE("[JSONRPC] process_string invalid") {
JSONRPC json_rpc = JSONRPC();
check_invalid_string(json_rpc.process_string("\"String is 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"));
}
class TestClassJSONRPC : public JSONRPC {
GDCLASS(TestClassJSONRPC, JSONRPC)
public:
String something(const String &p_in);
protected:
static void _bind_methods();
};
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";
in_dict["params"] = "yes";
Dictionary expected_dict = Dictionary();
expected_dict["jsonrpc"] = "2.0";
expected_dict["id"] = "ID";
expected_dict["result"] = "yes, please";
test_process_action(in_dict, expected_dict);
}
TEST_CASE("[JSONRPC] process_action Array") {
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);
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);
}
void test_process_string(const String &p_in, const String &p_expected);
TEST_CASE("[JSONRPC] process_string Dictionary") {
const String in = "{\"method\":\"something\",\"id\":\"ID\",\"params\":\"yes\"}";
const String expected = "{\"id\":\"ID\",\"jsonrpc\":\"2.0\",\"result\":\"yes, please\"}";
test_process_string(in, expected);
}
void test_process_action_bad_method(const Dictionary &p_in);
TEST_CASE("[JSONRPC] process_action bad method") {
Dictionary in_dict;
in_dict["method"] = "nothing";
test_process_action_bad_method(in_dict);
}
} // namespace TestJSONRPC
#endif // TEST_JSONRPC_H