gdscript.cpp 75 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735
  1. /**************************************************************************/
  2. /* gdscript.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  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 "gdscript_analyzer.h"
  32. #include "gdscript_cache.h"
  33. #include "gdscript_compiler.h"
  34. #include "gdscript_parser.h"
  35. #include "gdscript_rpc_callable.h"
  36. #include "gdscript_warning.h"
  37. #ifdef TOOLS_ENABLED
  38. #include "editor/gdscript_docgen.h"
  39. #endif
  40. #ifdef TESTS_ENABLED
  41. #include "tests/gdscript_test_runner.h"
  42. #endif
  43. #include "core/config/engine.h"
  44. #include "core/config/project_settings.h"
  45. #include "core/core_constants.h"
  46. #include "core/core_string_names.h"
  47. #include "core/io/file_access.h"
  48. #include "core/io/file_access_encrypted.h"
  49. #include "core/os/os.h"
  50. #ifdef TOOLS_ENABLED
  51. #include "editor/editor_paths.h"
  52. #endif
  53. #include <stdint.h>
  54. ///////////////////////////
  55. GDScriptNativeClass::GDScriptNativeClass(const StringName &p_name) {
  56. name = p_name;
  57. }
  58. bool GDScriptNativeClass::_get(const StringName &p_name, Variant &r_ret) const {
  59. bool ok;
  60. int64_t v = ClassDB::get_integer_constant(name, p_name, &ok);
  61. if (ok) {
  62. r_ret = v;
  63. return true;
  64. } else {
  65. return false;
  66. }
  67. }
  68. void GDScriptNativeClass::_bind_methods() {
  69. ClassDB::bind_method(D_METHOD("new"), &GDScriptNativeClass::_new);
  70. }
  71. Variant GDScriptNativeClass::_new() {
  72. Object *o = instantiate();
  73. ERR_FAIL_NULL_V_MSG(o, Variant(), "Class type: '" + String(name) + "' is not instantiable.");
  74. RefCounted *rc = Object::cast_to<RefCounted>(o);
  75. if (rc) {
  76. return Ref<RefCounted>(rc);
  77. } else {
  78. return o;
  79. }
  80. }
  81. Object *GDScriptNativeClass::instantiate() {
  82. return ClassDB::instantiate(name);
  83. }
  84. Variant GDScriptNativeClass::callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  85. if (p_method == SNAME("new")) {
  86. // Constructor.
  87. return Object::callp(p_method, p_args, p_argcount, r_error);
  88. }
  89. MethodBind *method = ClassDB::get_method(name, p_method);
  90. if (method && method->is_static()) {
  91. // Native static method.
  92. return method->call(nullptr, p_args, p_argcount, r_error);
  93. }
  94. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  95. return Variant();
  96. }
  97. GDScriptFunction *GDScript::_super_constructor(GDScript *p_script) {
  98. if (p_script->initializer) {
  99. return p_script->initializer;
  100. } else {
  101. GDScript *base_src = p_script->_base;
  102. if (base_src != nullptr) {
  103. return _super_constructor(base_src);
  104. } else {
  105. return nullptr;
  106. }
  107. }
  108. }
  109. void GDScript::_super_implicit_constructor(GDScript *p_script, GDScriptInstance *p_instance, Callable::CallError &r_error) {
  110. GDScript *base_src = p_script->_base;
  111. if (base_src != nullptr) {
  112. _super_implicit_constructor(base_src, p_instance, r_error);
  113. if (r_error.error != Callable::CallError::CALL_OK) {
  114. return;
  115. }
  116. }
  117. ERR_FAIL_NULL(p_script->implicit_initializer);
  118. p_script->implicit_initializer->call(p_instance, nullptr, 0, r_error);
  119. }
  120. GDScriptInstance *GDScript::_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_is_ref_counted, Callable::CallError &r_error) {
  121. /* STEP 1, CREATE */
  122. GDScriptInstance *instance = memnew(GDScriptInstance);
  123. instance->base_ref_counted = p_is_ref_counted;
  124. instance->members.resize(member_indices.size());
  125. instance->script = Ref<GDScript>(this);
  126. instance->owner = p_owner;
  127. instance->owner_id = p_owner->get_instance_id();
  128. #ifdef DEBUG_ENABLED
  129. //needed for hot reloading
  130. for (const KeyValue<StringName, MemberInfo> &E : member_indices) {
  131. instance->member_indices_cache[E.key] = E.value.index;
  132. }
  133. #endif
  134. instance->owner->set_script_instance(instance);
  135. /* STEP 2, INITIALIZE AND CONSTRUCT */
  136. {
  137. MutexLock lock(GDScriptLanguage::singleton->mutex);
  138. instances.insert(instance->owner);
  139. }
  140. _super_implicit_constructor(this, instance, r_error);
  141. if (r_error.error != Callable::CallError::CALL_OK) {
  142. instance->script = Ref<GDScript>();
  143. instance->owner->set_script_instance(nullptr);
  144. {
  145. MutexLock lock(GDScriptLanguage::singleton->mutex);
  146. instances.erase(p_owner);
  147. }
  148. ERR_FAIL_V_MSG(nullptr, "Error constructing a GDScriptInstance.");
  149. }
  150. if (p_argcount < 0) {
  151. return instance;
  152. }
  153. initializer = _super_constructor(this);
  154. if (initializer != nullptr) {
  155. initializer->call(instance, p_args, p_argcount, r_error);
  156. if (r_error.error != Callable::CallError::CALL_OK) {
  157. instance->script = Ref<GDScript>();
  158. instance->owner->set_script_instance(nullptr);
  159. {
  160. MutexLock lock(GDScriptLanguage::singleton->mutex);
  161. instances.erase(p_owner);
  162. }
  163. ERR_FAIL_V_MSG(nullptr, "Error constructing a GDScriptInstance.");
  164. }
  165. }
  166. //@TODO make thread safe
  167. return instance;
  168. }
  169. Variant GDScript::_new(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  170. /* STEP 1, CREATE */
  171. if (!valid) {
  172. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  173. return Variant();
  174. }
  175. r_error.error = Callable::CallError::CALL_OK;
  176. Ref<RefCounted> ref;
  177. Object *owner = nullptr;
  178. GDScript *_baseptr = this;
  179. while (_baseptr->_base) {
  180. _baseptr = _baseptr->_base;
  181. }
  182. ERR_FAIL_COND_V(_baseptr->native.is_null(), Variant());
  183. if (_baseptr->native.ptr()) {
  184. owner = _baseptr->native->instantiate();
  185. } else {
  186. owner = memnew(RefCounted); //by default, no base means use reference
  187. }
  188. ERR_FAIL_NULL_V_MSG(owner, Variant(), "Can't inherit from a virtual class.");
  189. RefCounted *r = Object::cast_to<RefCounted>(owner);
  190. if (r) {
  191. ref = Ref<RefCounted>(r);
  192. }
  193. GDScriptInstance *instance = _create_instance(p_args, p_argcount, owner, r != nullptr, r_error);
  194. if (!instance) {
  195. if (ref.is_null()) {
  196. memdelete(owner); //no owner, sorry
  197. }
  198. return Variant();
  199. }
  200. if (ref.is_valid()) {
  201. return ref;
  202. } else {
  203. return owner;
  204. }
  205. }
  206. bool GDScript::can_instantiate() const {
  207. #ifdef TOOLS_ENABLED
  208. return valid && (tool || ScriptServer::is_scripting_enabled());
  209. #else
  210. return valid;
  211. #endif
  212. }
  213. Ref<Script> GDScript::get_base_script() const {
  214. if (_base) {
  215. return Ref<GDScript>(_base);
  216. } else {
  217. return Ref<Script>();
  218. }
  219. }
  220. StringName GDScript::get_global_name() const {
  221. return global_name;
  222. }
  223. StringName GDScript::get_instance_base_type() const {
  224. if (native.is_valid()) {
  225. return native->get_name();
  226. }
  227. if (base.is_valid() && base->is_valid()) {
  228. return base->get_instance_base_type();
  229. }
  230. return StringName();
  231. }
  232. struct _GDScriptMemberSort {
  233. int index = 0;
  234. StringName name;
  235. _FORCE_INLINE_ bool operator<(const _GDScriptMemberSort &p_member) const { return index < p_member.index; }
  236. };
  237. #ifdef TOOLS_ENABLED
  238. void GDScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  239. placeholders.erase(p_placeholder);
  240. }
  241. #endif
  242. void GDScript::_get_script_method_list(List<MethodInfo> *r_list, bool p_include_base) const {
  243. const GDScript *current = this;
  244. while (current) {
  245. for (const KeyValue<StringName, GDScriptFunction *> &E : current->member_functions) {
  246. r_list->push_back(E.value->get_method_info());
  247. }
  248. if (!p_include_base) {
  249. return;
  250. }
  251. current = current->_base;
  252. }
  253. }
  254. void GDScript::get_script_method_list(List<MethodInfo> *r_list) const {
  255. _get_script_method_list(r_list, true);
  256. }
  257. void GDScript::_get_script_property_list(List<PropertyInfo> *r_list, bool p_include_base) const {
  258. const GDScript *sptr = this;
  259. List<PropertyInfo> props;
  260. while (sptr) {
  261. Vector<_GDScriptMemberSort> msort;
  262. for (const KeyValue<StringName, MemberInfo> &E : sptr->member_indices) {
  263. if (!sptr->members.has(E.key)) {
  264. continue; // Skip base class members.
  265. }
  266. _GDScriptMemberSort ms;
  267. ms.index = E.value.index;
  268. ms.name = E.key;
  269. msort.push_back(ms);
  270. }
  271. msort.sort();
  272. msort.reverse();
  273. for (int i = 0; i < msort.size(); i++) {
  274. props.push_front(sptr->member_indices[msort[i].name].property_info);
  275. }
  276. #ifdef TOOLS_ENABLED
  277. r_list->push_back(sptr->get_class_category());
  278. #endif // TOOLS_ENABLED
  279. for (const PropertyInfo &E : props) {
  280. r_list->push_back(E);
  281. }
  282. if (!p_include_base) {
  283. break;
  284. }
  285. props.clear();
  286. sptr = sptr->_base;
  287. }
  288. }
  289. void GDScript::get_script_property_list(List<PropertyInfo> *r_list) const {
  290. _get_script_property_list(r_list, true);
  291. }
  292. bool GDScript::has_method(const StringName &p_method) const {
  293. return member_functions.has(p_method);
  294. }
  295. bool GDScript::has_static_method(const StringName &p_method) const {
  296. return member_functions.has(p_method) && member_functions[p_method]->is_static();
  297. }
  298. MethodInfo GDScript::get_method_info(const StringName &p_method) const {
  299. HashMap<StringName, GDScriptFunction *>::ConstIterator E = member_functions.find(p_method);
  300. if (!E) {
  301. return MethodInfo();
  302. }
  303. return E->value->get_method_info();
  304. }
  305. bool GDScript::get_property_default_value(const StringName &p_property, Variant &r_value) const {
  306. #ifdef TOOLS_ENABLED
  307. HashMap<StringName, Variant>::ConstIterator E = member_default_values_cache.find(p_property);
  308. if (E) {
  309. r_value = E->value;
  310. return true;
  311. }
  312. if (base_cache.is_valid()) {
  313. return base_cache->get_property_default_value(p_property, r_value);
  314. }
  315. #endif
  316. return false;
  317. }
  318. ScriptInstance *GDScript::instance_create(Object *p_this) {
  319. GDScript *top = this;
  320. while (top->_base) {
  321. top = top->_base;
  322. }
  323. if (top->native.is_valid()) {
  324. if (!ClassDB::is_parent_class(p_this->get_class_name(), top->native->get_name())) {
  325. if (EngineDebugger::is_active()) {
  326. 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 assigned to an object of type: '" + p_this->get_class() + "'");
  327. }
  328. ERR_FAIL_V_MSG(nullptr, "Script inherits from native type '" + String(top->native->get_name()) + "', so it can't be assigned to an object of type '" + p_this->get_class() + "'" + ".");
  329. }
  330. }
  331. Callable::CallError unchecked_error;
  332. return _create_instance(nullptr, 0, p_this, Object::cast_to<RefCounted>(p_this) != nullptr, unchecked_error);
  333. }
  334. PlaceHolderScriptInstance *GDScript::placeholder_instance_create(Object *p_this) {
  335. #ifdef TOOLS_ENABLED
  336. PlaceHolderScriptInstance *si = memnew(PlaceHolderScriptInstance(GDScriptLanguage::get_singleton(), Ref<Script>(this), p_this));
  337. placeholders.insert(si);
  338. _update_exports(nullptr, false, si);
  339. return si;
  340. #else
  341. return nullptr;
  342. #endif
  343. }
  344. bool GDScript::instance_has(const Object *p_this) const {
  345. MutexLock lock(GDScriptLanguage::singleton->mutex);
  346. return instances.has((Object *)p_this);
  347. }
  348. bool GDScript::has_source_code() const {
  349. return !source.is_empty();
  350. }
  351. String GDScript::get_source_code() const {
  352. return source;
  353. }
  354. void GDScript::set_source_code(const String &p_code) {
  355. if (source == p_code) {
  356. return;
  357. }
  358. source = p_code;
  359. #ifdef TOOLS_ENABLED
  360. source_changed_cache = true;
  361. #endif
  362. }
  363. #ifdef TOOLS_ENABLED
  364. void GDScript::_update_exports_values(HashMap<StringName, Variant> &values, List<PropertyInfo> &propnames) {
  365. for (const KeyValue<StringName, Variant> &E : member_default_values_cache) {
  366. values[E.key] = E.value;
  367. }
  368. for (const PropertyInfo &E : members_cache) {
  369. propnames.push_back(E);
  370. }
  371. if (base_cache.is_valid()) {
  372. base_cache->_update_exports_values(values, propnames);
  373. }
  374. }
  375. void GDScript::_add_doc(const DocData::ClassDoc &p_inner_class) {
  376. if (_owner) { // Only the top-level class stores doc info
  377. _owner->_add_doc(p_inner_class);
  378. } else { // Remove old docs, add new
  379. for (int i = 0; i < docs.size(); i++) {
  380. if (docs[i].name == p_inner_class.name) {
  381. docs.remove_at(i);
  382. break;
  383. }
  384. }
  385. docs.append(p_inner_class);
  386. }
  387. }
  388. void GDScript::_clear_doc() {
  389. docs.clear();
  390. doc = DocData::ClassDoc();
  391. }
  392. String GDScript::get_class_icon_path() const {
  393. return simplified_icon_path;
  394. }
  395. #endif
  396. bool GDScript::_update_exports(bool *r_err, bool p_recursive_call, PlaceHolderScriptInstance *p_instance_to_update) {
  397. #ifdef TOOLS_ENABLED
  398. static Vector<GDScript *> base_caches;
  399. if (!p_recursive_call) {
  400. base_caches.clear();
  401. }
  402. base_caches.append(this);
  403. bool changed = false;
  404. if (source_changed_cache) {
  405. source_changed_cache = false;
  406. changed = true;
  407. String basedir = path;
  408. if (basedir.is_empty()) {
  409. basedir = get_path();
  410. }
  411. if (!basedir.is_empty()) {
  412. basedir = basedir.get_base_dir();
  413. }
  414. GDScriptParser parser;
  415. GDScriptAnalyzer analyzer(&parser);
  416. Error err = parser.parse(source, path, false);
  417. if (err == OK && analyzer.analyze() == OK) {
  418. const GDScriptParser::ClassNode *c = parser.get_tree();
  419. if (base_cache.is_valid()) {
  420. base_cache->inheriters_cache.erase(get_instance_id());
  421. base_cache = Ref<GDScript>();
  422. }
  423. GDScriptParser::DataType base_type = parser.get_tree()->base_type;
  424. if (base_type.kind == GDScriptParser::DataType::CLASS) {
  425. Ref<GDScript> bf = GDScriptCache::get_full_script(base_type.script_path, err, path);
  426. if (err == OK) {
  427. bf = Ref<GDScript>(bf->find_class(base_type.class_type->fqcn));
  428. if (bf.is_valid()) {
  429. base_cache = bf;
  430. bf->inheriters_cache.insert(get_instance_id());
  431. }
  432. }
  433. }
  434. members_cache.clear();
  435. member_default_values_cache.clear();
  436. _signals.clear();
  437. members_cache.push_back(get_class_category());
  438. for (int i = 0; i < c->members.size(); i++) {
  439. const GDScriptParser::ClassNode::Member &member = c->members[i];
  440. switch (member.type) {
  441. case GDScriptParser::ClassNode::Member::VARIABLE: {
  442. if (!member.variable->exported) {
  443. continue;
  444. }
  445. members_cache.push_back(member.variable->export_info);
  446. Variant default_value = analyzer.make_variable_default_value(member.variable);
  447. member_default_values_cache[member.variable->identifier->name] = default_value;
  448. } break;
  449. case GDScriptParser::ClassNode::Member::SIGNAL: {
  450. _signals[member.signal->identifier->name] = member.signal->method_info;
  451. } break;
  452. case GDScriptParser::ClassNode::Member::GROUP: {
  453. members_cache.push_back(member.annotation->export_info);
  454. } break;
  455. default:
  456. break; // Nothing.
  457. }
  458. }
  459. } else {
  460. placeholder_fallback_enabled = true;
  461. return false;
  462. }
  463. } else if (placeholder_fallback_enabled) {
  464. return false;
  465. }
  466. placeholder_fallback_enabled = false;
  467. if (base_cache.is_valid() && base_cache->is_valid()) {
  468. for (int i = 0; i < base_caches.size(); i++) {
  469. if (base_caches[i] == base_cache.ptr()) {
  470. if (r_err) {
  471. *r_err = true;
  472. }
  473. valid = false; // to show error in the editor
  474. base_cache->valid = false;
  475. base_cache->inheriters_cache.clear(); // to prevent future stackoverflows
  476. base_cache.unref();
  477. base.unref();
  478. _base = nullptr;
  479. ERR_FAIL_V_MSG(false, "Cyclic inheritance in script class.");
  480. }
  481. }
  482. if (base_cache->_update_exports(r_err, true)) {
  483. if (r_err && *r_err) {
  484. return false;
  485. }
  486. changed = true;
  487. }
  488. }
  489. if ((changed || p_instance_to_update) && placeholders.size()) { //hm :(
  490. // update placeholders if any
  491. HashMap<StringName, Variant> values;
  492. List<PropertyInfo> propnames;
  493. _update_exports_values(values, propnames);
  494. if (changed) {
  495. for (PlaceHolderScriptInstance *E : placeholders) {
  496. E->update(propnames, values);
  497. }
  498. } else {
  499. p_instance_to_update->update(propnames, values);
  500. }
  501. }
  502. return changed;
  503. #else
  504. return false;
  505. #endif
  506. }
  507. void GDScript::update_exports() {
  508. #ifdef TOOLS_ENABLED
  509. bool cyclic_error = false;
  510. _update_exports(&cyclic_error);
  511. if (cyclic_error) {
  512. return;
  513. }
  514. HashSet<ObjectID> copy = inheriters_cache; //might get modified
  515. for (const ObjectID &E : copy) {
  516. Object *id = ObjectDB::get_instance(E);
  517. GDScript *s = Object::cast_to<GDScript>(id);
  518. if (!s) {
  519. continue;
  520. }
  521. s->update_exports();
  522. }
  523. #endif
  524. }
  525. String GDScript::_get_debug_path() const {
  526. if (is_built_in() && !get_name().is_empty()) {
  527. return vformat("%s(%s)", get_name(), get_script_path());
  528. } else {
  529. return get_script_path();
  530. }
  531. }
  532. Error GDScript::_static_init() {
  533. if (static_initializer) {
  534. Callable::CallError call_err;
  535. static_initializer->call(nullptr, nullptr, 0, call_err);
  536. if (call_err.error != Callable::CallError::CALL_OK) {
  537. return ERR_CANT_CREATE;
  538. }
  539. }
  540. Error err = OK;
  541. for (KeyValue<StringName, Ref<GDScript>> &inner : subclasses) {
  542. err = inner.value->_static_init();
  543. if (err) {
  544. break;
  545. }
  546. }
  547. return err;
  548. }
  549. #ifdef TOOLS_ENABLED
  550. void GDScript::_save_old_static_data() {
  551. old_static_variables_indices = static_variables_indices;
  552. old_static_variables = static_variables;
  553. for (KeyValue<StringName, Ref<GDScript>> &inner : subclasses) {
  554. inner.value->_save_old_static_data();
  555. }
  556. }
  557. void GDScript::_restore_old_static_data() {
  558. for (KeyValue<StringName, MemberInfo> &E : old_static_variables_indices) {
  559. if (static_variables_indices.has(E.key)) {
  560. static_variables.write[static_variables_indices[E.key].index] = old_static_variables[E.value.index];
  561. }
  562. }
  563. old_static_variables_indices.clear();
  564. old_static_variables.clear();
  565. for (KeyValue<StringName, Ref<GDScript>> &inner : subclasses) {
  566. inner.value->_restore_old_static_data();
  567. }
  568. }
  569. #endif
  570. Error GDScript::reload(bool p_keep_state) {
  571. if (reloading) {
  572. return OK;
  573. }
  574. reloading = true;
  575. bool has_instances;
  576. {
  577. MutexLock lock(GDScriptLanguage::singleton->mutex);
  578. has_instances = instances.size();
  579. }
  580. ERR_FAIL_COND_V(!p_keep_state && has_instances, ERR_ALREADY_IN_USE);
  581. String basedir = path;
  582. if (basedir.is_empty()) {
  583. basedir = get_path();
  584. }
  585. if (!basedir.is_empty()) {
  586. basedir = basedir.get_base_dir();
  587. }
  588. // Loading a template, don't parse.
  589. #ifdef TOOLS_ENABLED
  590. if (EditorPaths::get_singleton() && basedir.begins_with(EditorPaths::get_singleton()->get_project_script_templates_dir())) {
  591. reloading = false;
  592. return OK;
  593. }
  594. #endif
  595. {
  596. String source_path = path;
  597. if (source_path.is_empty()) {
  598. source_path = get_path();
  599. }
  600. Ref<GDScript> cached_script = GDScriptCache::get_cached_script(source_path);
  601. if (!source_path.is_empty() && cached_script.is_null()) {
  602. MutexLock lock(GDScriptCache::singleton->mutex);
  603. GDScriptCache::singleton->shallow_gdscript_cache[source_path] = Ref<GDScript>(this);
  604. }
  605. }
  606. bool can_run = ScriptServer::is_scripting_enabled() || is_tool();
  607. #ifdef TOOLS_ENABLED
  608. if (p_keep_state && can_run && is_valid()) {
  609. _save_old_static_data();
  610. }
  611. #endif
  612. valid = false;
  613. GDScriptParser parser;
  614. Error err = parser.parse(source, path, false);
  615. if (err) {
  616. if (EngineDebugger::is_active()) {
  617. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), parser.get_errors().front()->get().line, "Parser Error: " + parser.get_errors().front()->get().message);
  618. }
  619. // TODO: Show all error messages.
  620. _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);
  621. reloading = false;
  622. return ERR_PARSE_ERROR;
  623. }
  624. GDScriptAnalyzer analyzer(&parser);
  625. err = analyzer.analyze();
  626. if (err) {
  627. if (EngineDebugger::is_active()) {
  628. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), parser.get_errors().front()->get().line, "Parser Error: " + parser.get_errors().front()->get().message);
  629. }
  630. const List<GDScriptParser::ParserError>::Element *e = parser.get_errors().front();
  631. while (e != nullptr) {
  632. _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);
  633. e = e->next();
  634. }
  635. reloading = false;
  636. return ERR_PARSE_ERROR;
  637. }
  638. can_run = ScriptServer::is_scripting_enabled() || parser.is_tool();
  639. GDScriptCompiler compiler;
  640. err = compiler.compile(&parser, this, p_keep_state);
  641. if (err) {
  642. _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);
  643. if (can_run) {
  644. if (EngineDebugger::is_active()) {
  645. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), compiler.get_error_line(), "Parser Error: " + compiler.get_error());
  646. }
  647. reloading = false;
  648. return ERR_COMPILATION_FAILED;
  649. } else {
  650. reloading = false;
  651. return err;
  652. }
  653. }
  654. #ifdef TOOLS_ENABLED
  655. // Done after compilation because it needs the GDScript object's inner class GDScript objects,
  656. // which are made by calling make_scripts() within compiler.compile() above.
  657. GDScriptDocGen::generate_docs(this, parser.get_tree());
  658. #endif
  659. #ifdef DEBUG_ENABLED
  660. for (const GDScriptWarning &warning : parser.get_warnings()) {
  661. if (EngineDebugger::is_active()) {
  662. Vector<ScriptLanguage::StackInfo> si;
  663. EngineDebugger::get_script_debugger()->send_error("", get_script_path(), warning.start_line, warning.get_name(), warning.get_message(), false, ERR_HANDLER_WARNING, si);
  664. }
  665. }
  666. #endif
  667. if (can_run) {
  668. err = _static_init();
  669. if (err) {
  670. return err;
  671. }
  672. }
  673. #ifdef TOOLS_ENABLED
  674. if (can_run && p_keep_state) {
  675. _restore_old_static_data();
  676. }
  677. #endif
  678. reloading = false;
  679. return OK;
  680. }
  681. ScriptLanguage *GDScript::get_language() const {
  682. return GDScriptLanguage::get_singleton();
  683. }
  684. void GDScript::get_constants(HashMap<StringName, Variant> *p_constants) {
  685. if (p_constants) {
  686. for (const KeyValue<StringName, Variant> &E : constants) {
  687. (*p_constants)[E.key] = E.value;
  688. }
  689. }
  690. }
  691. void GDScript::get_members(HashSet<StringName> *p_members) {
  692. if (p_members) {
  693. for (const StringName &E : members) {
  694. p_members->insert(E);
  695. }
  696. }
  697. }
  698. const Variant GDScript::get_rpc_config() const {
  699. return rpc_config;
  700. }
  701. void GDScript::unload_static() const {
  702. GDScriptCache::remove_script(fully_qualified_name);
  703. }
  704. Variant GDScript::callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  705. GDScript *top = this;
  706. while (top) {
  707. HashMap<StringName, GDScriptFunction *>::Iterator E = top->member_functions.find(p_method);
  708. if (E) {
  709. ERR_FAIL_COND_V_MSG(!E->value->is_static(), Variant(), "Can't call non-static function '" + String(p_method) + "' in script.");
  710. return E->value->call(nullptr, p_args, p_argcount, r_error);
  711. }
  712. top = top->_base;
  713. }
  714. //none found, regular
  715. return Script::callp(p_method, p_args, p_argcount, r_error);
  716. }
  717. bool GDScript::_get(const StringName &p_name, Variant &r_ret) const {
  718. if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
  719. r_ret = get_source_code();
  720. return true;
  721. }
  722. const GDScript *top = this;
  723. while (top) {
  724. {
  725. HashMap<StringName, Variant>::ConstIterator E = top->constants.find(p_name);
  726. if (E) {
  727. r_ret = E->value;
  728. return true;
  729. }
  730. }
  731. {
  732. HashMap<StringName, MemberInfo>::ConstIterator E = top->static_variables_indices.find(p_name);
  733. if (E) {
  734. if (E->value.getter) {
  735. Callable::CallError ce;
  736. r_ret = const_cast<GDScript *>(this)->callp(E->value.getter, nullptr, 0, ce);
  737. return true;
  738. }
  739. r_ret = top->static_variables[E->value.index];
  740. return true;
  741. }
  742. }
  743. {
  744. HashMap<StringName, GDScriptFunction *>::ConstIterator E = top->member_functions.find(p_name);
  745. if (E && E->value->is_static()) {
  746. if (top->rpc_config.has(p_name)) {
  747. r_ret = Callable(memnew(GDScriptRPCCallable(const_cast<GDScript *>(top), E->key)));
  748. } else {
  749. r_ret = Callable(const_cast<GDScript *>(top), E->key);
  750. }
  751. return true;
  752. }
  753. }
  754. {
  755. HashMap<StringName, Ref<GDScript>>::ConstIterator E = top->subclasses.find(p_name);
  756. if (E) {
  757. r_ret = E->value;
  758. return true;
  759. }
  760. }
  761. top = top->_base;
  762. }
  763. return false;
  764. }
  765. bool GDScript::_set(const StringName &p_name, const Variant &p_value) {
  766. if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
  767. set_source_code(p_value);
  768. reload();
  769. return true;
  770. }
  771. GDScript *top = this;
  772. while (top) {
  773. HashMap<StringName, MemberInfo>::ConstIterator E = top->static_variables_indices.find(p_name);
  774. if (E) {
  775. const MemberInfo *member = &E->value;
  776. Variant value = p_value;
  777. if (member->data_type.has_type && !member->data_type.is_type(value)) {
  778. const Variant *args = &p_value;
  779. Callable::CallError err;
  780. Variant::construct(member->data_type.builtin_type, value, &args, 1, err);
  781. if (err.error != Callable::CallError::CALL_OK || !member->data_type.is_type(value)) {
  782. return false;
  783. }
  784. }
  785. if (member->setter) {
  786. const Variant *args = &value;
  787. Callable::CallError err;
  788. callp(member->setter, &args, 1, err);
  789. return err.error == Callable::CallError::CALL_OK;
  790. } else {
  791. top->static_variables.write[member->index] = value;
  792. return true;
  793. }
  794. }
  795. top = top->_base;
  796. }
  797. return false;
  798. }
  799. void GDScript::_get_property_list(List<PropertyInfo> *p_properties) const {
  800. p_properties->push_back(PropertyInfo(Variant::STRING, "script/source", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  801. List<const GDScript *> classes;
  802. const GDScript *top = this;
  803. while (top) {
  804. classes.push_back(top);
  805. top = top->_base;
  806. }
  807. for (const List<const GDScript *>::Element *E = classes.back(); E; E = E->prev()) {
  808. Vector<_GDScriptMemberSort> msort;
  809. for (const KeyValue<StringName, MemberInfo> &F : E->get()->static_variables_indices) {
  810. _GDScriptMemberSort ms;
  811. ms.index = F.value.index;
  812. ms.name = F.key;
  813. msort.push_back(ms);
  814. }
  815. msort.sort();
  816. for (int i = 0; i < msort.size(); i++) {
  817. p_properties->push_back(E->get()->static_variables_indices[msort[i].name].property_info);
  818. }
  819. }
  820. }
  821. void GDScript::_bind_methods() {
  822. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "new", &GDScript::_new, MethodInfo("new"));
  823. }
  824. void GDScript::set_path(const String &p_path, bool p_take_over) {
  825. if (is_root_script()) {
  826. Script::set_path(p_path, p_take_over);
  827. }
  828. String old_path = path;
  829. path = p_path;
  830. GDScriptCache::move_script(old_path, p_path);
  831. for (KeyValue<StringName, Ref<GDScript>> &kv : subclasses) {
  832. kv.value->set_path(p_path, p_take_over);
  833. }
  834. }
  835. String GDScript::get_script_path() const {
  836. return path;
  837. }
  838. Error GDScript::load_source_code(const String &p_path) {
  839. if (p_path.is_empty() || p_path.begins_with("gdscript://") || ResourceLoader::get_resource_type(p_path.get_slice("::", 0)) == "PackedScene") {
  840. return OK;
  841. }
  842. Vector<uint8_t> sourcef;
  843. Error err;
  844. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);
  845. if (err) {
  846. const char *err_name;
  847. if (err < 0 || err >= ERR_MAX) {
  848. err_name = "(invalid error code)";
  849. } else {
  850. err_name = error_names[err];
  851. }
  852. ERR_FAIL_COND_V_MSG(err, err, "Attempt to open script '" + p_path + "' resulted in error '" + err_name + "'.");
  853. }
  854. uint64_t len = f->get_length();
  855. sourcef.resize(len + 1);
  856. uint8_t *w = sourcef.ptrw();
  857. uint64_t r = f->get_buffer(w, len);
  858. ERR_FAIL_COND_V(r != len, ERR_CANT_OPEN);
  859. w[len] = 0;
  860. String s;
  861. if (s.parse_utf8((const char *)w) != OK) {
  862. 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.");
  863. }
  864. source = s;
  865. path = p_path;
  866. #ifdef TOOLS_ENABLED
  867. source_changed_cache = true;
  868. set_edited(false);
  869. set_last_modified_time(FileAccess::get_modified_time(path));
  870. #endif // TOOLS_ENABLED
  871. return OK;
  872. }
  873. const HashMap<StringName, GDScriptFunction *> &GDScript::debug_get_member_functions() const {
  874. return member_functions;
  875. }
  876. StringName GDScript::debug_get_member_by_index(int p_idx) const {
  877. for (const KeyValue<StringName, MemberInfo> &E : member_indices) {
  878. if (E.value.index == p_idx) {
  879. return E.key;
  880. }
  881. }
  882. return "<error>";
  883. }
  884. StringName GDScript::debug_get_static_var_by_index(int p_idx) const {
  885. for (const KeyValue<StringName, MemberInfo> &E : static_variables_indices) {
  886. if (E.value.index == p_idx) {
  887. return E.key;
  888. }
  889. }
  890. return "<error>";
  891. }
  892. Ref<GDScript> GDScript::get_base() const {
  893. return base;
  894. }
  895. bool GDScript::inherits_script(const Ref<Script> &p_script) const {
  896. Ref<GDScript> gd = p_script;
  897. if (gd.is_null()) {
  898. return false;
  899. }
  900. const GDScript *s = this;
  901. while (s) {
  902. if (s == p_script.ptr()) {
  903. return true;
  904. }
  905. s = s->_base;
  906. }
  907. return false;
  908. }
  909. GDScript *GDScript::find_class(const String &p_qualified_name) {
  910. String first = p_qualified_name.get_slice("::", 0);
  911. Vector<String> class_names;
  912. GDScript *result = nullptr;
  913. // Empty initial name means start here.
  914. if (first.is_empty() || first == global_name) {
  915. class_names = p_qualified_name.split("::");
  916. result = this;
  917. } else if (p_qualified_name.begins_with(get_root_script()->path)) {
  918. // Script path could have a class path separator("::") in it.
  919. class_names = p_qualified_name.trim_prefix(get_root_script()->path).split("::");
  920. result = get_root_script();
  921. } else if (HashMap<StringName, Ref<GDScript>>::Iterator E = subclasses.find(first)) {
  922. class_names = p_qualified_name.split("::");
  923. result = E->value.ptr();
  924. } else if (_owner != nullptr) {
  925. // Check parent scope.
  926. return _owner->find_class(p_qualified_name);
  927. }
  928. // Starts at index 1 because index 0 was handled above.
  929. for (int i = 1; result != nullptr && i < class_names.size(); i++) {
  930. String current_name = class_names[i];
  931. if (HashMap<StringName, Ref<GDScript>>::Iterator E = result->subclasses.find(current_name)) {
  932. result = E->value.ptr();
  933. } else {
  934. // Couldn't find inner class.
  935. return nullptr;
  936. }
  937. }
  938. return result;
  939. }
  940. bool GDScript::has_class(const GDScript *p_script) {
  941. String fqn = p_script->fully_qualified_name;
  942. if (fully_qualified_name.is_empty() && fqn.get_slice("::", 0).is_empty()) {
  943. return p_script == this;
  944. } else if (fqn.begins_with(fully_qualified_name)) {
  945. return p_script == find_class(fqn.trim_prefix(fully_qualified_name));
  946. }
  947. return false;
  948. }
  949. GDScript *GDScript::get_root_script() {
  950. GDScript *result = this;
  951. while (result->_owner) {
  952. result = result->_owner;
  953. }
  954. return result;
  955. }
  956. RBSet<GDScript *> GDScript::get_dependencies() {
  957. RBSet<GDScript *> dependencies;
  958. _get_dependencies(dependencies, this);
  959. dependencies.erase(this);
  960. return dependencies;
  961. }
  962. RBSet<GDScript *> GDScript::get_inverted_dependencies() {
  963. RBSet<GDScript *> inverted_dependencies;
  964. List<GDScript *> scripts;
  965. {
  966. MutexLock lock(GDScriptLanguage::singleton->mutex);
  967. SelfList<GDScript> *elem = GDScriptLanguage::singleton->script_list.first();
  968. while (elem) {
  969. scripts.push_back(elem->self());
  970. elem = elem->next();
  971. }
  972. }
  973. for (GDScript *scr : scripts) {
  974. if (scr == nullptr || scr == this || scr->destructing) {
  975. continue;
  976. }
  977. RBSet<GDScript *> scr_dependencies = scr->get_dependencies();
  978. if (scr_dependencies.has(this)) {
  979. inverted_dependencies.insert(scr);
  980. }
  981. }
  982. return inverted_dependencies;
  983. }
  984. RBSet<GDScript *> GDScript::get_must_clear_dependencies() {
  985. RBSet<GDScript *> dependencies = get_dependencies();
  986. RBSet<GDScript *> must_clear_dependencies;
  987. HashMap<GDScript *, RBSet<GDScript *>> inverted_dependencies;
  988. for (GDScript *E : dependencies) {
  989. inverted_dependencies.insert(E, E->get_inverted_dependencies());
  990. }
  991. RBSet<GDScript *> cant_clear;
  992. for (KeyValue<GDScript *, RBSet<GDScript *>> &E : inverted_dependencies) {
  993. for (GDScript *F : E.value) {
  994. if (!dependencies.has(F)) {
  995. cant_clear.insert(E.key);
  996. for (GDScript *G : E.key->get_dependencies()) {
  997. cant_clear.insert(G);
  998. }
  999. break;
  1000. }
  1001. }
  1002. }
  1003. for (KeyValue<GDScript *, RBSet<GDScript *>> &E : inverted_dependencies) {
  1004. if (cant_clear.has(E.key) || ScriptServer::is_global_class(E.key->get_fully_qualified_name())) {
  1005. continue;
  1006. }
  1007. must_clear_dependencies.insert(E.key);
  1008. }
  1009. cant_clear.clear();
  1010. dependencies.clear();
  1011. inverted_dependencies.clear();
  1012. return must_clear_dependencies;
  1013. }
  1014. bool GDScript::has_script_signal(const StringName &p_signal) const {
  1015. if (_signals.has(p_signal)) {
  1016. return true;
  1017. }
  1018. if (base.is_valid()) {
  1019. return base->has_script_signal(p_signal);
  1020. }
  1021. #ifdef TOOLS_ENABLED
  1022. else if (base_cache.is_valid()) {
  1023. return base_cache->has_script_signal(p_signal);
  1024. }
  1025. #endif
  1026. return false;
  1027. }
  1028. void GDScript::_get_script_signal_list(List<MethodInfo> *r_list, bool p_include_base) const {
  1029. for (const KeyValue<StringName, MethodInfo> &E : _signals) {
  1030. r_list->push_back(E.value);
  1031. }
  1032. if (!p_include_base) {
  1033. return;
  1034. }
  1035. if (base.is_valid()) {
  1036. base->get_script_signal_list(r_list);
  1037. }
  1038. #ifdef TOOLS_ENABLED
  1039. else if (base_cache.is_valid()) {
  1040. base_cache->get_script_signal_list(r_list);
  1041. }
  1042. #endif
  1043. }
  1044. void GDScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
  1045. _get_script_signal_list(r_signals, true);
  1046. }
  1047. GDScript *GDScript::_get_gdscript_from_variant(const Variant &p_variant) {
  1048. Object *obj = p_variant;
  1049. if (obj == nullptr || obj->get_instance_id().is_null()) {
  1050. return nullptr;
  1051. }
  1052. return Object::cast_to<GDScript>(obj);
  1053. }
  1054. void GDScript::_get_dependencies(RBSet<GDScript *> &p_dependencies, const GDScript *p_except) {
  1055. if (p_dependencies.has(this)) {
  1056. return;
  1057. }
  1058. p_dependencies.insert(this);
  1059. for (const KeyValue<StringName, GDScriptFunction *> &E : member_functions) {
  1060. if (E.value == nullptr) {
  1061. continue;
  1062. }
  1063. for (const Variant &V : E.value->constants) {
  1064. GDScript *scr = _get_gdscript_from_variant(V);
  1065. if (scr != nullptr && scr != p_except) {
  1066. scr->_get_dependencies(p_dependencies, p_except);
  1067. }
  1068. }
  1069. }
  1070. if (implicit_initializer) {
  1071. for (const Variant &V : implicit_initializer->constants) {
  1072. GDScript *scr = _get_gdscript_from_variant(V);
  1073. if (scr != nullptr && scr != p_except) {
  1074. scr->_get_dependencies(p_dependencies, p_except);
  1075. }
  1076. }
  1077. }
  1078. if (implicit_ready) {
  1079. for (const Variant &V : implicit_ready->constants) {
  1080. GDScript *scr = _get_gdscript_from_variant(V);
  1081. if (scr != nullptr && scr != p_except) {
  1082. scr->_get_dependencies(p_dependencies, p_except);
  1083. }
  1084. }
  1085. }
  1086. for (KeyValue<StringName, Ref<GDScript>> &E : subclasses) {
  1087. if (E.value != p_except) {
  1088. E.value->_get_dependencies(p_dependencies, p_except);
  1089. }
  1090. }
  1091. for (const KeyValue<StringName, Variant> &E : constants) {
  1092. GDScript *scr = _get_gdscript_from_variant(E.value);
  1093. if (scr != nullptr && scr != p_except) {
  1094. scr->_get_dependencies(p_dependencies, p_except);
  1095. }
  1096. }
  1097. }
  1098. GDScript::GDScript() :
  1099. script_list(this) {
  1100. {
  1101. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1102. GDScriptLanguage::get_singleton()->script_list.add(&script_list);
  1103. }
  1104. path = vformat("gdscript://%d.gd", get_instance_id());
  1105. }
  1106. void GDScript::_save_orphaned_subclasses(ClearData *p_clear_data) {
  1107. struct ClassRefWithName {
  1108. ObjectID id;
  1109. String fully_qualified_name;
  1110. };
  1111. Vector<ClassRefWithName> weak_subclasses;
  1112. // collect subclasses ObjectID and name
  1113. for (KeyValue<StringName, Ref<GDScript>> &E : subclasses) {
  1114. E.value->_owner = nullptr; //bye, you are no longer owned cause I died
  1115. ClassRefWithName subclass;
  1116. subclass.id = E.value->get_instance_id();
  1117. subclass.fully_qualified_name = E.value->fully_qualified_name;
  1118. weak_subclasses.push_back(subclass);
  1119. }
  1120. // clear subclasses to allow unused subclasses to be deleted
  1121. for (KeyValue<StringName, Ref<GDScript>> &E : subclasses) {
  1122. p_clear_data->scripts.insert(E.value);
  1123. }
  1124. subclasses.clear();
  1125. // subclasses are also held by constants, clear those as well
  1126. for (KeyValue<StringName, Variant> &E : constants) {
  1127. GDScript *gdscr = _get_gdscript_from_variant(E.value);
  1128. if (gdscr != nullptr) {
  1129. p_clear_data->scripts.insert(gdscr);
  1130. }
  1131. }
  1132. constants.clear();
  1133. // keep orphan subclass only for subclasses that are still in use
  1134. for (int i = 0; i < weak_subclasses.size(); i++) {
  1135. ClassRefWithName subclass = weak_subclasses[i];
  1136. Object *obj = ObjectDB::get_instance(subclass.id);
  1137. if (!obj) {
  1138. continue;
  1139. }
  1140. // subclass is not released
  1141. GDScriptLanguage::get_singleton()->add_orphan_subclass(subclass.fully_qualified_name, subclass.id);
  1142. }
  1143. }
  1144. #ifdef DEBUG_ENABLED
  1145. String GDScript::debug_get_script_name(const Ref<Script> &p_script) {
  1146. if (p_script.is_valid()) {
  1147. Ref<GDScript> gdscript = p_script;
  1148. if (gdscript.is_valid()) {
  1149. if (gdscript->get_local_name() != StringName()) {
  1150. return gdscript->get_local_name();
  1151. }
  1152. return gdscript->get_fully_qualified_name().get_file();
  1153. }
  1154. if (p_script->get_global_name() != StringName()) {
  1155. return p_script->get_global_name();
  1156. } else if (!p_script->get_path().is_empty()) {
  1157. return p_script->get_path().get_file();
  1158. } else if (!p_script->get_name().is_empty()) {
  1159. return p_script->get_name(); // Resource name.
  1160. }
  1161. }
  1162. return "<unknown script>";
  1163. }
  1164. #endif
  1165. void GDScript::clear(ClearData *p_clear_data) {
  1166. if (clearing) {
  1167. return;
  1168. }
  1169. clearing = true;
  1170. ClearData data;
  1171. ClearData *clear_data = p_clear_data;
  1172. bool is_root = false;
  1173. // If `clear_data` is `nullptr`, it means that it's the root.
  1174. // The root is in charge to clear functions and scripts of itself and its dependencies
  1175. if (clear_data == nullptr) {
  1176. clear_data = &data;
  1177. is_root = true;
  1178. }
  1179. RBSet<GDScript *> must_clear_dependencies = get_must_clear_dependencies();
  1180. for (GDScript *E : must_clear_dependencies) {
  1181. clear_data->scripts.insert(E);
  1182. E->clear(clear_data);
  1183. }
  1184. for (const KeyValue<StringName, GDScriptFunction *> &E : member_functions) {
  1185. clear_data->functions.insert(E.value);
  1186. }
  1187. member_functions.clear();
  1188. for (KeyValue<StringName, MemberInfo> &E : member_indices) {
  1189. clear_data->scripts.insert(E.value.data_type.script_type_ref);
  1190. E.value.data_type.script_type_ref = Ref<Script>();
  1191. }
  1192. for (KeyValue<StringName, MemberInfo> &E : static_variables_indices) {
  1193. clear_data->scripts.insert(E.value.data_type.script_type_ref);
  1194. E.value.data_type.script_type_ref = Ref<Script>();
  1195. }
  1196. static_variables.clear();
  1197. static_variables_indices.clear();
  1198. if (implicit_initializer) {
  1199. clear_data->functions.insert(implicit_initializer);
  1200. implicit_initializer = nullptr;
  1201. }
  1202. if (implicit_ready) {
  1203. clear_data->functions.insert(implicit_ready);
  1204. implicit_ready = nullptr;
  1205. }
  1206. if (static_initializer) {
  1207. clear_data->functions.insert(static_initializer);
  1208. static_initializer = nullptr;
  1209. }
  1210. _save_orphaned_subclasses(clear_data);
  1211. #ifdef TOOLS_ENABLED
  1212. // Clearing inner class doc, script doc only cleared when the script source deleted.
  1213. if (_owner) {
  1214. _clear_doc();
  1215. }
  1216. #endif
  1217. // If it's not the root, skip clearing the data
  1218. if (is_root) {
  1219. // All dependencies have been accounted for
  1220. for (GDScriptFunction *E : clear_data->functions) {
  1221. memdelete(E);
  1222. }
  1223. for (Ref<Script> &E : clear_data->scripts) {
  1224. Ref<GDScript> gdscr = E;
  1225. if (gdscr.is_valid()) {
  1226. GDScriptCache::remove_script(gdscr->get_path());
  1227. }
  1228. }
  1229. clear_data->clear();
  1230. }
  1231. }
  1232. GDScript::~GDScript() {
  1233. if (destructing) {
  1234. return;
  1235. }
  1236. destructing = true;
  1237. clear();
  1238. {
  1239. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1240. while (SelfList<GDScriptFunctionState> *E = pending_func_states.first()) {
  1241. // Order matters since clearing the stack may already cause
  1242. // the GDScriptFunctionState to be destroyed and thus removed from the list.
  1243. pending_func_states.remove(E);
  1244. GDScriptFunctionState *state = E->self();
  1245. ObjectID state_id = state->get_instance_id();
  1246. state->_clear_connections();
  1247. if (ObjectDB::get_instance(state_id)) {
  1248. state->_clear_stack();
  1249. }
  1250. }
  1251. }
  1252. {
  1253. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1254. script_list.remove_from_list();
  1255. }
  1256. }
  1257. //////////////////////////////
  1258. // INSTANCE //
  1259. //////////////////////////////
  1260. bool GDScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  1261. {
  1262. HashMap<StringName, GDScript::MemberInfo>::Iterator E = script->member_indices.find(p_name);
  1263. if (E) {
  1264. const GDScript::MemberInfo *member = &E->value;
  1265. Variant value = p_value;
  1266. if (member->data_type.has_type && !member->data_type.is_type(value)) {
  1267. const Variant *args = &p_value;
  1268. Callable::CallError err;
  1269. Variant::construct(member->data_type.builtin_type, value, &args, 1, err);
  1270. if (err.error != Callable::CallError::CALL_OK || !member->data_type.is_type(value)) {
  1271. return false;
  1272. }
  1273. }
  1274. if (member->setter) {
  1275. const Variant *args = &value;
  1276. Callable::CallError err;
  1277. callp(member->setter, &args, 1, err);
  1278. return err.error == Callable::CallError::CALL_OK;
  1279. } else {
  1280. members.write[member->index] = value;
  1281. return true;
  1282. }
  1283. }
  1284. }
  1285. GDScript *sptr = script.ptr();
  1286. while (sptr) {
  1287. {
  1288. HashMap<StringName, GDScript::MemberInfo>::ConstIterator E = sptr->static_variables_indices.find(p_name);
  1289. if (E) {
  1290. const GDScript::MemberInfo *member = &E->value;
  1291. Variant value = p_value;
  1292. if (member->data_type.has_type && !member->data_type.is_type(value)) {
  1293. const Variant *args = &p_value;
  1294. Callable::CallError err;
  1295. Variant::construct(member->data_type.builtin_type, value, &args, 1, err);
  1296. if (err.error != Callable::CallError::CALL_OK || !member->data_type.is_type(value)) {
  1297. return false;
  1298. }
  1299. }
  1300. if (member->setter) {
  1301. const Variant *args = &value;
  1302. Callable::CallError err;
  1303. callp(member->setter, &args, 1, err);
  1304. return err.error == Callable::CallError::CALL_OK;
  1305. } else {
  1306. sptr->static_variables.write[member->index] = value;
  1307. return true;
  1308. }
  1309. }
  1310. }
  1311. {
  1312. HashMap<StringName, GDScriptFunction *>::Iterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._set);
  1313. if (E) {
  1314. Variant name = p_name;
  1315. const Variant *args[2] = { &name, &p_value };
  1316. Callable::CallError err;
  1317. Variant ret = E->value->call(this, (const Variant **)args, 2, err);
  1318. if (err.error == Callable::CallError::CALL_OK && ret.get_type() == Variant::BOOL && ret.operator bool()) {
  1319. return true;
  1320. }
  1321. }
  1322. }
  1323. sptr = sptr->_base;
  1324. }
  1325. return false;
  1326. }
  1327. bool GDScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  1328. {
  1329. HashMap<StringName, GDScript::MemberInfo>::ConstIterator E = script->member_indices.find(p_name);
  1330. if (E) {
  1331. if (E->value.getter) {
  1332. Callable::CallError err;
  1333. r_ret = const_cast<GDScriptInstance *>(this)->callp(E->value.getter, nullptr, 0, err);
  1334. if (err.error == Callable::CallError::CALL_OK) {
  1335. return true;
  1336. }
  1337. }
  1338. r_ret = members[E->value.index];
  1339. return true;
  1340. }
  1341. }
  1342. const GDScript *sptr = script.ptr();
  1343. while (sptr) {
  1344. {
  1345. HashMap<StringName, Variant>::ConstIterator E = sptr->constants.find(p_name);
  1346. if (E) {
  1347. r_ret = E->value;
  1348. return true;
  1349. }
  1350. }
  1351. {
  1352. HashMap<StringName, GDScript::MemberInfo>::ConstIterator E = sptr->static_variables_indices.find(p_name);
  1353. if (E) {
  1354. if (E->value.getter) {
  1355. Callable::CallError ce;
  1356. r_ret = const_cast<GDScript *>(sptr)->callp(E->value.getter, nullptr, 0, ce);
  1357. return true;
  1358. }
  1359. r_ret = sptr->static_variables[E->value.index];
  1360. return true;
  1361. }
  1362. }
  1363. {
  1364. HashMap<StringName, MethodInfo>::ConstIterator E = sptr->_signals.find(p_name);
  1365. if (E) {
  1366. r_ret = Signal(this->owner, E->key);
  1367. return true;
  1368. }
  1369. }
  1370. {
  1371. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(p_name);
  1372. if (E) {
  1373. if (sptr->rpc_config.has(p_name)) {
  1374. r_ret = Callable(memnew(GDScriptRPCCallable(this->owner, E->key)));
  1375. } else {
  1376. r_ret = Callable(this->owner, E->key);
  1377. }
  1378. return true;
  1379. }
  1380. }
  1381. {
  1382. HashMap<StringName, Ref<GDScript>>::ConstIterator E = sptr->subclasses.find(p_name);
  1383. if (E) {
  1384. r_ret = E->value;
  1385. return true;
  1386. }
  1387. }
  1388. {
  1389. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get);
  1390. if (E) {
  1391. Variant name = p_name;
  1392. const Variant *args[1] = { &name };
  1393. Callable::CallError err;
  1394. Variant ret = const_cast<GDScriptFunction *>(E->value)->call(const_cast<GDScriptInstance *>(this), (const Variant **)args, 1, err);
  1395. if (err.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1396. r_ret = ret;
  1397. return true;
  1398. }
  1399. }
  1400. }
  1401. sptr = sptr->_base;
  1402. }
  1403. return false;
  1404. }
  1405. Variant::Type GDScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  1406. if (script->member_indices.has(p_name)) {
  1407. if (r_is_valid) {
  1408. *r_is_valid = true;
  1409. }
  1410. return script->member_indices[p_name].property_info.type;
  1411. }
  1412. if (r_is_valid) {
  1413. *r_is_valid = false;
  1414. }
  1415. return Variant::NIL;
  1416. }
  1417. void GDScriptInstance::validate_property(PropertyInfo &p_property) const {
  1418. Variant property = (Dictionary)p_property;
  1419. const Variant *args[1] = { &property };
  1420. const GDScript *sptr = script.ptr();
  1421. while (sptr) {
  1422. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._validate_property);
  1423. if (E) {
  1424. Callable::CallError err;
  1425. Variant ret = E->value->call(const_cast<GDScriptInstance *>(this), args, 1, err);
  1426. if (err.error == Callable::CallError::CALL_OK) {
  1427. p_property = PropertyInfo::from_dict(property);
  1428. return;
  1429. }
  1430. }
  1431. sptr = sptr->_base;
  1432. }
  1433. }
  1434. void GDScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  1435. // exported members, not done yet!
  1436. const GDScript *sptr = script.ptr();
  1437. List<PropertyInfo> props;
  1438. while (sptr) {
  1439. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get_property_list);
  1440. if (E) {
  1441. Callable::CallError err;
  1442. Variant ret = const_cast<GDScriptFunction *>(E->value)->call(const_cast<GDScriptInstance *>(this), nullptr, 0, err);
  1443. if (err.error == Callable::CallError::CALL_OK) {
  1444. ERR_FAIL_COND_MSG(ret.get_type() != Variant::ARRAY, "Wrong type for _get_property_list, must be an array of dictionaries.");
  1445. Array arr = ret;
  1446. for (int i = 0; i < arr.size(); i++) {
  1447. Dictionary d = arr[i];
  1448. ERR_CONTINUE(!d.has("name"));
  1449. ERR_CONTINUE(!d.has("type"));
  1450. PropertyInfo pinfo;
  1451. pinfo.name = d["name"];
  1452. pinfo.type = Variant::Type(d["type"].operator int());
  1453. if (d.has("hint")) {
  1454. pinfo.hint = PropertyHint(d["hint"].operator int());
  1455. }
  1456. if (d.has("hint_string")) {
  1457. pinfo.hint_string = d["hint_string"];
  1458. }
  1459. if (d.has("usage")) {
  1460. pinfo.usage = d["usage"];
  1461. }
  1462. if (d.has("class_name")) {
  1463. pinfo.class_name = d["class_name"];
  1464. }
  1465. ERR_CONTINUE(pinfo.name.is_empty() && (pinfo.usage & PROPERTY_USAGE_STORAGE));
  1466. ERR_CONTINUE(pinfo.type < 0 || pinfo.type >= Variant::VARIANT_MAX);
  1467. props.push_back(pinfo);
  1468. }
  1469. }
  1470. }
  1471. //instance a fake script for editing the values
  1472. Vector<_GDScriptMemberSort> msort;
  1473. for (const KeyValue<StringName, GDScript::MemberInfo> &F : sptr->member_indices) {
  1474. if (!sptr->members.has(F.key)) {
  1475. continue; // Skip base class members.
  1476. }
  1477. _GDScriptMemberSort ms;
  1478. ms.index = F.value.index;
  1479. ms.name = F.key;
  1480. msort.push_back(ms);
  1481. }
  1482. msort.sort();
  1483. msort.reverse();
  1484. for (int i = 0; i < msort.size(); i++) {
  1485. props.push_front(sptr->member_indices[msort[i].name].property_info);
  1486. }
  1487. #ifdef TOOLS_ENABLED
  1488. p_properties->push_back(sptr->get_class_category());
  1489. #endif // TOOLS_ENABLED
  1490. for (PropertyInfo &prop : props) {
  1491. validate_property(prop);
  1492. p_properties->push_back(prop);
  1493. }
  1494. props.clear();
  1495. sptr = sptr->_base;
  1496. }
  1497. }
  1498. bool GDScriptInstance::property_can_revert(const StringName &p_name) const {
  1499. Variant name = p_name;
  1500. const Variant *args[1] = { &name };
  1501. const GDScript *sptr = script.ptr();
  1502. while (sptr) {
  1503. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._property_can_revert);
  1504. if (E) {
  1505. Callable::CallError err;
  1506. Variant ret = E->value->call(const_cast<GDScriptInstance *>(this), args, 1, err);
  1507. if (err.error == Callable::CallError::CALL_OK && ret.get_type() == Variant::BOOL && ret.operator bool()) {
  1508. return true;
  1509. }
  1510. }
  1511. sptr = sptr->_base;
  1512. }
  1513. return false;
  1514. }
  1515. bool GDScriptInstance::property_get_revert(const StringName &p_name, Variant &r_ret) const {
  1516. Variant name = p_name;
  1517. const Variant *args[1] = { &name };
  1518. const GDScript *sptr = script.ptr();
  1519. while (sptr) {
  1520. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._property_get_revert);
  1521. if (E) {
  1522. Callable::CallError err;
  1523. Variant ret = E->value->call(const_cast<GDScriptInstance *>(this), args, 1, err);
  1524. if (err.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1525. r_ret = ret;
  1526. return true;
  1527. }
  1528. }
  1529. sptr = sptr->_base;
  1530. }
  1531. return false;
  1532. }
  1533. void GDScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  1534. const GDScript *sptr = script.ptr();
  1535. while (sptr) {
  1536. for (const KeyValue<StringName, GDScriptFunction *> &E : sptr->member_functions) {
  1537. p_list->push_back(E.value->get_method_info());
  1538. }
  1539. sptr = sptr->_base;
  1540. }
  1541. }
  1542. bool GDScriptInstance::has_method(const StringName &p_method) const {
  1543. const GDScript *sptr = script.ptr();
  1544. while (sptr) {
  1545. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(p_method);
  1546. if (E) {
  1547. return true;
  1548. }
  1549. sptr = sptr->_base;
  1550. }
  1551. return false;
  1552. }
  1553. Variant GDScriptInstance::callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1554. GDScript *sptr = script.ptr();
  1555. if (unlikely(p_method == SNAME("_ready"))) {
  1556. // Call implicit ready first, including for the super classes.
  1557. while (sptr) {
  1558. if (sptr->implicit_ready) {
  1559. sptr->implicit_ready->call(this, nullptr, 0, r_error);
  1560. }
  1561. sptr = sptr->_base;
  1562. }
  1563. // Reset this back for the regular call.
  1564. sptr = script.ptr();
  1565. }
  1566. while (sptr) {
  1567. HashMap<StringName, GDScriptFunction *>::Iterator E = sptr->member_functions.find(p_method);
  1568. if (E) {
  1569. return E->value->call(this, p_args, p_argcount, r_error);
  1570. }
  1571. sptr = sptr->_base;
  1572. }
  1573. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1574. return Variant();
  1575. }
  1576. void GDScriptInstance::notification(int p_notification, bool p_reversed) {
  1577. //notification is not virtual, it gets called at ALL levels just like in C.
  1578. Variant value = p_notification;
  1579. const Variant *args[1] = { &value };
  1580. List<GDScript *> pl;
  1581. GDScript *sptr = script.ptr();
  1582. while (sptr) {
  1583. if (p_reversed) {
  1584. pl.push_back(sptr);
  1585. } else {
  1586. pl.push_front(sptr);
  1587. }
  1588. sptr = sptr->_base;
  1589. }
  1590. for (GDScript *sc : pl) {
  1591. HashMap<StringName, GDScriptFunction *>::Iterator E = sc->member_functions.find(GDScriptLanguage::get_singleton()->strings._notification);
  1592. if (E) {
  1593. Callable::CallError err;
  1594. E->value->call(this, args, 1, err);
  1595. if (err.error != Callable::CallError::CALL_OK) {
  1596. //print error about notification call
  1597. }
  1598. }
  1599. }
  1600. }
  1601. String GDScriptInstance::to_string(bool *r_valid) {
  1602. if (has_method(CoreStringNames::get_singleton()->_to_string)) {
  1603. Callable::CallError ce;
  1604. Variant ret = callp(CoreStringNames::get_singleton()->_to_string, nullptr, 0, ce);
  1605. if (ce.error == Callable::CallError::CALL_OK) {
  1606. if (ret.get_type() != Variant::STRING) {
  1607. if (r_valid) {
  1608. *r_valid = false;
  1609. }
  1610. ERR_FAIL_V_MSG(String(), "Wrong type for " + CoreStringNames::get_singleton()->_to_string + ", must be a String.");
  1611. }
  1612. if (r_valid) {
  1613. *r_valid = true;
  1614. }
  1615. return ret.operator String();
  1616. }
  1617. }
  1618. if (r_valid) {
  1619. *r_valid = false;
  1620. }
  1621. return String();
  1622. }
  1623. Ref<Script> GDScriptInstance::get_script() const {
  1624. return script;
  1625. }
  1626. ScriptLanguage *GDScriptInstance::get_language() {
  1627. return GDScriptLanguage::get_singleton();
  1628. }
  1629. const Variant GDScriptInstance::get_rpc_config() const {
  1630. return script->get_rpc_config();
  1631. }
  1632. void GDScriptInstance::reload_members() {
  1633. #ifdef DEBUG_ENABLED
  1634. Vector<Variant> new_members;
  1635. new_members.resize(script->member_indices.size());
  1636. //pass the values to the new indices
  1637. for (KeyValue<StringName, GDScript::MemberInfo> &E : script->member_indices) {
  1638. if (member_indices_cache.has(E.key)) {
  1639. Variant value = members[member_indices_cache[E.key]];
  1640. new_members.write[E.value.index] = value;
  1641. }
  1642. }
  1643. members.resize(new_members.size()); //resize
  1644. //apply
  1645. members = new_members;
  1646. //pass the values to the new indices
  1647. member_indices_cache.clear();
  1648. for (const KeyValue<StringName, GDScript::MemberInfo> &E : script->member_indices) {
  1649. member_indices_cache[E.key] = E.value.index;
  1650. }
  1651. #endif
  1652. }
  1653. GDScriptInstance::GDScriptInstance() {
  1654. owner = nullptr;
  1655. base_ref_counted = false;
  1656. }
  1657. GDScriptInstance::~GDScriptInstance() {
  1658. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1659. while (SelfList<GDScriptFunctionState> *E = pending_func_states.first()) {
  1660. // Order matters since clearing the stack may already cause
  1661. // the GDSCriptFunctionState to be destroyed and thus removed from the list.
  1662. pending_func_states.remove(E);
  1663. GDScriptFunctionState *state = E->self();
  1664. ObjectID state_id = state->get_instance_id();
  1665. state->_clear_connections();
  1666. if (ObjectDB::get_instance(state_id)) {
  1667. state->_clear_stack();
  1668. }
  1669. }
  1670. if (script.is_valid() && owner) {
  1671. script->instances.erase(owner);
  1672. }
  1673. }
  1674. /************* SCRIPT LANGUAGE **************/
  1675. GDScriptLanguage *GDScriptLanguage::singleton = nullptr;
  1676. String GDScriptLanguage::get_name() const {
  1677. return "GDScript";
  1678. }
  1679. /* LANGUAGE FUNCTIONS */
  1680. void GDScriptLanguage::_add_global(const StringName &p_name, const Variant &p_value) {
  1681. if (globals.has(p_name)) {
  1682. //overwrite existing
  1683. global_array.write[globals[p_name]] = p_value;
  1684. return;
  1685. }
  1686. globals[p_name] = global_array.size();
  1687. global_array.push_back(p_value);
  1688. _global_array = global_array.ptrw();
  1689. }
  1690. void GDScriptLanguage::add_global_constant(const StringName &p_variable, const Variant &p_value) {
  1691. _add_global(p_variable, p_value);
  1692. }
  1693. void GDScriptLanguage::add_named_global_constant(const StringName &p_name, const Variant &p_value) {
  1694. named_globals[p_name] = p_value;
  1695. }
  1696. Variant GDScriptLanguage::get_any_global_constant(const StringName &p_name) {
  1697. if (named_globals.has(p_name)) {
  1698. return named_globals[p_name];
  1699. }
  1700. if (globals.has(p_name)) {
  1701. return _global_array[globals[p_name]];
  1702. }
  1703. ERR_FAIL_V_MSG(Variant(), vformat("Could not find any global constant with name: %s.", p_name));
  1704. }
  1705. void GDScriptLanguage::remove_named_global_constant(const StringName &p_name) {
  1706. ERR_FAIL_COND(!named_globals.has(p_name));
  1707. named_globals.erase(p_name);
  1708. }
  1709. void GDScriptLanguage::init() {
  1710. //populate global constants
  1711. int gcc = CoreConstants::get_global_constant_count();
  1712. for (int i = 0; i < gcc; i++) {
  1713. _add_global(StaticCString::create(CoreConstants::get_global_constant_name(i)), CoreConstants::get_global_constant_value(i));
  1714. }
  1715. _add_global(StaticCString::create("PI"), Math_PI);
  1716. _add_global(StaticCString::create("TAU"), Math_TAU);
  1717. _add_global(StaticCString::create("INF"), INFINITY);
  1718. _add_global(StaticCString::create("NAN"), NAN);
  1719. //populate native classes
  1720. List<StringName> class_list;
  1721. ClassDB::get_class_list(&class_list);
  1722. for (const StringName &n : class_list) {
  1723. if (globals.has(n)) {
  1724. continue;
  1725. }
  1726. Ref<GDScriptNativeClass> nc = memnew(GDScriptNativeClass(n));
  1727. _add_global(n, nc);
  1728. }
  1729. //populate singletons
  1730. List<Engine::Singleton> singletons;
  1731. Engine::get_singleton()->get_singletons(&singletons);
  1732. for (const Engine::Singleton &E : singletons) {
  1733. _add_global(E.name, E.ptr);
  1734. }
  1735. #ifdef TESTS_ENABLED
  1736. GDScriptTests::GDScriptTestRunner::handle_cmdline();
  1737. #endif
  1738. }
  1739. String GDScriptLanguage::get_type() const {
  1740. return "GDScript";
  1741. }
  1742. String GDScriptLanguage::get_extension() const {
  1743. return "gd";
  1744. }
  1745. void GDScriptLanguage::finish() {
  1746. _call_stack.free();
  1747. // Clear the cache before parsing the script_list
  1748. GDScriptCache::clear();
  1749. // Clear dependencies between scripts, to ensure cyclic references are broken
  1750. // (to avoid leaks at exit).
  1751. SelfList<GDScript> *s = script_list.first();
  1752. while (s) {
  1753. // This ensures the current script is not released before we can check
  1754. // what's the next one in the list (we can't get the next upfront because we
  1755. // don't know if the reference breaking will cause it -or any other after
  1756. // it, for that matter- to be released so the next one is not the same as
  1757. // before).
  1758. Ref<GDScript> scr = s->self();
  1759. if (scr.is_valid()) {
  1760. for (KeyValue<StringName, GDScriptFunction *> &E : scr->member_functions) {
  1761. GDScriptFunction *func = E.value;
  1762. for (int i = 0; i < func->argument_types.size(); i++) {
  1763. func->argument_types.write[i].script_type_ref = Ref<Script>();
  1764. }
  1765. func->return_type.script_type_ref = Ref<Script>();
  1766. }
  1767. for (KeyValue<StringName, GDScript::MemberInfo> &E : scr->member_indices) {
  1768. E.value.data_type.script_type_ref = Ref<Script>();
  1769. }
  1770. // Clear backup for scripts that could slip out of the cyclic reference
  1771. // check
  1772. scr->clear();
  1773. }
  1774. s = s->next();
  1775. }
  1776. script_list.clear();
  1777. function_list.clear();
  1778. }
  1779. void GDScriptLanguage::profiling_start() {
  1780. #ifdef DEBUG_ENABLED
  1781. MutexLock lock(this->mutex);
  1782. SelfList<GDScriptFunction> *elem = function_list.first();
  1783. while (elem) {
  1784. elem->self()->profile.call_count.set(0);
  1785. elem->self()->profile.self_time.set(0);
  1786. elem->self()->profile.total_time.set(0);
  1787. elem->self()->profile.frame_call_count.set(0);
  1788. elem->self()->profile.frame_self_time.set(0);
  1789. elem->self()->profile.frame_total_time.set(0);
  1790. elem->self()->profile.last_frame_call_count = 0;
  1791. elem->self()->profile.last_frame_self_time = 0;
  1792. elem->self()->profile.last_frame_total_time = 0;
  1793. elem = elem->next();
  1794. }
  1795. profiling = true;
  1796. #endif
  1797. }
  1798. void GDScriptLanguage::profiling_stop() {
  1799. #ifdef DEBUG_ENABLED
  1800. MutexLock lock(this->mutex);
  1801. profiling = false;
  1802. #endif
  1803. }
  1804. int GDScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1805. int current = 0;
  1806. #ifdef DEBUG_ENABLED
  1807. MutexLock lock(this->mutex);
  1808. SelfList<GDScriptFunction> *elem = function_list.first();
  1809. while (elem) {
  1810. if (current >= p_info_max) {
  1811. break;
  1812. }
  1813. p_info_arr[current].call_count = elem->self()->profile.call_count.get();
  1814. p_info_arr[current].self_time = elem->self()->profile.self_time.get();
  1815. p_info_arr[current].total_time = elem->self()->profile.total_time.get();
  1816. p_info_arr[current].signature = elem->self()->profile.signature;
  1817. elem = elem->next();
  1818. current++;
  1819. }
  1820. #endif
  1821. return current;
  1822. }
  1823. int GDScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1824. int current = 0;
  1825. #ifdef DEBUG_ENABLED
  1826. MutexLock lock(this->mutex);
  1827. SelfList<GDScriptFunction> *elem = function_list.first();
  1828. while (elem) {
  1829. if (current >= p_info_max) {
  1830. break;
  1831. }
  1832. if (elem->self()->profile.last_frame_call_count > 0) {
  1833. p_info_arr[current].call_count = elem->self()->profile.last_frame_call_count;
  1834. p_info_arr[current].self_time = elem->self()->profile.last_frame_self_time;
  1835. p_info_arr[current].total_time = elem->self()->profile.last_frame_total_time;
  1836. p_info_arr[current].signature = elem->self()->profile.signature;
  1837. current++;
  1838. }
  1839. elem = elem->next();
  1840. }
  1841. #endif
  1842. return current;
  1843. }
  1844. struct GDScriptDepSort {
  1845. //must support sorting so inheritance works properly (parent must be reloaded first)
  1846. bool operator()(const Ref<GDScript> &A, const Ref<GDScript> &B) const {
  1847. if (A == B) {
  1848. return false; //shouldn't happen but..
  1849. }
  1850. const GDScript *I = B->get_base().ptr();
  1851. while (I) {
  1852. if (I == A.ptr()) {
  1853. // A is a base of B
  1854. return true;
  1855. }
  1856. I = I->get_base().ptr();
  1857. }
  1858. return false; //not a base
  1859. }
  1860. };
  1861. void GDScriptLanguage::reload_all_scripts() {
  1862. #ifdef DEBUG_ENABLED
  1863. print_verbose("GDScript: Reloading all scripts");
  1864. List<Ref<GDScript>> scripts;
  1865. {
  1866. MutexLock lock(this->mutex);
  1867. SelfList<GDScript> *elem = script_list.first();
  1868. while (elem) {
  1869. // Scripts will reload all subclasses, so only reload root scripts.
  1870. if (elem->self()->is_root_script() && elem->self()->get_path().is_resource_file()) {
  1871. print_verbose("GDScript: Found: " + elem->self()->get_path());
  1872. scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
  1873. }
  1874. elem = elem->next();
  1875. }
  1876. }
  1877. //as scripts are going to be reloaded, must proceed without locking here
  1878. scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
  1879. for (Ref<GDScript> &scr : scripts) {
  1880. print_verbose("GDScript: Reloading: " + scr->get_path());
  1881. scr->load_source_code(scr->get_path());
  1882. scr->reload(true);
  1883. }
  1884. #endif
  1885. }
  1886. void GDScriptLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
  1887. #ifdef DEBUG_ENABLED
  1888. List<Ref<GDScript>> scripts;
  1889. {
  1890. MutexLock lock(this->mutex);
  1891. SelfList<GDScript> *elem = script_list.first();
  1892. while (elem) {
  1893. // Scripts will reload all subclasses, so only reload root scripts.
  1894. if (elem->self()->is_root_script() && elem->self()->get_path().is_resource_file()) {
  1895. scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
  1896. }
  1897. elem = elem->next();
  1898. }
  1899. }
  1900. //when someone asks you why dynamically typed languages are easier to write....
  1901. HashMap<Ref<GDScript>, HashMap<ObjectID, List<Pair<StringName, Variant>>>> to_reload;
  1902. //as scripts are going to be reloaded, must proceed without locking here
  1903. scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
  1904. for (Ref<GDScript> &scr : scripts) {
  1905. bool reload = scr == p_script || to_reload.has(scr->get_base());
  1906. if (!reload) {
  1907. continue;
  1908. }
  1909. to_reload.insert(scr, HashMap<ObjectID, List<Pair<StringName, Variant>>>());
  1910. if (!p_soft_reload) {
  1911. //save state and remove script from instances
  1912. HashMap<ObjectID, List<Pair<StringName, Variant>>> &map = to_reload[scr];
  1913. while (scr->instances.front()) {
  1914. Object *obj = scr->instances.front()->get();
  1915. //save instance info
  1916. List<Pair<StringName, Variant>> state;
  1917. if (obj->get_script_instance()) {
  1918. obj->get_script_instance()->get_property_state(state);
  1919. map[obj->get_instance_id()] = state;
  1920. obj->set_script(Variant());
  1921. }
  1922. }
  1923. //same thing for placeholders
  1924. #ifdef TOOLS_ENABLED
  1925. while (scr->placeholders.size()) {
  1926. Object *obj = (*scr->placeholders.begin())->get_owner();
  1927. //save instance info
  1928. if (obj->get_script_instance()) {
  1929. map.insert(obj->get_instance_id(), List<Pair<StringName, Variant>>());
  1930. List<Pair<StringName, Variant>> &state = map[obj->get_instance_id()];
  1931. obj->get_script_instance()->get_property_state(state);
  1932. obj->set_script(Variant());
  1933. } else {
  1934. // no instance found. Let's remove it so we don't loop forever
  1935. scr->placeholders.erase(*scr->placeholders.begin());
  1936. }
  1937. }
  1938. #endif
  1939. for (const KeyValue<ObjectID, List<Pair<StringName, Variant>>> &F : scr->pending_reload_state) {
  1940. map[F.key] = F.value; //pending to reload, use this one instead
  1941. }
  1942. }
  1943. }
  1944. for (KeyValue<Ref<GDScript>, HashMap<ObjectID, List<Pair<StringName, Variant>>>> &E : to_reload) {
  1945. Ref<GDScript> scr = E.key;
  1946. scr->reload(p_soft_reload);
  1947. //restore state if saved
  1948. for (KeyValue<ObjectID, List<Pair<StringName, Variant>>> &F : E.value) {
  1949. List<Pair<StringName, Variant>> &saved_state = F.value;
  1950. Object *obj = ObjectDB::get_instance(F.key);
  1951. if (!obj) {
  1952. continue;
  1953. }
  1954. if (!p_soft_reload) {
  1955. //clear it just in case (may be a pending reload state)
  1956. obj->set_script(Variant());
  1957. }
  1958. obj->set_script(scr);
  1959. ScriptInstance *script_inst = obj->get_script_instance();
  1960. if (!script_inst) {
  1961. //failed, save reload state for next time if not saved
  1962. if (!scr->pending_reload_state.has(obj->get_instance_id())) {
  1963. scr->pending_reload_state[obj->get_instance_id()] = saved_state;
  1964. }
  1965. continue;
  1966. }
  1967. if (script_inst->is_placeholder() && scr->is_placeholder_fallback_enabled()) {
  1968. PlaceHolderScriptInstance *placeholder = static_cast<PlaceHolderScriptInstance *>(script_inst);
  1969. for (List<Pair<StringName, Variant>>::Element *G = saved_state.front(); G; G = G->next()) {
  1970. placeholder->property_set_fallback(G->get().first, G->get().second);
  1971. }
  1972. } else {
  1973. for (List<Pair<StringName, Variant>>::Element *G = saved_state.front(); G; G = G->next()) {
  1974. script_inst->set(G->get().first, G->get().second);
  1975. }
  1976. }
  1977. scr->pending_reload_state.erase(obj->get_instance_id()); //as it reloaded, remove pending state
  1978. }
  1979. //if instance states were saved, set them!
  1980. }
  1981. #endif
  1982. }
  1983. void GDScriptLanguage::frame() {
  1984. calls = 0;
  1985. #ifdef DEBUG_ENABLED
  1986. if (profiling) {
  1987. MutexLock lock(this->mutex);
  1988. SelfList<GDScriptFunction> *elem = function_list.first();
  1989. while (elem) {
  1990. elem->self()->profile.last_frame_call_count = elem->self()->profile.frame_call_count.get();
  1991. elem->self()->profile.last_frame_self_time = elem->self()->profile.frame_self_time.get();
  1992. elem->self()->profile.last_frame_total_time = elem->self()->profile.frame_total_time.get();
  1993. elem->self()->profile.frame_call_count.set(0);
  1994. elem->self()->profile.frame_self_time.set(0);
  1995. elem->self()->profile.frame_total_time.set(0);
  1996. elem = elem->next();
  1997. }
  1998. }
  1999. #endif
  2000. }
  2001. /* EDITOR FUNCTIONS */
  2002. void GDScriptLanguage::get_reserved_words(List<String> *p_words) const {
  2003. // Please keep alphabetical order within categories.
  2004. static const char *_reserved_words[] = {
  2005. // Control flow.
  2006. "break",
  2007. "continue",
  2008. "elif",
  2009. "else",
  2010. "for",
  2011. "if",
  2012. "match",
  2013. "pass",
  2014. "return",
  2015. "when",
  2016. "while",
  2017. // Declarations.
  2018. "class",
  2019. "class_name",
  2020. "const",
  2021. "enum",
  2022. "extends",
  2023. "func",
  2024. "namespace", // Reserved for potential future use.
  2025. "signal",
  2026. "static",
  2027. "trait", // Reserved for potential future use.
  2028. "var",
  2029. // Other keywords.
  2030. "await",
  2031. "breakpoint",
  2032. "self",
  2033. "super",
  2034. "yield", // Reserved for potential future use.
  2035. // Operators.
  2036. "and",
  2037. "as",
  2038. "in",
  2039. "is",
  2040. "not",
  2041. "or",
  2042. // Special values (tokenizer treats them as literals, not as tokens).
  2043. "false",
  2044. "null",
  2045. "true",
  2046. // Constants.
  2047. "INF",
  2048. "NAN",
  2049. "PI",
  2050. "TAU",
  2051. // Functions (highlighter uses global function color instead).
  2052. "assert",
  2053. "preload",
  2054. // Types (highlighter uses type color instead).
  2055. "void",
  2056. nullptr,
  2057. };
  2058. const char **w = _reserved_words;
  2059. while (*w) {
  2060. p_words->push_back(*w);
  2061. w++;
  2062. }
  2063. }
  2064. bool GDScriptLanguage::is_control_flow_keyword(String p_keyword) const {
  2065. // Please keep alphabetical order.
  2066. return p_keyword == "break" ||
  2067. p_keyword == "continue" ||
  2068. p_keyword == "elif" ||
  2069. p_keyword == "else" ||
  2070. p_keyword == "for" ||
  2071. p_keyword == "if" ||
  2072. p_keyword == "match" ||
  2073. p_keyword == "pass" ||
  2074. p_keyword == "return" ||
  2075. p_keyword == "when" ||
  2076. p_keyword == "while";
  2077. }
  2078. bool GDScriptLanguage::handles_global_class_type(const String &p_type) const {
  2079. return p_type == "GDScript";
  2080. }
  2081. String GDScriptLanguage::get_global_class_name(const String &p_path, String *r_base_type, String *r_icon_path) const {
  2082. Error err;
  2083. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);
  2084. if (err) {
  2085. return String();
  2086. }
  2087. String source = f->get_as_utf8_string();
  2088. GDScriptParser parser;
  2089. err = parser.parse(source, p_path, false);
  2090. const GDScriptParser::ClassNode *c = parser.get_tree();
  2091. if (!c) {
  2092. return String(); // No class parsed.
  2093. }
  2094. /* **WARNING**
  2095. *
  2096. * This function is written with the goal to be *extremely* error tolerant, as such
  2097. * it should meet the following requirements:
  2098. *
  2099. * - It must not rely on the analyzer (in fact, the analyzer must not be used here),
  2100. * because at the time global classes are parsed, the dependencies may not be present
  2101. * yet, hence the function will fail (which is unintended).
  2102. * - It must not fail even if the parsing fails, because even if the file is broken,
  2103. * it should attempt its best to retrieve the inheritance metadata.
  2104. *
  2105. * Before changing this function, please ask the current maintainer of EditorFileSystem.
  2106. */
  2107. if (r_base_type) {
  2108. const GDScriptParser::ClassNode *subclass = c;
  2109. String path = p_path;
  2110. GDScriptParser subparser;
  2111. while (subclass) {
  2112. if (subclass->extends_used) {
  2113. if (!subclass->extends_path.is_empty()) {
  2114. if (subclass->extends.size() == 0) {
  2115. get_global_class_name(subclass->extends_path, r_base_type);
  2116. subclass = nullptr;
  2117. break;
  2118. } else {
  2119. Vector<GDScriptParser::IdentifierNode *> extend_classes = subclass->extends;
  2120. Ref<FileAccess> subfile = FileAccess::open(subclass->extends_path, FileAccess::READ);
  2121. if (subfile.is_null()) {
  2122. break;
  2123. }
  2124. String subsource = subfile->get_as_utf8_string();
  2125. if (subsource.is_empty()) {
  2126. break;
  2127. }
  2128. String subpath = subclass->extends_path;
  2129. if (subpath.is_relative_path()) {
  2130. subpath = path.get_base_dir().path_join(subpath).simplify_path();
  2131. }
  2132. if (OK != subparser.parse(subsource, subpath, false)) {
  2133. break;
  2134. }
  2135. path = subpath;
  2136. subclass = subparser.get_tree();
  2137. while (extend_classes.size() > 0) {
  2138. bool found = false;
  2139. for (int i = 0; i < subclass->members.size(); i++) {
  2140. if (subclass->members[i].type != GDScriptParser::ClassNode::Member::CLASS) {
  2141. continue;
  2142. }
  2143. const GDScriptParser::ClassNode *inner_class = subclass->members[i].m_class;
  2144. if (inner_class->identifier->name == extend_classes[0]->name) {
  2145. extend_classes.remove_at(0);
  2146. found = true;
  2147. subclass = inner_class;
  2148. break;
  2149. }
  2150. }
  2151. if (!found) {
  2152. subclass = nullptr;
  2153. break;
  2154. }
  2155. }
  2156. }
  2157. } else if (subclass->extends.size() == 1) {
  2158. *r_base_type = subclass->extends[0]->name;
  2159. subclass = nullptr;
  2160. } else {
  2161. break;
  2162. }
  2163. } else {
  2164. *r_base_type = "RefCounted";
  2165. subclass = nullptr;
  2166. }
  2167. }
  2168. }
  2169. if (r_icon_path) {
  2170. *r_icon_path = c->simplified_icon_path;
  2171. }
  2172. return c->identifier != nullptr ? String(c->identifier->name) : String();
  2173. }
  2174. thread_local GDScriptLanguage::CallStack GDScriptLanguage::_call_stack;
  2175. GDScriptLanguage::GDScriptLanguage() {
  2176. calls = 0;
  2177. ERR_FAIL_COND(singleton);
  2178. singleton = this;
  2179. strings._init = StaticCString::create("_init");
  2180. strings._static_init = StaticCString::create("_static_init");
  2181. strings._notification = StaticCString::create("_notification");
  2182. strings._set = StaticCString::create("_set");
  2183. strings._get = StaticCString::create("_get");
  2184. strings._get_property_list = StaticCString::create("_get_property_list");
  2185. strings._validate_property = StaticCString::create("_validate_property");
  2186. strings._property_can_revert = StaticCString::create("_property_can_revert");
  2187. strings._property_get_revert = StaticCString::create("_property_get_revert");
  2188. strings._script_source = StaticCString::create("script/source");
  2189. _debug_parse_err_line = -1;
  2190. _debug_parse_err_file = "";
  2191. profiling = false;
  2192. script_frame_time = 0;
  2193. int dmcs = GLOBAL_DEF(PropertyInfo(Variant::INT, "debug/settings/gdscript/max_call_stack", PROPERTY_HINT_RANGE, "512," + itos(GDScriptFunction::MAX_CALL_DEPTH - 1) + ",1"), 1024);
  2194. if (EngineDebugger::is_active()) {
  2195. //debugging enabled!
  2196. _debug_max_call_stack = dmcs;
  2197. } else {
  2198. _debug_max_call_stack = 0;
  2199. }
  2200. #ifdef DEBUG_ENABLED
  2201. GLOBAL_DEF("debug/gdscript/warnings/enable", true);
  2202. GLOBAL_DEF("debug/gdscript/warnings/exclude_addons", true);
  2203. for (int i = 0; i < (int)GDScriptWarning::WARNING_MAX; i++) {
  2204. GDScriptWarning::Code code = (GDScriptWarning::Code)i;
  2205. Variant default_enabled = GDScriptWarning::get_default_value(code);
  2206. String path = GDScriptWarning::get_settings_path_from_code(code);
  2207. GLOBAL_DEF(GDScriptWarning::get_property_info(code), default_enabled);
  2208. }
  2209. #endif // DEBUG_ENABLED
  2210. }
  2211. GDScriptLanguage::~GDScriptLanguage() {
  2212. singleton = nullptr;
  2213. }
  2214. void GDScriptLanguage::add_orphan_subclass(const String &p_qualified_name, const ObjectID &p_subclass) {
  2215. orphan_subclasses[p_qualified_name] = p_subclass;
  2216. }
  2217. Ref<GDScript> GDScriptLanguage::get_orphan_subclass(const String &p_qualified_name) {
  2218. HashMap<String, ObjectID>::Iterator orphan_subclass_element = orphan_subclasses.find(p_qualified_name);
  2219. if (!orphan_subclass_element) {
  2220. return Ref<GDScript>();
  2221. }
  2222. ObjectID orphan_subclass = orphan_subclass_element->value;
  2223. Object *obj = ObjectDB::get_instance(orphan_subclass);
  2224. orphan_subclasses.remove(orphan_subclass_element);
  2225. if (!obj) {
  2226. return Ref<GDScript>();
  2227. }
  2228. return Ref<GDScript>(Object::cast_to<GDScript>(obj));
  2229. }
  2230. Ref<GDScript> GDScriptLanguage::get_script_by_fully_qualified_name(const String &p_name) {
  2231. {
  2232. MutexLock lock(mutex);
  2233. SelfList<GDScript> *elem = script_list.first();
  2234. while (elem) {
  2235. GDScript *scr = elem->self();
  2236. if (scr->fully_qualified_name == p_name) {
  2237. return scr;
  2238. }
  2239. elem = elem->next();
  2240. }
  2241. }
  2242. Ref<GDScript> scr;
  2243. scr.instantiate();
  2244. scr->fully_qualified_name = p_name;
  2245. return scr;
  2246. }
  2247. /*************** RESOURCE ***************/
  2248. 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) {
  2249. Error err;
  2250. Ref<GDScript> scr = GDScriptCache::get_full_script(p_path, err, "", p_cache_mode == CACHE_MODE_IGNORE);
  2251. if (err && scr.is_valid()) {
  2252. // If !scr.is_valid(), the error was likely from scr->load_source_code(), which already generates an error.
  2253. ERR_PRINT_ED(vformat(R"(Failed to load script "%s" with error "%s".)", p_path, error_names[err]));
  2254. }
  2255. if (r_error) {
  2256. // Don't fail loading because of parsing error.
  2257. *r_error = scr.is_valid() ? OK : err;
  2258. }
  2259. return scr;
  2260. }
  2261. void ResourceFormatLoaderGDScript::get_recognized_extensions(List<String> *p_extensions) const {
  2262. p_extensions->push_back("gd");
  2263. }
  2264. bool ResourceFormatLoaderGDScript::handles_type(const String &p_type) const {
  2265. return (p_type == "Script" || p_type == "GDScript");
  2266. }
  2267. String ResourceFormatLoaderGDScript::get_resource_type(const String &p_path) const {
  2268. String el = p_path.get_extension().to_lower();
  2269. if (el == "gd") {
  2270. return "GDScript";
  2271. }
  2272. return "";
  2273. }
  2274. void ResourceFormatLoaderGDScript::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
  2275. Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::READ);
  2276. ERR_FAIL_COND_MSG(file.is_null(), "Cannot open file '" + p_path + "'.");
  2277. String source = file->get_as_utf8_string();
  2278. if (source.is_empty()) {
  2279. return;
  2280. }
  2281. GDScriptParser parser;
  2282. if (OK != parser.parse(source, p_path, false)) {
  2283. return;
  2284. }
  2285. for (const String &E : parser.get_dependencies()) {
  2286. p_dependencies->push_back(E);
  2287. }
  2288. }
  2289. Error ResourceFormatSaverGDScript::save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags) {
  2290. Ref<GDScript> sqscr = p_resource;
  2291. ERR_FAIL_COND_V(sqscr.is_null(), ERR_INVALID_PARAMETER);
  2292. String source = sqscr->get_source_code();
  2293. {
  2294. Error err;
  2295. Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::WRITE, &err);
  2296. ERR_FAIL_COND_V_MSG(err, err, "Cannot save GDScript file '" + p_path + "'.");
  2297. file->store_string(source);
  2298. if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
  2299. return ERR_CANT_CREATE;
  2300. }
  2301. }
  2302. if (ScriptServer::is_reload_scripts_on_save_enabled()) {
  2303. GDScriptLanguage::get_singleton()->reload_tool_script(p_resource, true);
  2304. }
  2305. return OK;
  2306. }
  2307. void ResourceFormatSaverGDScript::get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const {
  2308. if (Object::cast_to<GDScript>(*p_resource)) {
  2309. p_extensions->push_back("gd");
  2310. }
  2311. }
  2312. bool ResourceFormatSaverGDScript::recognize(const Ref<Resource> &p_resource) const {
  2313. return Object::cast_to<GDScript>(*p_resource) != nullptr;
  2314. }