script_language.cpp 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797
  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 *existing = global_classes.getptr(p_class);
  292. if (existing) {
  293. // Update an existing class (only set dirty if something changed).
  294. if (existing->base != p_base || existing->path != p_path || existing->language != p_language) {
  295. existing->base = p_base;
  296. existing->path = p_path;
  297. existing->language = p_language;
  298. inheriters_cache_dirty = true;
  299. }
  300. } else {
  301. // Add new class.
  302. GlobalScriptClass g;
  303. g.language = p_language;
  304. g.path = p_path;
  305. g.base = p_base;
  306. global_classes[p_class] = g;
  307. inheriters_cache_dirty = true;
  308. }
  309. }
  310. void ScriptServer::remove_global_class(const StringName &p_class) {
  311. global_classes.erase(p_class);
  312. inheriters_cache_dirty = true;
  313. }
  314. void ScriptServer::get_inheriters_list(const StringName &p_base_type, List<StringName> *r_classes) {
  315. if (inheriters_cache_dirty) {
  316. inheriters_cache.clear();
  317. for (const KeyValue<StringName, GlobalScriptClass> &K : global_classes) {
  318. if (!inheriters_cache.has(K.value.base)) {
  319. inheriters_cache[K.value.base] = Vector<StringName>();
  320. }
  321. inheriters_cache[K.value.base].push_back(K.key);
  322. }
  323. for (KeyValue<StringName, Vector<StringName>> &K : inheriters_cache) {
  324. K.value.sort_custom<StringName::AlphCompare>();
  325. }
  326. inheriters_cache_dirty = false;
  327. }
  328. if (!inheriters_cache.has(p_base_type)) {
  329. return;
  330. }
  331. const Vector<StringName> &v = inheriters_cache[p_base_type];
  332. for (int i = 0; i < v.size(); i++) {
  333. r_classes->push_back(v[i]);
  334. }
  335. }
  336. void ScriptServer::remove_global_class_by_path(const String &p_path) {
  337. for (const KeyValue<StringName, GlobalScriptClass> &kv : global_classes) {
  338. if (kv.value.path == p_path) {
  339. global_classes.erase(kv.key);
  340. inheriters_cache_dirty = true;
  341. return;
  342. }
  343. }
  344. }
  345. bool ScriptServer::is_global_class(const StringName &p_class) {
  346. return global_classes.has(p_class);
  347. }
  348. StringName ScriptServer::get_global_class_language(const StringName &p_class) {
  349. ERR_FAIL_COND_V(!global_classes.has(p_class), StringName());
  350. return global_classes[p_class].language;
  351. }
  352. String ScriptServer::get_global_class_path(const String &p_class) {
  353. ERR_FAIL_COND_V(!global_classes.has(p_class), String());
  354. return global_classes[p_class].path;
  355. }
  356. StringName ScriptServer::get_global_class_base(const String &p_class) {
  357. ERR_FAIL_COND_V(!global_classes.has(p_class), String());
  358. return global_classes[p_class].base;
  359. }
  360. StringName ScriptServer::get_global_class_native_base(const String &p_class) {
  361. ERR_FAIL_COND_V(!global_classes.has(p_class), String());
  362. String base = global_classes[p_class].base;
  363. while (global_classes.has(base)) {
  364. base = global_classes[base].base;
  365. }
  366. return base;
  367. }
  368. void ScriptServer::get_global_class_list(List<StringName> *r_global_classes) {
  369. List<StringName> classes;
  370. for (const KeyValue<StringName, GlobalScriptClass> &E : global_classes) {
  371. classes.push_back(E.key);
  372. }
  373. classes.sort_custom<StringName::AlphCompare>();
  374. for (const StringName &E : classes) {
  375. r_global_classes->push_back(E);
  376. }
  377. }
  378. void ScriptServer::save_global_classes() {
  379. Dictionary class_icons;
  380. Array script_classes = ProjectSettings::get_singleton()->get_global_class_list();
  381. for (int i = 0; i < script_classes.size(); i++) {
  382. Dictionary d = script_classes[i];
  383. if (!d.has("name") || !d.has("icon")) {
  384. continue;
  385. }
  386. class_icons[d["name"]] = d["icon"];
  387. }
  388. List<StringName> gc;
  389. get_global_class_list(&gc);
  390. Array gcarr;
  391. for (const StringName &E : gc) {
  392. Dictionary d;
  393. d["class"] = E;
  394. d["language"] = global_classes[E].language;
  395. d["path"] = global_classes[E].path;
  396. d["base"] = global_classes[E].base;
  397. d["icon"] = class_icons.get(E, "");
  398. gcarr.push_back(d);
  399. }
  400. ProjectSettings::get_singleton()->store_global_class_list(gcarr);
  401. }
  402. String ScriptServer::get_global_class_cache_file_path() {
  403. return ProjectSettings::get_singleton()->get_global_class_list_path();
  404. }
  405. ////////////////////
  406. ScriptCodeCompletionCache *ScriptCodeCompletionCache::singleton = nullptr;
  407. ScriptCodeCompletionCache::ScriptCodeCompletionCache() {
  408. singleton = this;
  409. }
  410. void ScriptLanguage::get_core_type_words(List<String> *p_core_type_words) const {
  411. p_core_type_words->push_back("String");
  412. p_core_type_words->push_back("Vector2");
  413. p_core_type_words->push_back("Vector2i");
  414. p_core_type_words->push_back("Rect2");
  415. p_core_type_words->push_back("Rect2i");
  416. p_core_type_words->push_back("Vector3");
  417. p_core_type_words->push_back("Vector3i");
  418. p_core_type_words->push_back("Transform2D");
  419. p_core_type_words->push_back("Vector4");
  420. p_core_type_words->push_back("Vector4i");
  421. p_core_type_words->push_back("Plane");
  422. p_core_type_words->push_back("Quaternion");
  423. p_core_type_words->push_back("AABB");
  424. p_core_type_words->push_back("Basis");
  425. p_core_type_words->push_back("Transform3D");
  426. p_core_type_words->push_back("Projection");
  427. p_core_type_words->push_back("Color");
  428. p_core_type_words->push_back("StringName");
  429. p_core_type_words->push_back("NodePath");
  430. p_core_type_words->push_back("RID");
  431. p_core_type_words->push_back("Callable");
  432. p_core_type_words->push_back("Signal");
  433. p_core_type_words->push_back("Dictionary");
  434. p_core_type_words->push_back("Array");
  435. p_core_type_words->push_back("PackedByteArray");
  436. p_core_type_words->push_back("PackedInt32Array");
  437. p_core_type_words->push_back("PackedInt64Array");
  438. p_core_type_words->push_back("PackedFloat32Array");
  439. p_core_type_words->push_back("PackedFloat64Array");
  440. p_core_type_words->push_back("PackedStringArray");
  441. p_core_type_words->push_back("PackedVector2Array");
  442. p_core_type_words->push_back("PackedVector3Array");
  443. p_core_type_words->push_back("PackedColorArray");
  444. }
  445. void ScriptLanguage::frame() {
  446. }
  447. TypedArray<int> ScriptLanguage::CodeCompletionOption::get_option_characteristics(const String &p_base) {
  448. // Return characacteristics of the match found by order of importance.
  449. // Matches will be ranked by a lexicographical order on the vector returned by this function.
  450. // The lower values indicate better matches and that they should go before in the order of appearance.
  451. if (last_matches == matches) {
  452. return charac;
  453. }
  454. charac.clear();
  455. // Ensure base is not empty and at the same time that matches is not empty too.
  456. if (p_base.length() == 0) {
  457. last_matches = matches;
  458. charac.push_back(location);
  459. return charac;
  460. }
  461. charac.push_back(matches.size());
  462. charac.push_back((matches[0].first == 0) ? 0 : 1);
  463. const char32_t *target_char = &p_base[0];
  464. int bad_case = 0;
  465. for (const Pair<int, int> &match_segment : matches) {
  466. const char32_t *string_to_complete_char = &display[match_segment.first];
  467. for (int j = 0; j < match_segment.second; j++, string_to_complete_char++, target_char++) {
  468. if (*string_to_complete_char != *target_char) {
  469. bad_case++;
  470. }
  471. }
  472. }
  473. charac.push_back(bad_case);
  474. charac.push_back(location);
  475. charac.push_back(matches[0].first);
  476. last_matches = matches;
  477. return charac;
  478. }
  479. void ScriptLanguage::CodeCompletionOption::clear_characteristics() {
  480. charac = TypedArray<int>();
  481. }
  482. TypedArray<int> ScriptLanguage::CodeCompletionOption::get_option_cached_characteristics() const {
  483. // Only returns the cached value and warns if it was not updated since the last change of matches.
  484. if (last_matches != matches) {
  485. WARN_PRINT("Characteristics are not up to date.");
  486. }
  487. return charac;
  488. }
  489. void ScriptLanguage::_bind_methods() {
  490. BIND_ENUM_CONSTANT(SCRIPT_NAME_CASING_AUTO);
  491. BIND_ENUM_CONSTANT(SCRIPT_NAME_CASING_PASCAL_CASE);
  492. BIND_ENUM_CONSTANT(SCRIPT_NAME_CASING_SNAKE_CASE);
  493. BIND_ENUM_CONSTANT(SCRIPT_NAME_CASING_KEBAB_CASE);
  494. }
  495. bool PlaceHolderScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  496. if (script->is_placeholder_fallback_enabled()) {
  497. return false;
  498. }
  499. if (values.has(p_name)) {
  500. Variant defval;
  501. if (script->get_property_default_value(p_name, defval)) {
  502. // The evaluate function ensures that a NIL variant is equal to e.g. an empty Resource.
  503. // Simply doing defval == p_value does not do this.
  504. if (Variant::evaluate(Variant::OP_EQUAL, defval, p_value)) {
  505. values.erase(p_name);
  506. return true;
  507. }
  508. }
  509. values[p_name] = p_value;
  510. return true;
  511. } else {
  512. Variant defval;
  513. if (script->get_property_default_value(p_name, defval)) {
  514. if (Variant::evaluate(Variant::OP_NOT_EQUAL, defval, p_value)) {
  515. values[p_name] = p_value;
  516. }
  517. return true;
  518. }
  519. }
  520. return false;
  521. }
  522. bool PlaceHolderScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  523. if (values.has(p_name)) {
  524. r_ret = values[p_name];
  525. return true;
  526. }
  527. if (constants.has(p_name)) {
  528. r_ret = constants[p_name];
  529. return true;
  530. }
  531. if (!script->is_placeholder_fallback_enabled()) {
  532. Variant defval;
  533. if (script->get_property_default_value(p_name, defval)) {
  534. r_ret = defval;
  535. return true;
  536. }
  537. }
  538. return false;
  539. }
  540. void PlaceHolderScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  541. if (script->is_placeholder_fallback_enabled()) {
  542. for (const PropertyInfo &E : properties) {
  543. p_properties->push_back(E);
  544. }
  545. } else {
  546. for (const PropertyInfo &E : properties) {
  547. PropertyInfo pinfo = E;
  548. p_properties->push_back(E);
  549. }
  550. }
  551. }
  552. Variant::Type PlaceHolderScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  553. if (values.has(p_name)) {
  554. if (r_is_valid) {
  555. *r_is_valid = true;
  556. }
  557. return values[p_name].get_type();
  558. }
  559. if (constants.has(p_name)) {
  560. if (r_is_valid) {
  561. *r_is_valid = true;
  562. }
  563. return constants[p_name].get_type();
  564. }
  565. if (r_is_valid) {
  566. *r_is_valid = false;
  567. }
  568. return Variant::NIL;
  569. }
  570. void PlaceHolderScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  571. if (script->is_placeholder_fallback_enabled()) {
  572. return;
  573. }
  574. if (script.is_valid()) {
  575. script->get_script_method_list(p_list);
  576. }
  577. }
  578. bool PlaceHolderScriptInstance::has_method(const StringName &p_method) const {
  579. if (script->is_placeholder_fallback_enabled()) {
  580. return false;
  581. }
  582. if (script.is_valid()) {
  583. return script->has_method(p_method);
  584. }
  585. return false;
  586. }
  587. void PlaceHolderScriptInstance::update(const List<PropertyInfo> &p_properties, const HashMap<StringName, Variant> &p_values) {
  588. HashSet<StringName> new_values;
  589. for (const PropertyInfo &E : p_properties) {
  590. if (E.usage & (PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_CATEGORY)) {
  591. continue;
  592. }
  593. StringName n = E.name;
  594. new_values.insert(n);
  595. if (!values.has(n) || values[n].get_type() != E.type) {
  596. if (p_values.has(n)) {
  597. values[n] = p_values[n];
  598. }
  599. }
  600. }
  601. properties = p_properties;
  602. List<StringName> to_remove;
  603. for (KeyValue<StringName, Variant> &E : values) {
  604. if (!new_values.has(E.key)) {
  605. to_remove.push_back(E.key);
  606. }
  607. Variant defval;
  608. if (script->get_property_default_value(E.key, defval)) {
  609. //remove because it's the same as the default value
  610. if (defval == E.value) {
  611. to_remove.push_back(E.key);
  612. }
  613. }
  614. }
  615. while (to_remove.size()) {
  616. values.erase(to_remove.front()->get());
  617. to_remove.pop_front();
  618. }
  619. if (owner && owner->get_script_instance() == this) {
  620. owner->notify_property_list_changed();
  621. }
  622. //change notify
  623. constants.clear();
  624. script->get_constants(&constants);
  625. }
  626. void PlaceHolderScriptInstance::property_set_fallback(const StringName &p_name, const Variant &p_value, bool *r_valid) {
  627. if (script->is_placeholder_fallback_enabled()) {
  628. HashMap<StringName, Variant>::Iterator E = values.find(p_name);
  629. if (E) {
  630. E->value = p_value;
  631. } else {
  632. values.insert(p_name, p_value);
  633. }
  634. bool found = false;
  635. for (const PropertyInfo &F : properties) {
  636. if (F.name == p_name) {
  637. found = true;
  638. break;
  639. }
  640. }
  641. if (!found) {
  642. PropertyHint hint = PROPERTY_HINT_NONE;
  643. const Object *obj = p_value.get_validated_object();
  644. if (obj && obj->is_class("Node")) {
  645. hint = PROPERTY_HINT_NODE_TYPE;
  646. }
  647. properties.push_back(PropertyInfo(p_value.get_type(), p_name, hint, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_SCRIPT_VARIABLE));
  648. }
  649. }
  650. if (r_valid) {
  651. *r_valid = false; // Cannot change the value in either case
  652. }
  653. }
  654. Variant PlaceHolderScriptInstance::property_get_fallback(const StringName &p_name, bool *r_valid) {
  655. if (script->is_placeholder_fallback_enabled()) {
  656. HashMap<StringName, Variant>::ConstIterator E = values.find(p_name);
  657. if (E) {
  658. if (r_valid) {
  659. *r_valid = true;
  660. }
  661. return E->value;
  662. }
  663. E = constants.find(p_name);
  664. if (E) {
  665. if (r_valid) {
  666. *r_valid = true;
  667. }
  668. return E->value;
  669. }
  670. }
  671. if (r_valid) {
  672. *r_valid = false;
  673. }
  674. return Variant();
  675. }
  676. PlaceHolderScriptInstance::PlaceHolderScriptInstance(ScriptLanguage *p_language, Ref<Script> p_script, Object *p_owner) :
  677. owner(p_owner),
  678. language(p_language),
  679. script(p_script) {
  680. }
  681. PlaceHolderScriptInstance::~PlaceHolderScriptInstance() {
  682. if (script.is_valid()) {
  683. script->_placeholder_erased(this);
  684. }
  685. }