gdscript.cpp 60 KB

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