gdscript.cpp 61 KB

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