gdscript.cpp 76 KB

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