gdscript.cpp 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737
  1. /**************************************************************************/
  2. /* gdscript.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 "gdscript.h"
  31. #include "gdscript_analyzer.h"
  32. #include "gdscript_cache.h"
  33. #include "gdscript_compiler.h"
  34. #include "gdscript_parser.h"
  35. #include "gdscript_rpc_callable.h"
  36. #include "gdscript_warning.h"
  37. #ifdef TOOLS_ENABLED
  38. #include "editor/gdscript_docgen.h"
  39. #endif
  40. #ifdef TESTS_ENABLED
  41. #include "tests/gdscript_test_runner.h"
  42. #endif
  43. #include "core/config/engine.h"
  44. #include "core/config/project_settings.h"
  45. #include "core/core_constants.h"
  46. #include "core/core_string_names.h"
  47. #include "core/io/file_access.h"
  48. #include "core/io/file_access_encrypted.h"
  49. #include "core/os/os.h"
  50. #ifdef TOOLS_ENABLED
  51. #include "editor/editor_paths.h"
  52. #endif
  53. #include <stdint.h>
  54. ///////////////////////////
  55. GDScriptNativeClass::GDScriptNativeClass(const StringName &p_name) {
  56. name = p_name;
  57. }
  58. bool GDScriptNativeClass::_get(const StringName &p_name, Variant &r_ret) const {
  59. bool ok;
  60. int64_t v = ClassDB::get_integer_constant(name, p_name, &ok);
  61. if (ok) {
  62. r_ret = v;
  63. return true;
  64. } else {
  65. return false;
  66. }
  67. }
  68. void GDScriptNativeClass::_bind_methods() {
  69. ClassDB::bind_method(D_METHOD("new"), &GDScriptNativeClass::_new);
  70. }
  71. Variant GDScriptNativeClass::_new() {
  72. Object *o = instantiate();
  73. ERR_FAIL_COND_V_MSG(!o, Variant(), "Class type: '" + String(name) + "' is not instantiable.");
  74. RefCounted *rc = Object::cast_to<RefCounted>(o);
  75. if (rc) {
  76. return Ref<RefCounted>(rc);
  77. } else {
  78. return o;
  79. }
  80. }
  81. Object *GDScriptNativeClass::instantiate() {
  82. return ClassDB::instantiate(name);
  83. }
  84. Variant GDScriptNativeClass::callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  85. if (p_method == SNAME("new")) {
  86. // Constructor.
  87. return Object::callp(p_method, p_args, p_argcount, r_error);
  88. }
  89. MethodBind *method = ClassDB::get_method(name, p_method);
  90. if (method && method->is_static()) {
  91. // Native static method.
  92. return method->call(nullptr, p_args, p_argcount, r_error);
  93. }
  94. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  95. return Variant();
  96. }
  97. GDScriptFunction *GDScript::_super_constructor(GDScript *p_script) {
  98. if (p_script->initializer) {
  99. return p_script->initializer;
  100. } else {
  101. GDScript *base_src = p_script->_base;
  102. if (base_src != nullptr) {
  103. return _super_constructor(base_src);
  104. } else {
  105. return nullptr;
  106. }
  107. }
  108. }
  109. void GDScript::_super_implicit_constructor(GDScript *p_script, GDScriptInstance *p_instance, Callable::CallError &r_error) {
  110. GDScript *base_src = p_script->_base;
  111. if (base_src != nullptr) {
  112. _super_implicit_constructor(base_src, p_instance, r_error);
  113. if (r_error.error != Callable::CallError::CALL_OK) {
  114. return;
  115. }
  116. }
  117. ERR_FAIL_NULL(p_script->implicit_initializer);
  118. p_script->implicit_initializer->call(p_instance, nullptr, 0, r_error);
  119. }
  120. GDScriptInstance *GDScript::_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_is_ref_counted, Callable::CallError &r_error) {
  121. /* STEP 1, CREATE */
  122. GDScriptInstance *instance = memnew(GDScriptInstance);
  123. instance->base_ref_counted = p_is_ref_counted;
  124. instance->members.resize(member_indices.size());
  125. instance->script = Ref<GDScript>(this);
  126. instance->owner = p_owner;
  127. instance->owner_id = p_owner->get_instance_id();
  128. #ifdef DEBUG_ENABLED
  129. //needed for hot reloading
  130. for (const KeyValue<StringName, MemberInfo> &E : member_indices) {
  131. instance->member_indices_cache[E.key] = E.value.index;
  132. }
  133. #endif
  134. instance->owner->set_script_instance(instance);
  135. /* STEP 2, INITIALIZE AND CONSTRUCT */
  136. {
  137. MutexLock lock(GDScriptLanguage::singleton->mutex);
  138. instances.insert(instance->owner);
  139. }
  140. _super_implicit_constructor(this, instance, r_error);
  141. if (r_error.error != Callable::CallError::CALL_OK) {
  142. instance->script = Ref<GDScript>();
  143. instance->owner->set_script_instance(nullptr);
  144. {
  145. MutexLock lock(GDScriptLanguage::singleton->mutex);
  146. instances.erase(p_owner);
  147. }
  148. ERR_FAIL_V_MSG(nullptr, "Error constructing a GDScriptInstance.");
  149. }
  150. if (p_argcount < 0) {
  151. return instance;
  152. }
  153. initializer = _super_constructor(this);
  154. if (initializer != nullptr) {
  155. initializer->call(instance, p_args, p_argcount, r_error);
  156. if (r_error.error != Callable::CallError::CALL_OK) {
  157. instance->script = Ref<GDScript>();
  158. instance->owner->set_script_instance(nullptr);
  159. {
  160. MutexLock lock(GDScriptLanguage::singleton->mutex);
  161. instances.erase(p_owner);
  162. }
  163. ERR_FAIL_V_MSG(nullptr, "Error constructing a GDScriptInstance.");
  164. }
  165. }
  166. //@TODO make thread safe
  167. return instance;
  168. }
  169. Variant GDScript::_new(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  170. /* STEP 1, CREATE */
  171. if (!valid) {
  172. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  173. return Variant();
  174. }
  175. r_error.error = Callable::CallError::CALL_OK;
  176. Ref<RefCounted> ref;
  177. Object *owner = nullptr;
  178. GDScript *_baseptr = this;
  179. while (_baseptr->_base) {
  180. _baseptr = _baseptr->_base;
  181. }
  182. ERR_FAIL_COND_V(_baseptr->native.is_null(), Variant());
  183. if (_baseptr->native.ptr()) {
  184. owner = _baseptr->native->instantiate();
  185. } else {
  186. owner = memnew(RefCounted); //by default, no base means use reference
  187. }
  188. ERR_FAIL_COND_V_MSG(!owner, Variant(), "Can't inherit from a virtual class.");
  189. RefCounted *r = Object::cast_to<RefCounted>(owner);
  190. if (r) {
  191. ref = Ref<RefCounted>(r);
  192. }
  193. GDScriptInstance *instance = _create_instance(p_args, p_argcount, owner, r != nullptr, r_error);
  194. if (!instance) {
  195. if (ref.is_null()) {
  196. memdelete(owner); //no owner, sorry
  197. }
  198. return Variant();
  199. }
  200. if (ref.is_valid()) {
  201. return ref;
  202. } else {
  203. return owner;
  204. }
  205. }
  206. bool GDScript::can_instantiate() const {
  207. #ifdef TOOLS_ENABLED
  208. return valid && (tool || ScriptServer::is_scripting_enabled());
  209. #else
  210. return valid;
  211. #endif
  212. }
  213. Ref<Script> GDScript::get_base_script() const {
  214. if (_base) {
  215. return Ref<GDScript>(_base);
  216. } else {
  217. return Ref<Script>();
  218. }
  219. }
  220. StringName GDScript::get_global_name() const {
  221. return global_name;
  222. }
  223. StringName GDScript::get_instance_base_type() const {
  224. if (native.is_valid()) {
  225. return native->get_name();
  226. }
  227. if (base.is_valid() && base->is_valid()) {
  228. return base->get_instance_base_type();
  229. }
  230. return StringName();
  231. }
  232. struct _GDScriptMemberSort {
  233. int index = 0;
  234. StringName name;
  235. _FORCE_INLINE_ bool operator<(const _GDScriptMemberSort &p_member) const { return index < p_member.index; }
  236. };
  237. #ifdef TOOLS_ENABLED
  238. void GDScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  239. placeholders.erase(p_placeholder);
  240. }
  241. #endif
  242. void GDScript::_get_script_method_list(List<MethodInfo> *r_list, bool p_include_base) const {
  243. const GDScript *current = this;
  244. while (current) {
  245. for (const KeyValue<StringName, GDScriptFunction *> &E : current->member_functions) {
  246. r_list->push_back(E.value->get_method_info());
  247. }
  248. if (!p_include_base) {
  249. return;
  250. }
  251. current = current->_base;
  252. }
  253. }
  254. void GDScript::get_script_method_list(List<MethodInfo> *r_list) const {
  255. _get_script_method_list(r_list, true);
  256. }
  257. void GDScript::_get_script_property_list(List<PropertyInfo> *r_list, bool p_include_base) const {
  258. const GDScript *sptr = this;
  259. List<PropertyInfo> props;
  260. while (sptr) {
  261. Vector<_GDScriptMemberSort> msort;
  262. for (const KeyValue<StringName, MemberInfo> &E : sptr->member_indices) {
  263. if (!sptr->members.has(E.key)) {
  264. continue; // Skip base class members.
  265. }
  266. _GDScriptMemberSort ms;
  267. ms.index = E.value.index;
  268. ms.name = E.key;
  269. msort.push_back(ms);
  270. }
  271. msort.sort();
  272. msort.reverse();
  273. for (int i = 0; i < msort.size(); i++) {
  274. props.push_front(sptr->member_indices[msort[i].name].property_info);
  275. }
  276. #ifdef TOOLS_ENABLED
  277. r_list->push_back(sptr->get_class_category());
  278. #endif // TOOLS_ENABLED
  279. for (const PropertyInfo &E : props) {
  280. r_list->push_back(E);
  281. }
  282. if (!p_include_base) {
  283. break;
  284. }
  285. props.clear();
  286. sptr = sptr->_base;
  287. }
  288. }
  289. void GDScript::get_script_property_list(List<PropertyInfo> *r_list) const {
  290. _get_script_property_list(r_list, true);
  291. }
  292. bool GDScript::has_method(const StringName &p_method) const {
  293. return member_functions.has(p_method);
  294. }
  295. MethodInfo GDScript::get_method_info(const StringName &p_method) const {
  296. HashMap<StringName, GDScriptFunction *>::ConstIterator E = member_functions.find(p_method);
  297. if (!E) {
  298. return MethodInfo();
  299. }
  300. return E->value->get_method_info();
  301. }
  302. bool GDScript::get_property_default_value(const StringName &p_property, Variant &r_value) const {
  303. #ifdef TOOLS_ENABLED
  304. HashMap<StringName, Variant>::ConstIterator E = member_default_values_cache.find(p_property);
  305. if (E) {
  306. r_value = E->value;
  307. return true;
  308. }
  309. if (base_cache.is_valid()) {
  310. return base_cache->get_property_default_value(p_property, r_value);
  311. }
  312. #endif
  313. return false;
  314. }
  315. ScriptInstance *GDScript::instance_create(Object *p_this) {
  316. GDScript *top = this;
  317. while (top->_base) {
  318. top = top->_base;
  319. }
  320. if (top->native.is_valid()) {
  321. if (!ClassDB::is_parent_class(p_this->get_class_name(), top->native->get_name())) {
  322. if (EngineDebugger::is_active()) {
  323. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), 1, "Script inherits from native type '" + String(top->native->get_name()) + "', so it can't be assigned to an object of type: '" + p_this->get_class() + "'");
  324. }
  325. ERR_FAIL_V_MSG(nullptr, "Script inherits from native type '" + String(top->native->get_name()) + "', so it can't be assigned to an object of type '" + p_this->get_class() + "'" + ".");
  326. }
  327. }
  328. Callable::CallError unchecked_error;
  329. return _create_instance(nullptr, 0, p_this, Object::cast_to<RefCounted>(p_this) != nullptr, unchecked_error);
  330. }
  331. PlaceHolderScriptInstance *GDScript::placeholder_instance_create(Object *p_this) {
  332. #ifdef TOOLS_ENABLED
  333. PlaceHolderScriptInstance *si = memnew(PlaceHolderScriptInstance(GDScriptLanguage::get_singleton(), Ref<Script>(this), p_this));
  334. placeholders.insert(si);
  335. _update_exports(nullptr, false, si);
  336. return si;
  337. #else
  338. return nullptr;
  339. #endif
  340. }
  341. bool GDScript::instance_has(const Object *p_this) const {
  342. MutexLock lock(GDScriptLanguage::singleton->mutex);
  343. return instances.has((Object *)p_this);
  344. }
  345. bool GDScript::has_source_code() const {
  346. return !source.is_empty();
  347. }
  348. String GDScript::get_source_code() const {
  349. return source;
  350. }
  351. void GDScript::set_source_code(const String &p_code) {
  352. if (source == p_code) {
  353. return;
  354. }
  355. source = p_code;
  356. #ifdef TOOLS_ENABLED
  357. source_changed_cache = true;
  358. #endif
  359. }
  360. #ifdef TOOLS_ENABLED
  361. void GDScript::_update_exports_values(HashMap<StringName, Variant> &values, List<PropertyInfo> &propnames) {
  362. for (const KeyValue<StringName, Variant> &E : member_default_values_cache) {
  363. values[E.key] = E.value;
  364. }
  365. for (const PropertyInfo &E : members_cache) {
  366. propnames.push_back(E);
  367. }
  368. if (base_cache.is_valid()) {
  369. base_cache->_update_exports_values(values, propnames);
  370. }
  371. }
  372. void GDScript::_add_doc(const DocData::ClassDoc &p_inner_class) {
  373. if (_owner) { // Only the top-level class stores doc info
  374. _owner->_add_doc(p_inner_class);
  375. } else { // Remove old docs, add new
  376. for (int i = 0; i < docs.size(); i++) {
  377. if (docs[i].name == p_inner_class.name) {
  378. docs.remove_at(i);
  379. break;
  380. }
  381. }
  382. docs.append(p_inner_class);
  383. }
  384. }
  385. void GDScript::_clear_doc() {
  386. docs.clear();
  387. doc = DocData::ClassDoc();
  388. }
  389. String GDScript::get_class_icon_path() const {
  390. return simplified_icon_path;
  391. }
  392. #endif
  393. bool GDScript::_update_exports(bool *r_err, bool p_recursive_call, PlaceHolderScriptInstance *p_instance_to_update) {
  394. #ifdef TOOLS_ENABLED
  395. static Vector<GDScript *> base_caches;
  396. if (!p_recursive_call) {
  397. base_caches.clear();
  398. }
  399. base_caches.append(this);
  400. bool changed = false;
  401. if (source_changed_cache) {
  402. source_changed_cache = false;
  403. changed = true;
  404. String basedir = path;
  405. if (basedir.is_empty()) {
  406. basedir = get_path();
  407. }
  408. if (!basedir.is_empty()) {
  409. basedir = basedir.get_base_dir();
  410. }
  411. GDScriptParser parser;
  412. GDScriptAnalyzer analyzer(&parser);
  413. Error err = parser.parse(source, path, false);
  414. if (err == OK && analyzer.analyze() == OK) {
  415. const GDScriptParser::ClassNode *c = parser.get_tree();
  416. if (base_cache.is_valid()) {
  417. base_cache->inheriters_cache.erase(get_instance_id());
  418. base_cache = Ref<GDScript>();
  419. }
  420. GDScriptParser::DataType base_type = parser.get_tree()->base_type;
  421. if (base_type.kind == GDScriptParser::DataType::CLASS) {
  422. Ref<GDScript> bf = GDScriptCache::get_full_script(base_type.script_path, err, path);
  423. if (err == OK) {
  424. bf = Ref<GDScript>(bf->find_class(base_type.class_type->fqcn));
  425. if (bf.is_valid()) {
  426. base_cache = bf;
  427. bf->inheriters_cache.insert(get_instance_id());
  428. }
  429. }
  430. }
  431. members_cache.clear();
  432. member_default_values_cache.clear();
  433. _signals.clear();
  434. members_cache.push_back(get_class_category());
  435. for (int i = 0; i < c->members.size(); i++) {
  436. const GDScriptParser::ClassNode::Member &member = c->members[i];
  437. switch (member.type) {
  438. case GDScriptParser::ClassNode::Member::VARIABLE: {
  439. if (!member.variable->exported) {
  440. continue;
  441. }
  442. members_cache.push_back(member.variable->export_info);
  443. Variant default_value = analyzer.make_variable_default_value(member.variable);
  444. member_default_values_cache[member.variable->identifier->name] = default_value;
  445. } break;
  446. case GDScriptParser::ClassNode::Member::SIGNAL: {
  447. _signals[member.signal->identifier->name] = member.signal->method_info;
  448. } break;
  449. case GDScriptParser::ClassNode::Member::GROUP: {
  450. members_cache.push_back(member.annotation->export_info);
  451. } break;
  452. default:
  453. break; // Nothing.
  454. }
  455. }
  456. } else {
  457. placeholder_fallback_enabled = true;
  458. return false;
  459. }
  460. } else if (placeholder_fallback_enabled) {
  461. return false;
  462. }
  463. placeholder_fallback_enabled = false;
  464. if (base_cache.is_valid() && base_cache->is_valid()) {
  465. for (int i = 0; i < base_caches.size(); i++) {
  466. if (base_caches[i] == base_cache.ptr()) {
  467. if (r_err) {
  468. *r_err = true;
  469. }
  470. valid = false; // to show error in the editor
  471. base_cache->valid = false;
  472. base_cache->inheriters_cache.clear(); // to prevent future stackoverflows
  473. base_cache.unref();
  474. base.unref();
  475. _base = nullptr;
  476. ERR_FAIL_V_MSG(false, "Cyclic inheritance in script class.");
  477. }
  478. }
  479. if (base_cache->_update_exports(r_err, true)) {
  480. if (r_err && *r_err) {
  481. return false;
  482. }
  483. changed = true;
  484. }
  485. }
  486. if ((changed || p_instance_to_update) && placeholders.size()) { //hm :(
  487. // update placeholders if any
  488. HashMap<StringName, Variant> values;
  489. List<PropertyInfo> propnames;
  490. _update_exports_values(values, propnames);
  491. if (changed) {
  492. for (PlaceHolderScriptInstance *E : placeholders) {
  493. E->update(propnames, values);
  494. }
  495. } else {
  496. p_instance_to_update->update(propnames, values);
  497. }
  498. }
  499. return changed;
  500. #else
  501. return false;
  502. #endif
  503. }
  504. void GDScript::update_exports() {
  505. #ifdef TOOLS_ENABLED
  506. bool cyclic_error = false;
  507. _update_exports(&cyclic_error);
  508. if (cyclic_error) {
  509. return;
  510. }
  511. HashSet<ObjectID> copy = inheriters_cache; //might get modified
  512. for (const ObjectID &E : copy) {
  513. Object *id = ObjectDB::get_instance(E);
  514. GDScript *s = Object::cast_to<GDScript>(id);
  515. if (!s) {
  516. continue;
  517. }
  518. s->update_exports();
  519. }
  520. #endif
  521. }
  522. String GDScript::_get_debug_path() const {
  523. if (is_built_in() && !get_name().is_empty()) {
  524. return vformat("%s(%s)", get_name(), get_script_path());
  525. } else {
  526. return get_script_path();
  527. }
  528. }
  529. Error GDScript::_static_init() {
  530. if (static_initializer) {
  531. Callable::CallError call_err;
  532. static_initializer->call(nullptr, nullptr, 0, call_err);
  533. if (call_err.error != Callable::CallError::CALL_OK) {
  534. return ERR_CANT_CREATE;
  535. }
  536. }
  537. Error err = OK;
  538. for (KeyValue<StringName, Ref<GDScript>> &inner : subclasses) {
  539. err = inner.value->_static_init();
  540. if (err) {
  541. break;
  542. }
  543. }
  544. return err;
  545. }
  546. #ifdef TOOLS_ENABLED
  547. void GDScript::_save_old_static_data() {
  548. old_static_variables_indices = static_variables_indices;
  549. old_static_variables = static_variables;
  550. for (KeyValue<StringName, Ref<GDScript>> &inner : subclasses) {
  551. inner.value->_save_old_static_data();
  552. }
  553. }
  554. void GDScript::_restore_old_static_data() {
  555. for (KeyValue<StringName, MemberInfo> &E : old_static_variables_indices) {
  556. if (static_variables_indices.has(E.key)) {
  557. static_variables.write[static_variables_indices[E.key].index] = old_static_variables[E.value.index];
  558. }
  559. }
  560. old_static_variables_indices.clear();
  561. old_static_variables.clear();
  562. for (KeyValue<StringName, Ref<GDScript>> &inner : subclasses) {
  563. inner.value->_restore_old_static_data();
  564. }
  565. }
  566. #endif
  567. Error GDScript::reload(bool p_keep_state) {
  568. if (reloading) {
  569. return OK;
  570. }
  571. reloading = true;
  572. bool has_instances;
  573. {
  574. MutexLock lock(GDScriptLanguage::singleton->mutex);
  575. has_instances = instances.size();
  576. }
  577. ERR_FAIL_COND_V(!p_keep_state && has_instances, ERR_ALREADY_IN_USE);
  578. String basedir = path;
  579. if (basedir.is_empty()) {
  580. basedir = get_path();
  581. }
  582. if (!basedir.is_empty()) {
  583. basedir = basedir.get_base_dir();
  584. }
  585. // Loading a template, don't parse.
  586. #ifdef TOOLS_ENABLED
  587. if (EditorPaths::get_singleton() && basedir.begins_with(EditorPaths::get_singleton()->get_project_script_templates_dir())) {
  588. reloading = false;
  589. return OK;
  590. }
  591. #endif
  592. {
  593. String source_path = path;
  594. if (source_path.is_empty()) {
  595. source_path = get_path();
  596. }
  597. Ref<GDScript> cached_script = GDScriptCache::get_cached_script(source_path);
  598. if (!source_path.is_empty() && cached_script.is_null()) {
  599. MutexLock lock(GDScriptCache::singleton->mutex);
  600. GDScriptCache::singleton->shallow_gdscript_cache[source_path] = Ref<GDScript>(this);
  601. }
  602. }
  603. bool can_run = ScriptServer::is_scripting_enabled() || is_tool();
  604. #ifdef TOOLS_ENABLED
  605. if (p_keep_state && can_run && is_valid()) {
  606. _save_old_static_data();
  607. }
  608. #endif
  609. valid = false;
  610. GDScriptParser parser;
  611. Error err = parser.parse(source, path, false);
  612. if (err) {
  613. if (EngineDebugger::is_active()) {
  614. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), parser.get_errors().front()->get().line, "Parser Error: " + parser.get_errors().front()->get().message);
  615. }
  616. // TODO: Show all error messages.
  617. _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(), false, ERR_HANDLER_SCRIPT);
  618. reloading = false;
  619. return ERR_PARSE_ERROR;
  620. }
  621. GDScriptAnalyzer analyzer(&parser);
  622. err = analyzer.analyze();
  623. if (err) {
  624. if (EngineDebugger::is_active()) {
  625. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), parser.get_errors().front()->get().line, "Parser Error: " + parser.get_errors().front()->get().message);
  626. }
  627. const List<GDScriptParser::ParserError>::Element *e = parser.get_errors().front();
  628. while (e != nullptr) {
  629. _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(), false, ERR_HANDLER_SCRIPT);
  630. e = e->next();
  631. }
  632. reloading = false;
  633. return ERR_PARSE_ERROR;
  634. }
  635. can_run = ScriptServer::is_scripting_enabled() || parser.is_tool();
  636. GDScriptCompiler compiler;
  637. err = compiler.compile(&parser, this, p_keep_state);
  638. if (err) {
  639. _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(), false, ERR_HANDLER_SCRIPT);
  640. if (can_run) {
  641. if (EngineDebugger::is_active()) {
  642. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), compiler.get_error_line(), "Parser Error: " + compiler.get_error());
  643. }
  644. reloading = false;
  645. return ERR_COMPILATION_FAILED;
  646. } else {
  647. reloading = false;
  648. return err;
  649. }
  650. }
  651. #ifdef TOOLS_ENABLED
  652. // Done after compilation because it needs the GDScript object's inner class GDScript objects,
  653. // which are made by calling make_scripts() within compiler.compile() above.
  654. GDScriptDocGen::generate_docs(this, parser.get_tree());
  655. #endif
  656. #ifdef DEBUG_ENABLED
  657. for (const GDScriptWarning &warning : parser.get_warnings()) {
  658. if (EngineDebugger::is_active()) {
  659. Vector<ScriptLanguage::StackInfo> si;
  660. EngineDebugger::get_script_debugger()->send_error("", get_script_path(), warning.start_line, warning.get_name(), warning.get_message(), false, ERR_HANDLER_WARNING, si);
  661. }
  662. }
  663. #endif
  664. if (can_run) {
  665. err = _static_init();
  666. if (err) {
  667. return err;
  668. }
  669. }
  670. #ifdef TOOLS_ENABLED
  671. if (can_run && p_keep_state) {
  672. _restore_old_static_data();
  673. }
  674. #endif
  675. reloading = false;
  676. return OK;
  677. }
  678. ScriptLanguage *GDScript::get_language() const {
  679. return GDScriptLanguage::get_singleton();
  680. }
  681. void GDScript::get_constants(HashMap<StringName, Variant> *p_constants) {
  682. if (p_constants) {
  683. for (const KeyValue<StringName, Variant> &E : constants) {
  684. (*p_constants)[E.key] = E.value;
  685. }
  686. }
  687. }
  688. void GDScript::get_members(HashSet<StringName> *p_members) {
  689. if (p_members) {
  690. for (const StringName &E : members) {
  691. p_members->insert(E);
  692. }
  693. }
  694. }
  695. const Variant GDScript::get_rpc_config() const {
  696. return rpc_config;
  697. }
  698. void GDScript::unload_static() const {
  699. GDScriptCache::remove_script(fully_qualified_name);
  700. }
  701. Variant GDScript::callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  702. GDScript *top = this;
  703. while (top) {
  704. HashMap<StringName, GDScriptFunction *>::Iterator E = top->member_functions.find(p_method);
  705. if (E) {
  706. ERR_FAIL_COND_V_MSG(!E->value->is_static(), Variant(), "Can't call non-static function '" + String(p_method) + "' in script.");
  707. return E->value->call(nullptr, p_args, p_argcount, r_error);
  708. }
  709. top = top->_base;
  710. }
  711. //none found, regular
  712. return Script::callp(p_method, p_args, p_argcount, r_error);
  713. }
  714. bool GDScript::_get(const StringName &p_name, Variant &r_ret) const {
  715. if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
  716. r_ret = get_source_code();
  717. return true;
  718. }
  719. const GDScript *top = this;
  720. while (top) {
  721. {
  722. HashMap<StringName, Variant>::ConstIterator E = top->constants.find(p_name);
  723. if (E) {
  724. r_ret = E->value;
  725. return true;
  726. }
  727. }
  728. {
  729. HashMap<StringName, MemberInfo>::ConstIterator E = top->static_variables_indices.find(p_name);
  730. if (E) {
  731. if (E->value.getter) {
  732. Callable::CallError ce;
  733. r_ret = const_cast<GDScript *>(this)->callp(E->value.getter, nullptr, 0, ce);
  734. return true;
  735. }
  736. r_ret = top->static_variables[E->value.index];
  737. return true;
  738. }
  739. }
  740. {
  741. HashMap<StringName, GDScriptFunction *>::ConstIterator E = top->member_functions.find(p_name);
  742. if (E && E->value->is_static()) {
  743. if (top->rpc_config.has(p_name)) {
  744. r_ret = Callable(memnew(GDScriptRPCCallable(const_cast<GDScript *>(top), E->key)));
  745. } else {
  746. r_ret = Callable(const_cast<GDScript *>(top), E->key);
  747. }
  748. return true;
  749. }
  750. }
  751. {
  752. HashMap<StringName, Ref<GDScript>>::ConstIterator E = top->subclasses.find(p_name);
  753. if (E) {
  754. r_ret = E->value;
  755. return true;
  756. }
  757. }
  758. top = top->_base;
  759. }
  760. return false;
  761. }
  762. bool GDScript::_set(const StringName &p_name, const Variant &p_value) {
  763. if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
  764. set_source_code(p_value);
  765. reload();
  766. return true;
  767. }
  768. GDScript *top = this;
  769. while (top) {
  770. HashMap<StringName, MemberInfo>::ConstIterator E = top->static_variables_indices.find(p_name);
  771. if (E) {
  772. const MemberInfo *member = &E->value;
  773. Variant value = p_value;
  774. if (member->data_type.has_type && !member->data_type.is_type(value)) {
  775. const Variant *args = &p_value;
  776. Callable::CallError err;
  777. Variant::construct(member->data_type.builtin_type, value, &args, 1, err);
  778. if (err.error != Callable::CallError::CALL_OK || !member->data_type.is_type(value)) {
  779. return false;
  780. }
  781. }
  782. if (member->setter) {
  783. const Variant *args = &value;
  784. Callable::CallError err;
  785. callp(member->setter, &args, 1, err);
  786. return err.error == Callable::CallError::CALL_OK;
  787. } else {
  788. top->static_variables.write[member->index] = value;
  789. return true;
  790. }
  791. }
  792. top = top->_base;
  793. }
  794. return false;
  795. }
  796. void GDScript::_get_property_list(List<PropertyInfo> *p_properties) const {
  797. p_properties->push_back(PropertyInfo(Variant::STRING, "script/source", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  798. List<const GDScript *> classes;
  799. const GDScript *top = this;
  800. while (top) {
  801. classes.push_back(top);
  802. top = top->_base;
  803. }
  804. for (const List<const GDScript *>::Element *E = classes.back(); E; E = E->prev()) {
  805. Vector<_GDScriptMemberSort> msort;
  806. for (const KeyValue<StringName, MemberInfo> &F : E->get()->static_variables_indices) {
  807. _GDScriptMemberSort ms;
  808. ms.index = F.value.index;
  809. ms.name = F.key;
  810. msort.push_back(ms);
  811. }
  812. msort.sort();
  813. for (int i = 0; i < msort.size(); i++) {
  814. p_properties->push_back(E->get()->static_variables_indices[msort[i].name].property_info);
  815. }
  816. }
  817. }
  818. void GDScript::_bind_methods() {
  819. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "new", &GDScript::_new, MethodInfo("new"));
  820. }
  821. void GDScript::set_path(const String &p_path, bool p_take_over) {
  822. if (is_root_script()) {
  823. Script::set_path(p_path, p_take_over);
  824. }
  825. String old_path = path;
  826. path = p_path;
  827. GDScriptCache::move_script(old_path, p_path);
  828. for (KeyValue<StringName, Ref<GDScript>> &kv : subclasses) {
  829. kv.value->set_path(p_path, p_take_over);
  830. }
  831. }
  832. String GDScript::get_script_path() const {
  833. return path;
  834. }
  835. Error GDScript::load_source_code(const String &p_path) {
  836. if (p_path.is_empty() || p_path.begins_with("gdscript://") || ResourceLoader::get_resource_type(p_path.get_slice("::", 0)) == "PackedScene") {
  837. return OK;
  838. }
  839. Vector<uint8_t> sourcef;
  840. Error err;
  841. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);
  842. if (err) {
  843. const char *err_name;
  844. if (err < 0 || err >= ERR_MAX) {
  845. err_name = "(invalid error code)";
  846. } else {
  847. err_name = error_names[err];
  848. }
  849. ERR_FAIL_COND_V_MSG(err, err, "Attempt to open script '" + p_path + "' resulted in error '" + err_name + "'.");
  850. }
  851. uint64_t len = f->get_length();
  852. sourcef.resize(len + 1);
  853. uint8_t *w = sourcef.ptrw();
  854. uint64_t r = f->get_buffer(w, len);
  855. ERR_FAIL_COND_V(r != len, ERR_CANT_OPEN);
  856. w[len] = 0;
  857. String s;
  858. if (s.parse_utf8((const char *)w) != OK) {
  859. 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.");
  860. }
  861. source = s;
  862. path = p_path;
  863. #ifdef TOOLS_ENABLED
  864. source_changed_cache = true;
  865. set_edited(false);
  866. set_last_modified_time(FileAccess::get_modified_time(path));
  867. #endif // TOOLS_ENABLED
  868. return OK;
  869. }
  870. const HashMap<StringName, GDScriptFunction *> &GDScript::debug_get_member_functions() const {
  871. return member_functions;
  872. }
  873. StringName GDScript::debug_get_member_by_index(int p_idx) const {
  874. for (const KeyValue<StringName, MemberInfo> &E : member_indices) {
  875. if (E.value.index == p_idx) {
  876. return E.key;
  877. }
  878. }
  879. return "<error>";
  880. }
  881. StringName GDScript::debug_get_static_var_by_index(int p_idx) const {
  882. for (const KeyValue<StringName, MemberInfo> &E : static_variables_indices) {
  883. if (E.value.index == p_idx) {
  884. return E.key;
  885. }
  886. }
  887. return "<error>";
  888. }
  889. Ref<GDScript> GDScript::get_base() const {
  890. return base;
  891. }
  892. bool GDScript::inherits_script(const Ref<Script> &p_script) const {
  893. Ref<GDScript> gd = p_script;
  894. if (gd.is_null()) {
  895. return false;
  896. }
  897. const GDScript *s = this;
  898. while (s) {
  899. if (s == p_script.ptr()) {
  900. return true;
  901. }
  902. s = s->_base;
  903. }
  904. return false;
  905. }
  906. GDScript *GDScript::find_class(const String &p_qualified_name) {
  907. String first = p_qualified_name.get_slice("::", 0);
  908. Vector<String> class_names;
  909. GDScript *result = nullptr;
  910. // Empty initial name means start here.
  911. if (first.is_empty() || first == global_name) {
  912. class_names = p_qualified_name.split("::");
  913. result = this;
  914. } else if (p_qualified_name.begins_with(get_root_script()->path)) {
  915. // Script path could have a class path separator("::") in it.
  916. class_names = p_qualified_name.trim_prefix(get_root_script()->path).split("::");
  917. result = get_root_script();
  918. } else if (HashMap<StringName, Ref<GDScript>>::Iterator E = subclasses.find(first)) {
  919. class_names = p_qualified_name.split("::");
  920. result = E->value.ptr();
  921. } else if (_owner != nullptr) {
  922. // Check parent scope.
  923. return _owner->find_class(p_qualified_name);
  924. }
  925. // Starts at index 1 because index 0 was handled above.
  926. for (int i = 1; result != nullptr && i < class_names.size(); i++) {
  927. String current_name = class_names[i];
  928. if (HashMap<StringName, Ref<GDScript>>::Iterator E = result->subclasses.find(current_name)) {
  929. result = E->value.ptr();
  930. } else {
  931. // Couldn't find inner class.
  932. return nullptr;
  933. }
  934. }
  935. return result;
  936. }
  937. bool GDScript::has_class(const GDScript *p_script) {
  938. String fqn = p_script->fully_qualified_name;
  939. if (fully_qualified_name.is_empty() && fqn.get_slice("::", 0).is_empty()) {
  940. return p_script == this;
  941. } else if (fqn.begins_with(fully_qualified_name)) {
  942. return p_script == find_class(fqn.trim_prefix(fully_qualified_name));
  943. }
  944. return false;
  945. }
  946. GDScript *GDScript::get_root_script() {
  947. GDScript *result = this;
  948. while (result->_owner) {
  949. result = result->_owner;
  950. }
  951. return result;
  952. }
  953. RBSet<GDScript *> GDScript::get_dependencies() {
  954. RBSet<GDScript *> dependencies;
  955. _get_dependencies(dependencies, this);
  956. dependencies.erase(this);
  957. return dependencies;
  958. }
  959. RBSet<GDScript *> GDScript::get_inverted_dependencies() {
  960. RBSet<GDScript *> inverted_dependencies;
  961. List<GDScript *> scripts;
  962. {
  963. MutexLock lock(GDScriptLanguage::singleton->mutex);
  964. SelfList<GDScript> *elem = GDScriptLanguage::singleton->script_list.first();
  965. while (elem) {
  966. scripts.push_back(elem->self());
  967. elem = elem->next();
  968. }
  969. }
  970. for (GDScript *scr : scripts) {
  971. if (scr == nullptr || scr == this || scr->destructing) {
  972. continue;
  973. }
  974. RBSet<GDScript *> scr_dependencies = scr->get_dependencies();
  975. if (scr_dependencies.has(this)) {
  976. inverted_dependencies.insert(scr);
  977. }
  978. }
  979. return inverted_dependencies;
  980. }
  981. RBSet<GDScript *> GDScript::get_must_clear_dependencies() {
  982. RBSet<GDScript *> dependencies = get_dependencies();
  983. RBSet<GDScript *> must_clear_dependencies;
  984. HashMap<GDScript *, RBSet<GDScript *>> inverted_dependencies;
  985. for (GDScript *E : dependencies) {
  986. inverted_dependencies.insert(E, E->get_inverted_dependencies());
  987. }
  988. RBSet<GDScript *> cant_clear;
  989. for (KeyValue<GDScript *, RBSet<GDScript *>> &E : inverted_dependencies) {
  990. for (GDScript *F : E.value) {
  991. if (!dependencies.has(F)) {
  992. cant_clear.insert(E.key);
  993. for (GDScript *G : E.key->get_dependencies()) {
  994. cant_clear.insert(G);
  995. }
  996. break;
  997. }
  998. }
  999. }
  1000. for (KeyValue<GDScript *, RBSet<GDScript *>> &E : inverted_dependencies) {
  1001. if (cant_clear.has(E.key) || ScriptServer::is_global_class(E.key->get_fully_qualified_name())) {
  1002. continue;
  1003. }
  1004. must_clear_dependencies.insert(E.key);
  1005. }
  1006. cant_clear.clear();
  1007. dependencies.clear();
  1008. inverted_dependencies.clear();
  1009. return must_clear_dependencies;
  1010. }
  1011. bool GDScript::has_script_signal(const StringName &p_signal) const {
  1012. if (_signals.has(p_signal)) {
  1013. return true;
  1014. }
  1015. if (base.is_valid()) {
  1016. return base->has_script_signal(p_signal);
  1017. }
  1018. #ifdef TOOLS_ENABLED
  1019. else if (base_cache.is_valid()) {
  1020. return base_cache->has_script_signal(p_signal);
  1021. }
  1022. #endif
  1023. return false;
  1024. }
  1025. void GDScript::_get_script_signal_list(List<MethodInfo> *r_list, bool p_include_base) const {
  1026. for (const KeyValue<StringName, MethodInfo> &E : _signals) {
  1027. r_list->push_back(E.value);
  1028. }
  1029. if (!p_include_base) {
  1030. return;
  1031. }
  1032. if (base.is_valid()) {
  1033. base->get_script_signal_list(r_list);
  1034. }
  1035. #ifdef TOOLS_ENABLED
  1036. else if (base_cache.is_valid()) {
  1037. base_cache->get_script_signal_list(r_list);
  1038. }
  1039. #endif
  1040. }
  1041. void GDScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
  1042. _get_script_signal_list(r_signals, true);
  1043. }
  1044. GDScript *GDScript::_get_gdscript_from_variant(const Variant &p_variant) {
  1045. Object *obj = p_variant;
  1046. if (obj == nullptr || obj->get_instance_id().is_null()) {
  1047. return nullptr;
  1048. }
  1049. return Object::cast_to<GDScript>(obj);
  1050. }
  1051. void GDScript::_get_dependencies(RBSet<GDScript *> &p_dependencies, const GDScript *p_except) {
  1052. if (p_dependencies.has(this)) {
  1053. return;
  1054. }
  1055. p_dependencies.insert(this);
  1056. for (const KeyValue<StringName, GDScriptFunction *> &E : member_functions) {
  1057. if (E.value == nullptr) {
  1058. continue;
  1059. }
  1060. for (const Variant &V : E.value->constants) {
  1061. GDScript *scr = _get_gdscript_from_variant(V);
  1062. if (scr != nullptr && scr != p_except) {
  1063. scr->_get_dependencies(p_dependencies, p_except);
  1064. }
  1065. }
  1066. }
  1067. if (implicit_initializer) {
  1068. for (const Variant &V : implicit_initializer->constants) {
  1069. GDScript *scr = _get_gdscript_from_variant(V);
  1070. if (scr != nullptr && scr != p_except) {
  1071. scr->_get_dependencies(p_dependencies, p_except);
  1072. }
  1073. }
  1074. }
  1075. if (implicit_ready) {
  1076. for (const Variant &V : implicit_ready->constants) {
  1077. GDScript *scr = _get_gdscript_from_variant(V);
  1078. if (scr != nullptr && scr != p_except) {
  1079. scr->_get_dependencies(p_dependencies, p_except);
  1080. }
  1081. }
  1082. }
  1083. for (KeyValue<StringName, Ref<GDScript>> &E : subclasses) {
  1084. if (E.value != p_except) {
  1085. E.value->_get_dependencies(p_dependencies, p_except);
  1086. }
  1087. }
  1088. for (const KeyValue<StringName, Variant> &E : constants) {
  1089. GDScript *scr = _get_gdscript_from_variant(E.value);
  1090. if (scr != nullptr && scr != p_except) {
  1091. scr->_get_dependencies(p_dependencies, p_except);
  1092. }
  1093. }
  1094. }
  1095. GDScript::GDScript() :
  1096. script_list(this) {
  1097. {
  1098. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1099. GDScriptLanguage::get_singleton()->script_list.add(&script_list);
  1100. }
  1101. path = vformat("gdscript://%d.gd", get_instance_id());
  1102. }
  1103. void GDScript::_save_orphaned_subclasses(ClearData *p_clear_data) {
  1104. struct ClassRefWithName {
  1105. ObjectID id;
  1106. String fully_qualified_name;
  1107. };
  1108. Vector<ClassRefWithName> weak_subclasses;
  1109. // collect subclasses ObjectID and name
  1110. for (KeyValue<StringName, Ref<GDScript>> &E : subclasses) {
  1111. E.value->_owner = nullptr; //bye, you are no longer owned cause I died
  1112. ClassRefWithName subclass;
  1113. subclass.id = E.value->get_instance_id();
  1114. subclass.fully_qualified_name = E.value->fully_qualified_name;
  1115. weak_subclasses.push_back(subclass);
  1116. }
  1117. // clear subclasses to allow unused subclasses to be deleted
  1118. for (KeyValue<StringName, Ref<GDScript>> &E : subclasses) {
  1119. p_clear_data->scripts.insert(E.value);
  1120. }
  1121. subclasses.clear();
  1122. // subclasses are also held by constants, clear those as well
  1123. for (KeyValue<StringName, Variant> &E : constants) {
  1124. GDScript *gdscr = _get_gdscript_from_variant(E.value);
  1125. if (gdscr != nullptr) {
  1126. p_clear_data->scripts.insert(gdscr);
  1127. }
  1128. }
  1129. constants.clear();
  1130. // keep orphan subclass only for subclasses that are still in use
  1131. for (int i = 0; i < weak_subclasses.size(); i++) {
  1132. ClassRefWithName subclass = weak_subclasses[i];
  1133. Object *obj = ObjectDB::get_instance(subclass.id);
  1134. if (!obj) {
  1135. continue;
  1136. }
  1137. // subclass is not released
  1138. GDScriptLanguage::get_singleton()->add_orphan_subclass(subclass.fully_qualified_name, subclass.id);
  1139. }
  1140. }
  1141. #ifdef DEBUG_ENABLED
  1142. String GDScript::debug_get_script_name(const Ref<Script> &p_script) {
  1143. if (p_script.is_valid()) {
  1144. Ref<GDScript> gdscript = p_script;
  1145. if (gdscript.is_valid()) {
  1146. if (gdscript->get_local_name() != StringName()) {
  1147. return gdscript->get_local_name();
  1148. }
  1149. return gdscript->get_fully_qualified_name().get_file();
  1150. }
  1151. if (p_script->get_global_name() != StringName()) {
  1152. return p_script->get_global_name();
  1153. } else if (!p_script->get_path().is_empty()) {
  1154. return p_script->get_path().get_file();
  1155. } else if (!p_script->get_name().is_empty()) {
  1156. return p_script->get_name(); // Resource name.
  1157. }
  1158. }
  1159. return "<unknown script>";
  1160. }
  1161. #endif
  1162. void GDScript::clear(ClearData *p_clear_data) {
  1163. if (clearing) {
  1164. return;
  1165. }
  1166. clearing = true;
  1167. ClearData data;
  1168. ClearData *clear_data = p_clear_data;
  1169. bool is_root = false;
  1170. // If `clear_data` is `nullptr`, it means that it's the root.
  1171. // The root is in charge to clear functions and scripts of itself and its dependencies
  1172. if (clear_data == nullptr) {
  1173. clear_data = &data;
  1174. is_root = true;
  1175. }
  1176. RBSet<GDScript *> must_clear_dependencies = get_must_clear_dependencies();
  1177. for (GDScript *E : must_clear_dependencies) {
  1178. clear_data->scripts.insert(E);
  1179. E->clear(clear_data);
  1180. }
  1181. for (const KeyValue<StringName, GDScriptFunction *> &E : member_functions) {
  1182. clear_data->functions.insert(E.value);
  1183. }
  1184. member_functions.clear();
  1185. for (KeyValue<StringName, MemberInfo> &E : member_indices) {
  1186. clear_data->scripts.insert(E.value.data_type.script_type_ref);
  1187. E.value.data_type.script_type_ref = Ref<Script>();
  1188. }
  1189. for (KeyValue<StringName, MemberInfo> &E : static_variables_indices) {
  1190. clear_data->scripts.insert(E.value.data_type.script_type_ref);
  1191. E.value.data_type.script_type_ref = Ref<Script>();
  1192. }
  1193. static_variables.clear();
  1194. static_variables_indices.clear();
  1195. if (implicit_initializer) {
  1196. clear_data->functions.insert(implicit_initializer);
  1197. implicit_initializer = nullptr;
  1198. }
  1199. if (implicit_ready) {
  1200. clear_data->functions.insert(implicit_ready);
  1201. implicit_ready = nullptr;
  1202. }
  1203. if (static_initializer) {
  1204. clear_data->functions.insert(static_initializer);
  1205. static_initializer = nullptr;
  1206. }
  1207. _save_orphaned_subclasses(clear_data);
  1208. #ifdef TOOLS_ENABLED
  1209. // Clearing inner class doc, script doc only cleared when the script source deleted.
  1210. if (_owner) {
  1211. _clear_doc();
  1212. }
  1213. #endif
  1214. // If it's not the root, skip clearing the data
  1215. if (is_root) {
  1216. // All dependencies have been accounted for
  1217. for (GDScriptFunction *E : clear_data->functions) {
  1218. memdelete(E);
  1219. }
  1220. for (Ref<Script> &E : clear_data->scripts) {
  1221. Ref<GDScript> gdscr = E;
  1222. if (gdscr.is_valid()) {
  1223. GDScriptCache::remove_script(gdscr->get_path());
  1224. }
  1225. }
  1226. clear_data->clear();
  1227. }
  1228. }
  1229. GDScript::~GDScript() {
  1230. if (destructing) {
  1231. return;
  1232. }
  1233. destructing = true;
  1234. clear();
  1235. {
  1236. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1237. while (SelfList<GDScriptFunctionState> *E = pending_func_states.first()) {
  1238. // Order matters since clearing the stack may already cause
  1239. // the GDScriptFunctionState to be destroyed and thus removed from the list.
  1240. pending_func_states.remove(E);
  1241. GDScriptFunctionState *state = E->self();
  1242. ObjectID state_id = state->get_instance_id();
  1243. state->_clear_connections();
  1244. if (ObjectDB::get_instance(state_id)) {
  1245. state->_clear_stack();
  1246. }
  1247. }
  1248. }
  1249. {
  1250. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1251. script_list.remove_from_list();
  1252. }
  1253. }
  1254. //////////////////////////////
  1255. // INSTANCE //
  1256. //////////////////////////////
  1257. bool GDScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  1258. {
  1259. HashMap<StringName, GDScript::MemberInfo>::Iterator E = script->member_indices.find(p_name);
  1260. if (E) {
  1261. const GDScript::MemberInfo *member = &E->value;
  1262. Variant value = p_value;
  1263. if (member->data_type.has_type && !member->data_type.is_type(value)) {
  1264. const Variant *args = &p_value;
  1265. Callable::CallError err;
  1266. Variant::construct(member->data_type.builtin_type, value, &args, 1, err);
  1267. if (err.error != Callable::CallError::CALL_OK || !member->data_type.is_type(value)) {
  1268. return false;
  1269. }
  1270. }
  1271. if (member->setter) {
  1272. const Variant *args = &value;
  1273. Callable::CallError err;
  1274. callp(member->setter, &args, 1, err);
  1275. return err.error == Callable::CallError::CALL_OK;
  1276. } else {
  1277. members.write[member->index] = value;
  1278. return true;
  1279. }
  1280. }
  1281. }
  1282. GDScript *sptr = script.ptr();
  1283. while (sptr) {
  1284. {
  1285. HashMap<StringName, GDScript::MemberInfo>::ConstIterator E = sptr->static_variables_indices.find(p_name);
  1286. if (E) {
  1287. const GDScript::MemberInfo *member = &E->value;
  1288. Variant value = p_value;
  1289. if (member->data_type.has_type && !member->data_type.is_type(value)) {
  1290. const Variant *args = &p_value;
  1291. Callable::CallError err;
  1292. Variant::construct(member->data_type.builtin_type, value, &args, 1, err);
  1293. if (err.error != Callable::CallError::CALL_OK || !member->data_type.is_type(value)) {
  1294. return false;
  1295. }
  1296. }
  1297. if (member->setter) {
  1298. const Variant *args = &value;
  1299. Callable::CallError err;
  1300. callp(member->setter, &args, 1, err);
  1301. return err.error == Callable::CallError::CALL_OK;
  1302. } else {
  1303. sptr->static_variables.write[member->index] = value;
  1304. return true;
  1305. }
  1306. }
  1307. }
  1308. {
  1309. HashMap<StringName, GDScriptFunction *>::Iterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._set);
  1310. if (E) {
  1311. Variant name = p_name;
  1312. const Variant *args[2] = { &name, &p_value };
  1313. Callable::CallError err;
  1314. Variant ret = E->value->call(this, (const Variant **)args, 2, err);
  1315. if (err.error == Callable::CallError::CALL_OK && ret.get_type() == Variant::BOOL && ret.operator bool()) {
  1316. return true;
  1317. }
  1318. }
  1319. }
  1320. sptr = sptr->_base;
  1321. }
  1322. return false;
  1323. }
  1324. bool GDScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  1325. {
  1326. HashMap<StringName, GDScript::MemberInfo>::ConstIterator E = script->member_indices.find(p_name);
  1327. if (E) {
  1328. if (E->value.getter) {
  1329. Callable::CallError err;
  1330. r_ret = const_cast<GDScriptInstance *>(this)->callp(E->value.getter, nullptr, 0, err);
  1331. if (err.error == Callable::CallError::CALL_OK) {
  1332. return true;
  1333. }
  1334. }
  1335. r_ret = members[E->value.index];
  1336. return true;
  1337. }
  1338. }
  1339. const GDScript *sptr = script.ptr();
  1340. while (sptr) {
  1341. {
  1342. HashMap<StringName, Variant>::ConstIterator E = sptr->constants.find(p_name);
  1343. if (E) {
  1344. r_ret = E->value;
  1345. return true;
  1346. }
  1347. }
  1348. {
  1349. HashMap<StringName, GDScript::MemberInfo>::ConstIterator E = sptr->static_variables_indices.find(p_name);
  1350. if (E) {
  1351. if (E->value.getter) {
  1352. Callable::CallError ce;
  1353. r_ret = const_cast<GDScript *>(sptr)->callp(E->value.getter, nullptr, 0, ce);
  1354. return true;
  1355. }
  1356. r_ret = sptr->static_variables[E->value.index];
  1357. return true;
  1358. }
  1359. }
  1360. {
  1361. HashMap<StringName, MethodInfo>::ConstIterator E = sptr->_signals.find(p_name);
  1362. if (E) {
  1363. r_ret = Signal(this->owner, E->key);
  1364. return true;
  1365. }
  1366. }
  1367. {
  1368. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(p_name);
  1369. if (E) {
  1370. if (sptr->rpc_config.has(p_name)) {
  1371. r_ret = Callable(memnew(GDScriptRPCCallable(this->owner, E->key)));
  1372. } else {
  1373. r_ret = Callable(this->owner, E->key);
  1374. }
  1375. return true;
  1376. }
  1377. }
  1378. {
  1379. HashMap<StringName, Ref<GDScript>>::ConstIterator E = sptr->subclasses.find(p_name);
  1380. if (E) {
  1381. r_ret = E->value;
  1382. return true;
  1383. }
  1384. }
  1385. {
  1386. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get);
  1387. if (E) {
  1388. Variant name = p_name;
  1389. const Variant *args[1] = { &name };
  1390. Callable::CallError err;
  1391. Variant ret = const_cast<GDScriptFunction *>(E->value)->call(const_cast<GDScriptInstance *>(this), (const Variant **)args, 1, err);
  1392. if (err.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1393. r_ret = ret;
  1394. return true;
  1395. }
  1396. }
  1397. }
  1398. sptr = sptr->_base;
  1399. }
  1400. return false;
  1401. }
  1402. Variant::Type GDScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  1403. if (script->member_indices.has(p_name)) {
  1404. if (r_is_valid) {
  1405. *r_is_valid = true;
  1406. }
  1407. return script->member_indices[p_name].property_info.type;
  1408. }
  1409. if (r_is_valid) {
  1410. *r_is_valid = false;
  1411. }
  1412. return Variant::NIL;
  1413. }
  1414. void GDScriptInstance::validate_property(PropertyInfo &p_property) const {
  1415. Variant property = (Dictionary)p_property;
  1416. const Variant *args[1] = { &property };
  1417. const GDScript *sptr = script.ptr();
  1418. while (sptr) {
  1419. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._validate_property);
  1420. if (E) {
  1421. Callable::CallError err;
  1422. Variant ret = E->value->call(const_cast<GDScriptInstance *>(this), args, 1, err);
  1423. if (err.error == Callable::CallError::CALL_OK) {
  1424. p_property = PropertyInfo::from_dict(property);
  1425. return;
  1426. }
  1427. }
  1428. sptr = sptr->_base;
  1429. }
  1430. }
  1431. void GDScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  1432. // exported members, not done yet!
  1433. const GDScript *sptr = script.ptr();
  1434. List<PropertyInfo> props;
  1435. while (sptr) {
  1436. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get_property_list);
  1437. if (E) {
  1438. Callable::CallError err;
  1439. Variant ret = const_cast<GDScriptFunction *>(E->value)->call(const_cast<GDScriptInstance *>(this), nullptr, 0, err);
  1440. if (err.error == Callable::CallError::CALL_OK) {
  1441. ERR_FAIL_COND_MSG(ret.get_type() != Variant::ARRAY, "Wrong type for _get_property_list, must be an array of dictionaries.");
  1442. Array arr = ret;
  1443. for (int i = 0; i < arr.size(); i++) {
  1444. Dictionary d = arr[i];
  1445. ERR_CONTINUE(!d.has("name"));
  1446. ERR_CONTINUE(!d.has("type"));
  1447. PropertyInfo pinfo;
  1448. pinfo.name = d["name"];
  1449. pinfo.type = Variant::Type(d["type"].operator int());
  1450. if (d.has("hint")) {
  1451. pinfo.hint = PropertyHint(d["hint"].operator int());
  1452. }
  1453. if (d.has("hint_string")) {
  1454. pinfo.hint_string = d["hint_string"];
  1455. }
  1456. if (d.has("usage")) {
  1457. pinfo.usage = d["usage"];
  1458. }
  1459. if (d.has("class_name")) {
  1460. pinfo.class_name = d["class_name"];
  1461. }
  1462. ERR_CONTINUE(pinfo.name.is_empty() && (pinfo.usage & PROPERTY_USAGE_STORAGE));
  1463. ERR_CONTINUE(pinfo.type < 0 || pinfo.type >= Variant::VARIANT_MAX);
  1464. props.push_back(pinfo);
  1465. }
  1466. }
  1467. }
  1468. //instance a fake script for editing the values
  1469. Vector<_GDScriptMemberSort> msort;
  1470. for (const KeyValue<StringName, GDScript::MemberInfo> &F : sptr->member_indices) {
  1471. if (!sptr->members.has(F.key)) {
  1472. continue; // Skip base class members.
  1473. }
  1474. _GDScriptMemberSort ms;
  1475. ms.index = F.value.index;
  1476. ms.name = F.key;
  1477. msort.push_back(ms);
  1478. }
  1479. msort.sort();
  1480. msort.reverse();
  1481. for (int i = 0; i < msort.size(); i++) {
  1482. props.push_front(sptr->member_indices[msort[i].name].property_info);
  1483. }
  1484. #ifdef TOOLS_ENABLED
  1485. p_properties->push_back(sptr->get_class_category());
  1486. #endif // TOOLS_ENABLED
  1487. for (PropertyInfo &prop : props) {
  1488. validate_property(prop);
  1489. p_properties->push_back(prop);
  1490. }
  1491. props.clear();
  1492. sptr = sptr->_base;
  1493. }
  1494. }
  1495. bool GDScriptInstance::property_can_revert(const StringName &p_name) const {
  1496. Variant name = p_name;
  1497. const Variant *args[1] = { &name };
  1498. const GDScript *sptr = script.ptr();
  1499. while (sptr) {
  1500. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._property_can_revert);
  1501. if (E) {
  1502. Callable::CallError err;
  1503. Variant ret = E->value->call(const_cast<GDScriptInstance *>(this), args, 1, err);
  1504. if (err.error == Callable::CallError::CALL_OK && ret.get_type() == Variant::BOOL && ret.operator bool()) {
  1505. return true;
  1506. }
  1507. }
  1508. sptr = sptr->_base;
  1509. }
  1510. return false;
  1511. }
  1512. bool GDScriptInstance::property_get_revert(const StringName &p_name, Variant &r_ret) const {
  1513. Variant name = p_name;
  1514. const Variant *args[1] = { &name };
  1515. const GDScript *sptr = script.ptr();
  1516. while (sptr) {
  1517. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._property_get_revert);
  1518. if (E) {
  1519. Callable::CallError err;
  1520. Variant ret = E->value->call(const_cast<GDScriptInstance *>(this), args, 1, err);
  1521. if (err.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1522. r_ret = ret;
  1523. return true;
  1524. }
  1525. }
  1526. sptr = sptr->_base;
  1527. }
  1528. return false;
  1529. }
  1530. void GDScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  1531. const GDScript *sptr = script.ptr();
  1532. while (sptr) {
  1533. for (const KeyValue<StringName, GDScriptFunction *> &E : sptr->member_functions) {
  1534. p_list->push_back(E.value->get_method_info());
  1535. }
  1536. sptr = sptr->_base;
  1537. }
  1538. }
  1539. bool GDScriptInstance::has_method(const StringName &p_method) const {
  1540. const GDScript *sptr = script.ptr();
  1541. while (sptr) {
  1542. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(p_method);
  1543. if (E) {
  1544. return true;
  1545. }
  1546. sptr = sptr->_base;
  1547. }
  1548. return false;
  1549. }
  1550. Variant GDScriptInstance::callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1551. GDScript *sptr = script.ptr();
  1552. if (unlikely(p_method == SNAME("_ready"))) {
  1553. // Call implicit ready first, including for the super classes.
  1554. while (sptr) {
  1555. if (sptr->implicit_ready) {
  1556. sptr->implicit_ready->call(this, nullptr, 0, r_error);
  1557. }
  1558. sptr = sptr->_base;
  1559. }
  1560. // Reset this back for the regular call.
  1561. sptr = script.ptr();
  1562. }
  1563. while (sptr) {
  1564. HashMap<StringName, GDScriptFunction *>::Iterator E = sptr->member_functions.find(p_method);
  1565. if (E) {
  1566. return E->value->call(this, p_args, p_argcount, r_error);
  1567. }
  1568. sptr = sptr->_base;
  1569. }
  1570. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1571. return Variant();
  1572. }
  1573. void GDScriptInstance::notification(int p_notification, bool p_reversed) {
  1574. //notification is not virtual, it gets called at ALL levels just like in C.
  1575. Variant value = p_notification;
  1576. const Variant *args[1] = { &value };
  1577. List<GDScript *> pl;
  1578. GDScript *sptr = script.ptr();
  1579. while (sptr) {
  1580. if (p_reversed) {
  1581. pl.push_back(sptr);
  1582. } else {
  1583. pl.push_front(sptr);
  1584. }
  1585. sptr = sptr->_base;
  1586. }
  1587. for (GDScript *sc : pl) {
  1588. HashMap<StringName, GDScriptFunction *>::Iterator E = sc->member_functions.find(GDScriptLanguage::get_singleton()->strings._notification);
  1589. if (E) {
  1590. Callable::CallError err;
  1591. E->value->call(this, args, 1, err);
  1592. if (err.error != Callable::CallError::CALL_OK) {
  1593. //print error about notification call
  1594. }
  1595. }
  1596. }
  1597. }
  1598. String GDScriptInstance::to_string(bool *r_valid) {
  1599. if (has_method(CoreStringNames::get_singleton()->_to_string)) {
  1600. Callable::CallError ce;
  1601. Variant ret = callp(CoreStringNames::get_singleton()->_to_string, nullptr, 0, ce);
  1602. if (ce.error == Callable::CallError::CALL_OK) {
  1603. if (ret.get_type() != Variant::STRING) {
  1604. if (r_valid) {
  1605. *r_valid = false;
  1606. }
  1607. ERR_FAIL_V_MSG(String(), "Wrong type for " + CoreStringNames::get_singleton()->_to_string + ", must be a String.");
  1608. }
  1609. if (r_valid) {
  1610. *r_valid = true;
  1611. }
  1612. return ret.operator String();
  1613. }
  1614. }
  1615. if (r_valid) {
  1616. *r_valid = false;
  1617. }
  1618. return String();
  1619. }
  1620. Ref<Script> GDScriptInstance::get_script() const {
  1621. return script;
  1622. }
  1623. ScriptLanguage *GDScriptInstance::get_language() {
  1624. return GDScriptLanguage::get_singleton();
  1625. }
  1626. const Variant GDScriptInstance::get_rpc_config() const {
  1627. return script->get_rpc_config();
  1628. }
  1629. void GDScriptInstance::reload_members() {
  1630. #ifdef DEBUG_ENABLED
  1631. Vector<Variant> new_members;
  1632. new_members.resize(script->member_indices.size());
  1633. //pass the values to the new indices
  1634. for (KeyValue<StringName, GDScript::MemberInfo> &E : script->member_indices) {
  1635. if (member_indices_cache.has(E.key)) {
  1636. Variant value = members[member_indices_cache[E.key]];
  1637. new_members.write[E.value.index] = value;
  1638. }
  1639. }
  1640. members.resize(new_members.size()); //resize
  1641. //apply
  1642. members = new_members;
  1643. //pass the values to the new indices
  1644. member_indices_cache.clear();
  1645. for (const KeyValue<StringName, GDScript::MemberInfo> &E : script->member_indices) {
  1646. member_indices_cache[E.key] = E.value.index;
  1647. }
  1648. #endif
  1649. }
  1650. GDScriptInstance::GDScriptInstance() {
  1651. owner = nullptr;
  1652. base_ref_counted = false;
  1653. }
  1654. GDScriptInstance::~GDScriptInstance() {
  1655. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1656. while (SelfList<GDScriptFunctionState> *E = pending_func_states.first()) {
  1657. // Order matters since clearing the stack may already cause
  1658. // the GDSCriptFunctionState to be destroyed and thus removed from the list.
  1659. pending_func_states.remove(E);
  1660. GDScriptFunctionState *state = E->self();
  1661. ObjectID state_id = state->get_instance_id();
  1662. state->_clear_connections();
  1663. if (ObjectDB::get_instance(state_id)) {
  1664. state->_clear_stack();
  1665. }
  1666. }
  1667. if (script.is_valid() && owner) {
  1668. script->instances.erase(owner);
  1669. }
  1670. }
  1671. /************* SCRIPT LANGUAGE **************/
  1672. GDScriptLanguage *GDScriptLanguage::singleton = nullptr;
  1673. String GDScriptLanguage::get_name() const {
  1674. return "GDScript";
  1675. }
  1676. /* LANGUAGE FUNCTIONS */
  1677. void GDScriptLanguage::_add_global(const StringName &p_name, const Variant &p_value) {
  1678. if (globals.has(p_name)) {
  1679. //overwrite existing
  1680. global_array.write[globals[p_name]] = p_value;
  1681. return;
  1682. }
  1683. globals[p_name] = global_array.size();
  1684. global_array.push_back(p_value);
  1685. _global_array = global_array.ptrw();
  1686. }
  1687. void GDScriptLanguage::add_global_constant(const StringName &p_variable, const Variant &p_value) {
  1688. _add_global(p_variable, p_value);
  1689. }
  1690. void GDScriptLanguage::add_named_global_constant(const StringName &p_name, const Variant &p_value) {
  1691. named_globals[p_name] = p_value;
  1692. }
  1693. Variant GDScriptLanguage::get_any_global_constant(const StringName &p_name) {
  1694. if (named_globals.has(p_name)) {
  1695. return named_globals[p_name];
  1696. }
  1697. if (globals.has(p_name)) {
  1698. return _global_array[globals[p_name]];
  1699. }
  1700. ERR_FAIL_V_MSG(Variant(), vformat("Could not find any global constant with name: %s.", p_name));
  1701. }
  1702. void GDScriptLanguage::remove_named_global_constant(const StringName &p_name) {
  1703. ERR_FAIL_COND(!named_globals.has(p_name));
  1704. named_globals.erase(p_name);
  1705. }
  1706. void GDScriptLanguage::init() {
  1707. //populate global constants
  1708. int gcc = CoreConstants::get_global_constant_count();
  1709. for (int i = 0; i < gcc; i++) {
  1710. _add_global(StaticCString::create(CoreConstants::get_global_constant_name(i)), CoreConstants::get_global_constant_value(i));
  1711. }
  1712. _add_global(StaticCString::create("PI"), Math_PI);
  1713. _add_global(StaticCString::create("TAU"), Math_TAU);
  1714. _add_global(StaticCString::create("INF"), INFINITY);
  1715. _add_global(StaticCString::create("NAN"), NAN);
  1716. //populate native classes
  1717. List<StringName> class_list;
  1718. ClassDB::get_class_list(&class_list);
  1719. for (const StringName &n : class_list) {
  1720. if (globals.has(n)) {
  1721. continue;
  1722. }
  1723. Ref<GDScriptNativeClass> nc = memnew(GDScriptNativeClass(n));
  1724. _add_global(n, nc);
  1725. }
  1726. //populate singletons
  1727. List<Engine::Singleton> singletons;
  1728. Engine::get_singleton()->get_singletons(&singletons);
  1729. for (const Engine::Singleton &E : singletons) {
  1730. _add_global(E.name, E.ptr);
  1731. }
  1732. #ifdef TESTS_ENABLED
  1733. GDScriptTests::GDScriptTestRunner::handle_cmdline();
  1734. #endif
  1735. }
  1736. String GDScriptLanguage::get_type() const {
  1737. return "GDScript";
  1738. }
  1739. String GDScriptLanguage::get_extension() const {
  1740. return "gd";
  1741. }
  1742. void GDScriptLanguage::finish() {
  1743. _call_stack.free();
  1744. // Clear the cache before parsing the script_list
  1745. GDScriptCache::clear();
  1746. // Clear dependencies between scripts, to ensure cyclic references are broken
  1747. // (to avoid leaks at exit).
  1748. SelfList<GDScript> *s = script_list.first();
  1749. while (s) {
  1750. // This ensures the current script is not released before we can check
  1751. // what's the next one in the list (we can't get the next upfront because we
  1752. // don't know if the reference breaking will cause it -or any other after
  1753. // it, for that matter- to be released so the next one is not the same as
  1754. // before).
  1755. Ref<GDScript> scr = s->self();
  1756. if (scr.is_valid()) {
  1757. for (KeyValue<StringName, GDScriptFunction *> &E : scr->member_functions) {
  1758. GDScriptFunction *func = E.value;
  1759. for (int i = 0; i < func->argument_types.size(); i++) {
  1760. func->argument_types.write[i].script_type_ref = Ref<Script>();
  1761. }
  1762. func->return_type.script_type_ref = Ref<Script>();
  1763. }
  1764. for (KeyValue<StringName, GDScript::MemberInfo> &E : scr->member_indices) {
  1765. E.value.data_type.script_type_ref = Ref<Script>();
  1766. }
  1767. // Clear backup for scripts that could slip out of the cyclic reference
  1768. // check
  1769. scr->clear();
  1770. }
  1771. s = s->next();
  1772. }
  1773. script_list.clear();
  1774. function_list.clear();
  1775. }
  1776. void GDScriptLanguage::profiling_start() {
  1777. #ifdef DEBUG_ENABLED
  1778. MutexLock lock(this->mutex);
  1779. SelfList<GDScriptFunction> *elem = function_list.first();
  1780. while (elem) {
  1781. elem->self()->profile.call_count.set(0);
  1782. elem->self()->profile.self_time.set(0);
  1783. elem->self()->profile.total_time.set(0);
  1784. elem->self()->profile.frame_call_count.set(0);
  1785. elem->self()->profile.frame_self_time.set(0);
  1786. elem->self()->profile.frame_total_time.set(0);
  1787. elem->self()->profile.last_frame_call_count = 0;
  1788. elem->self()->profile.last_frame_self_time = 0;
  1789. elem->self()->profile.last_frame_total_time = 0;
  1790. elem = elem->next();
  1791. }
  1792. profiling = true;
  1793. #endif
  1794. }
  1795. void GDScriptLanguage::profiling_stop() {
  1796. #ifdef DEBUG_ENABLED
  1797. MutexLock lock(this->mutex);
  1798. profiling = false;
  1799. #endif
  1800. }
  1801. int GDScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1802. int current = 0;
  1803. #ifdef DEBUG_ENABLED
  1804. MutexLock lock(this->mutex);
  1805. SelfList<GDScriptFunction> *elem = function_list.first();
  1806. while (elem) {
  1807. if (current >= p_info_max) {
  1808. break;
  1809. }
  1810. p_info_arr[current].call_count = elem->self()->profile.call_count.get();
  1811. p_info_arr[current].self_time = elem->self()->profile.self_time.get();
  1812. p_info_arr[current].total_time = elem->self()->profile.total_time.get();
  1813. p_info_arr[current].signature = elem->self()->profile.signature;
  1814. elem = elem->next();
  1815. current++;
  1816. }
  1817. #endif
  1818. return current;
  1819. }
  1820. int GDScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1821. int current = 0;
  1822. #ifdef DEBUG_ENABLED
  1823. MutexLock lock(this->mutex);
  1824. SelfList<GDScriptFunction> *elem = function_list.first();
  1825. while (elem) {
  1826. if (current >= p_info_max) {
  1827. break;
  1828. }
  1829. if (elem->self()->profile.last_frame_call_count > 0) {
  1830. p_info_arr[current].call_count = elem->self()->profile.last_frame_call_count;
  1831. p_info_arr[current].self_time = elem->self()->profile.last_frame_self_time;
  1832. p_info_arr[current].total_time = elem->self()->profile.last_frame_total_time;
  1833. p_info_arr[current].signature = elem->self()->profile.signature;
  1834. current++;
  1835. }
  1836. elem = elem->next();
  1837. }
  1838. #endif
  1839. return current;
  1840. }
  1841. struct GDScriptDepSort {
  1842. //must support sorting so inheritance works properly (parent must be reloaded first)
  1843. bool operator()(const Ref<GDScript> &A, const Ref<GDScript> &B) const {
  1844. if (A == B) {
  1845. return false; //shouldn't happen but..
  1846. }
  1847. const GDScript *I = B->get_base().ptr();
  1848. while (I) {
  1849. if (I == A.ptr()) {
  1850. // A is a base of B
  1851. return true;
  1852. }
  1853. I = I->get_base().ptr();
  1854. }
  1855. return false; //not a base
  1856. }
  1857. };
  1858. void GDScriptLanguage::reload_all_scripts() {
  1859. #ifdef DEBUG_ENABLED
  1860. print_verbose("GDScript: Reloading all scripts");
  1861. List<Ref<GDScript>> scripts;
  1862. {
  1863. MutexLock lock(this->mutex);
  1864. SelfList<GDScript> *elem = script_list.first();
  1865. while (elem) {
  1866. // Scripts will reload all subclasses, so only reload root scripts.
  1867. if (elem->self()->is_root_script() && elem->self()->get_path().is_resource_file()) {
  1868. print_verbose("GDScript: Found: " + elem->self()->get_path());
  1869. scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
  1870. }
  1871. elem = elem->next();
  1872. }
  1873. }
  1874. //as scripts are going to be reloaded, must proceed without locking here
  1875. scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
  1876. for (Ref<GDScript> &scr : scripts) {
  1877. print_verbose("GDScript: Reloading: " + scr->get_path());
  1878. scr->load_source_code(scr->get_path());
  1879. scr->reload(true);
  1880. }
  1881. #endif
  1882. }
  1883. void GDScriptLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
  1884. #ifdef DEBUG_ENABLED
  1885. List<Ref<GDScript>> scripts;
  1886. {
  1887. MutexLock lock(this->mutex);
  1888. SelfList<GDScript> *elem = script_list.first();
  1889. while (elem) {
  1890. // Scripts will reload all subclasses, so only reload root scripts.
  1891. if (elem->self()->is_root_script() && elem->self()->get_path().is_resource_file()) {
  1892. scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
  1893. }
  1894. elem = elem->next();
  1895. }
  1896. }
  1897. //when someone asks you why dynamically typed languages are easier to write....
  1898. HashMap<Ref<GDScript>, HashMap<ObjectID, List<Pair<StringName, Variant>>>> to_reload;
  1899. //as scripts are going to be reloaded, must proceed without locking here
  1900. scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
  1901. for (Ref<GDScript> &scr : scripts) {
  1902. bool reload = scr == p_script || to_reload.has(scr->get_base());
  1903. if (!reload) {
  1904. continue;
  1905. }
  1906. to_reload.insert(scr, HashMap<ObjectID, List<Pair<StringName, Variant>>>());
  1907. if (!p_soft_reload) {
  1908. //save state and remove script from instances
  1909. HashMap<ObjectID, List<Pair<StringName, Variant>>> &map = to_reload[scr];
  1910. while (scr->instances.front()) {
  1911. Object *obj = scr->instances.front()->get();
  1912. //save instance info
  1913. List<Pair<StringName, Variant>> state;
  1914. if (obj->get_script_instance()) {
  1915. obj->get_script_instance()->get_property_state(state);
  1916. map[obj->get_instance_id()] = state;
  1917. obj->set_script(Variant());
  1918. }
  1919. }
  1920. //same thing for placeholders
  1921. #ifdef TOOLS_ENABLED
  1922. while (scr->placeholders.size()) {
  1923. Object *obj = (*scr->placeholders.begin())->get_owner();
  1924. //save instance info
  1925. if (obj->get_script_instance()) {
  1926. map.insert(obj->get_instance_id(), List<Pair<StringName, Variant>>());
  1927. List<Pair<StringName, Variant>> &state = map[obj->get_instance_id()];
  1928. obj->get_script_instance()->get_property_state(state);
  1929. obj->set_script(Variant());
  1930. } else {
  1931. // no instance found. Let's remove it so we don't loop forever
  1932. scr->placeholders.erase(*scr->placeholders.begin());
  1933. }
  1934. }
  1935. #endif
  1936. for (const KeyValue<ObjectID, List<Pair<StringName, Variant>>> &F : scr->pending_reload_state) {
  1937. map[F.key] = F.value; //pending to reload, use this one instead
  1938. }
  1939. }
  1940. }
  1941. for (KeyValue<Ref<GDScript>, HashMap<ObjectID, List<Pair<StringName, Variant>>>> &E : to_reload) {
  1942. Ref<GDScript> scr = E.key;
  1943. scr->reload(p_soft_reload);
  1944. //restore state if saved
  1945. for (KeyValue<ObjectID, List<Pair<StringName, Variant>>> &F : E.value) {
  1946. List<Pair<StringName, Variant>> &saved_state = F.value;
  1947. Object *obj = ObjectDB::get_instance(F.key);
  1948. if (!obj) {
  1949. continue;
  1950. }
  1951. if (!p_soft_reload) {
  1952. //clear it just in case (may be a pending reload state)
  1953. obj->set_script(Variant());
  1954. }
  1955. obj->set_script(scr);
  1956. ScriptInstance *script_inst = obj->get_script_instance();
  1957. if (!script_inst) {
  1958. //failed, save reload state for next time if not saved
  1959. if (!scr->pending_reload_state.has(obj->get_instance_id())) {
  1960. scr->pending_reload_state[obj->get_instance_id()] = saved_state;
  1961. }
  1962. continue;
  1963. }
  1964. if (script_inst->is_placeholder() && scr->is_placeholder_fallback_enabled()) {
  1965. PlaceHolderScriptInstance *placeholder = static_cast<PlaceHolderScriptInstance *>(script_inst);
  1966. for (List<Pair<StringName, Variant>>::Element *G = saved_state.front(); G; G = G->next()) {
  1967. placeholder->property_set_fallback(G->get().first, G->get().second);
  1968. }
  1969. } else {
  1970. for (List<Pair<StringName, Variant>>::Element *G = saved_state.front(); G; G = G->next()) {
  1971. script_inst->set(G->get().first, G->get().second);
  1972. }
  1973. }
  1974. scr->pending_reload_state.erase(obj->get_instance_id()); //as it reloaded, remove pending state
  1975. }
  1976. //if instance states were saved, set them!
  1977. }
  1978. #endif
  1979. }
  1980. void GDScriptLanguage::frame() {
  1981. calls = 0;
  1982. #ifdef DEBUG_ENABLED
  1983. if (profiling) {
  1984. MutexLock lock(this->mutex);
  1985. SelfList<GDScriptFunction> *elem = function_list.first();
  1986. while (elem) {
  1987. elem->self()->profile.last_frame_call_count = elem->self()->profile.frame_call_count.get();
  1988. elem->self()->profile.last_frame_self_time = elem->self()->profile.frame_self_time.get();
  1989. elem->self()->profile.last_frame_total_time = elem->self()->profile.frame_total_time.get();
  1990. elem->self()->profile.frame_call_count.set(0);
  1991. elem->self()->profile.frame_self_time.set(0);
  1992. elem->self()->profile.frame_total_time.set(0);
  1993. elem = elem->next();
  1994. }
  1995. }
  1996. #endif
  1997. }
  1998. /* EDITOR FUNCTIONS */
  1999. void GDScriptLanguage::get_reserved_words(List<String> *p_words) const {
  2000. // TODO: Add annotations here?
  2001. static const char *_reserved_words[] = {
  2002. // operators
  2003. "and",
  2004. "in",
  2005. "not",
  2006. "or",
  2007. // types and values
  2008. "false",
  2009. "float",
  2010. "int",
  2011. "bool",
  2012. "null",
  2013. "PI",
  2014. "TAU",
  2015. "INF",
  2016. "NAN",
  2017. "self",
  2018. "true",
  2019. "void",
  2020. // functions
  2021. "as",
  2022. "assert",
  2023. "await",
  2024. "breakpoint",
  2025. "class",
  2026. "class_name",
  2027. "extends",
  2028. "is",
  2029. "func",
  2030. "preload",
  2031. "signal",
  2032. "super",
  2033. // var
  2034. "const",
  2035. "enum",
  2036. "static",
  2037. "var",
  2038. // control flow
  2039. "break",
  2040. "continue",
  2041. "if",
  2042. "elif",
  2043. "else",
  2044. "for",
  2045. "pass",
  2046. "return",
  2047. "match",
  2048. "while",
  2049. // These keywords are not implemented currently, but reserved for (potential) future use.
  2050. // We highlight them as keywords to make errors easier to understand.
  2051. "trait",
  2052. "namespace",
  2053. "yield",
  2054. nullptr
  2055. };
  2056. const char **w = _reserved_words;
  2057. while (*w) {
  2058. p_words->push_back(*w);
  2059. w++;
  2060. }
  2061. List<StringName> functions;
  2062. GDScriptUtilityFunctions::get_function_list(&functions);
  2063. for (const StringName &E : functions) {
  2064. p_words->push_back(String(E));
  2065. }
  2066. }
  2067. bool GDScriptLanguage::is_control_flow_keyword(String p_keyword) const {
  2068. return p_keyword == "break" ||
  2069. p_keyword == "continue" ||
  2070. p_keyword == "elif" ||
  2071. p_keyword == "else" ||
  2072. p_keyword == "if" ||
  2073. p_keyword == "for" ||
  2074. p_keyword == "match" ||
  2075. p_keyword == "pass" ||
  2076. p_keyword == "return" ||
  2077. p_keyword == "while";
  2078. }
  2079. bool GDScriptLanguage::handles_global_class_type(const String &p_type) const {
  2080. return p_type == "GDScript";
  2081. }
  2082. String GDScriptLanguage::get_global_class_name(const String &p_path, String *r_base_type, String *r_icon_path) const {
  2083. Error err;
  2084. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);
  2085. if (err) {
  2086. return String();
  2087. }
  2088. String source = f->get_as_utf8_string();
  2089. GDScriptParser parser;
  2090. err = parser.parse(source, p_path, false);
  2091. const GDScriptParser::ClassNode *c = parser.get_tree();
  2092. if (!c) {
  2093. return String(); // No class parsed.
  2094. }
  2095. /* **WARNING**
  2096. *
  2097. * This function is written with the goal to be *extremely* error tolerant, as such
  2098. * it should meet the following requirements:
  2099. *
  2100. * - It must not rely on the analyzer (in fact, the analyzer must not be used here),
  2101. * because at the time global classes are parsed, the dependencies may not be present
  2102. * yet, hence the function will fail (which is unintended).
  2103. * - It must not fail even if the parsing fails, because even if the file is broken,
  2104. * it should attempt its best to retrieve the inheritance metadata.
  2105. *
  2106. * Before changing this function, please ask the current maintainer of EditorFileSystem.
  2107. */
  2108. if (r_base_type) {
  2109. const GDScriptParser::ClassNode *subclass = c;
  2110. String path = p_path;
  2111. GDScriptParser subparser;
  2112. while (subclass) {
  2113. if (subclass->extends_used) {
  2114. if (!subclass->extends_path.is_empty()) {
  2115. if (subclass->extends.size() == 0) {
  2116. get_global_class_name(subclass->extends_path, r_base_type);
  2117. subclass = nullptr;
  2118. break;
  2119. } else {
  2120. Vector<GDScriptParser::IdentifierNode *> extend_classes = subclass->extends;
  2121. Ref<FileAccess> subfile = FileAccess::open(subclass->extends_path, FileAccess::READ);
  2122. if (subfile.is_null()) {
  2123. break;
  2124. }
  2125. String subsource = subfile->get_as_utf8_string();
  2126. if (subsource.is_empty()) {
  2127. break;
  2128. }
  2129. String subpath = subclass->extends_path;
  2130. if (subpath.is_relative_path()) {
  2131. subpath = path.get_base_dir().path_join(subpath).simplify_path();
  2132. }
  2133. if (OK != subparser.parse(subsource, subpath, false)) {
  2134. break;
  2135. }
  2136. path = subpath;
  2137. subclass = subparser.get_tree();
  2138. while (extend_classes.size() > 0) {
  2139. bool found = false;
  2140. for (int i = 0; i < subclass->members.size(); i++) {
  2141. if (subclass->members[i].type != GDScriptParser::ClassNode::Member::CLASS) {
  2142. continue;
  2143. }
  2144. const GDScriptParser::ClassNode *inner_class = subclass->members[i].m_class;
  2145. if (inner_class->identifier->name == extend_classes[0]->name) {
  2146. extend_classes.remove_at(0);
  2147. found = true;
  2148. subclass = inner_class;
  2149. break;
  2150. }
  2151. }
  2152. if (!found) {
  2153. subclass = nullptr;
  2154. break;
  2155. }
  2156. }
  2157. }
  2158. } else if (subclass->extends.size() == 1) {
  2159. *r_base_type = subclass->extends[0]->name;
  2160. subclass = nullptr;
  2161. } else {
  2162. break;
  2163. }
  2164. } else {
  2165. *r_base_type = "RefCounted";
  2166. subclass = nullptr;
  2167. }
  2168. }
  2169. }
  2170. if (r_icon_path) {
  2171. *r_icon_path = c->simplified_icon_path;
  2172. }
  2173. return c->identifier != nullptr ? String(c->identifier->name) : String();
  2174. }
  2175. thread_local GDScriptLanguage::CallStack GDScriptLanguage::_call_stack;
  2176. GDScriptLanguage::GDScriptLanguage() {
  2177. calls = 0;
  2178. ERR_FAIL_COND(singleton);
  2179. singleton = this;
  2180. strings._init = StaticCString::create("_init");
  2181. strings._static_init = StaticCString::create("_static_init");
  2182. strings._notification = StaticCString::create("_notification");
  2183. strings._set = StaticCString::create("_set");
  2184. strings._get = StaticCString::create("_get");
  2185. strings._get_property_list = StaticCString::create("_get_property_list");
  2186. strings._validate_property = StaticCString::create("_validate_property");
  2187. strings._property_can_revert = StaticCString::create("_property_can_revert");
  2188. strings._property_get_revert = StaticCString::create("_property_get_revert");
  2189. strings._script_source = StaticCString::create("script/source");
  2190. _debug_parse_err_line = -1;
  2191. _debug_parse_err_file = "";
  2192. profiling = false;
  2193. script_frame_time = 0;
  2194. int dmcs = GLOBAL_DEF(PropertyInfo(Variant::INT, "debug/settings/gdscript/max_call_stack", PROPERTY_HINT_RANGE, "512," + itos(GDScriptFunction::MAX_CALL_DEPTH - 1) + ",1"), 1024);
  2195. if (EngineDebugger::is_active()) {
  2196. //debugging enabled!
  2197. _debug_max_call_stack = dmcs;
  2198. } else {
  2199. _debug_max_call_stack = 0;
  2200. }
  2201. #ifdef DEBUG_ENABLED
  2202. GLOBAL_DEF("debug/gdscript/warnings/enable", true);
  2203. GLOBAL_DEF("debug/gdscript/warnings/exclude_addons", true);
  2204. for (int i = 0; i < (int)GDScriptWarning::WARNING_MAX; i++) {
  2205. GDScriptWarning::Code code = (GDScriptWarning::Code)i;
  2206. Variant default_enabled = GDScriptWarning::get_default_value(code);
  2207. String path = GDScriptWarning::get_settings_path_from_code(code);
  2208. GLOBAL_DEF(GDScriptWarning::get_property_info(code), default_enabled);
  2209. }
  2210. #endif // DEBUG_ENABLED
  2211. }
  2212. GDScriptLanguage::~GDScriptLanguage() {
  2213. singleton = nullptr;
  2214. }
  2215. void GDScriptLanguage::add_orphan_subclass(const String &p_qualified_name, const ObjectID &p_subclass) {
  2216. orphan_subclasses[p_qualified_name] = p_subclass;
  2217. }
  2218. Ref<GDScript> GDScriptLanguage::get_orphan_subclass(const String &p_qualified_name) {
  2219. HashMap<String, ObjectID>::Iterator orphan_subclass_element = orphan_subclasses.find(p_qualified_name);
  2220. if (!orphan_subclass_element) {
  2221. return Ref<GDScript>();
  2222. }
  2223. ObjectID orphan_subclass = orphan_subclass_element->value;
  2224. Object *obj = ObjectDB::get_instance(orphan_subclass);
  2225. orphan_subclasses.remove(orphan_subclass_element);
  2226. if (!obj) {
  2227. return Ref<GDScript>();
  2228. }
  2229. return Ref<GDScript>(Object::cast_to<GDScript>(obj));
  2230. }
  2231. Ref<GDScript> GDScriptLanguage::get_script_by_fully_qualified_name(const String &p_name) {
  2232. {
  2233. MutexLock lock(mutex);
  2234. SelfList<GDScript> *elem = script_list.first();
  2235. while (elem) {
  2236. GDScript *scr = elem->self();
  2237. if (scr->fully_qualified_name == p_name) {
  2238. return scr;
  2239. }
  2240. elem = elem->next();
  2241. }
  2242. }
  2243. Ref<GDScript> scr;
  2244. scr.instantiate();
  2245. scr->fully_qualified_name = p_name;
  2246. return scr;
  2247. }
  2248. /*************** RESOURCE ***************/
  2249. Ref<Resource> 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) {
  2250. Error err;
  2251. Ref<GDScript> scr = GDScriptCache::get_full_script(p_path, err, "", p_cache_mode == CACHE_MODE_IGNORE);
  2252. if (err && scr.is_valid()) {
  2253. // If !scr.is_valid(), the error was likely from scr->load_source_code(), which already generates an error.
  2254. ERR_PRINT_ED(vformat(R"(Failed to load script "%s" with error "%s".)", p_path, error_names[err]));
  2255. }
  2256. if (r_error) {
  2257. // Don't fail loading because of parsing error.
  2258. *r_error = scr.is_valid() ? OK : err;
  2259. }
  2260. return scr;
  2261. }
  2262. void ResourceFormatLoaderGDScript::get_recognized_extensions(List<String> *p_extensions) const {
  2263. p_extensions->push_back("gd");
  2264. }
  2265. bool ResourceFormatLoaderGDScript::handles_type(const String &p_type) const {
  2266. return (p_type == "Script" || p_type == "GDScript");
  2267. }
  2268. String ResourceFormatLoaderGDScript::get_resource_type(const String &p_path) const {
  2269. String el = p_path.get_extension().to_lower();
  2270. if (el == "gd") {
  2271. return "GDScript";
  2272. }
  2273. return "";
  2274. }
  2275. void ResourceFormatLoaderGDScript::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
  2276. Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::READ);
  2277. ERR_FAIL_COND_MSG(file.is_null(), "Cannot open file '" + p_path + "'.");
  2278. String source = file->get_as_utf8_string();
  2279. if (source.is_empty()) {
  2280. return;
  2281. }
  2282. GDScriptParser parser;
  2283. if (OK != parser.parse(source, p_path, false)) {
  2284. return;
  2285. }
  2286. for (const String &E : parser.get_dependencies()) {
  2287. p_dependencies->push_back(E);
  2288. }
  2289. }
  2290. Error ResourceFormatSaverGDScript::save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags) {
  2291. Ref<GDScript> sqscr = p_resource;
  2292. ERR_FAIL_COND_V(sqscr.is_null(), ERR_INVALID_PARAMETER);
  2293. String source = sqscr->get_source_code();
  2294. {
  2295. Error err;
  2296. Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::WRITE, &err);
  2297. ERR_FAIL_COND_V_MSG(err, err, "Cannot save GDScript file '" + p_path + "'.");
  2298. file->store_string(source);
  2299. if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
  2300. return ERR_CANT_CREATE;
  2301. }
  2302. }
  2303. if (ScriptServer::is_reload_scripts_on_save_enabled()) {
  2304. GDScriptLanguage::get_singleton()->reload_tool_script(p_resource, true);
  2305. }
  2306. return OK;
  2307. }
  2308. void ResourceFormatSaverGDScript::get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const {
  2309. if (Object::cast_to<GDScript>(*p_resource)) {
  2310. p_extensions->push_back("gd");
  2311. }
  2312. }
  2313. bool ResourceFormatSaverGDScript::recognize(const Ref<Resource> &p_resource) const {
  2314. return Object::cast_to<GDScript>(*p_resource) != nullptr;
  2315. }