2023-01-05 12:25:55 +00:00
|
|
|
/**************************************************************************/
|
|
|
|
/* script_language.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. */
|
|
|
|
/**************************************************************************/
|
2018-01-04 23:50:27 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
#ifndef SCRIPT_LANGUAGE_H
|
|
|
|
#define SCRIPT_LANGUAGE_H
|
|
|
|
|
2020-11-29 03:42:06 +00:00
|
|
|
#include "core/doc_data.h"
|
2020-11-07 22:33:38 +00:00
|
|
|
#include "core/io/resource.h"
|
2023-09-06 19:02:52 +00:00
|
|
|
#include "core/object/script_instance.h"
|
2020-11-07 22:33:38 +00:00
|
|
|
#include "core/templates/pair.h"
|
2022-05-13 13:04:37 +00:00
|
|
|
#include "core/templates/rb_map.h"
|
Fix race in ScriptServer.
Fixes #76581.
TSAN flagged this issue on starting the editor:
1. main calls register_core_types, which calls IP::create(), which calls Thread::start on the resolver thread
2. Thread::callback calls ScriptServer::thread_enter(), as "Scripts may need to attach a stack."
3. ScriptServer::thread_enter() accesses ScriptServer::_languages, which is still being initialized on the main thread by initialize_gdscript_module
This fixes the issue by skipping thread enter/exit notifications if languages have not finished initializing yet.
I'm assuming that notifying un-initialized languages of thread starts/stops would have been pointless anyways. If we need to somehow notify languages of threads before the languages initialize, we'll need a different solution.
```
Godot Engine v4.0.2.stable.custom_build.7a0977ce2 - https://godotengine.org
==================
WARNING: ThreadSanitizer: data race (pid=9426)
Write of size 4 at 0x55615b187cd0 by main thread:
#0 ScriptServer::register_language(ScriptLanguage*) /home/rcorre/src/godot/godot/core/object/script_language.cpp:177:28 (godot.linuxbsd.editor.x86_64.llvm.san+0x9e52ab9) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#1 initialize_gdscript_module(ModuleInitializationLevel) /home/rcorre/src/godot/godot/modules/gdscript/register_types.cpp:118:3 (godot.linuxbsd.editor.x86_64.llvm.san+0x36f9c6f) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#2 initialize_modules(ModuleInitializationLevel) /home/rcorre/src/godot/godot/modules/register_module_types.gen.cpp:93:2 (godot.linuxbsd.editor.x86_64.llvm.san+0x2f50499) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#3 Main::setup2(unsigned long) /home/rcorre/src/godot/godot/main/main.cpp:1961:2 (godot.linuxbsd.editor.x86_64.llvm.san+0x2f1d40d) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#4 Main::setup(char const*, int, char**, bool) /home/rcorre/src/godot/godot/main/main.cpp:1879:10 (godot.linuxbsd.editor.x86_64.llvm.san+0x2f16370) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#5 main /home/rcorre/src/godot/godot/platform/linuxbsd/godot_linuxbsd.cpp:61:14 (godot.linuxbsd.editor.x86_64.llvm.san+0x2e67e1f) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
Previous read of size 4 at 0x55615b187cd0 by thread T1:
#0 ScriptServer::thread_enter() /home/rcorre/src/godot/godot/core/object/script_language.cpp:244:22 (godot.linuxbsd.editor.x86_64.llvm.san+0x9e54aed) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#1 Thread::callback(unsigned long, Thread::Settings const&, void (*)(void*), void*) /home/rcorre/src/godot/godot/core/os/thread.cpp:61:2 (godot.linuxbsd.editor.x86_64.llvm.san+0x9464ab0) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#2 void std::__invoke_impl<void, void (*)(unsigned long, Thread::Settings const&, void (*)(void*), void*), unsigned long, Thread::Settings, void (*)(void*), void*>(std::__invoke_other, void (*&&)(unsigned long, Thread::Settings const&, void (*)(void*), void*), unsigned long&&, Thread::Settings&&, void (*&&)(void*), void*&&) /usr/bin/../lib64/gcc/x86_64-pc-linux-gnu/12.2.1/../../../../include/c++/12.2.1/bits/invoke.h:61:14 (godot.linuxbsd.editor.x86_64.llvm.san+0x9465283) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#3 std::__invoke_result<void (*)(unsigned long, Thread::Settings const&, void (*)(void*), void*), unsigned long, Thread::Settings, void (*)(void*), void*>::type std::__invoke<void (*)(unsigned long, Thread::Settings const&, void (*)(void*), void*), unsigned long, Thread::Settings, void (*)(void*), void*>(void (*&&)(unsigned long, Thread::Settings const&, void (*)(void*), void*), unsigned long&&, Thread::Settings&&, void (*&&)(void*), void*&&) /usr/bin/../lib64/gcc/x86_64-pc-linux-gnu/12.2.1/../../../../include/c++/12.2.1/bits/invoke.h:96:14 (godot.linuxbsd.editor.x86_64.llvm.san+0x9465283)
#4 void std::thread::_Invoker<std::tuple<void (*)(unsigned long, Thread::Settings const&, void (*)(void*), void*), unsigned long, Thread::Settings, void (*)(void*), void*>>::_M_invoke<0ul, 1ul, 2ul, 3ul, 4ul>(std::_Index_tuple<0ul, 1ul, 2ul, 3ul, 4ul>) /usr/bin/../lib64/gcc/x86_64-pc-linux-gnu/12.2.1/../../../../include/c++/12.2.1/bits/std_thread.h:258:13 (godot.linuxbsd.editor.x86_64.llvm.san+0x9465283)
#5 std::thread::_Invoker<std::tuple<void (*)(unsigned long, Thread::Settings const&, void (*)(void*), void*), unsigned long, Thread::Settings, void (*)(void*), void*>>::operator()() /usr/bin/../lib64/gcc/x86_64-pc-linux-gnu/12.2.1/../../../../include/c++/12.2.1/bits/std_thread.h:265:11 (godot.linuxbsd.editor.x86_64.llvm.san+0x9465283)
#6 std::thread::_State_impl<std::thread::_Invoker<std::tuple<void (*)(unsigned long, Thread::Settings const&, void (*)(void*), void*), unsigned long, Thread::Settings, void (*)(void*), void*>>>::_M_run() /usr/bin/../lib64/gcc/x86_64-pc-linux-gnu/12.2.1/../../../../include/c++/12.2.1/bits/std_thread.h:210:13 (godot.linuxbsd.editor.x86_64.llvm.san+0x9465283)
#7 execute_native_thread_routine /usr/src/debug/gcc/gcc/libstdc++-v3/src/c++11/thread.cc:82:18 (libstdc++.so.6+0xd72c2) (BuildId: 6fe66a2d539a78c993bd2d377e00fad389220963)
Location is global 'ScriptServer::_language_count' of size 4 at 0x55615b187cd0 (godot.linuxbsd.editor.x86_64.llvm.san+0xbf46cd0)
Thread T1 (tid=9431, running) created by main thread at:
#0 pthread_create <null> (godot.linuxbsd.editor.x86_64.llvm.san+0x2de5776) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#1 __gthread_create /usr/src/debug/gcc/gcc-build/x86_64-pc-linux-gnu/libstdc++-v3/include/x86_64-pc-linux-gnu/bits/gthr-default.h:663:35 (libstdc++.so.6+0xd73a9) (BuildId: 6fe66a2d539a78c993bd2d377e00fad389220963)
#2 std::thread::_M_start_thread(std::unique_ptr<std::thread::_State, std::default_delete<std::thread::_State>>, void (*)()) /usr/src/debug/gcc/gcc/libstdc++-v3/src/c++11/thread.cc:147:37 (libstdc++.so.6+0xd73a9)
#3 IP::IP() /home/rcorre/src/godot/godot/core/io/ip.cpp:347:19 (godot.linuxbsd.editor.x86_64.llvm.san+0x962cbcd) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#4 IPUnix::IPUnix() /home/rcorre/src/godot/godot/drivers/unix/ip_unix.cpp:261:9 (godot.linuxbsd.editor.x86_64.llvm.san+0x4aee599) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#5 IPUnix::_create_unix() /home/rcorre/src/godot/godot/drivers/unix/ip_unix.cpp:258:9 (godot.linuxbsd.editor.x86_64.llvm.san+0x4aee599)
#6 IP::create() /home/rcorre/src/godot/godot/core/io/ip.cpp:339:9 (godot.linuxbsd.editor.x86_64.llvm.san+0x962ca5e) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#7 register_core_types() /home/rcorre/src/godot/godot/core/register_core_types.cpp:279:7 (godot.linuxbsd.editor.x86_64.llvm.san+0x93e2333) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#8 Main::setup(char const*, int, char**, bool) /home/rcorre/src/godot/godot/main/main.cpp:690:2 (godot.linuxbsd.editor.x86_64.llvm.san+0x2f08a49) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
#9 main /home/rcorre/src/godot/godot/platform/linuxbsd/godot_linuxbsd.cpp:61:14 (godot.linuxbsd.editor.x86_64.llvm.san+0x2e67e1f) (BuildId: 780a9db7c37d88e78d5ee659c4fa1cd378abd048)
SUMMARY: ThreadSanitizer: data race /home/rcorre/src/godot/godot/core/object/script_language.cpp:177:28 in ScriptServer::register_language(ScriptLanguage*)
```
Co-authored-by: Pedro J. Estébanez <RandomShaper@users.noreply.github.com>
2023-04-29 17:54:52 +00:00
|
|
|
#include "core/templates/safe_refcount.h"
|
2023-05-23 03:12:34 +00:00
|
|
|
#include "core/variant/typed_array.h"
|
2018-09-11 16:13:45 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
class ScriptLanguage;
|
2022-08-05 18:35:08 +00:00
|
|
|
template <typename T>
|
|
|
|
class TypedArray;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
typedef void (*ScriptEditRequestFunction)(const String &p_path);
|
2016-08-25 20:45:20 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
class ScriptServer {
|
|
|
|
enum {
|
2017-03-08 02:59:12 +00:00
|
|
|
MAX_LANGUAGES = 16
|
2014-02-10 01:10:30 +00:00
|
|
|
};
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
static ScriptLanguage *_languages[MAX_LANGUAGES];
|
|
|
|
static int _language_count;
|
2023-11-09 11:29:47 +00:00
|
|
|
static bool languages_ready;
|
|
|
|
static Mutex languages_mutex;
|
2024-09-10 09:29:54 +00:00
|
|
|
static thread_local bool thread_entered;
|
2023-11-09 11:29:47 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
static bool scripting_enabled;
|
2016-06-13 13:58:32 +00:00
|
|
|
static bool reload_scripts_on_save;
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2018-07-15 22:29:00 +00:00
|
|
|
struct GlobalScriptClass {
|
|
|
|
StringName language;
|
|
|
|
String path;
|
2023-01-19 15:47:01 +00:00
|
|
|
StringName base;
|
2018-07-15 22:29:00 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
static HashMap<StringName, GlobalScriptClass> global_classes;
|
2023-01-19 15:47:01 +00:00
|
|
|
static HashMap<StringName, Vector<StringName>> inheriters_cache;
|
|
|
|
static bool inheriters_cache_dirty;
|
2018-07-15 22:29:00 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2016-08-25 20:45:20 +00:00
|
|
|
static ScriptEditRequestFunction edit_request_func;
|
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
static void set_scripting_enabled(bool p_enabled);
|
|
|
|
static bool is_scripting_enabled();
|
2017-07-16 15:39:23 +00:00
|
|
|
_FORCE_INLINE_ static int get_language_count() { return _language_count; }
|
2014-02-10 01:10:30 +00:00
|
|
|
static ScriptLanguage *get_language(int p_idx);
|
2024-01-26 12:03:32 +00:00
|
|
|
static ScriptLanguage *get_language_for_extension(const String &p_extension);
|
2022-10-09 20:03:59 +00:00
|
|
|
static Error register_language(ScriptLanguage *p_language);
|
|
|
|
static Error unregister_language(const ScriptLanguage *p_language);
|
2014-11-13 03:53:12 +00:00
|
|
|
|
2016-06-13 13:58:32 +00:00
|
|
|
static void set_reload_scripts_on_save(bool p_enable);
|
|
|
|
static bool is_reload_scripts_on_save_enabled();
|
|
|
|
|
2016-06-25 13:40:33 +00:00
|
|
|
static void thread_enter();
|
|
|
|
static void thread_exit();
|
|
|
|
|
2018-07-15 22:29:00 +00:00
|
|
|
static void global_classes_clear();
|
|
|
|
static void add_global_class(const StringName &p_class, const StringName &p_base, const StringName &p_language, const String &p_path);
|
|
|
|
static void remove_global_class(const StringName &p_class);
|
2023-01-18 16:32:28 +00:00
|
|
|
static void remove_global_class_by_path(const String &p_path);
|
2018-07-15 22:29:00 +00:00
|
|
|
static bool is_global_class(const StringName &p_class);
|
|
|
|
static StringName get_global_class_language(const StringName &p_class);
|
|
|
|
static String get_global_class_path(const String &p_class);
|
|
|
|
static StringName get_global_class_base(const String &p_class);
|
2019-03-09 03:47:27 +00:00
|
|
|
static StringName get_global_class_native_base(const String &p_class);
|
2018-07-15 22:29:00 +00:00
|
|
|
static void get_global_class_list(List<StringName> *r_global_classes);
|
2023-01-19 15:47:01 +00:00
|
|
|
static void get_inheriters_list(const StringName &p_base_type, List<StringName> *r_classes);
|
2018-07-15 22:29:00 +00:00
|
|
|
static void save_global_classes();
|
|
|
|
|
2014-11-13 03:53:12 +00:00
|
|
|
static void init_languages();
|
2017-07-22 19:11:04 +00:00
|
|
|
static void finish_languages();
|
2023-11-09 11:29:47 +00:00
|
|
|
static bool are_languages_initialized();
|
2024-09-10 09:29:54 +00:00
|
|
|
static bool thread_is_entered();
|
2014-02-10 01:10:30 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
class PlaceHolderScriptInstance;
|
|
|
|
|
|
|
|
class Script : public Resource {
|
2017-03-05 15:44:50 +00:00
|
|
|
GDCLASS(Script, Resource);
|
|
|
|
OBJ_SAVE_TYPE(Script);
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
protected:
|
2024-09-18 23:37:12 +00:00
|
|
|
// Scripts are reloaded via the Script Editor when edited in Godot,
|
|
|
|
// the LSP server when edited in a connected external editor, or
|
|
|
|
// through EditorFileSystem::_update_script_documentation when updated directly on disk.
|
|
|
|
virtual bool editor_can_reload_from_file() override { return false; }
|
2017-03-05 15:44:50 +00:00
|
|
|
void _notification(int p_what);
|
2014-02-10 01:10:30 +00:00
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
friend class PlaceHolderScriptInstance;
|
2014-02-10 01:10:30 +00:00
|
|
|
virtual void _placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {}
|
|
|
|
|
2019-08-01 19:13:40 +00:00
|
|
|
Variant _get_property_default_value(const StringName &p_property);
|
2022-08-05 18:35:08 +00:00
|
|
|
TypedArray<Dictionary> _get_script_property_list();
|
|
|
|
TypedArray<Dictionary> _get_script_method_list();
|
|
|
|
TypedArray<Dictionary> _get_script_signal_list();
|
2019-08-01 19:13:40 +00:00
|
|
|
Dictionary _get_script_constant_map();
|
|
|
|
|
2024-04-17 00:01:53 +00:00
|
|
|
void _set_debugger_break_language();
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2024-03-07 19:19:05 +00:00
|
|
|
virtual void reload_from_file() override;
|
|
|
|
|
2021-06-17 22:03:09 +00:00
|
|
|
virtual bool can_instantiate() const = 0;
|
2016-08-25 20:45:20 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual Ref<Script> get_base_script() const = 0; //for script inheritance
|
2023-01-19 18:12:25 +00:00
|
|
|
virtual StringName get_global_name() const = 0;
|
2020-04-20 22:06:00 +00:00
|
|
|
virtual bool inherits_script(const Ref<Script> &p_script) const = 0;
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual StringName get_instance_base_type() const = 0; // this may not work in all scripts, will return empty if so
|
|
|
|
virtual ScriptInstance *instance_create(Object *p_this) = 0;
|
2020-04-01 23:20:12 +00:00
|
|
|
virtual PlaceHolderScriptInstance *placeholder_instance_create(Object *p_this) { return nullptr; }
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual bool instance_has(const Object *p_this) const = 0;
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual bool has_source_code() const = 0;
|
|
|
|
virtual String get_source_code() const = 0;
|
|
|
|
virtual void set_source_code(const String &p_code) = 0;
|
|
|
|
virtual Error reload(bool p_keep_state = false) = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2020-11-29 02:37:57 +00:00
|
|
|
#ifdef TOOLS_ENABLED
|
2022-03-26 15:48:43 +00:00
|
|
|
virtual Vector<DocData::ClassDoc> get_documentation() const = 0;
|
2023-08-24 10:49:20 +00:00
|
|
|
virtual String get_class_icon_path() const = 0;
|
2022-07-31 08:07:48 +00:00
|
|
|
virtual PropertyInfo get_class_category() const;
|
2020-11-29 02:37:57 +00:00
|
|
|
#endif // TOOLS_ENABLED
|
|
|
|
|
2023-10-04 04:54:03 +00:00
|
|
|
// TODO: In the next compat breakage rename to `*_script_*` to disambiguate from `Object::has_method()`.
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual bool has_method(const StringName &p_method) const = 0;
|
2023-10-04 04:54:03 +00:00
|
|
|
virtual bool has_static_method(const StringName &p_method) const { return false; }
|
|
|
|
|
2024-01-28 14:16:09 +00:00
|
|
|
virtual int get_script_method_argument_count(const StringName &p_method, bool *r_is_valid = nullptr) const;
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual MethodInfo get_method_info(const StringName &p_method) const = 0;
|
2016-08-08 04:21:22 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual bool is_tool() const = 0;
|
2018-11-27 22:55:37 +00:00
|
|
|
virtual bool is_valid() const = 0;
|
2023-05-23 16:25:34 +00:00
|
|
|
virtual bool is_abstract() const = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual ScriptLanguage *get_language() const = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual bool has_script_signal(const StringName &p_signal) const = 0;
|
|
|
|
virtual void get_script_signal_list(List<MethodInfo> *r_signals) const = 0;
|
2015-06-24 16:29:23 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual bool get_property_default_value(const StringName &p_property, Variant &r_value) const = 0;
|
2015-06-24 16:29:23 +00:00
|
|
|
|
2014-09-22 03:50:48 +00:00
|
|
|
virtual void update_exports() {} //editor tool
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void get_script_method_list(List<MethodInfo> *p_list) const = 0;
|
|
|
|
virtual void get_script_property_list(List<PropertyInfo> *p_list) const = 0;
|
2014-09-22 03:50:48 +00:00
|
|
|
|
2017-04-15 17:48:10 +00:00
|
|
|
virtual int get_member_line(const StringName &p_member) const { return -1; }
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2022-05-13 13:04:37 +00:00
|
|
|
virtual void get_constants(HashMap<StringName, Variant> *p_constants) {}
|
2022-05-19 15:00:06 +00:00
|
|
|
virtual void get_members(HashSet<StringName> *p_constants) {}
|
2017-10-17 14:35:49 +00:00
|
|
|
|
2019-01-09 23:26:00 +00:00
|
|
|
virtual bool is_placeholder_fallback_enabled() const { return false; }
|
|
|
|
|
2024-08-24 05:58:54 +00:00
|
|
|
virtual Variant get_rpc_config() const = 0;
|
2020-02-12 10:51:50 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
Script() {}
|
|
|
|
};
|
|
|
|
|
2015-06-26 04:14:31 +00:00
|
|
|
class ScriptCodeCompletionCache {
|
|
|
|
static ScriptCodeCompletionCache *singleton;
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2018-01-18 20:37:17 +00:00
|
|
|
static ScriptCodeCompletionCache *get_singleton() { return singleton; }
|
2015-06-26 04:14:31 +00:00
|
|
|
|
|
|
|
ScriptCodeCompletionCache();
|
2019-04-02 12:07:29 +00:00
|
|
|
|
|
|
|
virtual ~ScriptCodeCompletionCache() {}
|
2015-06-26 04:14:31 +00:00
|
|
|
};
|
|
|
|
|
2022-03-26 15:48:43 +00:00
|
|
|
class ScriptLanguage : public Object {
|
|
|
|
GDCLASS(ScriptLanguage, Object)
|
2023-06-11 16:23:48 +00:00
|
|
|
|
|
|
|
protected:
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
public:
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual String get_name() const = 0;
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
/* LANGUAGE FUNCTIONS */
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void init() = 0;
|
|
|
|
virtual String get_type() const = 0;
|
|
|
|
virtual String get_extension() const = 0;
|
|
|
|
virtual void finish() = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
/* EDITOR FUNCTIONS */
|
2018-07-01 16:17:40 +00:00
|
|
|
struct Warning {
|
2020-06-11 22:31:28 +00:00
|
|
|
int start_line = -1, end_line = -1;
|
|
|
|
int leftmost_column = -1, rightmost_column = -1;
|
2018-07-01 16:17:40 +00:00
|
|
|
int code;
|
|
|
|
String string_code;
|
|
|
|
String message;
|
|
|
|
};
|
|
|
|
|
2021-05-18 03:09:19 +00:00
|
|
|
struct ScriptError {
|
2023-07-24 13:49:39 +00:00
|
|
|
String path;
|
2021-05-18 03:09:19 +00:00
|
|
|
int line = -1;
|
|
|
|
int column = -1;
|
|
|
|
String message;
|
|
|
|
};
|
|
|
|
|
2021-10-11 09:30:59 +00:00
|
|
|
enum TemplateLocation {
|
|
|
|
TEMPLATE_BUILT_IN,
|
|
|
|
TEMPLATE_EDITOR,
|
|
|
|
TEMPLATE_PROJECT
|
|
|
|
};
|
|
|
|
|
2023-06-11 16:23:48 +00:00
|
|
|
enum ScriptNameCasing {
|
|
|
|
SCRIPT_NAME_CASING_AUTO,
|
|
|
|
SCRIPT_NAME_CASING_PASCAL_CASE,
|
|
|
|
SCRIPT_NAME_CASING_SNAKE_CASE,
|
|
|
|
SCRIPT_NAME_CASING_KEBAB_CASE,
|
|
|
|
};
|
|
|
|
|
2021-10-11 09:30:59 +00:00
|
|
|
struct ScriptTemplate {
|
|
|
|
String inherit = "Object";
|
|
|
|
String name;
|
|
|
|
String description;
|
|
|
|
String content;
|
|
|
|
int id = 0;
|
|
|
|
TemplateLocation origin = TemplateLocation::TEMPLATE_BUILT_IN;
|
|
|
|
|
|
|
|
String get_hash() const {
|
|
|
|
return itos(origin) + inherit + name;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2020-04-01 19:07:43 +00:00
|
|
|
void get_core_type_words(List<String> *p_core_type_words) const;
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void get_reserved_words(List<String> *p_words) const = 0;
|
2024-01-09 01:36:19 +00:00
|
|
|
virtual bool is_control_flow_keyword(const String &p_string) const = 0;
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void get_comment_delimiters(List<String> *p_delimiters) const = 0;
|
2023-02-05 09:01:01 +00:00
|
|
|
virtual void get_doc_comment_delimiters(List<String> *p_delimiters) const = 0;
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void get_string_delimiters(List<String> *p_delimiters) const = 0;
|
2021-10-11 09:30:59 +00:00
|
|
|
virtual Ref<Script> make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const { return Ref<Script>(); }
|
2021-08-01 19:47:20 +00:00
|
|
|
virtual Vector<ScriptTemplate> get_built_in_templates(const StringName &p_object) { return Vector<ScriptTemplate>(); }
|
2017-06-13 20:03:08 +00:00
|
|
|
virtual bool is_using_templates() { return false; }
|
2022-05-19 15:00:06 +00:00
|
|
|
virtual bool validate(const String &p_script, const String &p_path = "", List<String> *r_functions = nullptr, List<ScriptError> *r_errors = nullptr, List<Warning> *r_warnings = nullptr, HashSet<int> *r_safe_lines = nullptr) const = 0;
|
2018-03-09 22:34:32 +00:00
|
|
|
virtual String validate_path(const String &p_path) const { return ""; }
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual Script *create_script() const = 0;
|
2023-09-12 08:52:43 +00:00
|
|
|
#ifndef DISABLE_DEPRECATED
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual bool has_named_classes() const = 0;
|
2023-09-12 08:52:43 +00:00
|
|
|
#endif
|
2017-10-23 23:54:47 +00:00
|
|
|
virtual bool supports_builtin_mode() const = 0;
|
2020-11-29 03:42:06 +00:00
|
|
|
virtual bool supports_documentation() const { return false; }
|
2020-12-08 12:06:15 +00:00
|
|
|
virtual bool can_inherit_from_file() const { return false; }
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual int find_function(const String &p_function, const String &p_code) const = 0;
|
2020-02-17 21:06:54 +00:00
|
|
|
virtual String make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const = 0;
|
2024-02-04 18:08:41 +00:00
|
|
|
virtual bool can_make_function() const { return true; }
|
2017-04-15 17:48:10 +00:00
|
|
|
virtual Error open_in_external_editor(const Ref<Script> &p_script, int p_line, int p_col) { return ERR_UNAVAILABLE; }
|
2017-09-03 19:23:36 +00:00
|
|
|
virtual bool overrides_external_editor() { return false; }
|
2023-06-11 16:23:48 +00:00
|
|
|
virtual ScriptNameCasing preferred_file_name_casing() const { return SCRIPT_NAME_CASING_SNAKE_CASE; }
|
2017-03-05 15:44:50 +00:00
|
|
|
|
2023-05-23 03:12:34 +00:00
|
|
|
// Keep enums in sync with:
|
|
|
|
// scene/gui/code_edit.h - CodeEdit::CodeCompletionKind
|
2022-03-26 15:48:43 +00:00
|
|
|
enum CodeCompletionKind {
|
|
|
|
CODE_COMPLETION_KIND_CLASS,
|
|
|
|
CODE_COMPLETION_KIND_FUNCTION,
|
|
|
|
CODE_COMPLETION_KIND_SIGNAL,
|
|
|
|
CODE_COMPLETION_KIND_VARIABLE,
|
|
|
|
CODE_COMPLETION_KIND_MEMBER,
|
|
|
|
CODE_COMPLETION_KIND_ENUM,
|
|
|
|
CODE_COMPLETION_KIND_CONSTANT,
|
|
|
|
CODE_COMPLETION_KIND_NODE_PATH,
|
|
|
|
CODE_COMPLETION_KIND_FILE_PATH,
|
|
|
|
CODE_COMPLETION_KIND_PLAIN_TEXT,
|
|
|
|
CODE_COMPLETION_KIND_MAX
|
|
|
|
};
|
|
|
|
|
2023-05-23 03:12:34 +00:00
|
|
|
// scene/gui/code_edit.h - CodeEdit::CodeCompletionLocation
|
2022-03-08 14:03:36 +00:00
|
|
|
enum CodeCompletionLocation {
|
|
|
|
LOCATION_LOCAL = 0,
|
|
|
|
LOCATION_PARENT_MASK = 1 << 8,
|
|
|
|
LOCATION_OTHER_USER_CODE = 1 << 9,
|
|
|
|
LOCATION_OTHER = 1 << 10,
|
|
|
|
};
|
|
|
|
|
2022-03-26 15:48:43 +00:00
|
|
|
struct CodeCompletionOption {
|
|
|
|
CodeCompletionKind kind = CODE_COMPLETION_KIND_PLAIN_TEXT;
|
|
|
|
String display;
|
|
|
|
String insert_text;
|
|
|
|
Color font_color;
|
2022-05-02 23:43:50 +00:00
|
|
|
Ref<Resource> icon;
|
2022-03-26 15:48:43 +00:00
|
|
|
Variant default_value;
|
|
|
|
Vector<Pair<int, int>> matches;
|
2023-06-16 09:16:33 +00:00
|
|
|
Vector<Pair<int, int>> last_matches = { { -1, -1 } }; // This value correspond to an impossible match
|
2022-03-08 14:03:36 +00:00
|
|
|
int location = LOCATION_OTHER;
|
2023-03-12 07:33:38 +00:00
|
|
|
String theme_color_name;
|
2022-03-26 15:48:43 +00:00
|
|
|
|
|
|
|
CodeCompletionOption() {}
|
|
|
|
|
2023-03-12 07:33:38 +00:00
|
|
|
CodeCompletionOption(const String &p_text, CodeCompletionKind p_kind, int p_location = LOCATION_OTHER, const String &p_theme_color_name = "") {
|
2022-03-26 15:48:43 +00:00
|
|
|
display = p_text;
|
|
|
|
insert_text = p_text;
|
|
|
|
kind = p_kind;
|
2022-03-08 14:03:36 +00:00
|
|
|
location = p_location;
|
2023-03-12 07:33:38 +00:00
|
|
|
theme_color_name = p_theme_color_name;
|
2022-03-26 15:48:43 +00:00
|
|
|
}
|
2023-05-23 03:12:34 +00:00
|
|
|
|
|
|
|
TypedArray<int> get_option_characteristics(const String &p_base);
|
|
|
|
void clear_characteristics();
|
|
|
|
TypedArray<int> get_option_cached_characteristics() const;
|
|
|
|
|
|
|
|
private:
|
|
|
|
TypedArray<int> charac;
|
2022-03-26 15:48:43 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
virtual Error complete_code(const String &p_code, const String &p_path, Object *p_owner, List<CodeCompletionOption> *r_options, bool &r_force, String &r_call_hint) { return ERR_UNAVAILABLE; }
|
|
|
|
|
|
|
|
enum LookupResultType {
|
|
|
|
LOOKUP_RESULT_SCRIPT_LOCATION,
|
|
|
|
LOOKUP_RESULT_CLASS,
|
|
|
|
LOOKUP_RESULT_CLASS_CONSTANT,
|
|
|
|
LOOKUP_RESULT_CLASS_PROPERTY,
|
|
|
|
LOOKUP_RESULT_CLASS_METHOD,
|
2022-05-12 13:07:05 +00:00
|
|
|
LOOKUP_RESULT_CLASS_SIGNAL,
|
2022-03-26 15:48:43 +00:00
|
|
|
LOOKUP_RESULT_CLASS_ENUM,
|
|
|
|
LOOKUP_RESULT_CLASS_TBD_GLOBALSCOPE,
|
2022-07-04 15:56:34 +00:00
|
|
|
LOOKUP_RESULT_CLASS_ANNOTATION,
|
2022-03-26 15:48:43 +00:00
|
|
|
LOOKUP_RESULT_MAX
|
|
|
|
};
|
2016-09-12 13:52:29 +00:00
|
|
|
|
|
|
|
struct LookupResult {
|
2022-03-26 15:48:43 +00:00
|
|
|
LookupResultType type;
|
2016-09-12 13:52:29 +00:00
|
|
|
Ref<Script> script;
|
|
|
|
String class_name;
|
|
|
|
String class_member;
|
2021-04-27 16:53:55 +00:00
|
|
|
String class_path;
|
2016-09-12 13:52:29 +00:00
|
|
|
int location;
|
|
|
|
};
|
|
|
|
|
2019-04-17 15:06:21 +00:00
|
|
|
virtual Error lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result) { return ERR_UNAVAILABLE; }
|
2016-09-12 13:52:29 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void auto_indent_code(String &p_code, int p_from_line, int p_to_line) const = 0;
|
|
|
|
virtual void add_global_constant(const StringName &p_variable, const Variant &p_value) = 0;
|
2018-05-01 14:06:23 +00:00
|
|
|
virtual void add_named_global_constant(const StringName &p_name, const Variant &p_value) {}
|
|
|
|
virtual void remove_named_global_constant(const StringName &p_name) {}
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2016-06-25 13:40:33 +00:00
|
|
|
/* MULTITHREAD FUNCTIONS */
|
|
|
|
|
|
|
|
//some VMs need to be notified of thread creation/exiting to allocate a stack
|
|
|
|
virtual void thread_enter() {}
|
|
|
|
virtual void thread_exit() {}
|
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
/* DEBUGGER FUNCTIONS */
|
2020-02-27 02:30:20 +00:00
|
|
|
struct StackInfo {
|
|
|
|
String file;
|
|
|
|
String func;
|
|
|
|
int line;
|
|
|
|
};
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual String debug_get_error() const = 0;
|
|
|
|
virtual int debug_get_stack_level_count() const = 0;
|
|
|
|
virtual int debug_get_stack_level_line(int p_level) const = 0;
|
|
|
|
virtual String debug_get_stack_level_function(int p_level) const = 0;
|
|
|
|
virtual String debug_get_stack_level_source(int p_level) const = 0;
|
|
|
|
virtual void debug_get_stack_level_locals(int p_level, List<String> *p_locals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) = 0;
|
|
|
|
virtual void debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) = 0;
|
2020-04-01 23:20:12 +00:00
|
|
|
virtual ScriptInstance *debug_get_stack_level_instance(int p_level) { return nullptr; }
|
2017-10-17 14:35:49 +00:00
|
|
|
virtual void debug_get_globals(List<String> *p_globals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) = 0;
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual String debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems = -1, int p_max_depth = -1) = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2015-08-04 12:47:32 +00:00
|
|
|
virtual Vector<StackInfo> debug_get_current_stack_info() { return Vector<StackInfo>(); }
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void reload_all_scripts() = 0;
|
2023-12-30 07:06:54 +00:00
|
|
|
virtual void reload_scripts(const Array &p_scripts, bool p_soft_reload) = 0;
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
/* LOADER FUNCTIONS */
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void get_recognized_extensions(List<String> *p_extensions) const = 0;
|
|
|
|
virtual void get_public_functions(List<MethodInfo> *p_functions) const = 0;
|
2020-03-17 06:33:00 +00:00
|
|
|
virtual void get_public_constants(List<Pair<String, Variant>> *p_constants) const = 0;
|
2022-07-04 15:56:34 +00:00
|
|
|
virtual void get_public_annotations(List<MethodInfo> *p_annotations) const = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2016-05-22 00:18:16 +00:00
|
|
|
struct ProfilingInfo {
|
|
|
|
StringName signature;
|
|
|
|
uint64_t call_count;
|
|
|
|
uint64_t total_time;
|
|
|
|
uint64_t self_time;
|
2023-03-05 12:37:11 +00:00
|
|
|
uint64_t internal_time;
|
2016-05-22 00:18:16 +00:00
|
|
|
};
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual void profiling_start() = 0;
|
|
|
|
virtual void profiling_stop() = 0;
|
2023-03-05 12:37:11 +00:00
|
|
|
virtual void profiling_set_save_native_calls(bool p_enable) = 0;
|
2016-05-22 00:18:16 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
virtual int profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) = 0;
|
|
|
|
virtual int profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) = 0;
|
2016-05-22 00:18:16 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
virtual void frame();
|
|
|
|
|
2018-07-15 22:29:00 +00:00
|
|
|
virtual bool handles_global_class_type(const String &p_type) const { return false; }
|
2020-04-01 23:20:12 +00:00
|
|
|
virtual String get_global_class_name(const String &p_path, String *r_base_type = nullptr, String *r_icon_path = nullptr) const { return String(); }
|
2018-07-15 22:29:00 +00:00
|
|
|
|
|
|
|
virtual ~ScriptLanguage() {}
|
2014-02-10 01:10:30 +00:00
|
|
|
};
|
|
|
|
|
2023-06-11 16:23:48 +00:00
|
|
|
VARIANT_ENUM_CAST(ScriptLanguage::ScriptNameCasing);
|
|
|
|
|
2014-06-11 13:41:03 +00:00
|
|
|
extern uint8_t script_encryption_key[32];
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
class PlaceHolderScriptInstance : public ScriptInstance {
|
2022-04-04 13:06:57 +00:00
|
|
|
Object *owner = nullptr;
|
2014-02-10 01:10:30 +00:00
|
|
|
List<PropertyInfo> properties;
|
2022-05-13 13:04:37 +00:00
|
|
|
HashMap<StringName, Variant> values;
|
|
|
|
HashMap<StringName, Variant> constants;
|
2022-04-04 13:06:57 +00:00
|
|
|
ScriptLanguage *language = nullptr;
|
2014-02-10 01:10:30 +00:00
|
|
|
Ref<Script> script;
|
|
|
|
|
|
|
|
public:
|
2022-04-05 10:40:26 +00:00
|
|
|
virtual bool set(const StringName &p_name, const Variant &p_value) override;
|
|
|
|
virtual bool get(const StringName &p_name, Variant &r_ret) const override;
|
|
|
|
virtual void get_property_list(List<PropertyInfo> *p_properties) const override;
|
|
|
|
virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid = nullptr) const override;
|
2023-04-07 12:01:57 +00:00
|
|
|
virtual void validate_property(PropertyInfo &p_property) const override {}
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-08-12 18:43:14 +00:00
|
|
|
virtual bool property_can_revert(const StringName &p_name) const override { return false; };
|
|
|
|
virtual bool property_get_revert(const StringName &p_name, Variant &r_ret) const override { return false; };
|
|
|
|
|
2022-04-05 10:40:26 +00:00
|
|
|
virtual void get_method_list(List<MethodInfo> *p_list) const override;
|
|
|
|
virtual bool has_method(const StringName &p_method) const override;
|
2022-03-09 13:58:40 +00:00
|
|
|
|
2024-01-28 14:16:09 +00:00
|
|
|
virtual int get_method_argument_count(const StringName &p_method, bool *r_is_valid = nullptr) const override {
|
|
|
|
if (r_is_valid) {
|
|
|
|
*r_is_valid = false;
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2024-07-18 13:42:54 +00:00
|
|
|
virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override;
|
2023-06-24 01:07:22 +00:00
|
|
|
virtual void notification(int p_notification, bool p_reversed = false) override {}
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-04-05 10:40:26 +00:00
|
|
|
virtual Ref<Script> get_script() const override { return script; }
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-04-05 10:40:26 +00:00
|
|
|
virtual ScriptLanguage *get_language() override { return language; }
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-04-05 10:40:26 +00:00
|
|
|
Object *get_owner() override { return owner; }
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-05-13 13:04:37 +00:00
|
|
|
void update(const List<PropertyInfo> &p_properties, const HashMap<StringName, Variant> &p_values); //likely changed in editor
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-04-05 10:40:26 +00:00
|
|
|
virtual bool is_placeholder() const override { return true; }
|
2016-06-01 23:22:02 +00:00
|
|
|
|
2022-04-05 10:40:26 +00:00
|
|
|
virtual void property_set_fallback(const StringName &p_name, const Variant &p_value, bool *r_valid = nullptr) override;
|
|
|
|
virtual Variant property_get_fallback(const StringName &p_name, bool *r_valid = nullptr) override;
|
2018-07-29 20:40:09 +00:00
|
|
|
|
2022-07-12 21:12:42 +00:00
|
|
|
virtual const Variant get_rpc_config() const override { return Variant(); }
|
2016-08-19 19:48:08 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
PlaceHolderScriptInstance(ScriptLanguage *p_language, Ref<Script> p_script, Object *p_owner);
|
2014-02-10 01:10:30 +00:00
|
|
|
~PlaceHolderScriptInstance();
|
|
|
|
};
|
2020-03-25 10:10:34 +00:00
|
|
|
|
|
|
|
#endif // SCRIPT_LANGUAGE_H
|