gdscript.cpp 88 KB

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