gdscript.cpp 65 KB

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