Skip to content

Commit b8ecc3d

Browse files
dsnopekdsnopek
committed
Add ScriptInstanceExtension class which mimicks the API of Godot's internal ScriptInstance class
1 parent daf6ad3 commit b8ecc3d

File tree

2 files changed

+325
-0
lines changed

2 files changed

+325
-0
lines changed

‎include/godot_cpp/classes/script_instance_extension.hpp

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/**************************************************************************/
2+
/* script_instance_extension.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+
#ifndef GODOT_SCRIPT_INSTANCE_EXTENSION_HPP
32+
#define GODOT_SCRIPT_INSTANCE_EXTENSION_HPP
33+
34+
#include <godot_cpp/classes/ref.hpp>
35+
#include <godot_cpp/variant/string_name.hpp>
36+
37+
namespace godot {
38+
39+
class Script;
40+
class ScriptLanguage;
41+
42+
class ScriptInstanceExtension {
43+
static GDExtensionScriptInstanceInfo3 script_instance_info;
44+
45+
public:
46+
static GDExtensionScriptInstancePtr create_native_instance(ScriptInstanceExtension *p_instance) {
47+
return internal::gdextension_interface_script_instance_create3(&script_instance_info, p_instance);
48+
}
49+
50+
virtual bool set(const StringName &p_name, const Variant &p_value) = 0;
51+
virtual bool get(const StringName &p_name, Variant &r_ret) const = 0;
52+
virtual const GDExtensionPropertyInfo *get_property_list(uint32_t *r_count) const = 0;
53+
virtual void free_property_list(const GDExtensionPropertyInfo *p_list, uint32_t p_count) const = 0;
54+
virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid) const = 0;
55+
virtual bool validate_property(GDExtensionPropertyInfo &p_property) const = 0;
56+
virtual bool get_class_category(GDExtensionPropertyInfo &r_class_category) const;
57+
virtual bool property_can_revert(const StringName &p_name) const = 0;
58+
virtual bool property_get_revert(const StringName &p_name, Variant &r_ret) const = 0;
59+
virtual Object *get_owner() = 0;
60+
virtual void get_property_state(GDExtensionScriptInstancePropertyStateAdd p_add_func, void *p_userdata) = 0;
61+
virtual const GDExtensionMethodInfo *get_method_list(uint32_t *r_count) const = 0;
62+
virtual void free_method_list(const GDExtensionMethodInfo *p_list, uint32_t p_count) const = 0;
63+
virtual bool has_method(const StringName &p_method) const = 0;
64+
virtual int get_method_argument_count(const StringName &p_method, bool *r_is_valid = nullptr) const = 0;
65+
// @todo Should godot-cpp have a Callable::CallError?
66+
virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, GDExtensionCallError &r_error) = 0;
67+
virtual void notification(int p_notification, bool p_reversed) = 0;
68+
virtual String to_string(bool *r_valid) = 0;
69+
virtual void refcount_incremented() = 0;
70+
virtual bool refcount_decremented() = 0;
71+
virtual Ref<Script> get_script() const = 0;
72+
virtual bool is_placeholder() const = 0;
73+
virtual void property_set_fallback(const StringName &p_name, const Variant &p_value, bool *r_valid) = 0;
74+
virtual Variant property_get_fallback(const StringName &p_name, bool *r_valid) = 0;
75+
virtual ScriptLanguage *get_language() = 0;
76+
77+
virtual ~ScriptInstanceExtension(){};
78+
};
79+
80+
}; // namespace godot
81+
82+
#endif // GODOT_SCRIPT_INSTANCE_EXTENSION_HPP

‎src/classes/script_instance_extension.cpp

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,243 @@
1+
/**************************************************************************/
2+
/* script_instance_extension.cpp */
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+
#include <godot_cpp/classes/script_instance_extension.hpp>
32+
33+
#include <godot_cpp/classes/script.hpp>
34+
#include <godot_cpp/classes/script_language_extension.hpp>
35+
36+
using namespace godot;
37+
38+
static GDExtensionBool gdextension_script_instance_set(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value) {
39+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
40+
const StringName *name = reinterpret_cast<const StringName *>(p_name);
41+
const Variant *value = reinterpret_cast<const Variant *>(p_value);
42+
43+
return instance->set(*name, *value);
44+
}
45+
46+
static GDExtensionBool gdextension_script_instance_get(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) {
47+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
48+
const StringName *name = reinterpret_cast<const StringName *>(p_name);
49+
Variant *ret = reinterpret_cast<Variant *>(r_ret);
50+
51+
return instance->get(*name, *ret);
52+
}
53+
54+
static const GDExtensionPropertyInfo *gdextension_script_instance_get_property_list(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count) {
55+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
56+
57+
return instance->get_property_list(r_count);
58+
}
59+
60+
static void gdextension_script_instance_free_property_list(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionPropertyInfo *p_list, uint32_t p_count) {
61+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
62+
instance->free_property_list(p_list, p_count);
63+
}
64+
65+
static GDExtensionBool gdextension_script_instance_get_class_category(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionPropertyInfo *r_class_category) {
66+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
67+
return instance->get_class_category(*r_class_category);
68+
}
69+
70+
static GDExtensionVariantType gdextension_script_instance_get_property_type(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid) {
71+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
72+
const StringName *name = reinterpret_cast<const StringName *>(p_name);
73+
74+
bool is_valid;
75+
GDExtensionVariantType ret = (GDExtensionVariantType)instance->get_property_type(*name, &is_valid);
76+
*r_is_valid = is_valid;
77+
78+
return ret;
79+
}
80+
81+
static GDExtensionBool gdextension_script_instance_validate_property(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionPropertyInfo *p_property) {
82+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
83+
return instance->validate_property(*p_property);
84+
}
85+
86+
static GDExtensionBool gdextension_script_instance_property_can_revert(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name) {
87+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
88+
const StringName *name = reinterpret_cast<const StringName *>(p_name);
89+
90+
return instance->property_can_revert(*name);
91+
}
92+
93+
static GDExtensionBool gdextension_script_instance_property_get_revert(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) {
94+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
95+
const StringName *name = reinterpret_cast<const StringName *>(p_name);
96+
Variant *ret = reinterpret_cast<Variant *>(r_ret);
97+
98+
return instance->property_get_revert(*name, *ret);
99+
}
100+
101+
static GDExtensionObjectPtr gdextension_script_instance_get_owner(GDExtensionScriptInstanceDataPtr p_instance) {
102+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
103+
104+
Object *ret = instance->get_owner();
105+
return ret->_owner;
106+
}
107+
108+
static void gdextension_script_instance_get_property_state(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionScriptInstancePropertyStateAdd p_add_func, void *p_userdata) {
109+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
110+
instance->get_property_state(p_add_func, p_userdata);
111+
}
112+
113+
static const GDExtensionMethodInfo *gdextension_script_instance_get_method_list(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count) {
114+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
115+
return instance->get_method_list(r_count);
116+
}
117+
118+
static void gdextension_script_instance_free_method_list(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionMethodInfo *p_list, uint32_t p_count) {
119+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
120+
return instance->free_method_list(p_list, p_count);
121+
}
122+
123+
static GDExtensionBool gdextension_script_instance_has_method(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name) {
124+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
125+
const StringName *name = reinterpret_cast<const StringName *>(p_name);
126+
127+
return instance->has_method(*name);
128+
}
129+
130+
static GDExtensionInt gdextension_script_instance_get_method_argument_count(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid) {
131+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
132+
const StringName *name = reinterpret_cast<const StringName *>(p_name);
133+
134+
bool is_valid;
135+
GDExtensionInt ret = instance->get_method_argument_count(*name, &is_valid);
136+
*r_is_valid = is_valid;
137+
138+
return ret;
139+
}
140+
141+
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) {
142+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
143+
const StringName *method = reinterpret_cast<const StringName *>(p_method);
144+
const Variant **args = reinterpret_cast<const Variant **>(const_cast<const void **>(p_args));
145+
Variant *ret = reinterpret_cast<Variant *>(r_return);
146+
147+
*ret = instance->callp(*method, args, p_argument_count, *r_error);
148+
}
149+
150+
static void gdextension_script_instance_notification(GDExtensionScriptInstanceDataPtr p_instance, int32_t p_what, GDExtensionBool p_reversed) {
151+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
152+
instance->notification(p_what, p_reversed);
153+
}
154+
155+
static void gdextension_script_instance_to_string(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out) {
156+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
157+
String *out = reinterpret_cast<String *>(r_out);
158+
159+
bool is_valid = false;
160+
*out = instance->to_string(&is_valid);
161+
*r_is_valid = is_valid;
162+
}
163+
164+
static void gdextension_script_instance_refcount_incremented(GDExtensionScriptInstanceDataPtr p_instance) {
165+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
166+
instance->refcount_incremented();
167+
}
168+
169+
static GDExtensionBool gdextension_script_instance_refcount_decremented(GDExtensionScriptInstanceDataPtr p_instance) {
170+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
171+
return instance->refcount_decremented();
172+
}
173+
174+
static GDExtensionObjectPtr gdextension_script_instance_get_script(GDExtensionScriptInstanceDataPtr p_instance) {
175+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
176+
return instance->get_script()->_owner;
177+
}
178+
179+
static GDExtensionBool gdextension_script_instance_is_placeholder(GDExtensionScriptInstanceDataPtr p_instance) {
180+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
181+
return instance->is_placeholder();
182+
}
183+
184+
static GDExtensionBool gdextension_script_instance_set_fallback(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value) {
185+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
186+
const StringName *name = reinterpret_cast<const StringName *>(p_name);
187+
const Variant *value = reinterpret_cast<const Variant *>(p_value);
188+
189+
bool is_valid = false;
190+
instance->property_set_fallback(*name, *value, &is_valid);
191+
return is_valid;
192+
}
193+
194+
static GDExtensionBool gdextension_script_instance_get_fallback(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) {
195+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
196+
const StringName *name = reinterpret_cast<const StringName *>(p_name);
197+
Variant *ret = reinterpret_cast<Variant *>(r_ret);
198+
199+
bool is_valid = false;
200+
instance->property_get_fallback(*name, &is_valid);
201+
return is_valid;
202+
}
203+
204+
static GDExtensionScriptLanguagePtr gdextension_script_instance_get_language(GDExtensionScriptInstanceDataPtr p_instance) {
205+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
206+
return instance->get_language()->_owner;
207+
}
208+
209+
static void gdextension_script_instance_free(GDExtensionScriptInstanceDataPtr p_instance) {
210+
if (p_instance) {
211+
ScriptInstanceExtension *instance = reinterpret_cast<ScriptInstanceExtension *>(p_instance);
212+
memdelete(instance);
213+
}
214+
}
215+
216+
GDExtensionScriptInstanceInfo3 ScriptInstanceExtension::script_instance_info = {
217+
&gdextension_script_instance_set,
218+
&gdextension_script_instance_get,
219+
&gdextension_script_instance_get_property_list,
220+
&gdextension_script_instance_free_property_list,
221+
&gdextension_script_instance_get_class_category,
222+
&gdextension_script_instance_property_can_revert,
223+
&gdextension_script_instance_property_get_revert,
224+
&gdextension_script_instance_get_owner,
225+
&gdextension_script_instance_get_property_state,
226+
&gdextension_script_instance_get_method_list,
227+
&gdextension_script_instance_free_method_list,
228+
&gdextension_script_instance_get_property_type,
229+
&gdextension_script_instance_validate_property,
230+
&gdextension_script_instance_has_method,
231+
&gdextension_script_instance_get_method_argument_count,
232+
&gdextension_script_instance_call,
233+
&gdextension_script_instance_notification,
234+
&gdextension_script_instance_to_string,
235+
&gdextension_script_instance_refcount_incremented,
236+
&gdextension_script_instance_refcount_decremented,
237+
&gdextension_script_instance_get_script,
238+
&gdextension_script_instance_is_placeholder,
239+
&gdextension_script_instance_set_fallback,
240+
&gdextension_script_instance_get_fallback,
241+
&gdextension_script_instance_get_language,
242+
&gdextension_script_instance_free,
243+
};

0 commit comments

Comments
 (0)