gdscript.cpp 66 KB

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