gdscript.cpp 88 KB

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