gdscript.cpp 82 KB

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