gdscript.cpp 67 KB

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