gdscript.cpp 76 KB

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