gdscript.cpp 75 KB

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