gdscript.cpp 68 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443
  1. /*************************************************************************/
  2. /* gdscript.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  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 "gdscript.h"
  31. #include <stdint.h>
  32. #include "core/config/engine.h"
  33. #include "core/config/project_settings.h"
  34. #include "core/core_constants.h"
  35. #include "core/core_string_names.h"
  36. #include "core/io/file_access_encrypted.h"
  37. #include "core/os/file_access.h"
  38. #include "core/os/os.h"
  39. #include "gdscript_analyzer.h"
  40. #include "gdscript_cache.h"
  41. #include "gdscript_compiler.h"
  42. #include "gdscript_parser.h"
  43. #include "gdscript_warning.h"
  44. #ifdef TESTS_ENABLED
  45. #include "tests/gdscript_test_runner.h"
  46. #endif
  47. ///////////////////////////
  48. GDScriptNativeClass::GDScriptNativeClass(const StringName &p_name) {
  49. name = p_name;
  50. }
  51. bool GDScriptNativeClass::_get(const StringName &p_name, Variant &r_ret) const {
  52. bool ok;
  53. int v = ClassDB::get_integer_constant(name, p_name, &ok);
  54. if (ok) {
  55. r_ret = v;
  56. return true;
  57. } else {
  58. return false;
  59. }
  60. }
  61. void GDScriptNativeClass::_bind_methods() {
  62. ClassDB::bind_method(D_METHOD("new"), &GDScriptNativeClass::_new);
  63. }
  64. Variant GDScriptNativeClass::_new() {
  65. Object *o = instance();
  66. ERR_FAIL_COND_V_MSG(!o, Variant(), "Class type: '" + String(name) + "' is not instantiable.");
  67. Reference *ref = Object::cast_to<Reference>(o);
  68. if (ref) {
  69. return REF(ref);
  70. } else {
  71. return o;
  72. }
  73. }
  74. Object *GDScriptNativeClass::instance() {
  75. return ClassDB::instance(name);
  76. }
  77. void GDScript::_super_implicit_constructor(GDScript *p_script, GDScriptInstance *p_instance, Callable::CallError &r_error) {
  78. GDScript *base = p_script->_base;
  79. if (base != nullptr) {
  80. _super_implicit_constructor(base, p_instance, r_error);
  81. if (r_error.error != Callable::CallError::CALL_OK) {
  82. return;
  83. }
  84. }
  85. p_script->implicit_initializer->call(p_instance, nullptr, 0, r_error);
  86. }
  87. GDScriptInstance *GDScript::_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_isref, Callable::CallError &r_error) {
  88. /* STEP 1, CREATE */
  89. GDScriptInstance *instance = memnew(GDScriptInstance);
  90. instance->base_ref = p_isref;
  91. instance->members.resize(member_indices.size());
  92. instance->script = Ref<GDScript>(this);
  93. instance->owner = p_owner;
  94. instance->owner_id = p_owner->get_instance_id();
  95. #ifdef DEBUG_ENABLED
  96. //needed for hot reloading
  97. for (Map<StringName, MemberInfo>::Element *E = member_indices.front(); E; E = E->next()) {
  98. instance->member_indices_cache[E->key()] = E->get().index;
  99. }
  100. #endif
  101. instance->owner->set_script_instance(instance);
  102. /* STEP 2, INITIALIZE AND CONSTRUCT */
  103. {
  104. MutexLock lock(GDScriptLanguage::singleton->lock);
  105. instances.insert(instance->owner);
  106. }
  107. _super_implicit_constructor(this, instance, r_error);
  108. if (r_error.error != Callable::CallError::CALL_OK) {
  109. instance->script = Ref<GDScript>();
  110. instance->owner->set_script_instance(nullptr);
  111. {
  112. MutexLock lock(GDScriptLanguage::singleton->lock);
  113. instances.erase(p_owner);
  114. }
  115. ERR_FAIL_V_MSG(nullptr, "Error constructing a GDScriptInstance.");
  116. }
  117. if (p_argcount < 0) {
  118. return instance;
  119. }
  120. if (initializer != nullptr) {
  121. initializer->call(instance, p_args, p_argcount, r_error);
  122. if (r_error.error != Callable::CallError::CALL_OK) {
  123. instance->script = Ref<GDScript>();
  124. instance->owner->set_script_instance(nullptr);
  125. {
  126. MutexLock lock(GDScriptLanguage::singleton->lock);
  127. instances.erase(p_owner);
  128. }
  129. ERR_FAIL_V_MSG(nullptr, "Error constructing a GDScriptInstance.");
  130. }
  131. }
  132. //@TODO make thread safe
  133. return instance;
  134. }
  135. Variant GDScript::_new(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  136. /* STEP 1, CREATE */
  137. if (!valid) {
  138. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  139. return Variant();
  140. }
  141. r_error.error = Callable::CallError::CALL_OK;
  142. REF ref;
  143. Object *owner = nullptr;
  144. GDScript *_baseptr = this;
  145. while (_baseptr->_base) {
  146. _baseptr = _baseptr->_base;
  147. }
  148. ERR_FAIL_COND_V(_baseptr->native.is_null(), Variant());
  149. if (_baseptr->native.ptr()) {
  150. owner = _baseptr->native->instance();
  151. } else {
  152. owner = memnew(Reference); //by default, no base means use reference
  153. }
  154. ERR_FAIL_COND_V_MSG(!owner, Variant(), "Can't inherit from a virtual class.");
  155. Reference *r = Object::cast_to<Reference>(owner);
  156. if (r) {
  157. ref = REF(r);
  158. }
  159. GDScriptInstance *instance = _create_instance(p_args, p_argcount, owner, r != nullptr, r_error);
  160. if (!instance) {
  161. if (ref.is_null()) {
  162. memdelete(owner); //no owner, sorry
  163. }
  164. return Variant();
  165. }
  166. if (ref.is_valid()) {
  167. return ref;
  168. } else {
  169. return owner;
  170. }
  171. }
  172. bool GDScript::can_instance() const {
  173. #ifdef TOOLS_ENABLED
  174. return valid && (tool || ScriptServer::is_scripting_enabled());
  175. #else
  176. return valid;
  177. #endif
  178. }
  179. Ref<Script> GDScript::get_base_script() const {
  180. if (_base) {
  181. return Ref<GDScript>(_base);
  182. } else {
  183. return Ref<Script>();
  184. }
  185. }
  186. StringName GDScript::get_instance_base_type() const {
  187. if (native.is_valid()) {
  188. return native->get_name();
  189. }
  190. if (base.is_valid() && base->is_valid()) {
  191. return base->get_instance_base_type();
  192. }
  193. return StringName();
  194. }
  195. struct _GDScriptMemberSort {
  196. int index = 0;
  197. StringName name;
  198. _FORCE_INLINE_ bool operator<(const _GDScriptMemberSort &p_member) const { return index < p_member.index; }
  199. };
  200. #ifdef TOOLS_ENABLED
  201. void GDScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  202. placeholders.erase(p_placeholder);
  203. }
  204. #endif
  205. void GDScript::_get_script_method_list(List<MethodInfo> *r_list, bool p_include_base) const {
  206. const GDScript *current = this;
  207. while (current) {
  208. for (const Map<StringName, GDScriptFunction *>::Element *E = current->member_functions.front(); E; E = E->next()) {
  209. GDScriptFunction *func = E->get();
  210. MethodInfo mi;
  211. mi.name = E->key();
  212. for (int i = 0; i < func->get_argument_count(); i++) {
  213. PropertyInfo arginfo = func->get_argument_type(i);
  214. #ifdef TOOLS_ENABLED
  215. arginfo.name = func->get_argument_name(i);
  216. #endif
  217. mi.arguments.push_back(arginfo);
  218. }
  219. mi.return_val = func->get_return_type();
  220. r_list->push_back(mi);
  221. }
  222. if (!p_include_base) {
  223. return;
  224. }
  225. current = current->_base;
  226. }
  227. }
  228. void GDScript::get_script_method_list(List<MethodInfo> *r_list) const {
  229. _get_script_method_list(r_list, true);
  230. }
  231. void GDScript::_get_script_property_list(List<PropertyInfo> *r_list, bool p_include_base) const {
  232. const GDScript *sptr = this;
  233. List<PropertyInfo> props;
  234. while (sptr) {
  235. Vector<_GDScriptMemberSort> msort;
  236. for (Map<StringName, PropertyInfo>::Element *E = sptr->member_info.front(); E; E = E->next()) {
  237. _GDScriptMemberSort ms;
  238. ERR_CONTINUE(!sptr->member_indices.has(E->key()));
  239. ms.index = sptr->member_indices[E->key()].index;
  240. ms.name = E->key();
  241. msort.push_back(ms);
  242. }
  243. msort.sort();
  244. msort.reverse();
  245. for (int i = 0; i < msort.size(); i++) {
  246. props.push_front(sptr->member_info[msort[i].name]);
  247. }
  248. if (!p_include_base) {
  249. break;
  250. }
  251. sptr = sptr->_base;
  252. }
  253. for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {
  254. r_list->push_back(E->get());
  255. }
  256. }
  257. void GDScript::get_script_property_list(List<PropertyInfo> *r_list) const {
  258. _get_script_property_list(r_list, true);
  259. }
  260. bool GDScript::has_method(const StringName &p_method) const {
  261. return member_functions.has(p_method);
  262. }
  263. MethodInfo GDScript::get_method_info(const StringName &p_method) const {
  264. const Map<StringName, GDScriptFunction *>::Element *E = member_functions.find(p_method);
  265. if (!E) {
  266. return MethodInfo();
  267. }
  268. GDScriptFunction *func = E->get();
  269. MethodInfo mi;
  270. mi.name = E->key();
  271. for (int i = 0; i < func->get_argument_count(); i++) {
  272. mi.arguments.push_back(func->get_argument_type(i));
  273. }
  274. mi.return_val = func->get_return_type();
  275. return mi;
  276. }
  277. bool GDScript::get_property_default_value(const StringName &p_property, Variant &r_value) const {
  278. #ifdef TOOLS_ENABLED
  279. const Map<StringName, Variant>::Element *E = member_default_values_cache.find(p_property);
  280. if (E) {
  281. r_value = E->get();
  282. return true;
  283. }
  284. if (base_cache.is_valid()) {
  285. return base_cache->get_property_default_value(p_property, r_value);
  286. }
  287. #endif
  288. return false;
  289. }
  290. ScriptInstance *GDScript::instance_create(Object *p_this) {
  291. GDScript *top = this;
  292. while (top->_base) {
  293. top = top->_base;
  294. }
  295. if (top->native.is_valid()) {
  296. if (!ClassDB::is_parent_class(p_this->get_class_name(), top->native->get_name())) {
  297. if (EngineDebugger::is_active()) {
  298. GDScriptLanguage::get_singleton()->debug_break_parse(get_path(), 1, "Script inherits from native type '" + String(top->native->get_name()) + "', so it can't be instanced in object of type: '" + p_this->get_class() + "'");
  299. }
  300. ERR_FAIL_V_MSG(nullptr, "Script inherits from native type '" + String(top->native->get_name()) + "', so it can't be instanced in object of type '" + p_this->get_class() + "'" + ".");
  301. }
  302. }
  303. Callable::CallError unchecked_error;
  304. return _create_instance(nullptr, 0, p_this, Object::cast_to<Reference>(p_this) != nullptr, unchecked_error);
  305. }
  306. PlaceHolderScriptInstance *GDScript::placeholder_instance_create(Object *p_this) {
  307. #ifdef TOOLS_ENABLED
  308. PlaceHolderScriptInstance *si = memnew(PlaceHolderScriptInstance(GDScriptLanguage::get_singleton(), Ref<Script>(this), p_this));
  309. placeholders.insert(si);
  310. _update_exports();
  311. return si;
  312. #else
  313. return nullptr;
  314. #endif
  315. }
  316. bool GDScript::instance_has(const Object *p_this) const {
  317. MutexLock lock(GDScriptLanguage::singleton->lock);
  318. return instances.has((Object *)p_this);
  319. }
  320. bool GDScript::has_source_code() const {
  321. return source != "";
  322. }
  323. String GDScript::get_source_code() const {
  324. return source;
  325. }
  326. void GDScript::set_source_code(const String &p_code) {
  327. if (source == p_code) {
  328. return;
  329. }
  330. source = p_code;
  331. #ifdef TOOLS_ENABLED
  332. source_changed_cache = true;
  333. #endif
  334. }
  335. #ifdef TOOLS_ENABLED
  336. void GDScript::_update_exports_values(Map<StringName, Variant> &values, List<PropertyInfo> &propnames) {
  337. if (base_cache.is_valid()) {
  338. base_cache->_update_exports_values(values, propnames);
  339. }
  340. for (Map<StringName, Variant>::Element *E = member_default_values_cache.front(); E; E = E->next()) {
  341. values[E->key()] = E->get();
  342. }
  343. for (List<PropertyInfo>::Element *E = members_cache.front(); E; E = E->next()) {
  344. propnames.push_back(E->get());
  345. }
  346. }
  347. void GDScript::_add_doc(const DocData::ClassDoc &p_inner_class) {
  348. if (_owner) {
  349. _owner->_add_doc(p_inner_class);
  350. } else {
  351. for (int i = 0; i < docs.size(); i++) {
  352. if (docs[i].name == p_inner_class.name) {
  353. docs.remove(i);
  354. break;
  355. }
  356. }
  357. docs.append(p_inner_class);
  358. }
  359. }
  360. void GDScript::_clear_doc() {
  361. docs.clear();
  362. doc = DocData::ClassDoc();
  363. }
  364. void GDScript::_update_doc() {
  365. _clear_doc();
  366. doc.script_path = "\"" + get_path().get_slice("://", 1) + "\"";
  367. if (!name.is_empty()) {
  368. doc.name = name;
  369. } else {
  370. doc.name = doc.script_path;
  371. }
  372. if (_owner) {
  373. doc.name = _owner->doc.name + "." + doc.name;
  374. doc.script_path = doc.script_path + "." + doc.name;
  375. }
  376. doc.is_script_doc = true;
  377. if (base.is_valid() && base->is_valid()) {
  378. if (base->doc.name != String()) {
  379. doc.inherits = base->doc.name;
  380. } else {
  381. doc.inherits = base->get_instance_base_type();
  382. }
  383. } else if (native.is_valid()) {
  384. doc.inherits = native->get_name();
  385. }
  386. doc.brief_description = doc_brief_description;
  387. doc.description = doc_description;
  388. doc.tutorials = doc_tutorials;
  389. for (Map<String, DocData::EnumDoc>::Element *E = doc_enums.front(); E; E = E->next()) {
  390. if (E->value().description != "") {
  391. doc.enums[E->key()] = E->value().description;
  392. }
  393. }
  394. List<MethodInfo> methods;
  395. _get_script_method_list(&methods, false);
  396. for (int i = 0; i < methods.size(); i++) {
  397. // Ignore internal methods.
  398. if (methods[i].name[0] == '@') {
  399. continue;
  400. }
  401. DocData::MethodDoc method_doc;
  402. const String &class_name = methods[i].name;
  403. if (member_functions.has(class_name)) {
  404. GDScriptFunction *fn = member_functions[class_name];
  405. // Change class name if return type is script reference.
  406. GDScriptDataType return_type = fn->get_return_type();
  407. if (return_type.kind == GDScriptDataType::GDSCRIPT) {
  408. methods[i].return_val.class_name = _get_gdscript_reference_class_name(Object::cast_to<GDScript>(return_type.script_type));
  409. }
  410. // Change class name if argument is script reference.
  411. for (int j = 0; j < fn->get_argument_count(); j++) {
  412. GDScriptDataType arg_type = fn->get_argument_type(j);
  413. if (arg_type.kind == GDScriptDataType::GDSCRIPT) {
  414. methods[i].arguments[j].class_name = _get_gdscript_reference_class_name(Object::cast_to<GDScript>(arg_type.script_type));
  415. }
  416. }
  417. }
  418. if (doc_functions.has(methods[i].name)) {
  419. DocData::method_doc_from_methodinfo(method_doc, methods[i], doc_functions[methods[i].name]);
  420. } else {
  421. DocData::method_doc_from_methodinfo(method_doc, methods[i], String());
  422. }
  423. doc.methods.push_back(method_doc);
  424. }
  425. List<PropertyInfo> props;
  426. _get_script_property_list(&props, false);
  427. for (int i = 0; i < props.size(); i++) {
  428. ScriptMemberInfo scr_member_info;
  429. scr_member_info.propinfo = props[i];
  430. scr_member_info.propinfo.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  431. if (member_indices.has(props[i].name)) {
  432. const MemberInfo &mi = member_indices[props[i].name];
  433. scr_member_info.setter = mi.setter;
  434. scr_member_info.getter = mi.getter;
  435. if (mi.data_type.kind == GDScriptDataType::GDSCRIPT) {
  436. scr_member_info.propinfo.class_name = _get_gdscript_reference_class_name(
  437. Object::cast_to<GDScript>(mi.data_type.script_type));
  438. }
  439. }
  440. if (member_default_values.has(props[i].name)) {
  441. scr_member_info.has_default_value = true;
  442. scr_member_info.default_value = member_default_values[props[i].name];
  443. }
  444. if (doc_variables.has(props[i].name)) {
  445. scr_member_info.doc_string = doc_variables[props[i].name];
  446. }
  447. DocData::PropertyDoc prop_doc;
  448. DocData::property_doc_from_scriptmemberinfo(prop_doc, scr_member_info);
  449. doc.properties.push_back(prop_doc);
  450. }
  451. List<MethodInfo> signals;
  452. _get_script_signal_list(&signals, false);
  453. for (int i = 0; i < signals.size(); i++) {
  454. DocData::MethodDoc signal_doc;
  455. if (doc_signals.has(signals[i].name)) {
  456. DocData::signal_doc_from_methodinfo(signal_doc, signals[i], signals[i].name);
  457. } else {
  458. DocData::signal_doc_from_methodinfo(signal_doc, signals[i], String());
  459. }
  460. doc.signals.push_back(signal_doc);
  461. }
  462. for (Map<StringName, Variant>::Element *E = constants.front(); E; E = E->next()) {
  463. if (subclasses.has(E->key())) {
  464. continue;
  465. }
  466. // Enums.
  467. bool is_enum = false;
  468. if (E->value().get_type() == Variant::DICTIONARY) {
  469. if (doc_enums.has(E->key())) {
  470. is_enum = true;
  471. for (int i = 0; i < doc_enums[E->key()].values.size(); i++) {
  472. doc_enums[E->key()].values.write[i].enumeration = E->key();
  473. doc.constants.push_back(doc_enums[E->key()].values[i]);
  474. }
  475. }
  476. }
  477. if (!is_enum && doc_enums.has("@unnamed_enums")) {
  478. for (int i = 0; i < doc_enums["@unnamed_enums"].values.size(); i++) {
  479. if (E->key() == doc_enums["@unnamed_enums"].values[i].name) {
  480. is_enum = true;
  481. DocData::ConstantDoc constant_doc;
  482. constant_doc.enumeration = "@unnamed_enums";
  483. DocData::constant_doc_from_variant(constant_doc, E->key(), E->value(), doc_enums["@unnamed_enums"].values[i].description);
  484. doc.constants.push_back(constant_doc);
  485. break;
  486. }
  487. }
  488. }
  489. if (!is_enum) {
  490. DocData::ConstantDoc constant_doc;
  491. String doc_description;
  492. if (doc_constants.has(E->key())) {
  493. doc_description = doc_constants[E->key()];
  494. }
  495. DocData::constant_doc_from_variant(constant_doc, E->key(), E->value(), doc_description);
  496. doc.constants.push_back(constant_doc);
  497. }
  498. }
  499. for (Map<StringName, Ref<GDScript>>::Element *E = subclasses.front(); E; E = E->next()) {
  500. E->get()->_update_doc();
  501. }
  502. _add_doc(doc);
  503. }
  504. #endif
  505. bool GDScript::_update_exports(bool *r_err, bool p_recursive_call) {
  506. #ifdef TOOLS_ENABLED
  507. static Vector<GDScript *> base_caches;
  508. if (!p_recursive_call) {
  509. base_caches.clear();
  510. }
  511. base_caches.append(this);
  512. bool changed = false;
  513. if (source_changed_cache) {
  514. source_changed_cache = false;
  515. changed = true;
  516. String basedir = path;
  517. if (basedir == "") {
  518. basedir = get_path();
  519. }
  520. if (basedir != "") {
  521. basedir = basedir.get_base_dir();
  522. }
  523. GDScriptParser parser;
  524. GDScriptAnalyzer analyzer(&parser);
  525. Error err = parser.parse(source, path, false);
  526. if (err == OK && analyzer.analyze() == OK) {
  527. const GDScriptParser::ClassNode *c = parser.get_tree();
  528. if (base_cache.is_valid()) {
  529. base_cache->inheriters_cache.erase(get_instance_id());
  530. base_cache = Ref<GDScript>();
  531. }
  532. if (c->extends_used) {
  533. String path = "";
  534. if (String(c->extends_path) != "" && String(c->extends_path) != get_path()) {
  535. path = c->extends_path;
  536. if (path.is_rel_path()) {
  537. String base = get_path();
  538. if (base == "" || base.is_rel_path()) {
  539. ERR_PRINT(("Could not resolve relative path for parent class: " + path).utf8().get_data());
  540. } else {
  541. path = base.get_base_dir().plus_file(path);
  542. }
  543. }
  544. } else if (c->extends.size() != 0) {
  545. const StringName &base = c->extends[0];
  546. if (ScriptServer::is_global_class(base)) {
  547. path = ScriptServer::get_global_class_path(base);
  548. }
  549. }
  550. if (path != "") {
  551. if (path != get_path()) {
  552. Ref<GDScript> bf = ResourceLoader::load(path);
  553. if (bf.is_valid()) {
  554. base_cache = bf;
  555. bf->inheriters_cache.insert(get_instance_id());
  556. }
  557. } else {
  558. ERR_PRINT(("Path extending itself in " + path).utf8().get_data());
  559. }
  560. }
  561. }
  562. members_cache.clear();
  563. member_default_values_cache.clear();
  564. _signals.clear();
  565. for (int i = 0; i < c->members.size(); i++) {
  566. const GDScriptParser::ClassNode::Member &member = c->members[i];
  567. switch (member.type) {
  568. case GDScriptParser::ClassNode::Member::VARIABLE: {
  569. if (!member.variable->exported) {
  570. continue;
  571. }
  572. members_cache.push_back(member.variable->export_info);
  573. Variant default_value;
  574. if (member.variable->initializer && member.variable->initializer->is_constant) {
  575. default_value = member.variable->initializer->reduced_value;
  576. }
  577. member_default_values_cache[member.variable->identifier->name] = default_value;
  578. } break;
  579. case GDScriptParser::ClassNode::Member::SIGNAL: {
  580. // TODO: Cache this in parser to avoid loops like this.
  581. Vector<StringName> parameters_names;
  582. parameters_names.resize(member.signal->parameters.size());
  583. for (int j = 0; j < member.signal->parameters.size(); j++) {
  584. parameters_names.write[j] = member.signal->parameters[j]->identifier->name;
  585. }
  586. _signals[member.signal->identifier->name] = parameters_names;
  587. } break;
  588. default:
  589. break; // Nothing.
  590. }
  591. }
  592. } else {
  593. placeholder_fallback_enabled = true;
  594. return false;
  595. }
  596. } else if (placeholder_fallback_enabled) {
  597. return false;
  598. }
  599. placeholder_fallback_enabled = false;
  600. if (base_cache.is_valid() && base_cache->is_valid()) {
  601. for (int i = 0; i < base_caches.size(); i++) {
  602. if (base_caches[i] == base_cache.ptr()) {
  603. if (r_err) {
  604. *r_err = true;
  605. }
  606. valid = false; // to show error in the editor
  607. base_cache->valid = false;
  608. base_cache->inheriters_cache.clear(); // to prevent future stackoverflows
  609. base_cache.unref();
  610. base.unref();
  611. _base = nullptr;
  612. ERR_FAIL_V_MSG(false, "Cyclic inheritance in script class.");
  613. }
  614. }
  615. if (base_cache->_update_exports(r_err, true)) {
  616. if (r_err && *r_err) {
  617. return false;
  618. }
  619. changed = true;
  620. }
  621. }
  622. if (placeholders.size()) { //hm :(
  623. // update placeholders if any
  624. Map<StringName, Variant> values;
  625. List<PropertyInfo> propnames;
  626. _update_exports_values(values, propnames);
  627. for (Set<PlaceHolderScriptInstance *>::Element *E = placeholders.front(); E; E = E->next()) {
  628. E->get()->update(propnames, values);
  629. }
  630. }
  631. return changed;
  632. #else
  633. return false;
  634. #endif
  635. }
  636. void GDScript::update_exports() {
  637. #ifdef TOOLS_ENABLED
  638. bool cyclic_error = false;
  639. _update_exports(&cyclic_error);
  640. if (cyclic_error) {
  641. return;
  642. }
  643. Set<ObjectID> copy = inheriters_cache; //might get modified
  644. for (Set<ObjectID>::Element *E = copy.front(); E; E = E->next()) {
  645. Object *id = ObjectDB::get_instance(E->get());
  646. GDScript *s = Object::cast_to<GDScript>(id);
  647. if (!s) {
  648. continue;
  649. }
  650. s->update_exports();
  651. }
  652. #endif
  653. }
  654. void GDScript::_set_subclass_path(Ref<GDScript> &p_sc, const String &p_path) {
  655. p_sc->path = p_path;
  656. for (Map<StringName, Ref<GDScript>>::Element *E = p_sc->subclasses.front(); E; E = E->next()) {
  657. _set_subclass_path(E->get(), p_path);
  658. }
  659. }
  660. Error GDScript::reload(bool p_keep_state) {
  661. bool has_instances;
  662. {
  663. MutexLock lock(GDScriptLanguage::singleton->lock);
  664. has_instances = instances.size();
  665. }
  666. ERR_FAIL_COND_V(!p_keep_state && has_instances, ERR_ALREADY_IN_USE);
  667. String basedir = path;
  668. if (basedir == "") {
  669. basedir = get_path();
  670. }
  671. if (basedir != "") {
  672. basedir = basedir.get_base_dir();
  673. }
  674. if (source.find("%BASE%") != -1) {
  675. //loading a template, don't parse
  676. return OK;
  677. }
  678. {
  679. String source_path = path;
  680. if (source_path.is_empty()) {
  681. source_path = get_path();
  682. }
  683. if (!source_path.is_empty()) {
  684. MutexLock lock(GDScriptCache::singleton->lock);
  685. if (!GDScriptCache::singleton->shallow_gdscript_cache.has(source_path)) {
  686. GDScriptCache::singleton->shallow_gdscript_cache[source_path] = this;
  687. }
  688. }
  689. }
  690. valid = false;
  691. GDScriptParser parser;
  692. Error err = parser.parse(source, path, false);
  693. if (err) {
  694. if (EngineDebugger::is_active()) {
  695. GDScriptLanguage::get_singleton()->debug_break_parse(get_path(), parser.get_errors().front()->get().line, "Parser Error: " + parser.get_errors().front()->get().message);
  696. }
  697. // TODO: Show all error messages.
  698. _err_print_error("GDScript::reload", path.is_empty() ? "built-in" : (const char *)path.utf8().get_data(), parser.get_errors().front()->get().line, ("Parse Error: " + parser.get_errors().front()->get().message).utf8().get_data(), ERR_HANDLER_SCRIPT);
  699. ERR_FAIL_V(ERR_PARSE_ERROR);
  700. }
  701. GDScriptAnalyzer analyzer(&parser);
  702. err = analyzer.analyze();
  703. if (err) {
  704. if (EngineDebugger::is_active()) {
  705. GDScriptLanguage::get_singleton()->debug_break_parse(get_path(), parser.get_errors().front()->get().line, "Parser Error: " + parser.get_errors().front()->get().message);
  706. }
  707. const List<GDScriptParser::ParserError>::Element *e = parser.get_errors().front();
  708. while (e != nullptr) {
  709. _err_print_error("GDScript::reload", path.is_empty() ? "built-in" : (const char *)path.utf8().get_data(), e->get().line, ("Parse Error: " + e->get().message).utf8().get_data(), ERR_HANDLER_SCRIPT);
  710. e = e->next();
  711. }
  712. ERR_FAIL_V(ERR_PARSE_ERROR);
  713. }
  714. bool can_run = ScriptServer::is_scripting_enabled() || parser.is_tool();
  715. GDScriptCompiler compiler;
  716. err = compiler.compile(&parser, this, p_keep_state);
  717. #ifdef TOOLS_ENABLED
  718. _update_doc();
  719. #endif
  720. if (err) {
  721. if (can_run) {
  722. if (EngineDebugger::is_active()) {
  723. GDScriptLanguage::get_singleton()->debug_break_parse(get_path(), compiler.get_error_line(), "Parser Error: " + compiler.get_error());
  724. }
  725. _err_print_error("GDScript::reload", path.is_empty() ? "built-in" : (const char *)path.utf8().get_data(), compiler.get_error_line(), ("Compile Error: " + compiler.get_error()).utf8().get_data(), ERR_HANDLER_SCRIPT);
  726. ERR_FAIL_V(ERR_COMPILATION_FAILED);
  727. } else {
  728. return err;
  729. }
  730. }
  731. #ifdef DEBUG_ENABLED
  732. for (const List<GDScriptWarning>::Element *E = parser.get_warnings().front(); E; E = E->next()) {
  733. const GDScriptWarning &warning = E->get();
  734. if (EngineDebugger::is_active()) {
  735. Vector<ScriptLanguage::StackInfo> si;
  736. EngineDebugger::get_script_debugger()->send_error("", get_path(), warning.start_line, warning.get_name(), warning.get_message(), ERR_HANDLER_WARNING, si);
  737. }
  738. }
  739. #endif
  740. valid = true;
  741. for (Map<StringName, Ref<GDScript>>::Element *E = subclasses.front(); E; E = E->next()) {
  742. _set_subclass_path(E->get(), path);
  743. }
  744. _init_rpc_methods_properties();
  745. return OK;
  746. }
  747. ScriptLanguage *GDScript::get_language() const {
  748. return GDScriptLanguage::get_singleton();
  749. }
  750. void GDScript::get_constants(Map<StringName, Variant> *p_constants) {
  751. if (p_constants) {
  752. for (Map<StringName, Variant>::Element *E = constants.front(); E; E = E->next()) {
  753. (*p_constants)[E->key()] = E->value();
  754. }
  755. }
  756. }
  757. void GDScript::get_members(Set<StringName> *p_members) {
  758. if (p_members) {
  759. for (Set<StringName>::Element *E = members.front(); E; E = E->next()) {
  760. p_members->insert(E->get());
  761. }
  762. }
  763. }
  764. Vector<ScriptNetData> GDScript::get_rpc_methods() const {
  765. return rpc_functions;
  766. }
  767. uint16_t GDScript::get_rpc_method_id(const StringName &p_method) const {
  768. for (int i = 0; i < rpc_functions.size(); i++) {
  769. if (rpc_functions[i].name == p_method) {
  770. return i;
  771. }
  772. }
  773. return UINT16_MAX;
  774. }
  775. StringName GDScript::get_rpc_method(const uint16_t p_rpc_method_id) const {
  776. if (p_rpc_method_id >= rpc_functions.size()) {
  777. return StringName();
  778. }
  779. return rpc_functions[p_rpc_method_id].name;
  780. }
  781. MultiplayerAPI::RPCMode GDScript::get_rpc_mode_by_id(const uint16_t p_rpc_method_id) const {
  782. if (p_rpc_method_id >= rpc_functions.size()) {
  783. return MultiplayerAPI::RPC_MODE_DISABLED;
  784. }
  785. return rpc_functions[p_rpc_method_id].mode;
  786. }
  787. MultiplayerAPI::RPCMode GDScript::get_rpc_mode(const StringName &p_method) const {
  788. return get_rpc_mode_by_id(get_rpc_method_id(p_method));
  789. }
  790. Vector<ScriptNetData> GDScript::get_rset_properties() const {
  791. return rpc_variables;
  792. }
  793. uint16_t GDScript::get_rset_property_id(const StringName &p_variable) const {
  794. for (int i = 0; i < rpc_variables.size(); i++) {
  795. if (rpc_variables[i].name == p_variable) {
  796. return i;
  797. }
  798. }
  799. return UINT16_MAX;
  800. }
  801. StringName GDScript::get_rset_property(const uint16_t p_rset_member_id) const {
  802. if (p_rset_member_id >= rpc_variables.size()) {
  803. return StringName();
  804. }
  805. return rpc_variables[p_rset_member_id].name;
  806. }
  807. MultiplayerAPI::RPCMode GDScript::get_rset_mode_by_id(const uint16_t p_rset_member_id) const {
  808. if (p_rset_member_id >= rpc_variables.size()) {
  809. return MultiplayerAPI::RPC_MODE_DISABLED;
  810. }
  811. return rpc_variables[p_rset_member_id].mode;
  812. }
  813. MultiplayerAPI::RPCMode GDScript::get_rset_mode(const StringName &p_variable) const {
  814. return get_rset_mode_by_id(get_rset_property_id(p_variable));
  815. }
  816. Variant GDScript::call(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  817. GDScript *top = this;
  818. while (top) {
  819. Map<StringName, GDScriptFunction *>::Element *E = top->member_functions.find(p_method);
  820. if (E) {
  821. ERR_FAIL_COND_V_MSG(!E->get()->is_static(), Variant(), "Can't call non-static function '" + String(p_method) + "' in script.");
  822. return E->get()->call(nullptr, p_args, p_argcount, r_error);
  823. }
  824. top = top->_base;
  825. }
  826. //none found, regular
  827. return Script::call(p_method, p_args, p_argcount, r_error);
  828. }
  829. bool GDScript::_get(const StringName &p_name, Variant &r_ret) const {
  830. {
  831. const GDScript *top = this;
  832. while (top) {
  833. {
  834. const Map<StringName, Variant>::Element *E = top->constants.find(p_name);
  835. if (E) {
  836. r_ret = E->get();
  837. return true;
  838. }
  839. }
  840. {
  841. const Map<StringName, Ref<GDScript>>::Element *E = subclasses.find(p_name);
  842. if (E) {
  843. r_ret = E->get();
  844. return true;
  845. }
  846. }
  847. top = top->_base;
  848. }
  849. if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
  850. r_ret = get_source_code();
  851. return true;
  852. }
  853. }
  854. return false;
  855. }
  856. bool GDScript::_set(const StringName &p_name, const Variant &p_value) {
  857. if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
  858. set_source_code(p_value);
  859. reload();
  860. } else {
  861. return false;
  862. }
  863. return true;
  864. }
  865. void GDScript::_get_property_list(List<PropertyInfo> *p_properties) const {
  866. p_properties->push_back(PropertyInfo(Variant::STRING, "script/source", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR | PROPERTY_USAGE_INTERNAL));
  867. }
  868. void GDScript::_bind_methods() {
  869. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "new", &GDScript::_new, MethodInfo("new"));
  870. ClassDB::bind_method(D_METHOD("get_as_byte_code"), &GDScript::get_as_byte_code);
  871. }
  872. Vector<uint8_t> GDScript::get_as_byte_code() const {
  873. return Vector<uint8_t>();
  874. };
  875. // TODO: Fully remove this. There's not this kind of "bytecode" anymore.
  876. Error GDScript::load_byte_code(const String &p_path) {
  877. return ERR_COMPILATION_FAILED;
  878. }
  879. Error GDScript::load_source_code(const String &p_path) {
  880. Vector<uint8_t> sourcef;
  881. Error err;
  882. FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
  883. if (err) {
  884. ERR_FAIL_COND_V(err, err);
  885. }
  886. uint64_t len = f->get_length();
  887. sourcef.resize(len + 1);
  888. uint8_t *w = sourcef.ptrw();
  889. uint64_t r = f->get_buffer(w, len);
  890. f->close();
  891. memdelete(f);
  892. ERR_FAIL_COND_V(r != len, ERR_CANT_OPEN);
  893. w[len] = 0;
  894. String s;
  895. if (s.parse_utf8((const char *)w)) {
  896. ERR_FAIL_V_MSG(ERR_INVALID_DATA, "Script '" + p_path + "' contains invalid unicode (UTF-8), so it was not loaded. Please ensure that scripts are saved in valid UTF-8 unicode.");
  897. }
  898. source = s;
  899. #ifdef TOOLS_ENABLED
  900. source_changed_cache = true;
  901. #endif
  902. path = p_path;
  903. return OK;
  904. }
  905. const Map<StringName, GDScriptFunction *> &GDScript::debug_get_member_functions() const {
  906. return member_functions;
  907. }
  908. StringName GDScript::debug_get_member_by_index(int p_idx) const {
  909. for (const Map<StringName, MemberInfo>::Element *E = member_indices.front(); E; E = E->next()) {
  910. if (E->get().index == p_idx) {
  911. return E->key();
  912. }
  913. }
  914. return "<error>";
  915. }
  916. Ref<GDScript> GDScript::get_base() const {
  917. return base;
  918. }
  919. bool GDScript::inherits_script(const Ref<Script> &p_script) const {
  920. Ref<GDScript> gd = p_script;
  921. if (gd.is_null()) {
  922. return false;
  923. }
  924. const GDScript *s = this;
  925. while (s) {
  926. if (s == p_script.ptr()) {
  927. return true;
  928. }
  929. s = s->_base;
  930. }
  931. return false;
  932. }
  933. bool GDScript::has_script_signal(const StringName &p_signal) const {
  934. if (_signals.has(p_signal)) {
  935. return true;
  936. }
  937. if (base.is_valid()) {
  938. return base->has_script_signal(p_signal);
  939. }
  940. #ifdef TOOLS_ENABLED
  941. else if (base_cache.is_valid()) {
  942. return base_cache->has_script_signal(p_signal);
  943. }
  944. #endif
  945. return false;
  946. }
  947. void GDScript::_get_script_signal_list(List<MethodInfo> *r_list, bool p_include_base) const {
  948. for (const Map<StringName, Vector<StringName>>::Element *E = _signals.front(); E; E = E->next()) {
  949. MethodInfo mi;
  950. mi.name = E->key();
  951. for (int i = 0; i < E->get().size(); i++) {
  952. PropertyInfo arg;
  953. arg.name = E->get()[i];
  954. mi.arguments.push_back(arg);
  955. }
  956. r_list->push_back(mi);
  957. }
  958. if (!p_include_base) {
  959. return;
  960. }
  961. if (base.is_valid()) {
  962. base->get_script_signal_list(r_list);
  963. }
  964. #ifdef TOOLS_ENABLED
  965. else if (base_cache.is_valid()) {
  966. base_cache->get_script_signal_list(r_list);
  967. }
  968. #endif
  969. }
  970. void GDScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
  971. _get_script_signal_list(r_signals, true);
  972. }
  973. String GDScript::_get_gdscript_reference_class_name(const GDScript *p_gdscript) {
  974. ERR_FAIL_NULL_V(p_gdscript, String());
  975. String class_name;
  976. while (p_gdscript) {
  977. if (class_name == "") {
  978. class_name = p_gdscript->get_script_class_name();
  979. } else {
  980. class_name = p_gdscript->get_script_class_name() + "." + class_name;
  981. }
  982. p_gdscript = p_gdscript->_owner;
  983. }
  984. return class_name;
  985. }
  986. GDScript::GDScript() :
  987. script_list(this) {
  988. #ifdef DEBUG_ENABLED
  989. {
  990. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  991. GDScriptLanguage::get_singleton()->script_list.add(&script_list);
  992. }
  993. #endif
  994. }
  995. void GDScript::_save_orphaned_subclasses() {
  996. struct ClassRefWithName {
  997. ObjectID id;
  998. String fully_qualified_name;
  999. };
  1000. Vector<ClassRefWithName> weak_subclasses;
  1001. // collect subclasses ObjectID and name
  1002. for (Map<StringName, Ref<GDScript>>::Element *E = subclasses.front(); E; E = E->next()) {
  1003. E->get()->_owner = nullptr; //bye, you are no longer owned cause I died
  1004. ClassRefWithName subclass;
  1005. subclass.id = E->get()->get_instance_id();
  1006. subclass.fully_qualified_name = E->get()->fully_qualified_name;
  1007. weak_subclasses.push_back(subclass);
  1008. }
  1009. // clear subclasses to allow unused subclasses to be deleted
  1010. subclasses.clear();
  1011. // subclasses are also held by constants, clear those as well
  1012. constants.clear();
  1013. // keep orphan subclass only for subclasses that are still in use
  1014. for (int i = 0; i < weak_subclasses.size(); i++) {
  1015. ClassRefWithName subclass = weak_subclasses[i];
  1016. Object *obj = ObjectDB::get_instance(subclass.id);
  1017. if (!obj) {
  1018. continue;
  1019. }
  1020. // subclass is not released
  1021. GDScriptLanguage::get_singleton()->add_orphan_subclass(subclass.fully_qualified_name, subclass.id);
  1022. }
  1023. }
  1024. void GDScript::_init_rpc_methods_properties() {
  1025. // Copy the base rpc methods so we don't mask their IDs.
  1026. rpc_functions.clear();
  1027. rpc_variables.clear();
  1028. if (base.is_valid()) {
  1029. rpc_functions = base->rpc_functions;
  1030. rpc_variables = base->rpc_variables;
  1031. }
  1032. GDScript *cscript = this;
  1033. Map<StringName, Ref<GDScript>>::Element *sub_E = subclasses.front();
  1034. while (cscript) {
  1035. // RPC Methods
  1036. for (Map<StringName, GDScriptFunction *>::Element *E = cscript->member_functions.front(); E; E = E->next()) {
  1037. if (E->get()->get_rpc_mode() != MultiplayerAPI::RPC_MODE_DISABLED) {
  1038. ScriptNetData nd;
  1039. nd.name = E->key();
  1040. nd.mode = E->get()->get_rpc_mode();
  1041. if (-1 == rpc_functions.find(nd)) {
  1042. rpc_functions.push_back(nd);
  1043. }
  1044. }
  1045. }
  1046. // RSet
  1047. for (Map<StringName, MemberInfo>::Element *E = cscript->member_indices.front(); E; E = E->next()) {
  1048. if (E->get().rpc_mode != MultiplayerAPI::RPC_MODE_DISABLED) {
  1049. ScriptNetData nd;
  1050. nd.name = E->key();
  1051. nd.mode = E->get().rpc_mode;
  1052. if (-1 == rpc_variables.find(nd)) {
  1053. rpc_variables.push_back(nd);
  1054. }
  1055. }
  1056. }
  1057. if (cscript != this) {
  1058. sub_E = sub_E->next();
  1059. }
  1060. if (sub_E) {
  1061. cscript = sub_E->get().ptr();
  1062. } else {
  1063. cscript = nullptr;
  1064. }
  1065. }
  1066. // Sort so we are 100% that they are always the same.
  1067. rpc_functions.sort_custom<SortNetData>();
  1068. rpc_variables.sort_custom<SortNetData>();
  1069. }
  1070. GDScript::~GDScript() {
  1071. {
  1072. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1073. while (SelfList<GDScriptFunctionState> *E = pending_func_states.first()) {
  1074. // Order matters since clearing the stack may already cause
  1075. // the GDSCriptFunctionState to be destroyed and thus removed from the list.
  1076. pending_func_states.remove(E);
  1077. E->self()->_clear_stack();
  1078. }
  1079. }
  1080. for (Map<StringName, GDScriptFunction *>::Element *E = member_functions.front(); E; E = E->next()) {
  1081. memdelete(E->get());
  1082. }
  1083. if (GDScriptCache::singleton) { // Cache may have been already destroyed at engine shutdown.
  1084. GDScriptCache::remove_script(get_path());
  1085. }
  1086. _save_orphaned_subclasses();
  1087. #ifdef TOOLS_ENABLED
  1088. // Clearing inner class doc, script doc only cleared when the script source deleted.
  1089. if (_owner) {
  1090. _clear_doc();
  1091. }
  1092. #endif
  1093. #ifdef DEBUG_ENABLED
  1094. {
  1095. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1096. GDScriptLanguage::get_singleton()->script_list.remove(&script_list);
  1097. }
  1098. #endif
  1099. }
  1100. //////////////////////////////
  1101. // INSTANCE //
  1102. //////////////////////////////
  1103. bool GDScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  1104. //member
  1105. {
  1106. const Map<StringName, GDScript::MemberInfo>::Element *E = script->member_indices.find(p_name);
  1107. if (E) {
  1108. const GDScript::MemberInfo *member = &E->get();
  1109. if (member->setter) {
  1110. const Variant *val = &p_value;
  1111. Callable::CallError err;
  1112. call(member->setter, &val, 1, err);
  1113. if (err.error == Callable::CallError::CALL_OK) {
  1114. return true; //function exists, call was successful
  1115. }
  1116. } else {
  1117. if (member->data_type.has_type) {
  1118. if (member->data_type.builtin_type == Variant::ARRAY && member->data_type.has_container_element_type()) {
  1119. // Typed array.
  1120. if (p_value.get_type() == Variant::ARRAY) {
  1121. return VariantInternal::get_array(&members.write[member->index])->typed_assign(p_value);
  1122. } else {
  1123. return false;
  1124. }
  1125. } else if (!member->data_type.is_type(p_value)) {
  1126. // Try conversion
  1127. Callable::CallError ce;
  1128. const Variant *value = &p_value;
  1129. Variant converted;
  1130. Variant::construct(member->data_type.builtin_type, converted, &value, 1, ce);
  1131. if (ce.error == Callable::CallError::CALL_OK) {
  1132. members.write[member->index] = converted;
  1133. return true;
  1134. } else {
  1135. return false;
  1136. }
  1137. }
  1138. }
  1139. members.write[member->index] = p_value;
  1140. }
  1141. return true;
  1142. }
  1143. }
  1144. GDScript *sptr = script.ptr();
  1145. while (sptr) {
  1146. Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._set);
  1147. if (E) {
  1148. Variant name = p_name;
  1149. const Variant *args[2] = { &name, &p_value };
  1150. Callable::CallError err;
  1151. Variant ret = E->get()->call(this, (const Variant **)args, 2, err);
  1152. if (err.error == Callable::CallError::CALL_OK && ret.get_type() == Variant::BOOL && ret.operator bool()) {
  1153. return true;
  1154. }
  1155. }
  1156. sptr = sptr->_base;
  1157. }
  1158. return false;
  1159. }
  1160. bool GDScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  1161. const GDScript *sptr = script.ptr();
  1162. while (sptr) {
  1163. {
  1164. const Map<StringName, GDScript::MemberInfo>::Element *E = script->member_indices.find(p_name);
  1165. if (E) {
  1166. if (E->get().getter) {
  1167. Callable::CallError err;
  1168. r_ret = const_cast<GDScriptInstance *>(this)->call(E->get().getter, nullptr, 0, err);
  1169. if (err.error == Callable::CallError::CALL_OK) {
  1170. return true;
  1171. }
  1172. }
  1173. r_ret = members[E->get().index];
  1174. return true; //index found
  1175. }
  1176. }
  1177. {
  1178. const GDScript *sl = sptr;
  1179. while (sl) {
  1180. const Map<StringName, Variant>::Element *E = sl->constants.find(p_name);
  1181. if (E) {
  1182. r_ret = E->get();
  1183. return true; //index found
  1184. }
  1185. sl = sl->_base;
  1186. }
  1187. }
  1188. {
  1189. // Signals.
  1190. const GDScript *sl = sptr;
  1191. while (sl) {
  1192. const Map<StringName, Vector<StringName>>::Element *E = sl->_signals.find(p_name);
  1193. if (E) {
  1194. r_ret = Signal(this->owner, E->key());
  1195. return true; //index found
  1196. }
  1197. sl = sl->_base;
  1198. }
  1199. }
  1200. {
  1201. // Methods.
  1202. const GDScript *sl = sptr;
  1203. while (sl) {
  1204. const Map<StringName, GDScriptFunction *>::Element *E = sl->member_functions.find(p_name);
  1205. if (E) {
  1206. r_ret = Callable(this->owner, E->key());
  1207. return true; //index found
  1208. }
  1209. sl = sl->_base;
  1210. }
  1211. }
  1212. {
  1213. const Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get);
  1214. if (E) {
  1215. Variant name = p_name;
  1216. const Variant *args[1] = { &name };
  1217. Callable::CallError err;
  1218. Variant ret = const_cast<GDScriptFunction *>(E->get())->call(const_cast<GDScriptInstance *>(this), (const Variant **)args, 1, err);
  1219. if (err.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1220. r_ret = ret;
  1221. return true;
  1222. }
  1223. }
  1224. }
  1225. sptr = sptr->_base;
  1226. }
  1227. return false;
  1228. }
  1229. Variant::Type GDScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  1230. const GDScript *sptr = script.ptr();
  1231. while (sptr) {
  1232. if (sptr->member_info.has(p_name)) {
  1233. if (r_is_valid) {
  1234. *r_is_valid = true;
  1235. }
  1236. return sptr->member_info[p_name].type;
  1237. }
  1238. sptr = sptr->_base;
  1239. }
  1240. if (r_is_valid) {
  1241. *r_is_valid = false;
  1242. }
  1243. return Variant::NIL;
  1244. }
  1245. void GDScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  1246. // exported members, not done yet!
  1247. const GDScript *sptr = script.ptr();
  1248. List<PropertyInfo> props;
  1249. while (sptr) {
  1250. const Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get_property_list);
  1251. if (E) {
  1252. Callable::CallError err;
  1253. Variant ret = const_cast<GDScriptFunction *>(E->get())->call(const_cast<GDScriptInstance *>(this), nullptr, 0, err);
  1254. if (err.error == Callable::CallError::CALL_OK) {
  1255. ERR_FAIL_COND_MSG(ret.get_type() != Variant::ARRAY, "Wrong type for _get_property_list, must be an array of dictionaries.");
  1256. Array arr = ret;
  1257. for (int i = 0; i < arr.size(); i++) {
  1258. Dictionary d = arr[i];
  1259. ERR_CONTINUE(!d.has("name"));
  1260. ERR_CONTINUE(!d.has("type"));
  1261. PropertyInfo pinfo;
  1262. pinfo.type = Variant::Type(d["type"].operator int());
  1263. ERR_CONTINUE(pinfo.type < 0 || pinfo.type >= Variant::VARIANT_MAX);
  1264. pinfo.name = d["name"];
  1265. ERR_CONTINUE(pinfo.name == "");
  1266. if (d.has("hint")) {
  1267. pinfo.hint = PropertyHint(d["hint"].operator int());
  1268. }
  1269. if (d.has("hint_string")) {
  1270. pinfo.hint_string = d["hint_string"];
  1271. }
  1272. if (d.has("usage")) {
  1273. pinfo.usage = d["usage"];
  1274. }
  1275. props.push_back(pinfo);
  1276. }
  1277. }
  1278. }
  1279. //instance a fake script for editing the values
  1280. Vector<_GDScriptMemberSort> msort;
  1281. for (Map<StringName, PropertyInfo>::Element *F = sptr->member_info.front(); F; F = F->next()) {
  1282. _GDScriptMemberSort ms;
  1283. ERR_CONTINUE(!sptr->member_indices.has(F->key()));
  1284. ms.index = sptr->member_indices[F->key()].index;
  1285. ms.name = F->key();
  1286. msort.push_back(ms);
  1287. }
  1288. msort.sort();
  1289. msort.reverse();
  1290. for (int i = 0; i < msort.size(); i++) {
  1291. props.push_front(sptr->member_info[msort[i].name]);
  1292. }
  1293. sptr = sptr->_base;
  1294. }
  1295. for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {
  1296. p_properties->push_back(E->get());
  1297. }
  1298. }
  1299. void GDScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  1300. const GDScript *sptr = script.ptr();
  1301. while (sptr) {
  1302. for (Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.front(); E; E = E->next()) {
  1303. MethodInfo mi;
  1304. mi.name = E->key();
  1305. mi.flags |= METHOD_FLAG_FROM_SCRIPT;
  1306. for (int i = 0; i < E->get()->get_argument_count(); i++) {
  1307. mi.arguments.push_back(PropertyInfo(Variant::NIL, "arg" + itos(i)));
  1308. }
  1309. p_list->push_back(mi);
  1310. }
  1311. sptr = sptr->_base;
  1312. }
  1313. }
  1314. bool GDScriptInstance::has_method(const StringName &p_method) const {
  1315. const GDScript *sptr = script.ptr();
  1316. while (sptr) {
  1317. const Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(p_method);
  1318. if (E) {
  1319. return true;
  1320. }
  1321. sptr = sptr->_base;
  1322. }
  1323. return false;
  1324. }
  1325. Variant GDScriptInstance::call(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1326. GDScript *sptr = script.ptr();
  1327. while (sptr) {
  1328. Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(p_method);
  1329. if (E) {
  1330. return E->get()->call(this, p_args, p_argcount, r_error);
  1331. }
  1332. sptr = sptr->_base;
  1333. }
  1334. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1335. return Variant();
  1336. }
  1337. void GDScriptInstance::notification(int p_notification) {
  1338. //notification is not virtual, it gets called at ALL levels just like in C.
  1339. Variant value = p_notification;
  1340. const Variant *args[1] = { &value };
  1341. GDScript *sptr = script.ptr();
  1342. while (sptr) {
  1343. Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._notification);
  1344. if (E) {
  1345. Callable::CallError err;
  1346. E->get()->call(this, args, 1, err);
  1347. if (err.error != Callable::CallError::CALL_OK) {
  1348. //print error about notification call
  1349. }
  1350. }
  1351. sptr = sptr->_base;
  1352. }
  1353. }
  1354. String GDScriptInstance::to_string(bool *r_valid) {
  1355. if (has_method(CoreStringNames::get_singleton()->_to_string)) {
  1356. Callable::CallError ce;
  1357. Variant ret = call(CoreStringNames::get_singleton()->_to_string, nullptr, 0, ce);
  1358. if (ce.error == Callable::CallError::CALL_OK) {
  1359. if (ret.get_type() != Variant::STRING) {
  1360. if (r_valid) {
  1361. *r_valid = false;
  1362. }
  1363. ERR_FAIL_V_MSG(String(), "Wrong type for " + CoreStringNames::get_singleton()->_to_string + ", must be a String.");
  1364. }
  1365. if (r_valid) {
  1366. *r_valid = true;
  1367. }
  1368. return ret.operator String();
  1369. }
  1370. }
  1371. if (r_valid) {
  1372. *r_valid = false;
  1373. }
  1374. return String();
  1375. }
  1376. Ref<Script> GDScriptInstance::get_script() const {
  1377. return script;
  1378. }
  1379. ScriptLanguage *GDScriptInstance::get_language() {
  1380. return GDScriptLanguage::get_singleton();
  1381. }
  1382. Vector<ScriptNetData> GDScriptInstance::get_rpc_methods() const {
  1383. return script->get_rpc_methods();
  1384. }
  1385. uint16_t GDScriptInstance::get_rpc_method_id(const StringName &p_method) const {
  1386. return script->get_rpc_method_id(p_method);
  1387. }
  1388. StringName GDScriptInstance::get_rpc_method(const uint16_t p_rpc_method_id) const {
  1389. return script->get_rpc_method(p_rpc_method_id);
  1390. }
  1391. MultiplayerAPI::RPCMode GDScriptInstance::get_rpc_mode_by_id(const uint16_t p_rpc_method_id) const {
  1392. return script->get_rpc_mode_by_id(p_rpc_method_id);
  1393. }
  1394. MultiplayerAPI::RPCMode GDScriptInstance::get_rpc_mode(const StringName &p_method) const {
  1395. return script->get_rpc_mode(p_method);
  1396. }
  1397. Vector<ScriptNetData> GDScriptInstance::get_rset_properties() const {
  1398. return script->get_rset_properties();
  1399. }
  1400. uint16_t GDScriptInstance::get_rset_property_id(const StringName &p_variable) const {
  1401. return script->get_rset_property_id(p_variable);
  1402. }
  1403. StringName GDScriptInstance::get_rset_property(const uint16_t p_rset_member_id) const {
  1404. return script->get_rset_property(p_rset_member_id);
  1405. }
  1406. MultiplayerAPI::RPCMode GDScriptInstance::get_rset_mode_by_id(const uint16_t p_rset_member_id) const {
  1407. return script->get_rset_mode_by_id(p_rset_member_id);
  1408. }
  1409. MultiplayerAPI::RPCMode GDScriptInstance::get_rset_mode(const StringName &p_variable) const {
  1410. return script->get_rset_mode(p_variable);
  1411. }
  1412. void GDScriptInstance::reload_members() {
  1413. #ifdef DEBUG_ENABLED
  1414. members.resize(script->member_indices.size()); //resize
  1415. Vector<Variant> new_members;
  1416. new_members.resize(script->member_indices.size());
  1417. //pass the values to the new indices
  1418. for (Map<StringName, GDScript::MemberInfo>::Element *E = script->member_indices.front(); E; E = E->next()) {
  1419. if (member_indices_cache.has(E->key())) {
  1420. Variant value = members[member_indices_cache[E->key()]];
  1421. new_members.write[E->get().index] = value;
  1422. }
  1423. }
  1424. //apply
  1425. members = new_members;
  1426. //pass the values to the new indices
  1427. member_indices_cache.clear();
  1428. for (Map<StringName, GDScript::MemberInfo>::Element *E = script->member_indices.front(); E; E = E->next()) {
  1429. member_indices_cache[E->key()] = E->get().index;
  1430. }
  1431. #endif
  1432. }
  1433. GDScriptInstance::GDScriptInstance() {
  1434. owner = nullptr;
  1435. base_ref = false;
  1436. }
  1437. GDScriptInstance::~GDScriptInstance() {
  1438. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1439. while (SelfList<GDScriptFunctionState> *E = pending_func_states.first()) {
  1440. // Order matters since clearing the stack may already cause
  1441. // the GDSCriptFunctionState to be destroyed and thus removed from the list.
  1442. pending_func_states.remove(E);
  1443. E->self()->_clear_stack();
  1444. }
  1445. if (script.is_valid() && owner) {
  1446. script->instances.erase(owner);
  1447. }
  1448. }
  1449. /************* SCRIPT LANGUAGE **************/
  1450. GDScriptLanguage *GDScriptLanguage::singleton = nullptr;
  1451. String GDScriptLanguage::get_name() const {
  1452. return "GDScript";
  1453. }
  1454. /* LANGUAGE FUNCTIONS */
  1455. void GDScriptLanguage::_add_global(const StringName &p_name, const Variant &p_value) {
  1456. if (globals.has(p_name)) {
  1457. //overwrite existing
  1458. global_array.write[globals[p_name]] = p_value;
  1459. return;
  1460. }
  1461. globals[p_name] = global_array.size();
  1462. global_array.push_back(p_value);
  1463. _global_array = global_array.ptrw();
  1464. }
  1465. void GDScriptLanguage::add_global_constant(const StringName &p_variable, const Variant &p_value) {
  1466. _add_global(p_variable, p_value);
  1467. }
  1468. void GDScriptLanguage::add_named_global_constant(const StringName &p_name, const Variant &p_value) {
  1469. named_globals[p_name] = p_value;
  1470. }
  1471. void GDScriptLanguage::remove_named_global_constant(const StringName &p_name) {
  1472. ERR_FAIL_COND(!named_globals.has(p_name));
  1473. named_globals.erase(p_name);
  1474. }
  1475. void GDScriptLanguage::init() {
  1476. //populate global constants
  1477. int gcc = CoreConstants::get_global_constant_count();
  1478. for (int i = 0; i < gcc; i++) {
  1479. _add_global(StaticCString::create(CoreConstants::get_global_constant_name(i)), CoreConstants::get_global_constant_value(i));
  1480. }
  1481. _add_global(StaticCString::create("PI"), Math_PI);
  1482. _add_global(StaticCString::create("TAU"), Math_TAU);
  1483. _add_global(StaticCString::create("INF"), Math_INF);
  1484. _add_global(StaticCString::create("NAN"), Math_NAN);
  1485. //populate native classes
  1486. List<StringName> class_list;
  1487. ClassDB::get_class_list(&class_list);
  1488. for (List<StringName>::Element *E = class_list.front(); E; E = E->next()) {
  1489. StringName n = E->get();
  1490. String s = String(n);
  1491. if (s.begins_with("_")) {
  1492. n = s.substr(1, s.length());
  1493. }
  1494. if (globals.has(n)) {
  1495. continue;
  1496. }
  1497. Ref<GDScriptNativeClass> nc = memnew(GDScriptNativeClass(E->get()));
  1498. _add_global(n, nc);
  1499. }
  1500. //populate singletons
  1501. List<Engine::Singleton> singletons;
  1502. Engine::get_singleton()->get_singletons(&singletons);
  1503. for (List<Engine::Singleton>::Element *E = singletons.front(); E; E = E->next()) {
  1504. _add_global(E->get().name, E->get().ptr);
  1505. }
  1506. #ifdef TESTS_ENABLED
  1507. GDScriptTests::GDScriptTestRunner::handle_cmdline();
  1508. #endif
  1509. }
  1510. String GDScriptLanguage::get_type() const {
  1511. return "GDScript";
  1512. }
  1513. String GDScriptLanguage::get_extension() const {
  1514. return "gd";
  1515. }
  1516. Error GDScriptLanguage::execute_file(const String &p_path) {
  1517. // ??
  1518. return OK;
  1519. }
  1520. void GDScriptLanguage::finish() {
  1521. }
  1522. void GDScriptLanguage::profiling_start() {
  1523. #ifdef DEBUG_ENABLED
  1524. MutexLock lock(this->lock);
  1525. SelfList<GDScriptFunction> *elem = function_list.first();
  1526. while (elem) {
  1527. elem->self()->profile.call_count = 0;
  1528. elem->self()->profile.self_time = 0;
  1529. elem->self()->profile.total_time = 0;
  1530. elem->self()->profile.frame_call_count = 0;
  1531. elem->self()->profile.frame_self_time = 0;
  1532. elem->self()->profile.frame_total_time = 0;
  1533. elem->self()->profile.last_frame_call_count = 0;
  1534. elem->self()->profile.last_frame_self_time = 0;
  1535. elem->self()->profile.last_frame_total_time = 0;
  1536. elem = elem->next();
  1537. }
  1538. profiling = true;
  1539. #endif
  1540. }
  1541. void GDScriptLanguage::profiling_stop() {
  1542. #ifdef DEBUG_ENABLED
  1543. MutexLock lock(this->lock);
  1544. profiling = false;
  1545. #endif
  1546. }
  1547. int GDScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1548. int current = 0;
  1549. #ifdef DEBUG_ENABLED
  1550. MutexLock lock(this->lock);
  1551. SelfList<GDScriptFunction> *elem = function_list.first();
  1552. while (elem) {
  1553. if (current >= p_info_max) {
  1554. break;
  1555. }
  1556. p_info_arr[current].call_count = elem->self()->profile.call_count;
  1557. p_info_arr[current].self_time = elem->self()->profile.self_time;
  1558. p_info_arr[current].total_time = elem->self()->profile.total_time;
  1559. p_info_arr[current].signature = elem->self()->profile.signature;
  1560. elem = elem->next();
  1561. current++;
  1562. }
  1563. #endif
  1564. return current;
  1565. }
  1566. int GDScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1567. int current = 0;
  1568. #ifdef DEBUG_ENABLED
  1569. MutexLock lock(this->lock);
  1570. SelfList<GDScriptFunction> *elem = function_list.first();
  1571. while (elem) {
  1572. if (current >= p_info_max) {
  1573. break;
  1574. }
  1575. if (elem->self()->profile.last_frame_call_count > 0) {
  1576. p_info_arr[current].call_count = elem->self()->profile.last_frame_call_count;
  1577. p_info_arr[current].self_time = elem->self()->profile.last_frame_self_time;
  1578. p_info_arr[current].total_time = elem->self()->profile.last_frame_total_time;
  1579. p_info_arr[current].signature = elem->self()->profile.signature;
  1580. current++;
  1581. }
  1582. elem = elem->next();
  1583. }
  1584. #endif
  1585. return current;
  1586. }
  1587. struct GDScriptDepSort {
  1588. //must support sorting so inheritance works properly (parent must be reloaded first)
  1589. bool operator()(const Ref<GDScript> &A, const Ref<GDScript> &B) const {
  1590. if (A == B) {
  1591. return false; //shouldn't happen but..
  1592. }
  1593. const GDScript *I = B->get_base().ptr();
  1594. while (I) {
  1595. if (I == A.ptr()) {
  1596. // A is a base of B
  1597. return true;
  1598. }
  1599. I = I->get_base().ptr();
  1600. }
  1601. return false; //not a base
  1602. }
  1603. };
  1604. void GDScriptLanguage::reload_all_scripts() {
  1605. #ifdef DEBUG_ENABLED
  1606. print_verbose("GDScript: Reloading all scripts");
  1607. List<Ref<GDScript>> scripts;
  1608. {
  1609. MutexLock lock(this->lock);
  1610. SelfList<GDScript> *elem = script_list.first();
  1611. while (elem) {
  1612. if (elem->self()->get_path().is_resource_file()) {
  1613. print_verbose("GDScript: Found: " + elem->self()->get_path());
  1614. scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
  1615. }
  1616. elem = elem->next();
  1617. }
  1618. }
  1619. //as scripts are going to be reloaded, must proceed without locking here
  1620. scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
  1621. for (List<Ref<GDScript>>::Element *E = scripts.front(); E; E = E->next()) {
  1622. print_verbose("GDScript: Reloading: " + E->get()->get_path());
  1623. E->get()->load_source_code(E->get()->get_path());
  1624. E->get()->reload(true);
  1625. }
  1626. #endif
  1627. }
  1628. void GDScriptLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
  1629. #ifdef DEBUG_ENABLED
  1630. List<Ref<GDScript>> scripts;
  1631. {
  1632. MutexLock lock(this->lock);
  1633. SelfList<GDScript> *elem = script_list.first();
  1634. while (elem) {
  1635. if (elem->self()->get_path().is_resource_file()) {
  1636. scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
  1637. }
  1638. elem = elem->next();
  1639. }
  1640. }
  1641. //when someone asks you why dynamically typed languages are easier to write....
  1642. Map<Ref<GDScript>, Map<ObjectID, List<Pair<StringName, Variant>>>> to_reload;
  1643. //as scripts are going to be reloaded, must proceed without locking here
  1644. scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
  1645. for (List<Ref<GDScript>>::Element *E = scripts.front(); E; E = E->next()) {
  1646. bool reload = E->get() == p_script || to_reload.has(E->get()->get_base());
  1647. if (!reload) {
  1648. continue;
  1649. }
  1650. to_reload.insert(E->get(), Map<ObjectID, List<Pair<StringName, Variant>>>());
  1651. if (!p_soft_reload) {
  1652. //save state and remove script from instances
  1653. Map<ObjectID, List<Pair<StringName, Variant>>> &map = to_reload[E->get()];
  1654. while (E->get()->instances.front()) {
  1655. Object *obj = E->get()->instances.front()->get();
  1656. //save instance info
  1657. List<Pair<StringName, Variant>> state;
  1658. if (obj->get_script_instance()) {
  1659. obj->get_script_instance()->get_property_state(state);
  1660. map[obj->get_instance_id()] = state;
  1661. obj->set_script(Variant());
  1662. }
  1663. }
  1664. //same thing for placeholders
  1665. #ifdef TOOLS_ENABLED
  1666. while (E->get()->placeholders.size()) {
  1667. Object *obj = E->get()->placeholders.front()->get()->get_owner();
  1668. //save instance info
  1669. if (obj->get_script_instance()) {
  1670. map.insert(obj->get_instance_id(), List<Pair<StringName, Variant>>());
  1671. List<Pair<StringName, Variant>> &state = map[obj->get_instance_id()];
  1672. obj->get_script_instance()->get_property_state(state);
  1673. obj->set_script(Variant());
  1674. } else {
  1675. // no instance found. Let's remove it so we don't loop forever
  1676. E->get()->placeholders.erase(E->get()->placeholders.front()->get());
  1677. }
  1678. }
  1679. #endif
  1680. for (Map<ObjectID, List<Pair<StringName, Variant>>>::Element *F = E->get()->pending_reload_state.front(); F; F = F->next()) {
  1681. map[F->key()] = F->get(); //pending to reload, use this one instead
  1682. }
  1683. }
  1684. }
  1685. for (Map<Ref<GDScript>, Map<ObjectID, List<Pair<StringName, Variant>>>>::Element *E = to_reload.front(); E; E = E->next()) {
  1686. Ref<GDScript> scr = E->key();
  1687. scr->reload(p_soft_reload);
  1688. //restore state if saved
  1689. for (Map<ObjectID, List<Pair<StringName, Variant>>>::Element *F = E->get().front(); F; F = F->next()) {
  1690. List<Pair<StringName, Variant>> &saved_state = F->get();
  1691. Object *obj = ObjectDB::get_instance(F->key());
  1692. if (!obj) {
  1693. continue;
  1694. }
  1695. if (!p_soft_reload) {
  1696. //clear it just in case (may be a pending reload state)
  1697. obj->set_script(Variant());
  1698. }
  1699. obj->set_script(scr);
  1700. ScriptInstance *script_instance = obj->get_script_instance();
  1701. if (!script_instance) {
  1702. //failed, save reload state for next time if not saved
  1703. if (!scr->pending_reload_state.has(obj->get_instance_id())) {
  1704. scr->pending_reload_state[obj->get_instance_id()] = saved_state;
  1705. }
  1706. continue;
  1707. }
  1708. if (script_instance->is_placeholder() && scr->is_placeholder_fallback_enabled()) {
  1709. PlaceHolderScriptInstance *placeholder = static_cast<PlaceHolderScriptInstance *>(script_instance);
  1710. for (List<Pair<StringName, Variant>>::Element *G = saved_state.front(); G; G = G->next()) {
  1711. placeholder->property_set_fallback(G->get().first, G->get().second);
  1712. }
  1713. } else {
  1714. for (List<Pair<StringName, Variant>>::Element *G = saved_state.front(); G; G = G->next()) {
  1715. script_instance->set(G->get().first, G->get().second);
  1716. }
  1717. }
  1718. scr->pending_reload_state.erase(obj->get_instance_id()); //as it reloaded, remove pending state
  1719. }
  1720. //if instance states were saved, set them!
  1721. }
  1722. #endif
  1723. }
  1724. void GDScriptLanguage::frame() {
  1725. calls = 0;
  1726. #ifdef DEBUG_ENABLED
  1727. if (profiling) {
  1728. MutexLock lock(this->lock);
  1729. SelfList<GDScriptFunction> *elem = function_list.first();
  1730. while (elem) {
  1731. elem->self()->profile.last_frame_call_count = elem->self()->profile.frame_call_count;
  1732. elem->self()->profile.last_frame_self_time = elem->self()->profile.frame_self_time;
  1733. elem->self()->profile.last_frame_total_time = elem->self()->profile.frame_total_time;
  1734. elem->self()->profile.frame_call_count = 0;
  1735. elem->self()->profile.frame_self_time = 0;
  1736. elem->self()->profile.frame_total_time = 0;
  1737. elem = elem->next();
  1738. }
  1739. }
  1740. #endif
  1741. }
  1742. /* EDITOR FUNCTIONS */
  1743. void GDScriptLanguage::get_reserved_words(List<String> *p_words) const {
  1744. // TODO: Add annotations here?
  1745. static const char *_reserved_words[] = {
  1746. // operators
  1747. "and",
  1748. "in",
  1749. "not",
  1750. "or",
  1751. // types and values
  1752. "false",
  1753. "float",
  1754. "int",
  1755. "bool",
  1756. "null",
  1757. "PI",
  1758. "TAU",
  1759. "INF",
  1760. "NAN",
  1761. "self",
  1762. "true",
  1763. "void",
  1764. // functions
  1765. "as",
  1766. "assert",
  1767. "await",
  1768. "breakpoint",
  1769. "class",
  1770. "class_name",
  1771. "extends",
  1772. "is",
  1773. "func",
  1774. "preload",
  1775. "signal",
  1776. "super",
  1777. "trait",
  1778. "yield",
  1779. // var
  1780. "const",
  1781. "enum",
  1782. "static",
  1783. "var",
  1784. // control flow
  1785. "break",
  1786. "continue",
  1787. "if",
  1788. "elif",
  1789. "else",
  1790. "for",
  1791. "pass",
  1792. "return",
  1793. "match",
  1794. "while",
  1795. nullptr
  1796. };
  1797. const char **w = _reserved_words;
  1798. while (*w) {
  1799. p_words->push_back(*w);
  1800. w++;
  1801. }
  1802. List<StringName> functions;
  1803. GDScriptUtilityFunctions::get_function_list(&functions);
  1804. for (const List<StringName>::Element *E = functions.front(); E; E = E->next()) {
  1805. p_words->push_back(String(E->get()));
  1806. }
  1807. }
  1808. bool GDScriptLanguage::is_control_flow_keyword(String p_keyword) const {
  1809. return p_keyword == "break" ||
  1810. p_keyword == "continue" ||
  1811. p_keyword == "elif" ||
  1812. p_keyword == "else" ||
  1813. p_keyword == "if" ||
  1814. p_keyword == "for" ||
  1815. p_keyword == "match" ||
  1816. p_keyword == "pass" ||
  1817. p_keyword == "return" ||
  1818. p_keyword == "while";
  1819. }
  1820. bool GDScriptLanguage::handles_global_class_type(const String &p_type) const {
  1821. return p_type == "GDScript";
  1822. }
  1823. String GDScriptLanguage::get_global_class_name(const String &p_path, String *r_base_type, String *r_icon_path) const {
  1824. Vector<uint8_t> sourcef;
  1825. Error err;
  1826. FileAccessRef f = FileAccess::open(p_path, FileAccess::READ, &err);
  1827. if (err) {
  1828. return String();
  1829. }
  1830. String source = f->get_as_utf8_string();
  1831. GDScriptParser parser;
  1832. err = parser.parse(source, p_path, false);
  1833. // TODO: Simplify this code by using the analyzer to get full inheritance.
  1834. if (err == OK) {
  1835. const GDScriptParser::ClassNode *c = parser.get_tree();
  1836. if (r_icon_path) {
  1837. if (c->icon_path.is_empty() || c->icon_path.is_absolute_path()) {
  1838. *r_icon_path = c->icon_path;
  1839. } else if (c->icon_path.is_rel_path()) {
  1840. *r_icon_path = p_path.get_base_dir().plus_file(c->icon_path).simplify_path();
  1841. }
  1842. }
  1843. if (r_base_type) {
  1844. const GDScriptParser::ClassNode *subclass = c;
  1845. String path = p_path;
  1846. GDScriptParser subparser;
  1847. while (subclass) {
  1848. if (subclass->extends_used) {
  1849. if (!subclass->extends_path.is_empty()) {
  1850. if (subclass->extends.size() == 0) {
  1851. get_global_class_name(subclass->extends_path, r_base_type);
  1852. subclass = nullptr;
  1853. break;
  1854. } else {
  1855. Vector<StringName> extend_classes = subclass->extends;
  1856. FileAccessRef subfile = FileAccess::open(subclass->extends_path, FileAccess::READ);
  1857. if (!subfile) {
  1858. break;
  1859. }
  1860. String subsource = subfile->get_as_utf8_string();
  1861. if (subsource.is_empty()) {
  1862. break;
  1863. }
  1864. String subpath = subclass->extends_path;
  1865. if (subpath.is_rel_path()) {
  1866. subpath = path.get_base_dir().plus_file(subpath).simplify_path();
  1867. }
  1868. if (OK != subparser.parse(subsource, subpath, false)) {
  1869. break;
  1870. }
  1871. path = subpath;
  1872. subclass = subparser.get_tree();
  1873. while (extend_classes.size() > 0) {
  1874. bool found = false;
  1875. for (int i = 0; i < subclass->members.size(); i++) {
  1876. if (subclass->members[i].type != GDScriptParser::ClassNode::Member::CLASS) {
  1877. continue;
  1878. }
  1879. const GDScriptParser::ClassNode *inner_class = subclass->members[i].m_class;
  1880. if (inner_class->identifier->name == extend_classes[0]) {
  1881. extend_classes.remove(0);
  1882. found = true;
  1883. subclass = inner_class;
  1884. break;
  1885. }
  1886. }
  1887. if (!found) {
  1888. subclass = nullptr;
  1889. break;
  1890. }
  1891. }
  1892. }
  1893. } else if (subclass->extends.size() == 1) {
  1894. *r_base_type = subclass->extends[0];
  1895. subclass = nullptr;
  1896. } else {
  1897. break;
  1898. }
  1899. } else {
  1900. *r_base_type = "Reference";
  1901. subclass = nullptr;
  1902. }
  1903. }
  1904. }
  1905. return c->identifier != nullptr ? String(c->identifier->name) : String();
  1906. }
  1907. return String();
  1908. }
  1909. GDScriptLanguage::GDScriptLanguage() {
  1910. calls = 0;
  1911. ERR_FAIL_COND(singleton);
  1912. singleton = this;
  1913. strings._init = StaticCString::create("_init");
  1914. strings._notification = StaticCString::create("_notification");
  1915. strings._set = StaticCString::create("_set");
  1916. strings._get = StaticCString::create("_get");
  1917. strings._get_property_list = StaticCString::create("_get_property_list");
  1918. strings._script_source = StaticCString::create("script/source");
  1919. _debug_parse_err_line = -1;
  1920. _debug_parse_err_file = "";
  1921. profiling = false;
  1922. script_frame_time = 0;
  1923. _debug_call_stack_pos = 0;
  1924. int dmcs = GLOBAL_DEF("debug/settings/gdscript/max_call_stack", 1024);
  1925. ProjectSettings::get_singleton()->set_custom_property_info("debug/settings/gdscript/max_call_stack", PropertyInfo(Variant::INT, "debug/settings/gdscript/max_call_stack", PROPERTY_HINT_RANGE, "1024,4096,1,or_greater")); //minimum is 1024
  1926. if (EngineDebugger::is_active()) {
  1927. //debugging enabled!
  1928. _debug_max_call_stack = dmcs;
  1929. _call_stack = memnew_arr(CallLevel, _debug_max_call_stack + 1);
  1930. } else {
  1931. _debug_max_call_stack = 0;
  1932. _call_stack = nullptr;
  1933. }
  1934. #ifdef DEBUG_ENABLED
  1935. GLOBAL_DEF("debug/gdscript/warnings/enable", true);
  1936. GLOBAL_DEF("debug/gdscript/warnings/treat_warnings_as_errors", false);
  1937. GLOBAL_DEF("debug/gdscript/warnings/exclude_addons", true);
  1938. GLOBAL_DEF("debug/gdscript/completion/autocomplete_setters_and_getters", false);
  1939. for (int i = 0; i < (int)GDScriptWarning::WARNING_MAX; i++) {
  1940. String warning = GDScriptWarning::get_name_from_code((GDScriptWarning::Code)i).to_lower();
  1941. bool default_enabled = !warning.begins_with("unsafe_");
  1942. GLOBAL_DEF("debug/gdscript/warnings/" + warning, default_enabled);
  1943. }
  1944. #endif // DEBUG_ENABLED
  1945. }
  1946. GDScriptLanguage::~GDScriptLanguage() {
  1947. if (_call_stack) {
  1948. memdelete_arr(_call_stack);
  1949. }
  1950. // Clear dependencies between scripts, to ensure cyclic references are broken (to avoid leaks at exit).
  1951. SelfList<GDScript> *s = script_list.first();
  1952. while (s) {
  1953. GDScript *script = s->self();
  1954. // This ensures the current script is not released before we can check what's the next one
  1955. // in the list (we can't get the next upfront because we don't know if the reference breaking
  1956. // will cause it -or any other after it, for that matter- to be released so the next one
  1957. // is not the same as before).
  1958. script->reference();
  1959. for (Map<StringName, GDScriptFunction *>::Element *E = script->member_functions.front(); E; E = E->next()) {
  1960. GDScriptFunction *func = E->get();
  1961. for (int i = 0; i < func->argument_types.size(); i++) {
  1962. func->argument_types.write[i].script_type_ref = Ref<Script>();
  1963. }
  1964. func->return_type.script_type_ref = Ref<Script>();
  1965. }
  1966. for (Map<StringName, GDScript::MemberInfo>::Element *E = script->member_indices.front(); E; E = E->next()) {
  1967. E->get().data_type.script_type_ref = Ref<Script>();
  1968. }
  1969. s = s->next();
  1970. script->unreference();
  1971. }
  1972. singleton = nullptr;
  1973. }
  1974. void GDScriptLanguage::add_orphan_subclass(const String &p_qualified_name, const ObjectID &p_subclass) {
  1975. orphan_subclasses[p_qualified_name] = p_subclass;
  1976. }
  1977. Ref<GDScript> GDScriptLanguage::get_orphan_subclass(const String &p_qualified_name) {
  1978. Map<String, ObjectID>::Element *orphan_subclass_element = orphan_subclasses.find(p_qualified_name);
  1979. if (!orphan_subclass_element) {
  1980. return Ref<GDScript>();
  1981. }
  1982. ObjectID orphan_subclass = orphan_subclass_element->get();
  1983. Object *obj = ObjectDB::get_instance(orphan_subclass);
  1984. orphan_subclasses.erase(orphan_subclass_element);
  1985. if (!obj) {
  1986. return Ref<GDScript>();
  1987. }
  1988. return Ref<GDScript>(Object::cast_to<GDScript>(obj));
  1989. }
  1990. /*************** RESOURCE ***************/
  1991. RES ResourceFormatLoaderGDScript::load(const String &p_path, const String &p_original_path, Error *r_error, bool p_use_sub_threads, float *r_progress, CacheMode p_cache_mode) {
  1992. if (r_error) {
  1993. *r_error = ERR_FILE_CANT_OPEN;
  1994. }
  1995. Error err;
  1996. Ref<GDScript> script = GDScriptCache::get_full_script(p_path, err);
  1997. // TODO: Reintroduce binary and encrypted scripts.
  1998. if (script.is_null()) {
  1999. // Don't fail loading because of parsing error.
  2000. script.instance();
  2001. }
  2002. if (r_error) {
  2003. *r_error = OK;
  2004. }
  2005. return script;
  2006. }
  2007. void ResourceFormatLoaderGDScript::get_recognized_extensions(List<String> *p_extensions) const {
  2008. p_extensions->push_back("gd");
  2009. // TODO: Reintroduce binary and encrypted scripts.
  2010. // p_extensions->push_back("gdc");
  2011. // p_extensions->push_back("gde");
  2012. }
  2013. bool ResourceFormatLoaderGDScript::handles_type(const String &p_type) const {
  2014. return (p_type == "Script" || p_type == "GDScript");
  2015. }
  2016. String ResourceFormatLoaderGDScript::get_resource_type(const String &p_path) const {
  2017. String el = p_path.get_extension().to_lower();
  2018. // TODO: Reintroduce binary and encrypted scripts.
  2019. if (el == "gd" /*|| el == "gdc" || el == "gde"*/) {
  2020. return "GDScript";
  2021. }
  2022. return "";
  2023. }
  2024. void ResourceFormatLoaderGDScript::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
  2025. FileAccessRef file = FileAccess::open(p_path, FileAccess::READ);
  2026. ERR_FAIL_COND_MSG(!file, "Cannot open file '" + p_path + "'.");
  2027. String source = file->get_as_utf8_string();
  2028. if (source.is_empty()) {
  2029. return;
  2030. }
  2031. GDScriptParser parser;
  2032. if (OK != parser.parse(source, p_path, false)) {
  2033. return;
  2034. }
  2035. for (const List<String>::Element *E = parser.get_dependencies().front(); E; E = E->next()) {
  2036. p_dependencies->push_back(E->get());
  2037. }
  2038. }
  2039. Error ResourceFormatSaverGDScript::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  2040. Ref<GDScript> sqscr = p_resource;
  2041. ERR_FAIL_COND_V(sqscr.is_null(), ERR_INVALID_PARAMETER);
  2042. String source = sqscr->get_source_code();
  2043. Error err;
  2044. FileAccess *file = FileAccess::open(p_path, FileAccess::WRITE, &err);
  2045. ERR_FAIL_COND_V_MSG(err, err, "Cannot save GDScript file '" + p_path + "'.");
  2046. file->store_string(source);
  2047. if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
  2048. memdelete(file);
  2049. return ERR_CANT_CREATE;
  2050. }
  2051. file->close();
  2052. memdelete(file);
  2053. if (ScriptServer::is_reload_scripts_on_save_enabled()) {
  2054. GDScriptLanguage::get_singleton()->reload_tool_script(p_resource, false);
  2055. }
  2056. return OK;
  2057. }
  2058. void ResourceFormatSaverGDScript::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  2059. if (Object::cast_to<GDScript>(*p_resource)) {
  2060. p_extensions->push_back("gd");
  2061. }
  2062. }
  2063. bool ResourceFormatSaverGDScript::recognize(const RES &p_resource) const {
  2064. return Object::cast_to<GDScript>(*p_resource) != nullptr;
  2065. }