gdscript.cpp 79 KB

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