Skip to content

Commit cf248a0

Browse files
dsnopekdsnopek
committed
Add ScriptInstance class which mimicks the API of Godot's internal ScriptInstance class
1 parent 5a16059 commit cf248a0

File tree

4 files changed

+491
-0
lines changed

4 files changed

+491
-0
lines changed

‎binding_generator.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -650,6 +650,23 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
650650
result.append("")
651651
result.append("public:")
652652

653+
if class_name == "Callable":
654+
result.append("\tstruct CallError {")
655+
result.append("\t\tenum Error {")
656+
result.append("\t\t\tCALL_OK,")
657+
result.append("\t\t\tCALL_ERROR_INVALID_METHOD,")
658+
result.append("\t\t\tCALL_ERROR_INVALID_ARGUMENT,")
659+
result.append("\t\t\tCALL_ERROR_TOO_MANY_ARGUMENTS,")
660+
result.append("\t\t\tCALL_ERROR_TOO_FEW_ARGUMENTS,")
661+
result.append("\t\t\tCALL_ERROR_INSTANCE_IS_NULL,")
662+
result.append("\t\t\tCALL_ERROR_METHOD_NOT_CONST,")
663+
result.append("\t\t};")
664+
result.append("\t\tError error = Error::CALL_OK;")
665+
result.append("\t\tint argument = 0;")
666+
result.append("\t\tint expected = 0;")
667+
result.append("\t};")
668+
result.append("")
669+
653670
result.append(
654671
f"\t_FORCE_INLINE_ GDExtensionTypePtr _native_ptr() const {{ return const_cast<uint8_t(*)[{snake_class_name}_SIZE]>(&opaque); }}"
655672
)

‎build_profile.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ def parse_build_profile(profile_filepath, api):
3333
front.append("FileAccess")
3434
front.append("Image")
3535
front.append("XMLParser")
36+
# In src/classes/script_instance.cpp
37+
front.append("Script")
3638
# In include/godot_cpp/templates/thread_work_pool.hpp
3739
front.append("Semaphore")
3840
while front:

