gdscript.cpp 66 KB

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