gdscript.cpp 82 KB

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