script_language.cpp 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757
  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. ScriptLanguage *ScriptServer::get_language_for_extension(const String &p_extension) {
  146. MutexLock lock(languages_mutex);
  147. for (int i = 0; i < _language_count; i++) {
  148. if (_languages[i] && _languages[i]->get_extension() == p_extension) {
  149. return _languages[i];
  150. }
  151. }
  152. return nullptr;
  153. }
  154. Error ScriptServer::register_language(ScriptLanguage *p_language) {
  155. MutexLock lock(languages_mutex);
  156. ERR_FAIL_NULL_V(p_language, ERR_INVALID_PARAMETER);
  157. ERR_FAIL_COND_V_MSG(_language_count >= MAX_LANGUAGES, ERR_UNAVAILABLE, "Script languages limit has been reach, cannot register more.");
  158. for (int i = 0; i < _language_count; i++) {
  159. const ScriptLanguage *other_language = _languages[i];
  160. 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.");
  161. 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.");
  162. 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.");
  163. }
  164. _languages[_language_count++] = p_language;
  165. return OK;
  166. }
  167. Error ScriptServer::unregister_language(const ScriptLanguage *p_language) {
  168. MutexLock lock(languages_mutex);
  169. for (int i = 0; i < _language_count; i++) {
  170. if (_languages[i] == p_language) {
  171. _language_count--;
  172. if (i < _language_count) {
  173. SWAP(_languages[i], _languages[_language_count]);
  174. }
  175. return OK;
  176. }
  177. }
  178. return ERR_DOES_NOT_EXIST;
  179. }
  180. void ScriptServer::init_languages() {
  181. { // Load global classes.
  182. global_classes_clear();
  183. #ifndef DISABLE_DEPRECATED
  184. if (ProjectSettings::get_singleton()->has_setting("_global_script_classes")) {
  185. Array script_classes = GLOBAL_GET("_global_script_classes");
  186. for (int i = 0; i < script_classes.size(); i++) {
  187. Dictionary c = script_classes[i];
  188. if (!c.has("class") || !c.has("language") || !c.has("path") || !c.has("base")) {
  189. continue;
  190. }
  191. add_global_class(c["class"], c["base"], c["language"], c["path"]);
  192. }
  193. ProjectSettings::get_singleton()->clear("_global_script_classes");
  194. }
  195. #endif
  196. Array script_classes = ProjectSettings::get_singleton()->get_global_class_list();
  197. for (int i = 0; i < script_classes.size(); i++) {
  198. Dictionary c = script_classes[i];
  199. if (!c.has("class") || !c.has("language") || !c.has("path") || !c.has("base")) {
  200. continue;
  201. }
  202. add_global_class(c["class"], c["base"], c["language"], c["path"]);
  203. }
  204. }
  205. HashSet<ScriptLanguage *> langs_to_init;
  206. {
  207. MutexLock lock(languages_mutex);
  208. for (int i = 0; i < _language_count; i++) {
  209. if (_languages[i]) {
  210. langs_to_init.insert(_languages[i]);
  211. }
  212. }
  213. }
  214. for (ScriptLanguage *E : langs_to_init) {
  215. E->init();
  216. }
  217. {
  218. MutexLock lock(languages_mutex);
  219. languages_ready = true;
  220. }
  221. }
  222. void ScriptServer::finish_languages() {
  223. HashSet<ScriptLanguage *> langs_to_finish;
  224. {
  225. MutexLock lock(languages_mutex);
  226. for (int i = 0; i < _language_count; i++) {
  227. if (_languages[i]) {
  228. langs_to_finish.insert(_languages[i]);
  229. }
  230. }
  231. }
  232. for (ScriptLanguage *E : langs_to_finish) {
  233. E->finish();
  234. }
  235. {
  236. MutexLock lock(languages_mutex);
  237. languages_ready = false;
  238. }
  239. global_classes_clear();
  240. }
  241. bool ScriptServer::are_languages_initialized() {
  242. MutexLock lock(languages_mutex);
  243. return languages_ready;
  244. }
  245. void ScriptServer::set_reload_scripts_on_save(bool p_enable) {
  246. reload_scripts_on_save = p_enable;
  247. }
  248. bool ScriptServer::is_reload_scripts_on_save_enabled() {
  249. return reload_scripts_on_save;
  250. }
  251. void ScriptServer::thread_enter() {
  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_enter();
  258. }
  259. }
  260. void ScriptServer::thread_exit() {
  261. MutexLock lock(languages_mutex);
  262. if (!languages_ready) {
  263. return;
  264. }
  265. for (int i = 0; i < _language_count; i++) {
  266. _languages[i]->thread_exit();
  267. }
  268. }
  269. HashMap<StringName, ScriptServer::GlobalScriptClass> ScriptServer::global_classes;
  270. HashMap<StringName, Vector<StringName>> ScriptServer::inheriters_cache;
  271. bool ScriptServer::inheriters_cache_dirty = true;
  272. void ScriptServer::global_classes_clear() {
  273. global_classes.clear();
  274. inheriters_cache.clear();
  275. }
  276. void ScriptServer::add_global_class(const StringName &p_class, const StringName &p_base, const StringName &p_language, const String &p_path) {
  277. 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.");
  278. GlobalScriptClass g;
  279. g.language = p_language;
  280. g.path = p_path;
  281. g.base = p_base;
  282. global_classes[p_class] = g;
  283. inheriters_cache_dirty = true;
  284. }
  285. void ScriptServer::remove_global_class(const StringName &p_class) {
  286. global_classes.erase(p_class);
  287. inheriters_cache_dirty = true;
  288. }
  289. void ScriptServer::get_inheriters_list(const StringName &p_base_type, List<StringName> *r_classes) {
  290. if (inheriters_cache_dirty) {
  291. inheriters_cache.clear();
  292. for (const KeyValue<StringName, GlobalScriptClass> &K : global_classes) {
  293. if (!inheriters_cache.has(K.value.base)) {
  294. inheriters_cache[K.value.base] = Vector<StringName>();
  295. }
  296. inheriters_cache[K.value.base].push_back(K.key);
  297. }
  298. for (KeyValue<StringName, Vector<StringName>> &K : inheriters_cache) {
  299. K.value.sort_custom<StringName::AlphCompare>();
  300. }
  301. inheriters_cache_dirty = false;
  302. }
  303. if (!inheriters_cache.has(p_base_type)) {
  304. return;
  305. }
  306. const Vector<StringName> &v = inheriters_cache[p_base_type];
  307. for (int i = 0; i < v.size(); i++) {
  308. r_classes->push_back(v[i]);
  309. }
  310. }
  311. void ScriptServer::remove_global_class_by_path(const String &p_path) {
  312. for (const KeyValue<StringName, GlobalScriptClass> &kv : global_classes) {
  313. if (kv.value.path == p_path) {
  314. global_classes.erase(kv.key);
  315. inheriters_cache_dirty = true;
  316. return;
  317. }
  318. }
  319. }
  320. bool ScriptServer::is_global_class(const StringName &p_class) {
  321. return global_classes.has(p_class);
  322. }
  323. StringName ScriptServer::get_global_class_language(const StringName &p_class) {
  324. ERR_FAIL_COND_V(!global_classes.has(p_class), StringName());
  325. return global_classes[p_class].language;
  326. }
  327. String ScriptServer::get_global_class_path(const String &p_class) {
  328. ERR_FAIL_COND_V(!global_classes.has(p_class), String());
  329. return global_classes[p_class].path;
  330. }
  331. StringName ScriptServer::get_global_class_base(const String &p_class) {
  332. ERR_FAIL_COND_V(!global_classes.has(p_class), String());
  333. return global_classes[p_class].base;
  334. }
  335. StringName ScriptServer::get_global_class_native_base(const String &p_class) {
  336. ERR_FAIL_COND_V(!global_classes.has(p_class), String());
  337. String base = global_classes[p_class].base;
  338. while (global_classes.has(base)) {
  339. base = global_classes[base].base;
  340. }
  341. return base;
  342. }
  343. void ScriptServer::get_global_class_list(List<StringName> *r_global_classes) {
  344. List<StringName> classes;
  345. for (const KeyValue<StringName, GlobalScriptClass> &E : global_classes) {
  346. classes.push_back(E.key);
  347. }
  348. classes.sort_custom<StringName::AlphCompare>();
  349. for (const StringName &E : classes) {
  350. r_global_classes->push_back(E);
  351. }
  352. }
  353. void ScriptServer::save_global_classes() {
  354. Dictionary class_icons;
  355. Array script_classes = ProjectSettings::get_singleton()->get_global_class_list();
  356. for (int i = 0; i < script_classes.size(); i++) {
  357. Dictionary d = script_classes[i];
  358. if (!d.has("name") || !d.has("icon")) {
  359. continue;
  360. }
  361. class_icons[d["name"]] = d["icon"];
  362. }
  363. List<StringName> gc;
  364. get_global_class_list(&gc);
  365. Array gcarr;
  366. for (const StringName &E : gc) {
  367. Dictionary d;
  368. d["class"] = E;
  369. d["language"] = global_classes[E].language;
  370. d["path"] = global_classes[E].path;
  371. d["base"] = global_classes[E].base;
  372. d["icon"] = class_icons.get(E, "");
  373. gcarr.push_back(d);
  374. }
  375. ProjectSettings::get_singleton()->store_global_class_list(gcarr);
  376. }
  377. String ScriptServer::get_global_class_cache_file_path() {
  378. return ProjectSettings::get_singleton()->get_global_class_list_path();
  379. }
  380. ////////////////////
  381. ScriptCodeCompletionCache *ScriptCodeCompletionCache::singleton = nullptr;
  382. ScriptCodeCompletionCache::ScriptCodeCompletionCache() {
  383. singleton = this;
  384. }
  385. void ScriptLanguage::get_core_type_words(List<String> *p_core_type_words) const {
  386. p_core_type_words->push_back("String");
  387. p_core_type_words->push_back("Vector2");
  388. p_core_type_words->push_back("Vector2i");
  389. p_core_type_words->push_back("Rect2");
  390. p_core_type_words->push_back("Rect2i");
  391. p_core_type_words->push_back("Vector3");
  392. p_core_type_words->push_back("Vector3i");
  393. p_core_type_words->push_back("Transform2D");
  394. p_core_type_words->push_back("Vector4");
  395. p_core_type_words->push_back("Vector4i");
  396. p_core_type_words->push_back("Plane");
  397. p_core_type_words->push_back("Quaternion");
  398. p_core_type_words->push_back("AABB");
  399. p_core_type_words->push_back("Basis");
  400. p_core_type_words->push_back("Transform3D");
  401. p_core_type_words->push_back("Projection");
  402. p_core_type_words->push_back("Color");
  403. p_core_type_words->push_back("StringName");
  404. p_core_type_words->push_back("NodePath");
  405. p_core_type_words->push_back("RID");
  406. p_core_type_words->push_back("Callable");
  407. p_core_type_words->push_back("Signal");
  408. p_core_type_words->push_back("Dictionary");
  409. p_core_type_words->push_back("Array");
  410. p_core_type_words->push_back("PackedByteArray");
  411. p_core_type_words->push_back("PackedInt32Array");
  412. p_core_type_words->push_back("PackedInt64Array");
  413. p_core_type_words->push_back("PackedFloat32Array");
  414. p_core_type_words->push_back("PackedFloat64Array");
  415. p_core_type_words->push_back("PackedStringArray");
  416. p_core_type_words->push_back("PackedVector2Array");
  417. p_core_type_words->push_back("PackedVector3Array");
  418. p_core_type_words->push_back("PackedColorArray");
  419. }
  420. void ScriptLanguage::frame() {
  421. }
  422. TypedArray<int> ScriptLanguage::CodeCompletionOption::get_option_characteristics(const String &p_base) {
  423. // Return characacteristics of the match found by order of importance.
  424. // Matches will be ranked by a lexicographical order on the vector returned by this function.
  425. // The lower values indicate better matches and that they should go before in the order of appearance.
  426. if (last_matches == matches) {
  427. return charac;
  428. }
  429. charac.clear();
  430. // Ensure base is not empty and at the same time that matches is not empty too.
  431. if (p_base.length() == 0) {
  432. last_matches = matches;
  433. charac.push_back(location);
  434. return charac;
  435. }
  436. charac.push_back(matches.size());
  437. charac.push_back((matches[0].first == 0) ? 0 : 1);
  438. const char32_t *target_char = &p_base[0];
  439. int bad_case = 0;
  440. for (const Pair<int, int> &match_segment : matches) {
  441. const char32_t *string_to_complete_char = &display[match_segment.first];
  442. for (int j = 0; j < match_segment.second; j++, string_to_complete_char++, target_char++) {
  443. if (*string_to_complete_char != *target_char) {
  444. bad_case++;
  445. }
  446. }
  447. }
  448. charac.push_back(bad_case);
  449. charac.push_back(location);
  450. charac.push_back(matches[0].first);
  451. last_matches = matches;
  452. return charac;
  453. }
  454. void ScriptLanguage::CodeCompletionOption::clear_characteristics() {
  455. charac = TypedArray<int>();
  456. }
  457. TypedArray<int> ScriptLanguage::CodeCompletionOption::get_option_cached_characteristics() const {
  458. // Only returns the cached value and warns if it was not updated since the last change of matches.
  459. if (last_matches != matches) {
  460. WARN_PRINT("Characteristics are not up to date.");
  461. }
  462. return charac;
  463. }
  464. bool PlaceHolderScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  465. if (script->is_placeholder_fallback_enabled()) {
  466. return false;
  467. }
  468. if (values.has(p_name)) {
  469. Variant defval;
  470. if (script->get_property_default_value(p_name, defval)) {
  471. // The evaluate function ensures that a NIL variant is equal to e.g. an empty Resource.
  472. // Simply doing defval == p_value does not do this.
  473. if (Variant::evaluate(Variant::OP_EQUAL, defval, p_value)) {
  474. values.erase(p_name);
  475. return true;
  476. }
  477. }
  478. values[p_name] = p_value;
  479. return true;
  480. } else {
  481. Variant defval;
  482. if (script->get_property_default_value(p_name, defval)) {
  483. if (Variant::evaluate(Variant::OP_NOT_EQUAL, defval, p_value)) {
  484. values[p_name] = p_value;
  485. }
  486. return true;
  487. }
  488. }
  489. return false;
  490. }
  491. bool PlaceHolderScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  492. if (values.has(p_name)) {
  493. r_ret = values[p_name];
  494. return true;
  495. }
  496. if (constants.has(p_name)) {
  497. r_ret = constants[p_name];
  498. return true;
  499. }
  500. if (!script->is_placeholder_fallback_enabled()) {
  501. Variant defval;
  502. if (script->get_property_default_value(p_name, defval)) {
  503. r_ret = defval;
  504. return true;
  505. }
  506. }
  507. return false;
  508. }
  509. void PlaceHolderScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  510. if (script->is_placeholder_fallback_enabled()) {
  511. for (const PropertyInfo &E : properties) {
  512. p_properties->push_back(E);
  513. }
  514. } else {
  515. for (const PropertyInfo &E : properties) {
  516. PropertyInfo pinfo = E;
  517. p_properties->push_back(E);
  518. }
  519. }
  520. }
  521. Variant::Type PlaceHolderScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  522. if (values.has(p_name)) {
  523. if (r_is_valid) {
  524. *r_is_valid = true;
  525. }
  526. return values[p_name].get_type();
  527. }
  528. if (constants.has(p_name)) {
  529. if (r_is_valid) {
  530. *r_is_valid = true;
  531. }
  532. return constants[p_name].get_type();
  533. }
  534. if (r_is_valid) {
  535. *r_is_valid = false;
  536. }
  537. return Variant::NIL;
  538. }
  539. void PlaceHolderScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  540. if (script->is_placeholder_fallback_enabled()) {
  541. return;
  542. }
  543. if (script.is_valid()) {
  544. script->get_script_method_list(p_list);
  545. }
  546. }
  547. bool PlaceHolderScriptInstance::has_method(const StringName &p_method) const {
  548. if (script->is_placeholder_fallback_enabled()) {
  549. return false;
  550. }
  551. if (script.is_valid()) {
  552. return script->has_method(p_method);
  553. }
  554. return false;
  555. }
  556. void PlaceHolderScriptInstance::update(const List<PropertyInfo> &p_properties, const HashMap<StringName, Variant> &p_values) {
  557. HashSet<StringName> new_values;
  558. for (const PropertyInfo &E : p_properties) {
  559. if (E.usage & (PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_CATEGORY)) {
  560. continue;
  561. }
  562. StringName n = E.name;
  563. new_values.insert(n);
  564. if (!values.has(n) || values[n].get_type() != E.type) {
  565. if (p_values.has(n)) {
  566. values[n] = p_values[n];
  567. }
  568. }
  569. }
  570. properties = p_properties;
  571. List<StringName> to_remove;
  572. for (KeyValue<StringName, Variant> &E : values) {
  573. if (!new_values.has(E.key)) {
  574. to_remove.push_back(E.key);
  575. }
  576. Variant defval;
  577. if (script->get_property_default_value(E.key, defval)) {
  578. //remove because it's the same as the default value
  579. if (defval == E.value) {
  580. to_remove.push_back(E.key);
  581. }
  582. }
  583. }
  584. while (to_remove.size()) {
  585. values.erase(to_remove.front()->get());
  586. to_remove.pop_front();
  587. }
  588. if (owner && owner->get_script_instance() == this) {
  589. owner->notify_property_list_changed();
  590. }
  591. //change notify
  592. constants.clear();
  593. script->get_constants(&constants);
  594. }
  595. void PlaceHolderScriptInstance::property_set_fallback(const StringName &p_name, const Variant &p_value, bool *r_valid) {
  596. if (script->is_placeholder_fallback_enabled()) {
  597. HashMap<StringName, Variant>::Iterator E = values.find(p_name);
  598. if (E) {
  599. E->value = p_value;
  600. } else {
  601. values.insert(p_name, p_value);
  602. }
  603. bool found = false;
  604. for (const PropertyInfo &F : properties) {
  605. if (F.name == p_name) {
  606. found = true;
  607. break;
  608. }
  609. }
  610. if (!found) {
  611. properties.push_back(PropertyInfo(p_value.get_type(), p_name, PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_SCRIPT_VARIABLE));
  612. }
  613. }
  614. if (r_valid) {
  615. *r_valid = false; // Cannot change the value in either case
  616. }
  617. }
  618. Variant PlaceHolderScriptInstance::property_get_fallback(const StringName &p_name, bool *r_valid) {
  619. if (script->is_placeholder_fallback_enabled()) {
  620. HashMap<StringName, Variant>::ConstIterator E = values.find(p_name);
  621. if (E) {
  622. if (r_valid) {
  623. *r_valid = true;
  624. }
  625. return E->value;
  626. }
  627. E = constants.find(p_name);
  628. if (E) {
  629. if (r_valid) {
  630. *r_valid = true;
  631. }
  632. return E->value;
  633. }
  634. }
  635. if (r_valid) {
  636. *r_valid = false;
  637. }
  638. return Variant();
  639. }
  640. PlaceHolderScriptInstance::PlaceHolderScriptInstance(ScriptLanguage *p_language, Ref<Script> p_script, Object *p_owner) :
  641. owner(p_owner),
  642. language(p_language),
  643. script(p_script) {
  644. }
  645. PlaceHolderScriptInstance::~PlaceHolderScriptInstance() {
  646. if (script.is_valid()) {
  647. script->_placeholder_erased(this);
  648. }
  649. }