gdscript.cpp 75 KB

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