script_language.cpp 23 KB

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