gdscript.cpp 68 KB

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