gdscript.cpp 87 KB

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