gdscript.cpp 84 KB

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