script_language.cpp 25 KB

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