gdscript.cpp 75 KB

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