Skip to content

Commit 2e40d13

Browse files
dsnopekdsnopek
committed
Add ScriptInstance class which mimicks the API of Godot's internal ScriptInstance class
1 parent 543c1f7 commit 2e40d13

File tree

7 files changed

+804
-0
lines changed

7 files changed

+804
-0
lines changed

‎binding_generator.py

+17
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

+3
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ 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("ScriptExtension")
38+
front.append("ScriptLanguageExtension")
3639
# In include/godot_cpp/templates/thread_work_pool.hpp
3740
front.append("Semaphore")
3841
while front:

‎include/godot_cpp/classes/script_instance.hpp

+167
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
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/hash_map.hpp>
35+
#include <godot_cpp/templates/pair.hpp>
36+
#include <godot_cpp/variant/string_name.hpp>
37+
38+
namespace godot {
39+
40+
class Script;
41+
class ScriptExtension;
42+
class ScriptLanguage;
43+
class ScriptLanguageExtension;
44+
45+
class ScriptInstance {
46+
static GDExtensionScriptInstanceInfo3 script_instance_info;
47+
48+
// Used to keep the refcounted properties alive after passing pointers to the data back to Godot.
49+
_GODOT_CPP_THREAD_LOCAL static List<PropertyInfo> property_list;
50+
_GODOT_CPP_THREAD_LOCAL static List<MethodInfo> method_list;
51+
52+
#ifdef _GODOT_CPP_AVOID_THREAD_LOCAL
53+
static std::recursive_mutex _property_list_mutex;
54+
static std::recursive_mutex _method_list_mutex;
55+
#endif
56+
57+
static GDExtensionBool gdextension_script_instance_set(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value);
58+
static GDExtensionBool gdextension_script_instance_get(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
59+
static const GDExtensionPropertyInfo *gdextension_script_instance_get_property_list(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
60+
static void gdextension_script_instance_free_property_list(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionPropertyInfo *p_list, uint32_t p_count);
61+
static GDExtensionVariantType gdextension_script_instance_get_property_type(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid);
62+
static GDExtensionBool gdextension_script_instance_validate_property(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionPropertyInfo *p_property);
63+
static GDExtensionBool gdextension_script_instance_property_can_revert(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name);
64+
static GDExtensionBool gdextension_script_instance_property_get_revert(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
65+
static GDExtensionObjectPtr gdextension_script_instance_get_owner(GDExtensionScriptInstanceDataPtr p_instance);
66+
static void gdextension_script_instance_get_property_state(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionScriptInstancePropertyStateAdd p_add_func, void *p_userdata);
67+
static const GDExtensionMethodInfo *gdextension_script_instance_get_method_list(GDExtensionScriptInstanceDataPtr p_instance, uint32_t *r_count);
68+
static void gdextension_script_instance_free_method_list(GDExtensionScriptInstanceDataPtr p_instance, const GDExtensionMethodInfo *p_list, uint32_t p_count);
69+
static GDExtensionBool gdextension_script_instance_has_method(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name);
70+
static GDExtensionInt gdextension_script_instance_get_method_argument_count(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionBool *r_is_valid);
71+
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);
72+
static void gdextension_script_instance_notification(GDExtensionScriptInstanceDataPtr p_instance, int32_t p_what, GDExtensionBool p_reversed);
73+
static void gdextension_script_instance_to_string(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out);
74+
static void gdextension_script_instance_refcount_incremented(GDExtensionScriptInstanceDataPtr p_instance);
75+
static GDExtensionBool gdextension_script_instance_refcount_decremented(GDExtensionScriptInstanceDataPtr p_instance);
76+
static GDExtensionObjectPtr gdextension_script_instance_get_script(GDExtensionScriptInstanceDataPtr p_instance);
77+
static GDExtensionBool gdextension_script_instance_is_placeholder(GDExtensionScriptInstanceDataPtr p_instance);
78+
static GDExtensionBool gdextension_script_instance_set_fallback(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value);
79+
static GDExtensionBool gdextension_script_instance_get_fallback(GDExtensionScriptInstanceDataPtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret);
80+
static GDExtensionScriptLanguagePtr gdextension_script_instance_get_language(GDExtensionScriptInstanceDataPtr p_instance);
81+
static void gdextension_script_instance_free(GDExtensionScriptInstanceDataPtr p_instance);
82+
83+
GDExtensionScriptInstancePtr _owner = nullptr;
84+
85+
public:
86+
GDExtensionScriptInstancePtr get_native_instance() {
87+
if (_owner == nullptr) {
88+
_owner = internal::gdextension_interface_script_instance_create3(&script_instance_info, this);
89+
}
90+
return _owner;
91+
}
92+
93+
virtual bool set(const StringName &p_name, const Variant &p_value) = 0;
94+
virtual bool get(const StringName &p_name, Variant &r_ret) const = 0;
95+
virtual void get_property_list(List<PropertyInfo> *p_properties) const = 0;
96+
virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid) const = 0;
97+
virtual void validate_property(PropertyInfo &p_property) const = 0;
98+
virtual bool property_can_revert(const StringName &p_name) const = 0;
99+
virtual bool property_get_revert(const StringName &p_name, Variant &r_ret) const = 0;
100+
virtual Object *get_owner() = 0;
101+
virtual void get_property_state(List<Pair<StringName, Variant>> &state);
102+
virtual void get_method_list(List<MethodInfo> *p_info) const = 0;
103+
virtual bool has_method(const StringName &p_method) const = 0;
104+
virtual int get_method_argument_count(const StringName &p_method, bool *r_is_valid = nullptr) const = 0;
105+
virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) = 0;
106+
virtual void notification(int p_notification, bool p_reversed) = 0;
107+
virtual String to_string(bool *r_valid) = 0;
108+
virtual void refcount_incremented() = 0;
109+
virtual bool refcount_decremented() = 0;
110+
virtual Ref<Script> get_script() const = 0;
111+
virtual bool is_placeholder() const = 0;
112+
virtual void property_set_fallback(const StringName &p_name, const Variant &p_value, bool *r_valid) = 0;
113+
virtual Variant property_get_fallback(const StringName &p_name, bool *r_valid) = 0;
114+
virtual ScriptLanguage *get_language() = 0;
115+
116+
virtual ~ScriptInstance(){};
117+
};
118+
119+
class PlaceHolderScriptInstance : public ScriptInstance {
120+
Object *owner = nullptr;
121+
List<PropertyInfo> properties;
122+
HashMap<StringName, Variant> values;
123+
Dictionary constants;
124+
ScriptLanguageExtension *language = nullptr;
125+
Ref<ScriptExtension> script;
126+
127+
public:
128+
virtual bool set(const StringName &p_name, const Variant &p_value) override;
129+
virtual bool get(const StringName &p_name, Variant &r_ret) const override;
130+
virtual void get_property_list(List<PropertyInfo> *p_properties) const override;
131+
virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid = nullptr) const override;
132+
virtual void validate_property(PropertyInfo &p_property) const override {}
133+
134+
virtual bool property_can_revert(const StringName &p_name) const override { return false; }
135+
virtual bool property_get_revert(const StringName &p_name, Variant &r_ret) const override { return false; }
136+
137+
virtual void get_method_list(List<MethodInfo> *p_list) const override;
138+
virtual bool has_method(const StringName &p_method) const override;
139+
140+
virtual int get_method_argument_count(const StringName &p_method, bool *r_is_valid = nullptr) const override {
141+
if (r_is_valid) {
142+
*r_is_valid = false;
143+
}
144+
return 0;
145+
}
146+
147+
virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override;
148+
virtual void notification(int p_notification, bool p_reversed = false) override {}
149+
150+
virtual Ref<Script> get_script() const override { return script; }
151+
152+
virtual ScriptLanguage *get_language() override { return (ScriptLanguage *)language; }
153+
154+
Object *get_owner() override { return owner; }
155+
156+
void update(const List<PropertyInfo> &p_properties, const HashMap<StringName, Variant> &p_values);
157+
158+
virtual bool is_placeholder() const override { return true; }
159+
160+
virtual void property_set_fallback(const StringName &p_name, const Variant &p_value, bool *r_valid = nullptr) override;
161+
virtual Variant property_get_fallback(const StringName &p_name, bool *r_valid = nullptr) override;
162+
163+
PlaceHolderScriptInstance(ScriptLanguageExtension *p_language, Ref<ScriptExtension> p_script, Object *p_owner);
164+
~PlaceHolderScriptInstance();
165+
};
166+
167+
}; // namespace godot

