gdscript.cpp 76 KB

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