gdscript.cpp 88 KB

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