gdscript.cpp 76 KB

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