gdscript.cpp 65 KB

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