gdscript.cpp 68 KB

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