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