gdscript.cpp 69 KB

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