gdscript.cpp 80 KB

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