gdscript.cpp 90 KB

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