gdscript.cpp 76 KB

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