gdscript.cpp 66 KB

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