‎include/godot_cpp/godot.hpp

+1
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ extern "C" GDExtensionInterfaceCallableCustomGetUserData gdextension_interface_c
179179
extern "C" GDExtensionInterfaceRefGetObject gdextension_interface_ref_get_object;
180180
extern "C" GDExtensionInterfaceRefSetObject gdextension_interface_ref_set_object;
181181
extern "C" GDExtensionInterfaceScriptInstanceCreate3 gdextension_interface_script_instance_create3;
182+
extern "C" GDExtensionInterfaceObjectGetScriptInstance gdextension_interface_object_get_script_instance;
182183
extern "C" GDExtensionInterfacePlaceHolderScriptInstanceCreate gdextension_interface_placeholder_script_instance_create;
183184
extern "C" GDExtensionInterfacePlaceHolderScriptInstanceUpdate gdextension_interface_placeholder_script_instance_update;
184185
extern "C" GDExtensionInterfaceClassdbConstructObject2 gdextension_interface_classdb_construct_object2;

‎include/godot_cpp/variant/variant.hpp

+6
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,12 @@ class Variant {
304304
}
305305

306306
static void evaluate(const Operator &op, const Variant &a, const Variant &b, Variant &r_ret, bool &r_valid);
307+
static _FORCE_INLINE_ Variant evaluate(const Operator &p_op, const Variant &p_a, const Variant &p_b) {
308+
bool valid = true;
309+
Variant res;
310+
evaluate(p_op, p_a, p_b, res, valid);
311+
return res;
312+
}
307313

308314
void set(const Variant &key, const Variant &value, bool *r_valid = nullptr);
309315
void set_named(const StringName &name, const Variant &value, bool &r_valid);

0 commit comments

Comments
 (0)