gdscript.cpp 68 KB

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