gdscript.cpp 85 KB

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