gdscript.cpp 91 KB

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