gdscript.cpp 85 KB

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