gdscript.cpp 80 KB

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