‎include/godot_cpp/classes/script_instance.hpp

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
/**************************************************************************/
2+
/* script_instance.hpp */
3+
/**************************************************************************/
4+
/* This file is part of: */
5+
/* GODOT ENGINE */
6+
/* https://godotengine.org */
7+
/**************************************************************************/
8+
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9+
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10+
/* */
11+
/* Permission is hereby granted, free of charge, to any person obtaining */
12+
/* a copy of this software and associated documentation files (the */
13+
/* "Software"), to deal in the Software without restriction, including */
14+
/* without limitation the rights to use, copy, modify, merge, publish, */
15+
/* distribute, sublicense, and/or sell copies of the Software, and to */
16+
/* permit persons to whom the Software is furnished to do so, subject to */
17+
/* the following conditions: */
18+
/* */
19+
/* The above copyright notice and this permission notice shall be */
20+
/* included in all copies or substantial portions of the Software. */
21+
/* */
22+
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23+
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24+
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25+
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26+
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27+
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28+
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29+
/**************************************************************************/
30+
31+
#pragma once
32+
33+
#include <godot_cpp/classes/ref.hpp>
34+
#include <godot_cpp/templates/pair.hpp>
35+
#include <godot_cpp/variant/string_name.hpp>
36+
37+
namespace godot {
38+
39+
class Script;
40+
class ScriptLanguage;
41+
42+
class ScriptInstance {
43+
static GDExtensionScriptInstanceInfo3 script_instance_info;
44+
45+
// Used to keep the refcounted properties alive after passing pointers to the data back to Godot.
46+
_GODOT_CPP_THREAD_LOCAL static List<PropertyInfo> property_list;
47+
_GODOT_CPP_THREAD_LOCAL static List<MethodInfo> method_list;
48+
49+
#ifdef _GODOT_CPP_AVOID_THREAD_LOCAL
50+
static std::recursive_mutex _property_list_mutex;
51+
static std::recursive_mutex _method_list_mutex;
52+
#endif
53+
54+
static GDExtensionBool gdextension_script_instance_set(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value);
55+
static GDExtensionBool gdextension_script_instance_get(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
56+
static const GDExtensionPropertyInfo *gdextension_script_instance_get_property_list(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
57+
static void gdextension_script_instance_free_property_list(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionPropertyInfo *p_list, uint32_t p_count);
58+
static GDExtensionVariantType gdextension_script_instance_get_property_type(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid);
59+
static GDExtensionBool gdextension_script_instance_validate_property(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionPropertyInfo *p_property);
60+
static GDExtensionBool gdextension_script_instance_property_can_revert(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name);
61+
static GDExtensionBool gdextension_script_instance_property_get_revert(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
62+
static GDExtensionObjectPtr gdextension_script_instance_get_owner(GDExtensionScriptInstanceDataPtr p_instance);
63+
static void gdextension_script_instance_get_property_state(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionScriptInstancePropertyStateAdd p_add_func, void *p_userdata);
64+
static const GDExtensionMethodInfo *gdextension_script_instance_get_method_list(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
65+
static void gdextension_script_instance_free_method_list(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionMethodInfo *p_list, uint32_t p_count);
66+
static GDExtensionBool gdextension_script_instance_has_method(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name);
67+
static GDExtensionInt gdextension_script_instance_get_method_argument_count(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid);
68+
static void gdextension_script_instance_call(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_method, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error);
69+
static void gdextension_script_instance_notification(GDExtensionScriptInstanceDataPtr p_instance, int32_t p_what, GDExtensionBool p_reversed);
70+
static void gdextension_script_instance_to_string(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out);
71+
static void gdextension_script_instance_refcount_incremented(GDExtensionScriptInstanceDataPtr p_instance);
72+
static GDExtensionBool gdextension_script_instance_refcount_decremented(GDExtensionScriptInstanceDataPtr p_instance);
73+
static GDExtensionObjectPtr gdextension_script_instance_get_script(GDExtensionScriptInstanceDataPtr p_instance);
74+
static GDExtensionBool gdextension_script_instance_is_placeholder(GDExtensionScriptInstanceDataPtr p_instance);
75+
static GDExtensionBool gdextension_script_instance_set_fallback(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value);
76+
static GDExtensionBool gdextension_script_instance_get_fallback(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
77+
static GDExtensionScriptLanguagePtr gdextension_script_instance_get_language(GDExtensionScriptInstanceDataPtr p_instance);
78+
static void gdextension_script_instance_free(GDExtensionScriptInstanceDataPtr p_instance);
79+
80+
public:
81+
static GDExtensionScriptInstancePtr create_native_instance(ScriptInstance *p_instance) {
82+
return internal::gdextension_interface_script_instance_create3(&script_instance_info, p_instance);
83+
}
84+
85+
virtual bool set(const StringName &p_name, const Variant &p_value) = 0;
86+
virtual bool get(const StringName &p_name, Variant &r_ret) const = 0;
87+
virtual void get_property_list(List<PropertyInfo> *p_properties) const = 0;
88+
virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid) const = 0;
89+
virtual void validate_property(PropertyInfo &p_property) const = 0;
90+
virtual bool property_can_revert(const StringName &p_name) const = 0;
91+
virtual bool property_get_revert(const StringName &p_name, Variant &r_ret) const = 0;
92+
virtual Object *get_owner() = 0;
93+
virtual void get_property_state(List<Pair<StringName, Variant>> &state);
94+
virtual void get_method_list(List<MethodInfo> *p_info) const = 0;
95+
virtual bool has_method(const StringName &p_method) const = 0;
96+
virtual int get_method_argument_count(const StringName &p_method, bool *r_is_valid = nullptr) const = 0;
97+
virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) = 0;
98+
virtual void notification(int p_notification, bool p_reversed) = 0;
99+
virtual String to_string(bool *r_valid) = 0;
100+
virtual void refcount_incremented() = 0;
101+
virtual bool refcount_decremented() = 0;
102+
virtual Ref<Script> get_script() const = 0;
103+
virtual bool is_placeholder() const = 0;
104+
virtual void property_set_fallback(const StringName &p_name, const Variant &p_value, bool *r_valid) = 0;
105+
virtual Variant property_get_fallback(const StringName &p_name, bool *r_valid) = 0;
106+
virtual ScriptLanguage *get_language() = 0;
107+
108+
virtual ~ScriptInstance(){};
109+
};
110+
111+
}; // namespace godot

0 commit comments

Comments
 (0)