gdscript.cpp 88 KB

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