gdscript.cpp 77 KB

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