script_language.cpp 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745
  1. /**************************************************************************/
  2. /* script_language.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. #include "script_language.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/core_string_names.h"
  33. #include "core/debugger/engine_debugger.h"
  34. #include "core/debugger/script_debugger.h"
  35. #include <stdint.h>
  36. ScriptLanguage *ScriptServer::_languages[MAX_LANGUAGES];
  37. int ScriptServer::_language_count = 0;
  38. bool ScriptServer::languages_ready = false;
  39. Mutex ScriptServer::languages_mutex;
  40. bool ScriptServer::scripting_enabled = true;
  41. bool ScriptServer::reload_scripts_on_save = false;
  42. ScriptEditRequestFunction ScriptServer::edit_request_func = nullptr;
  43. void Script::_notification(int p_what) {
  44. switch (p_what) {
  45. case NOTIFICATION_POSTINITIALIZE: {
  46. if (EngineDebugger::is_active()) {
  47. EngineDebugger::get_script_debugger()->set_break_language(get_language());
  48. }
  49. } break;
  50. }
  51. }
  52. Variant Script::_get_property_default_value(const StringName &p_property) {
  53. Variant ret;
  54. get_property_default_value(p_property, ret);
  55. return ret;
  56. }
  57. TypedArray<Dictionary> Script::_get_script_property_list() {
  58. TypedArray<Dictionary> ret;
  59. List<PropertyInfo> list;
  60. get_script_property_list(&list);
  61. for (const PropertyInfo &E : list) {
  62. ret.append(E.operator Dictionary());
  63. }
  64. return ret;
  65. }
  66. TypedArray<Dictionary> Script::_get_script_method_list() {
  67. TypedArray<Dictionary> ret;
  68. List<MethodInfo> list;
  69. get_script_method_list(&list);
  70. for (const MethodInfo &E : list) {
  71. ret.append(E.operator Dictionary());
  72. }
  73. return ret;
  74. }
  75. TypedArray<Dictionary> Script::_get_script_signal_list() {
  76. TypedArray<Dictionary> ret;
  77. List<MethodInfo> list;
  78. get_script_signal_list(&list);
  79. for (const MethodInfo &E : list) {
  80. ret.append(E.operator Dictionary());
  81. }
  82. return ret;
  83. }
  84. Dictionary Script::_get_script_constant_map() {
  85. Dictionary ret;
  86. HashMap<StringName, Variant> map;
  87. get_constants(&map);
  88. for (const KeyValue<StringName, Variant> &E : map) {
  89. ret[E.key] = E.value;
  90. }
  91. return ret;
  92. }
  93. #ifdef TOOLS_ENABLED
  94. PropertyInfo Script::get_class_category() const {
  95. String path = get_path();
  96. String scr_name;
  97. if (is_built_in()) {
  98. if (get_name().is_empty()) {
  99. scr_name = TTR("Built-in script");
  100. } else {
  101. scr_name = vformat("%s (%s)", get_name(), TTR("Built-in"));
  102. }
  103. } else {
  104. if (get_name().is_empty()) {
  105. scr_name = path.get_file();
  106. } else {
  107. scr_name = get_name();
  108. }
  109. }
  110. return PropertyInfo(Variant::NIL, scr_name, PROPERTY_HINT_NONE, path, PROPERTY_USAGE_CATEGORY);
  111. }
  112. #endif // TOOLS_ENABLED
  113. void Script::_bind_methods() {
  114. ClassDB::bind_method(D_METHOD("can_instantiate"), &Script::can_instantiate);
  115. //ClassDB::bind_method(D_METHOD("instance_create","base_object"),&Script::instance_create);
  116. ClassDB::bind_method(D_METHOD("instance_has", "base_object"), &Script::instance_has);
  117. ClassDB::bind_method(D_METHOD("has_source_code"), &Script::has_source_code);
  118. ClassDB::bind_method(D_METHOD("get_source_code"), &Script::get_source_code);
  119. ClassDB::bind_method(D_METHOD("set_source_code", "source"), &Script::set_source_code);
  120. ClassDB::bind_method(D_METHOD("reload", "keep_state"), &Script::reload, DEFVAL(false));
  121. ClassDB::bind_method(D_METHOD("get_base_script"), &Script::get_base_script);
  122. ClassDB::bind_method(D_METHOD("get_instance_base_type"), &Script::get_instance_base_type);
  123. ClassDB::bind_method(D_METHOD("get_global_name"), &Script::get_global_name);
  124. ClassDB::bind_method(D_METHOD("has_script_signal", "signal_name"), &Script::has_script_signal);
  125. ClassDB::bind_method(D_METHOD("get_script_property_list"), &Script::_get_script_property_list);
  126. ClassDB::bind_method(D_METHOD("get_script_method_list"), &Script::_get_script_method_list);
  127. ClassDB::bind_method(D_METHOD("get_script_signal_list"), &Script::_get_script_signal_list);
  128. ClassDB::bind_method(D_METHOD("get_script_constant_map"), &Script::_get_script_constant_map);
  129. ClassDB::bind_method(D_METHOD("get_property_default_value", "property"), &Script::_get_property_default_value);
  130. ClassDB::bind_method(D_METHOD("is_tool"), &Script::is_tool);
  131. ClassDB::bind_method(D_METHOD("is_abstract"), &Script::is_abstract);
  132. ADD_PROPERTY(PropertyInfo(Variant::STRING, "source_code", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_source_code", "get_source_code");
  133. }
  134. void ScriptServer::set_scripting_enabled(bool p_enabled) {
  135. scripting_enabled = p_enabled;
  136. }
  137. bool ScriptServer::is_scripting_enabled() {
  138. return scripting_enabled;
  139. }
  140. ScriptLanguage *ScriptServer::get_language(int p_idx) {
  141. MutexLock lock(languages_mutex);
  142. ERR_FAIL_INDEX_V(p_idx, _language_count, nullptr);
  143. return _languages[p_idx];
  144. }
  145. Error ScriptServer::register_language(ScriptLanguage *p_language) {
  146. MutexLock lock(languages_mutex);
  147. ERR_FAIL_NULL_V(p_language, ERR_INVALID_PARAMETER);
  148. ERR_FAIL_COND_V_MSG(_language_count >= MAX_LANGUAGES, ERR_UNAVAILABLE, "Script languages limit has been reach, cannot register more.");
  149. for (int i = 0; i < _language_count; i++) {
  150. const ScriptLanguage *other_language = _languages[i];
  151. ERR_FAIL_COND_V_MSG(other_language->get_extension() == p_language->get_extension(), ERR_ALREADY_EXISTS, "A script language with extension '" + p_language->get_extension() + "' is already registered.");
  152. ERR_FAIL_COND_V_MSG(other_language->get_name() == p_language->get_name(), ERR_ALREADY_EXISTS, "A script language with name '" + p_language->get_name() + "' is already registered.");
  153. ERR_FAIL_COND_V_MSG(other_language->get_type() == p_language->get_type(), ERR_ALREADY_EXISTS, "A script language with type '" + p_language->get_type() + "' is already registered.");
  154. }
  155. _languages[_language_count++] = p_language;
  156. return OK;
  157. }
  158. Error ScriptServer::unregister_language(const ScriptLanguage *p_language) {
  159. MutexLock lock(languages_mutex);
  160. for (int i = 0; i < _language_count; i++) {
  161. if (_languages[i] == p_language) {
  162. _language_count--;
  163. if (i < _language_count) {
  164. SWAP(_languages[i], _languages[_language_count]);
  165. }
  166. return OK;
  167. }
  168. }
  169. return ERR_DOES_NOT_EXIST;
  170. }
  171. void ScriptServer::init_languages() {
  172. { // Load global classes.
  173. global_classes_clear();
  174. #ifndef DISABLE_DEPRECATED
  175. if (ProjectSettings::get_singleton()->has_setting("_global_script_classes")) {
  176. Array script_classes = GLOBAL_GET("_global_script_classes");
  177. for (int i = 0; i < script_classes.size(); i++) {
  178. Dictionary c = script_classes[i];
  179. if (!c.has("class") || !c.has("language") || !c.has("path") || !c.has("base")) {
  180. continue;
  181. }
  182. add_global_class(c["class"], c["base"], c["language"], c["path"]);
  183. }
  184. ProjectSettings::get_singleton()->clear("_global_script_classes");
  185. }
  186. #endif
  187. Array script_classes = ProjectSettings::get_singleton()->get_global_class_list();
  188. for (int i = 0; i < script_classes.size(); i++) {
  189. Dictionary c = script_classes[i];
  190. if (!c.has("class") || !c.has("language") || !c.has("path") || !c.has("base")) {
  191. continue;
  192. }
  193. add_global_class(c["class"], c["base"], c["language"], c["path"]);
  194. }
  195. }
  196. HashSet<ScriptLanguage *> langs_to_init;
  197. {
  198. MutexLock lock(languages_mutex);
  199. for (int i = 0; i < _language_count; i++) {
  200. if (_languages[i]) {
  201. langs_to_init.insert(_languages[i]);
  202. }
  203. }
  204. }
  205. for (ScriptLanguage *E : langs_to_init) {
  206. E->init();
  207. }
  208. {
  209. MutexLock lock(languages_mutex);
  210. languages_ready = true;
  211. }
  212. }
  213. void ScriptServer::finish_languages() {
  214. HashSet<ScriptLanguage *> langs_to_finish;
  215. {
  216. MutexLock lock(languages_mutex);
  217. for (int i = 0; i < _language_count; i++) {
  218. if (_languages[i]) {
  219. langs_to_finish.insert(_languages[i]);
  220. }
  221. }
  222. }
  223. for (ScriptLanguage *E : langs_to_finish) {
  224. E->finish();
  225. }
  226. {
  227. MutexLock lock(languages_mutex);
  228. languages_ready = false;
  229. }
  230. global_classes_clear();
  231. }
  232. bool ScriptServer::are_languages_initialized() {
  233. MutexLock lock(languages_mutex);
  234. return languages_ready;
  235. }
  236. void ScriptServer::set_reload_scripts_on_save(bool p_enable) {
  237. reload_scripts_on_save = p_enable;
  238. }
  239. bool ScriptServer::is_reload_scripts_on_save_enabled() {
  240. return reload_scripts_on_save;
  241. }
  242. void ScriptServer::thread_enter() {
  243. MutexLock lock(languages_mutex);
  244. if (!languages_ready) {
  245. return;
  246. }
  247. for (int i = 0; i < _language_count; i++) {
  248. _languages[i]->thread_enter();
  249. }
  250. }
  251. void ScriptServer::thread_exit() {
  252. MutexLock lock(languages_mutex);
  253. if (!languages_ready) {
  254. return;
  255. }
  256. for (int i = 0; i < _language_count; i++) {
  257. _languages[i]->thread_exit();
  258. }
  259. }
  260. HashMap<StringName, ScriptServer::GlobalScriptClass> ScriptServer::global_classes;
  261. HashMap<StringName, Vector<StringName>> ScriptServer::inheriters_cache;
  262. bool ScriptServer::inheriters_cache_dirty = true;
  263. void ScriptServer::global_classes_clear() {
  264. global_classes.clear();
  265. inheriters_cache.clear();
  266. }
  267. void ScriptServer::add_global_class(const StringName &p_class, const StringName &p_base, const StringName &p_language, const String &p_path) {
  268. ERR_FAIL_COND_MSG(p_class == p_base || (global_classes.has(p_base) && get_global_class_native_base(p_base) == p_class), "Cyclic inheritance in script class.");
  269. GlobalScriptClass g;
  270. g.language = p_language;
  271. g.path = p_path;
  272. g.base = p_base;
  273. global_classes[p_class] = g;
  274. inheriters_cache_dirty = true;
  275. }
  276. void ScriptServer::remove_global_class(const StringName &p_class) {
  277. global_classes.erase(p_class);
  278. inheriters_cache_dirty = true;
  279. }
  280. void ScriptServer::get_inheriters_list(const StringName &p_base_type, List<StringName> *r_classes) {
  281. if (inheriters_cache_dirty) {
  282. inheriters_cache.clear();
  283. for (const KeyValue<StringName, GlobalScriptClass> &K : global_classes) {
  284. if (!inheriters_cache.has(K.value.base)) {
  285. inheriters_cache[K.value.base] = Vector<StringName>();
  286. }
  287. inheriters_cache[K.value.base].push_back(K.key);
  288. }
  289. for (KeyValue<StringName, Vector<StringName>> &K : inheriters_cache) {
  290. K.value.sort_custom<StringName::AlphCompare>();
  291. }
  292. inheriters_cache_dirty = false;
  293. }
  294. if (!inheriters_cache.has(p_base_type)) {
  295. return;
  296. }
  297. const Vector<StringName> &v = inheriters_cache[p_base_type];
  298. for (int i = 0; i < v.size(); i++) {
  299. r_classes->push_back(v[i]);
  300. }
  301. }
  302. void ScriptServer::remove_global_class_by_path(const String &p_path) {
  303. for (const KeyValue<StringName, GlobalScriptClass> &kv : global_classes) {
  304. if (kv.value.path == p_path) {
  305. global_classes.erase(kv.key);
  306. inheriters_cache_dirty = true;
  307. return;
  308. }
  309. }
  310. }
  311. bool ScriptServer::is_global_class(const StringName &p_class) {
  312. return global_classes.has(p_class);
  313. }
  314. StringName ScriptServer::get_global_class_language(const StringName &p_class) {
  315. ERR_FAIL_COND_V(!global_classes.has(p_class), StringName());
  316. return global_classes[p_class].language;
  317. }
  318. String ScriptServer::get_global_class_path(const String &p_class) {
  319. ERR_FAIL_COND_V(!global_classes.has(p_class), String());
  320. return global_classes[p_class].path;
  321. }
  322. StringName ScriptServer::get_global_class_base(const String &p_class) {
  323. ERR_FAIL_COND_V(!global_classes.has(p_class), String());
  324. return global_classes[p_class].base;
  325. }
  326. StringName ScriptServer::get_global_class_native_base(const String &p_class) {
  327. ERR_FAIL_COND_V(!global_classes.has(p_class), String());
  328. String base = global_classes[p_class].base;
  329. while (global_classes.has(base)) {
  330. base = global_classes[base].base;
  331. }
  332. return base;
  333. }
  334. void ScriptServer::get_global_class_list(List<StringName> *r_global_classes) {
  335. List<StringName> classes;
  336. for (const KeyValue<StringName, GlobalScriptClass> &E : global_classes) {
  337. classes.push_back(E.key);
  338. }
  339. classes.sort_custom<StringName::AlphCompare>();
  340. for (const StringName &E : classes) {
  341. r_global_classes->push_back(E);
  342. }
  343. }
  344. void ScriptServer::save_global_classes() {
  345. Dictionary class_icons;
  346. Array script_classes = ProjectSettings::get_singleton()->get_global_class_list();
  347. for (int i = 0; i < script_classes.size(); i++) {
  348. Dictionary d = script_classes[i];
  349. if (!d.has("name") || !d.has("icon")) {
  350. continue;
  351. }
  352. class_icons[d["name"]] = d["icon"];
  353. }
  354. List<StringName> gc;
  355. get_global_class_list(&gc);
  356. Array gcarr;
  357. for (const StringName &E : gc) {
  358. Dictionary d;
  359. d["class"] = E;
  360. d["language"] = global_classes[E].language;
  361. d["path"] = global_classes[E].path;
  362. d["base"] = global_classes[E].base;
  363. d["icon"] = class_icons.get(E, "");
  364. gcarr.push_back(d);
  365. }
  366. ProjectSettings::get_singleton()->store_global_class_list(gcarr);
  367. }
  368. String ScriptServer::get_global_class_cache_file_path() {
  369. return ProjectSettings::get_singleton()->get_global_class_list_path();
  370. }
  371. ////////////////////
  372. ScriptCodeCompletionCache *ScriptCodeCompletionCache::singleton = nullptr;
  373. ScriptCodeCompletionCache::ScriptCodeCompletionCache() {
  374. singleton = this;
  375. }
  376. void ScriptLanguage::get_core_type_words(List<String> *p_core_type_words) const {
  377. p_core_type_words->push_back("String");
  378. p_core_type_words->push_back("Vector2");
  379. p_core_type_words->push_back("Vector2i");
  380. p_core_type_words->push_back("Rect2");
  381. p_core_type_words->push_back("Rect2i");
  382. p_core_type_words->push_back("Vector3");
  383. p_core_type_words->push_back("Vector3i");
  384. p_core_type_words->push_back("Transform2D");
  385. p_core_type_words->push_back("Vector4");
  386. p_core_type_words->push_back("Vector4i");
  387. p_core_type_words->push_back("Plane");
  388. p_core_type_words->push_back("Quaternion");
  389. p_core_type_words->push_back("AABB");
  390. p_core_type_words->push_back("Basis");
  391. p_core_type_words->push_back("Transform3D");
  392. p_core_type_words->push_back("Projection");
  393. p_core_type_words->push_back("Color");
  394. p_core_type_words->push_back("StringName");
  395. p_core_type_words->push_back("NodePath");
  396. p_core_type_words->push_back("RID");
  397. p_core_type_words->push_back("Callable");
  398. p_core_type_words->push_back("Signal");
  399. p_core_type_words->push_back("Dictionary");
  400. p_core_type_words->push_back("Array");
  401. p_core_type_words->push_back("PackedByteArray");
  402. p_core_type_words->push_back("PackedInt32Array");
  403. p_core_type_words->push_back("PackedInt64Array");
  404. p_core_type_words->push_back("PackedFloat32Array");
  405. p_core_type_words->push_back("PackedFloat64Array");
  406. p_core_type_words->push_back("PackedStringArray");
  407. p_core_type_words->push_back("PackedVector2Array");
  408. p_core_type_words->push_back("PackedVector3Array");
  409. p_core_type_words->push_back("PackedColorArray");
  410. }
  411. void ScriptLanguage::frame() {
  412. }
  413. TypedArray<int> ScriptLanguage::CodeCompletionOption::get_option_characteristics(const String &p_base) {
  414. // Return characacteristics of the match found by order of importance.
  415. // Matches will be ranked by a lexicographical order on the vector returned by this function.
  416. // The lower values indicate better matches and that they should go before in the order of appearance.
  417. if (last_matches == matches) {
  418. return charac;
  419. }
  420. charac.clear();
  421. // Ensure base is not empty and at the same time that matches is not empty too.
  422. if (p_base.length() == 0) {
  423. last_matches = matches;
  424. charac.push_back(location);
  425. return charac;
  426. }
  427. charac.push_back(matches.size());
  428. charac.push_back((matches[0].first == 0) ? 0 : 1);
  429. const char32_t *target_char = &p_base[0];
  430. int bad_case = 0;
  431. for (const Pair<int, int> &match_segment : matches) {
  432. const char32_t *string_to_complete_char = &display[match_segment.first];
  433. for (int j = 0; j < match_segment.second; j++, string_to_complete_char++, target_char++) {
  434. if (*string_to_complete_char != *target_char) {
  435. bad_case++;
  436. }
  437. }
  438. }
  439. charac.push_back(bad_case);
  440. charac.push_back(location);
  441. charac.push_back(matches[0].first);
  442. last_matches = matches;
  443. return charac;
  444. }
  445. void ScriptLanguage::CodeCompletionOption::clear_characteristics() {
  446. charac = TypedArray<int>();
  447. }
  448. TypedArray<int> ScriptLanguage::CodeCompletionOption::get_option_cached_characteristics() const {
  449. // Only returns the cached value and warns if it was not updated since the last change of matches.
  450. if (last_matches != matches) {
  451. WARN_PRINT("Characteristics are not up to date.");
  452. }
  453. return charac;
  454. }
  455. bool PlaceHolderScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  456. if (script->is_placeholder_fallback_enabled()) {
  457. return false;
  458. }
  459. if (values.has(p_name)) {
  460. Variant defval;
  461. if (script->get_property_default_value(p_name, defval)) {
  462. // The evaluate function ensures that a NIL variant is equal to e.g. an empty Resource.
  463. // Simply doing defval == p_value does not do this.
  464. if (Variant::evaluate(Variant::OP_EQUAL, defval, p_value)) {
  465. values.erase(p_name);
  466. return true;
  467. }
  468. }
  469. values[p_name] = p_value;
  470. return true;
  471. } else {
  472. Variant defval;
  473. if (script->get_property_default_value(p_name, defval)) {
  474. if (Variant::evaluate(Variant::OP_NOT_EQUAL, defval, p_value)) {
  475. values[p_name] = p_value;
  476. }
  477. return true;
  478. }
  479. }
  480. return false;
  481. }
  482. bool PlaceHolderScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  483. if (values.has(p_name)) {
  484. r_ret = values[p_name];
  485. return true;
  486. }
  487. if (constants.has(p_name)) {
  488. r_ret = constants[p_name];
  489. return true;
  490. }
  491. if (!script->is_placeholder_fallback_enabled()) {
  492. Variant defval;
  493. if (script->get_property_default_value(p_name, defval)) {
  494. r_ret = defval;
  495. return true;
  496. }
  497. }
  498. return false;
  499. }
  500. void PlaceHolderScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  501. if (script->is_placeholder_fallback_enabled()) {
  502. for (const PropertyInfo &E : properties) {
  503. p_properties->push_back(E);
  504. }
  505. } else {
  506. for (const PropertyInfo &E : properties) {
  507. PropertyInfo pinfo = E;
  508. p_properties->push_back(E);
  509. }
  510. }
  511. }
  512. Variant::Type PlaceHolderScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  513. if (values.has(p_name)) {
  514. if (r_is_valid) {
  515. *r_is_valid = true;
  516. }
  517. return values[p_name].get_type();
  518. }
  519. if (constants.has(p_name)) {
  520. if (r_is_valid) {
  521. *r_is_valid = true;
  522. }
  523. return constants[p_name].get_type();
  524. }
  525. if (r_is_valid) {
  526. *r_is_valid = false;
  527. }
  528. return Variant::NIL;
  529. }
  530. void PlaceHolderScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  531. if (script->is_placeholder_fallback_enabled()) {
  532. return;
  533. }
  534. if (script.is_valid()) {
  535. script->get_script_method_list(p_list);
  536. }
  537. }
  538. bool PlaceHolderScriptInstance::has_method(const StringName &p_method) const {
  539. if (script->is_placeholder_fallback_enabled()) {
  540. return false;
  541. }
  542. if (script.is_valid()) {
  543. return script->has_method(p_method);
  544. }
  545. return false;
  546. }
  547. void PlaceHolderScriptInstance::update(const List<PropertyInfo> &p_properties, const HashMap<StringName, Variant> &p_values) {
  548. HashSet<StringName> new_values;
  549. for (const PropertyInfo &E : p_properties) {
  550. if (E.usage & (PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_CATEGORY)) {
  551. continue;
  552. }
  553. StringName n = E.name;
  554. new_values.insert(n);
  555. if (!values.has(n) || values[n].get_type() != E.type) {
  556. if (p_values.has(n)) {
  557. values[n] = p_values[n];
  558. }
  559. }
  560. }
  561. properties = p_properties;
  562. List<StringName> to_remove;
  563. for (KeyValue<StringName, Variant> &E : values) {
  564. if (!new_values.has(E.key)) {
  565. to_remove.push_back(E.key);
  566. }
  567. Variant defval;
  568. if (script->get_property_default_value(E.key, defval)) {
  569. //remove because it's the same as the default value
  570. if (defval == E.value) {
  571. to_remove.push_back(E.key);
  572. }
  573. }
  574. }
  575. while (to_remove.size()) {
  576. values.erase(to_remove.front()->get());
  577. to_remove.pop_front();
  578. }
  579. if (owner && owner->get_script_instance() == this) {
  580. owner->notify_property_list_changed();
  581. }
  582. //change notify
  583. constants.clear();
  584. script->get_constants(&constants);
  585. }
  586. void PlaceHolderScriptInstance::property_set_fallback(const StringName &p_name, const Variant &p_value, bool *r_valid) {
  587. if (script->is_placeholder_fallback_enabled()) {
  588. HashMap<StringName, Variant>::Iterator E = values.find(p_name);
  589. if (E) {
  590. E->value = p_value;
  591. } else {
  592. values.insert(p_name, p_value);
  593. }
  594. bool found = false;
  595. for (const PropertyInfo &F : properties) {
  596. if (F.name == p_name) {
  597. found = true;
  598. break;
  599. }
  600. }
  601. if (!found) {
  602. properties.push_back(PropertyInfo(p_value.get_type(), p_name, PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_SCRIPT_VARIABLE));
  603. }
  604. }
  605. if (r_valid) {
  606. *r_valid = false; // Cannot change the value in either case
  607. }
  608. }
  609. Variant PlaceHolderScriptInstance::property_get_fallback(const StringName &p_name, bool *r_valid) {
  610. if (script->is_placeholder_fallback_enabled()) {
  611. HashMap<StringName, Variant>::ConstIterator E = values.find(p_name);
  612. if (E) {
  613. if (r_valid) {
  614. *r_valid = true;
  615. }
  616. return E->value;
  617. }
  618. E = constants.find(p_name);
  619. if (E) {
  620. if (r_valid) {
  621. *r_valid = true;
  622. }
  623. return E->value;
  624. }
  625. }
  626. if (r_valid) {
  627. *r_valid = false;
  628. }
  629. return Variant();
  630. }
  631. PlaceHolderScriptInstance::PlaceHolderScriptInstance(ScriptLanguage *p_language, Ref<Script> p_script, Object *p_owner) :
  632. owner(p_owner),
  633. language(p_language),
  634. script(p_script) {
  635. }
  636. PlaceHolderScriptInstance::~PlaceHolderScriptInstance() {
  637. if (script.is_valid()) {
  638. script->_placeholder_erased(this);
  639. }
  640. }