gdscript.cpp 85 KB

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