gdscript.cpp 77 KB

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