gdscript.cpp 84 KB

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