gdscript.cpp 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481
  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 = p_script->_base;
  99. if (base != nullptr) {
  100. return _super_constructor(base);
  101. } else {
  102. return nullptr;
  103. }
  104. }
  105. }
  106. void GDScript::_super_implicit_constructor(GDScript *p_script, GDScriptInstance *p_instance, Callable::CallError &r_error) {
  107. GDScript *base = p_script->_base;
  108. if (base != nullptr) {
  109. _super_implicit_constructor(base, p_instance, r_error);
  110. if (r_error.error != Callable::CallError::CALL_OK) {
  111. return;
  112. }
  113. }
  114. ERR_FAIL_NULL(p_script->implicit_initializer);
  115. p_script->implicit_initializer->call(p_instance, nullptr, 0, r_error);
  116. }
  117. GDScriptInstance *GDScript::_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_is_ref_counted, Callable::CallError &r_error) {
  118. /* STEP 1, CREATE */
  119. GDScriptInstance *instance = memnew(GDScriptInstance);
  120. instance->base_ref_counted = p_is_ref_counted;
  121. instance->members.resize(member_indices.size());
  122. instance->script = Ref<GDScript>(this);
  123. instance->owner = p_owner;
  124. instance->owner_id = p_owner->get_instance_id();
  125. #ifdef DEBUG_ENABLED
  126. //needed for hot reloading
  127. for (const KeyValue<StringName, MemberInfo> &E : member_indices) {
  128. instance->member_indices_cache[E.key] = E.value.index;
  129. }
  130. #endif
  131. instance->owner->set_script_instance(instance);
  132. /* STEP 2, INITIALIZE AND CONSTRUCT */
  133. {
  134. MutexLock lock(GDScriptLanguage::singleton->lock);
  135. instances.insert(instance->owner);
  136. }
  137. _super_implicit_constructor(this, instance, r_error);
  138. if (r_error.error != Callable::CallError::CALL_OK) {
  139. instance->script = Ref<GDScript>();
  140. instance->owner->set_script_instance(nullptr);
  141. {
  142. MutexLock lock(GDScriptLanguage::singleton->lock);
  143. instances.erase(p_owner);
  144. }
  145. ERR_FAIL_V_MSG(nullptr, "Error constructing a GDScriptInstance.");
  146. }
  147. if (p_argcount < 0) {
  148. return instance;
  149. }
  150. initializer = _super_constructor(this);
  151. if (initializer != nullptr) {
  152. initializer->call(instance, p_args, p_argcount, r_error);
  153. if (r_error.error != Callable::CallError::CALL_OK) {
  154. instance->script = Ref<GDScript>();
  155. instance->owner->set_script_instance(nullptr);
  156. {
  157. MutexLock lock(GDScriptLanguage::singleton->lock);
  158. instances.erase(p_owner);
  159. }
  160. ERR_FAIL_V_MSG(nullptr, "Error constructing a GDScriptInstance.");
  161. }
  162. }
  163. //@TODO make thread safe
  164. return instance;
  165. }
  166. Variant GDScript::_new(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  167. /* STEP 1, CREATE */
  168. if (!valid) {
  169. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  170. return Variant();
  171. }
  172. r_error.error = Callable::CallError::CALL_OK;
  173. Ref<RefCounted> ref;
  174. Object *owner = nullptr;
  175. GDScript *_baseptr = this;
  176. while (_baseptr->_base) {
  177. _baseptr = _baseptr->_base;
  178. }
  179. ERR_FAIL_COND_V(_baseptr->native.is_null(), Variant());
  180. if (_baseptr->native.ptr()) {
  181. owner = _baseptr->native->instantiate();
  182. } else {
  183. owner = memnew(RefCounted); //by default, no base means use reference
  184. }
  185. ERR_FAIL_COND_V_MSG(!owner, Variant(), "Can't inherit from a virtual class.");
  186. RefCounted *r = Object::cast_to<RefCounted>(owner);
  187. if (r) {
  188. ref = Ref<RefCounted>(r);
  189. }
  190. GDScriptInstance *instance = _create_instance(p_args, p_argcount, owner, r != nullptr, r_error);
  191. if (!instance) {
  192. if (ref.is_null()) {
  193. memdelete(owner); //no owner, sorry
  194. }
  195. return Variant();
  196. }
  197. if (ref.is_valid()) {
  198. return ref;
  199. } else {
  200. return owner;
  201. }
  202. }
  203. bool GDScript::can_instantiate() const {
  204. #ifdef TOOLS_ENABLED
  205. return valid && (tool || ScriptServer::is_scripting_enabled());
  206. #else
  207. return valid;
  208. #endif
  209. }
  210. Ref<Script> GDScript::get_base_script() const {
  211. if (_base) {
  212. return Ref<GDScript>(_base);
  213. } else {
  214. return Ref<Script>();
  215. }
  216. }
  217. StringName GDScript::get_instance_base_type() const {
  218. if (native.is_valid()) {
  219. return native->get_name();
  220. }
  221. if (base.is_valid() && base->is_valid()) {
  222. return base->get_instance_base_type();
  223. }
  224. return StringName();
  225. }
  226. struct _GDScriptMemberSort {
  227. int index = 0;
  228. StringName name;
  229. _FORCE_INLINE_ bool operator<(const _GDScriptMemberSort &p_member) const { return index < p_member.index; }
  230. };
  231. #ifdef TOOLS_ENABLED
  232. void GDScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  233. placeholders.erase(p_placeholder);
  234. }
  235. #endif
  236. void GDScript::_get_script_method_list(List<MethodInfo> *r_list, bool p_include_base) const {
  237. const GDScript *current = this;
  238. while (current) {
  239. for (const KeyValue<StringName, GDScriptFunction *> &E : current->member_functions) {
  240. GDScriptFunction *func = E.value;
  241. MethodInfo mi;
  242. mi.name = E.key;
  243. 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->lock);
  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 doc_description;
  536. if (doc_constants.has(E.key)) {
  537. doc_description = doc_constants[E.key];
  538. }
  539. DocData::constant_doc_from_variant(constant_doc, E.key, E.value, doc_description);
  540. doc.constants.push_back(constant_doc);
  541. }
  542. }
  543. for (KeyValue<StringName, Ref<GDScript>> &E : subclasses) {
  544. E.value->_update_doc();
  545. }
  546. _add_doc(doc);
  547. }
  548. #endif
  549. bool GDScript::_update_exports(bool *r_err, bool p_recursive_call, PlaceHolderScriptInstance *p_instance_to_update) {
  550. #ifdef TOOLS_ENABLED
  551. static Vector<GDScript *> base_caches;
  552. if (!p_recursive_call) {
  553. base_caches.clear();
  554. }
  555. base_caches.append(this);
  556. bool changed = false;
  557. if (source_changed_cache) {
  558. source_changed_cache = false;
  559. changed = true;
  560. String basedir = path;
  561. if (basedir.is_empty()) {
  562. basedir = get_path();
  563. }
  564. if (!basedir.is_empty()) {
  565. basedir = basedir.get_base_dir();
  566. }
  567. GDScriptParser parser;
  568. GDScriptAnalyzer analyzer(&parser);
  569. Error err = parser.parse(source, path, false);
  570. if (err == OK && analyzer.analyze() == OK) {
  571. const GDScriptParser::ClassNode *c = parser.get_tree();
  572. if (base_cache.is_valid()) {
  573. base_cache->inheriters_cache.erase(get_instance_id());
  574. base_cache = Ref<GDScript>();
  575. }
  576. if (c->extends_used) {
  577. String path = "";
  578. if (String(c->extends_path) != "" && String(c->extends_path) != get_path()) {
  579. path = c->extends_path;
  580. if (path.is_relative_path()) {
  581. String base = get_path();
  582. if (base.is_empty() || base.is_relative_path()) {
  583. ERR_PRINT(("Could not resolve relative path for parent class: " + path).utf8().get_data());
  584. } else {
  585. path = base.get_base_dir().path_join(path);
  586. }
  587. }
  588. } else if (c->extends.size() != 0) {
  589. const StringName &base = c->extends[0];
  590. if (ScriptServer::is_global_class(base)) {
  591. path = ScriptServer::get_global_class_path(base);
  592. }
  593. }
  594. if (!path.is_empty()) {
  595. if (path != get_path()) {
  596. Ref<GDScript> bf = ResourceLoader::load(path);
  597. if (bf.is_valid()) {
  598. base_cache = bf;
  599. bf->inheriters_cache.insert(get_instance_id());
  600. }
  601. } else {
  602. ERR_PRINT(("Path extending itself in " + path).utf8().get_data());
  603. }
  604. }
  605. }
  606. members_cache.clear();
  607. member_default_values_cache.clear();
  608. _signals.clear();
  609. members_cache.push_back(get_class_category());
  610. for (int i = 0; i < c->members.size(); i++) {
  611. const GDScriptParser::ClassNode::Member &member = c->members[i];
  612. switch (member.type) {
  613. case GDScriptParser::ClassNode::Member::VARIABLE: {
  614. if (!member.variable->exported) {
  615. continue;
  616. }
  617. members_cache.push_back(member.variable->export_info);
  618. Variant default_value;
  619. if (member.variable->initializer && member.variable->initializer->is_constant) {
  620. default_value = member.variable->initializer->reduced_value;
  621. }
  622. member_default_values_cache[member.variable->identifier->name] = default_value;
  623. } break;
  624. case GDScriptParser::ClassNode::Member::SIGNAL: {
  625. // TODO: Cache this in parser to avoid loops like this.
  626. Vector<StringName> parameters_names;
  627. parameters_names.resize(member.signal->parameters.size());
  628. for (int j = 0; j < member.signal->parameters.size(); j++) {
  629. parameters_names.write[j] = member.signal->parameters[j]->identifier->name;
  630. }
  631. _signals[member.signal->identifier->name] = parameters_names;
  632. } break;
  633. case GDScriptParser::ClassNode::Member::GROUP: {
  634. members_cache.push_back(member.annotation->export_info);
  635. } break;
  636. default:
  637. break; // Nothing.
  638. }
  639. }
  640. } else {
  641. placeholder_fallback_enabled = true;
  642. return false;
  643. }
  644. } else if (placeholder_fallback_enabled) {
  645. return false;
  646. }
  647. placeholder_fallback_enabled = false;
  648. if (base_cache.is_valid() && base_cache->is_valid()) {
  649. for (int i = 0; i < base_caches.size(); i++) {
  650. if (base_caches[i] == base_cache.ptr()) {
  651. if (r_err) {
  652. *r_err = true;
  653. }
  654. valid = false; // to show error in the editor
  655. base_cache->valid = false;
  656. base_cache->inheriters_cache.clear(); // to prevent future stackoverflows
  657. base_cache.unref();
  658. base.unref();
  659. _base = nullptr;
  660. ERR_FAIL_V_MSG(false, "Cyclic inheritance in script class.");
  661. }
  662. }
  663. if (base_cache->_update_exports(r_err, true)) {
  664. if (r_err && *r_err) {
  665. return false;
  666. }
  667. changed = true;
  668. }
  669. }
  670. if ((changed || p_instance_to_update) && placeholders.size()) { //hm :(
  671. // update placeholders if any
  672. HashMap<StringName, Variant> values;
  673. List<PropertyInfo> propnames;
  674. _update_exports_values(values, propnames);
  675. if (changed) {
  676. for (PlaceHolderScriptInstance *E : placeholders) {
  677. E->update(propnames, values);
  678. }
  679. } else {
  680. p_instance_to_update->update(propnames, values);
  681. }
  682. }
  683. return changed;
  684. #else
  685. return false;
  686. #endif
  687. }
  688. void GDScript::update_exports() {
  689. #ifdef TOOLS_ENABLED
  690. bool cyclic_error = false;
  691. _update_exports(&cyclic_error);
  692. if (cyclic_error) {
  693. return;
  694. }
  695. HashSet<ObjectID> copy = inheriters_cache; //might get modified
  696. for (const ObjectID &E : copy) {
  697. Object *id = ObjectDB::get_instance(E);
  698. GDScript *s = Object::cast_to<GDScript>(id);
  699. if (!s) {
  700. continue;
  701. }
  702. s->update_exports();
  703. }
  704. #endif
  705. }
  706. void GDScript::_set_subclass_path(Ref<GDScript> &p_sc, const String &p_path) {
  707. p_sc->path = p_path;
  708. for (KeyValue<StringName, Ref<GDScript>> &E : p_sc->subclasses) {
  709. _set_subclass_path(E.value, p_path);
  710. }
  711. }
  712. String GDScript::_get_debug_path() const {
  713. if (is_built_in() && !get_name().is_empty()) {
  714. return get_name() + " (" + get_path() + ")";
  715. } else {
  716. return get_path();
  717. }
  718. }
  719. Error GDScript::reload(bool p_keep_state) {
  720. bool has_instances;
  721. {
  722. MutexLock lock(GDScriptLanguage::singleton->lock);
  723. has_instances = instances.size();
  724. }
  725. ERR_FAIL_COND_V(!p_keep_state && has_instances, ERR_ALREADY_IN_USE);
  726. String basedir = path;
  727. if (basedir.is_empty()) {
  728. basedir = get_path();
  729. }
  730. if (!basedir.is_empty()) {
  731. basedir = basedir.get_base_dir();
  732. }
  733. // Loading a template, don't parse.
  734. #ifdef TOOLS_ENABLED
  735. if (EditorPaths::get_singleton() && basedir.begins_with(EditorPaths::get_singleton()->get_project_script_templates_dir())) {
  736. return OK;
  737. }
  738. #endif
  739. {
  740. String source_path = path;
  741. if (source_path.is_empty()) {
  742. source_path = get_path();
  743. }
  744. if (!source_path.is_empty()) {
  745. MutexLock lock(GDScriptCache::singleton->lock);
  746. if (!GDScriptCache::singleton->shallow_gdscript_cache.has(source_path)) {
  747. GDScriptCache::singleton->shallow_gdscript_cache[source_path] = this;
  748. }
  749. }
  750. }
  751. valid = false;
  752. GDScriptParser parser;
  753. Error err = parser.parse(source, path, false);
  754. if (err) {
  755. if (EngineDebugger::is_active()) {
  756. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), parser.get_errors().front()->get().line, "Parser Error: " + parser.get_errors().front()->get().message);
  757. }
  758. // TODO: Show all error messages.
  759. _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);
  760. return ERR_PARSE_ERROR;
  761. }
  762. GDScriptAnalyzer analyzer(&parser);
  763. err = analyzer.analyze();
  764. if (err) {
  765. if (EngineDebugger::is_active()) {
  766. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), parser.get_errors().front()->get().line, "Parser Error: " + parser.get_errors().front()->get().message);
  767. }
  768. const List<GDScriptParser::ParserError>::Element *e = parser.get_errors().front();
  769. while (e != nullptr) {
  770. _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);
  771. e = e->next();
  772. }
  773. return ERR_PARSE_ERROR;
  774. }
  775. bool can_run = ScriptServer::is_scripting_enabled() || parser.is_tool();
  776. GDScriptCompiler compiler;
  777. err = compiler.compile(&parser, this, p_keep_state);
  778. #ifdef TOOLS_ENABLED
  779. _update_doc();
  780. #endif
  781. if (err) {
  782. if (can_run) {
  783. if (EngineDebugger::is_active()) {
  784. GDScriptLanguage::get_singleton()->debug_break_parse(_get_debug_path(), compiler.get_error_line(), "Parser Error: " + compiler.get_error());
  785. }
  786. _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);
  787. return ERR_COMPILATION_FAILED;
  788. } else {
  789. return err;
  790. }
  791. }
  792. #ifdef DEBUG_ENABLED
  793. for (const GDScriptWarning &warning : parser.get_warnings()) {
  794. if (EngineDebugger::is_active()) {
  795. Vector<ScriptLanguage::StackInfo> si;
  796. EngineDebugger::get_script_debugger()->send_error("", get_path(), warning.start_line, warning.get_name(), warning.get_message(), false, ERR_HANDLER_WARNING, si);
  797. }
  798. }
  799. #endif
  800. valid = true;
  801. for (KeyValue<StringName, Ref<GDScript>> &E : subclasses) {
  802. _set_subclass_path(E.value, path);
  803. }
  804. _init_rpc_methods_properties();
  805. return OK;
  806. }
  807. ScriptLanguage *GDScript::get_language() const {
  808. return GDScriptLanguage::get_singleton();
  809. }
  810. void GDScript::get_constants(HashMap<StringName, Variant> *p_constants) {
  811. if (p_constants) {
  812. for (const KeyValue<StringName, Variant> &E : constants) {
  813. (*p_constants)[E.key] = E.value;
  814. }
  815. }
  816. }
  817. void GDScript::get_members(HashSet<StringName> *p_members) {
  818. if (p_members) {
  819. for (const StringName &E : members) {
  820. p_members->insert(E);
  821. }
  822. }
  823. }
  824. const Variant GDScript::get_rpc_config() const {
  825. return rpc_config;
  826. }
  827. Variant GDScript::callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  828. GDScript *top = this;
  829. while (top) {
  830. HashMap<StringName, GDScriptFunction *>::Iterator E = top->member_functions.find(p_method);
  831. if (E) {
  832. ERR_FAIL_COND_V_MSG(!E->value->is_static(), Variant(), "Can't call non-static function '" + String(p_method) + "' in script.");
  833. return E->value->call(nullptr, p_args, p_argcount, r_error);
  834. }
  835. top = top->_base;
  836. }
  837. //none found, regular
  838. return Script::callp(p_method, p_args, p_argcount, r_error);
  839. }
  840. bool GDScript::_get(const StringName &p_name, Variant &r_ret) const {
  841. {
  842. const GDScript *top = this;
  843. while (top) {
  844. {
  845. HashMap<StringName, Variant>::ConstIterator E = top->constants.find(p_name);
  846. if (E) {
  847. r_ret = E->value;
  848. return true;
  849. }
  850. }
  851. {
  852. HashMap<StringName, Ref<GDScript>>::ConstIterator E = subclasses.find(p_name);
  853. if (E) {
  854. r_ret = E->value;
  855. return true;
  856. }
  857. }
  858. top = top->_base;
  859. }
  860. if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
  861. r_ret = get_source_code();
  862. return true;
  863. }
  864. }
  865. return false;
  866. }
  867. bool GDScript::_set(const StringName &p_name, const Variant &p_value) {
  868. if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
  869. set_source_code(p_value);
  870. reload();
  871. } else {
  872. return false;
  873. }
  874. return true;
  875. }
  876. void GDScript::_get_property_list(List<PropertyInfo> *p_properties) const {
  877. p_properties->push_back(PropertyInfo(Variant::STRING, "script/source", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  878. }
  879. void GDScript::_bind_methods() {
  880. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "new", &GDScript::_new, MethodInfo("new"));
  881. ClassDB::bind_method(D_METHOD("get_as_byte_code"), &GDScript::get_as_byte_code);
  882. }
  883. Vector<uint8_t> GDScript::get_as_byte_code() const {
  884. return Vector<uint8_t>();
  885. };
  886. // TODO: Fully remove this. There's not this kind of "bytecode" anymore.
  887. Error GDScript::load_byte_code(const String &p_path) {
  888. return ERR_COMPILATION_FAILED;
  889. }
  890. Error GDScript::load_source_code(const String &p_path) {
  891. Vector<uint8_t> sourcef;
  892. Error err;
  893. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);
  894. if (err) {
  895. const char *err_name;
  896. if (err < 0 || err >= ERR_MAX) {
  897. err_name = "(invalid error code)";
  898. } else {
  899. err_name = error_names[err];
  900. }
  901. ERR_FAIL_COND_V_MSG(err, err, "Attempt to open script '" + p_path + "' resulted in error '" + err_name + "'.");
  902. }
  903. uint64_t len = f->get_length();
  904. sourcef.resize(len + 1);
  905. uint8_t *w = sourcef.ptrw();
  906. uint64_t r = f->get_buffer(w, len);
  907. ERR_FAIL_COND_V(r != len, ERR_CANT_OPEN);
  908. w[len] = 0;
  909. String s;
  910. if (s.parse_utf8((const char *)w) != OK) {
  911. 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.");
  912. }
  913. source = s;
  914. path = p_path;
  915. #ifdef TOOLS_ENABLED
  916. source_changed_cache = true;
  917. set_edited(false);
  918. set_last_modified_time(FileAccess::get_modified_time(path));
  919. #endif // TOOLS_ENABLED
  920. return OK;
  921. }
  922. const HashMap<StringName, GDScriptFunction *> &GDScript::debug_get_member_functions() const {
  923. return member_functions;
  924. }
  925. StringName GDScript::debug_get_member_by_index(int p_idx) const {
  926. for (const KeyValue<StringName, MemberInfo> &E : member_indices) {
  927. if (E.value.index == p_idx) {
  928. return E.key;
  929. }
  930. }
  931. return "<error>";
  932. }
  933. Ref<GDScript> GDScript::get_base() const {
  934. return base;
  935. }
  936. bool GDScript::inherits_script(const Ref<Script> &p_script) const {
  937. Ref<GDScript> gd = p_script;
  938. if (gd.is_null()) {
  939. return false;
  940. }
  941. const GDScript *s = this;
  942. while (s) {
  943. if (s == p_script.ptr()) {
  944. return true;
  945. }
  946. s = s->_base;
  947. }
  948. return false;
  949. }
  950. bool GDScript::has_script_signal(const StringName &p_signal) const {
  951. if (_signals.has(p_signal)) {
  952. return true;
  953. }
  954. if (base.is_valid()) {
  955. return base->has_script_signal(p_signal);
  956. }
  957. #ifdef TOOLS_ENABLED
  958. else if (base_cache.is_valid()) {
  959. return base_cache->has_script_signal(p_signal);
  960. }
  961. #endif
  962. return false;
  963. }
  964. void GDScript::_get_script_signal_list(List<MethodInfo> *r_list, bool p_include_base) const {
  965. for (const KeyValue<StringName, Vector<StringName>> &E : _signals) {
  966. MethodInfo mi;
  967. mi.name = E.key;
  968. for (int i = 0; i < E.value.size(); i++) {
  969. PropertyInfo arg;
  970. arg.name = E.value[i];
  971. mi.arguments.push_back(arg);
  972. }
  973. r_list->push_back(mi);
  974. }
  975. if (!p_include_base) {
  976. return;
  977. }
  978. if (base.is_valid()) {
  979. base->get_script_signal_list(r_list);
  980. }
  981. #ifdef TOOLS_ENABLED
  982. else if (base_cache.is_valid()) {
  983. base_cache->get_script_signal_list(r_list);
  984. }
  985. #endif
  986. }
  987. void GDScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
  988. _get_script_signal_list(r_signals, true);
  989. }
  990. String GDScript::_get_gdscript_reference_class_name(const GDScript *p_gdscript) {
  991. ERR_FAIL_NULL_V(p_gdscript, String());
  992. String class_name;
  993. while (p_gdscript) {
  994. if (class_name.is_empty()) {
  995. class_name = p_gdscript->get_script_class_name();
  996. } else {
  997. class_name = p_gdscript->get_script_class_name() + "." + class_name;
  998. }
  999. p_gdscript = p_gdscript->_owner;
  1000. }
  1001. return class_name;
  1002. }
  1003. GDScript::GDScript() :
  1004. script_list(this) {
  1005. #ifdef DEBUG_ENABLED
  1006. {
  1007. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1008. GDScriptLanguage::get_singleton()->script_list.add(&script_list);
  1009. }
  1010. #endif
  1011. }
  1012. void GDScript::_save_orphaned_subclasses() {
  1013. struct ClassRefWithName {
  1014. ObjectID id;
  1015. String fully_qualified_name;
  1016. };
  1017. Vector<ClassRefWithName> weak_subclasses;
  1018. // collect subclasses ObjectID and name
  1019. for (KeyValue<StringName, Ref<GDScript>> &E : subclasses) {
  1020. E.value->_owner = nullptr; //bye, you are no longer owned cause I died
  1021. ClassRefWithName subclass;
  1022. subclass.id = E.value->get_instance_id();
  1023. subclass.fully_qualified_name = E.value->fully_qualified_name;
  1024. weak_subclasses.push_back(subclass);
  1025. }
  1026. // clear subclasses to allow unused subclasses to be deleted
  1027. subclasses.clear();
  1028. // subclasses are also held by constants, clear those as well
  1029. constants.clear();
  1030. // keep orphan subclass only for subclasses that are still in use
  1031. for (int i = 0; i < weak_subclasses.size(); i++) {
  1032. ClassRefWithName subclass = weak_subclasses[i];
  1033. Object *obj = ObjectDB::get_instance(subclass.id);
  1034. if (!obj) {
  1035. continue;
  1036. }
  1037. // subclass is not released
  1038. GDScriptLanguage::get_singleton()->add_orphan_subclass(subclass.fully_qualified_name, subclass.id);
  1039. }
  1040. }
  1041. void GDScript::_init_rpc_methods_properties() {
  1042. // Copy the base rpc methods so we don't mask their IDs.
  1043. rpc_config.clear();
  1044. if (base.is_valid()) {
  1045. rpc_config = base->rpc_config.duplicate();
  1046. }
  1047. GDScript *cscript = this;
  1048. HashMap<StringName, Ref<GDScript>>::Iterator sub_E = subclasses.begin();
  1049. while (cscript) {
  1050. // RPC Methods
  1051. for (KeyValue<StringName, GDScriptFunction *> &E : cscript->member_functions) {
  1052. Variant config = E.value->get_rpc_config();
  1053. if (config.get_type() != Variant::NIL) {
  1054. rpc_config[E.value->get_name()] = config;
  1055. }
  1056. }
  1057. if (cscript != this) {
  1058. ++sub_E;
  1059. }
  1060. if (sub_E) {
  1061. cscript = sub_E->value.ptr();
  1062. } else {
  1063. cscript = nullptr;
  1064. }
  1065. }
  1066. }
  1067. GDScript::~GDScript() {
  1068. {
  1069. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1070. while (SelfList<GDScriptFunctionState> *E = pending_func_states.first()) {
  1071. // Order matters since clearing the stack may already cause
  1072. // the GDSCriptFunctionState to be destroyed and thus removed from the list.
  1073. pending_func_states.remove(E);
  1074. E->self()->_clear_stack();
  1075. }
  1076. }
  1077. for (const KeyValue<StringName, GDScriptFunction *> &E : member_functions) {
  1078. memdelete(E.value);
  1079. }
  1080. if (implicit_initializer) {
  1081. memdelete(implicit_initializer);
  1082. }
  1083. if (implicit_ready) {
  1084. memdelete(implicit_ready);
  1085. }
  1086. if (GDScriptCache::singleton) { // Cache may have been already destroyed at engine shutdown.
  1087. GDScriptCache::remove_script(get_path());
  1088. }
  1089. _save_orphaned_subclasses();
  1090. #ifdef TOOLS_ENABLED
  1091. // Clearing inner class doc, script doc only cleared when the script source deleted.
  1092. if (_owner) {
  1093. _clear_doc();
  1094. }
  1095. #endif
  1096. #ifdef DEBUG_ENABLED
  1097. {
  1098. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1099. GDScriptLanguage::get_singleton()->script_list.remove(&script_list);
  1100. }
  1101. #endif
  1102. }
  1103. //////////////////////////////
  1104. // INSTANCE //
  1105. //////////////////////////////
  1106. bool GDScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  1107. //member
  1108. {
  1109. HashMap<StringName, GDScript::MemberInfo>::Iterator E = script->member_indices.find(p_name);
  1110. if (E) {
  1111. const GDScript::MemberInfo *member = &E->value;
  1112. if (member->setter) {
  1113. const Variant *val = &p_value;
  1114. Callable::CallError err;
  1115. callp(member->setter, &val, 1, err);
  1116. if (err.error == Callable::CallError::CALL_OK) {
  1117. return true; //function exists, call was successful
  1118. } else {
  1119. return false;
  1120. }
  1121. } else {
  1122. if (member->data_type.has_type) {
  1123. if (member->data_type.builtin_type == Variant::ARRAY && member->data_type.has_container_element_type()) {
  1124. // Typed array.
  1125. if (p_value.get_type() == Variant::ARRAY) {
  1126. return VariantInternal::get_array(&members.write[member->index])->typed_assign(p_value);
  1127. } else {
  1128. return false;
  1129. }
  1130. } else if (!member->data_type.is_type(p_value)) {
  1131. // Try conversion
  1132. Callable::CallError ce;
  1133. const Variant *value = &p_value;
  1134. Variant converted;
  1135. Variant::construct(member->data_type.builtin_type, converted, &value, 1, ce);
  1136. if (ce.error == Callable::CallError::CALL_OK) {
  1137. members.write[member->index] = converted;
  1138. return true;
  1139. } else {
  1140. return false;
  1141. }
  1142. }
  1143. }
  1144. members.write[member->index] = p_value;
  1145. }
  1146. return true;
  1147. }
  1148. }
  1149. GDScript *sptr = script.ptr();
  1150. while (sptr) {
  1151. HashMap<StringName, GDScriptFunction *>::Iterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._set);
  1152. if (E) {
  1153. Variant name = p_name;
  1154. const Variant *args[2] = { &name, &p_value };
  1155. Callable::CallError err;
  1156. Variant ret = E->value->call(this, (const Variant **)args, 2, err);
  1157. if (err.error == Callable::CallError::CALL_OK && ret.get_type() == Variant::BOOL && ret.operator bool()) {
  1158. return true;
  1159. }
  1160. }
  1161. sptr = sptr->_base;
  1162. }
  1163. return false;
  1164. }
  1165. bool GDScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  1166. const GDScript *sptr = script.ptr();
  1167. while (sptr) {
  1168. {
  1169. HashMap<StringName, GDScript::MemberInfo>::ConstIterator E = script->member_indices.find(p_name);
  1170. if (E) {
  1171. if (E->value.getter) {
  1172. Callable::CallError err;
  1173. r_ret = const_cast<GDScriptInstance *>(this)->callp(E->value.getter, nullptr, 0, err);
  1174. if (err.error == Callable::CallError::CALL_OK) {
  1175. return true;
  1176. }
  1177. }
  1178. r_ret = members[E->value.index];
  1179. return true; //index found
  1180. }
  1181. }
  1182. {
  1183. const GDScript *sl = sptr;
  1184. while (sl) {
  1185. HashMap<StringName, Variant>::ConstIterator E = sl->constants.find(p_name);
  1186. if (E) {
  1187. r_ret = E->value;
  1188. return true; //index found
  1189. }
  1190. sl = sl->_base;
  1191. }
  1192. }
  1193. {
  1194. // Signals.
  1195. const GDScript *sl = sptr;
  1196. while (sl) {
  1197. HashMap<StringName, Vector<StringName>>::ConstIterator E = sl->_signals.find(p_name);
  1198. if (E) {
  1199. r_ret = Signal(this->owner, E->key);
  1200. return true; //index found
  1201. }
  1202. sl = sl->_base;
  1203. }
  1204. }
  1205. {
  1206. // Methods.
  1207. const GDScript *sl = sptr;
  1208. while (sl) {
  1209. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sl->member_functions.find(p_name);
  1210. if (E) {
  1211. if (sptr->rpc_config.has(p_name)) {
  1212. r_ret = Callable(memnew(GDScriptRPCCallable(this->owner, E->key)));
  1213. } else {
  1214. r_ret = Callable(this->owner, E->key);
  1215. }
  1216. return true; //index found
  1217. }
  1218. sl = sl->_base;
  1219. }
  1220. }
  1221. {
  1222. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get);
  1223. if (E) {
  1224. Variant name = p_name;
  1225. const Variant *args[1] = { &name };
  1226. Callable::CallError err;
  1227. Variant ret = const_cast<GDScriptFunction *>(E->value)->call(const_cast<GDScriptInstance *>(this), (const Variant **)args, 1, err);
  1228. if (err.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1229. r_ret = ret;
  1230. return true;
  1231. }
  1232. }
  1233. }
  1234. sptr = sptr->_base;
  1235. }
  1236. return false;
  1237. }
  1238. Variant::Type GDScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  1239. const GDScript *sptr = script.ptr();
  1240. while (sptr) {
  1241. if (sptr->member_info.has(p_name)) {
  1242. if (r_is_valid) {
  1243. *r_is_valid = true;
  1244. }
  1245. return sptr->member_info[p_name].type;
  1246. }
  1247. sptr = sptr->_base;
  1248. }
  1249. if (r_is_valid) {
  1250. *r_is_valid = false;
  1251. }
  1252. return Variant::NIL;
  1253. }
  1254. void GDScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  1255. // exported members, not done yet!
  1256. const GDScript *sptr = script.ptr();
  1257. List<PropertyInfo> props;
  1258. while (sptr) {
  1259. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get_property_list);
  1260. if (E) {
  1261. Callable::CallError err;
  1262. Variant ret = const_cast<GDScriptFunction *>(E->value)->call(const_cast<GDScriptInstance *>(this), nullptr, 0, err);
  1263. if (err.error == Callable::CallError::CALL_OK) {
  1264. ERR_FAIL_COND_MSG(ret.get_type() != Variant::ARRAY, "Wrong type for _get_property_list, must be an array of dictionaries.");
  1265. Array arr = ret;
  1266. for (int i = 0; i < arr.size(); i++) {
  1267. Dictionary d = arr[i];
  1268. ERR_CONTINUE(!d.has("name"));
  1269. ERR_CONTINUE(!d.has("type"));
  1270. PropertyInfo pinfo;
  1271. pinfo.type = Variant::Type(d["type"].operator int());
  1272. ERR_CONTINUE(pinfo.type < 0 || pinfo.type >= Variant::VARIANT_MAX);
  1273. pinfo.name = d["name"];
  1274. ERR_CONTINUE(pinfo.name.is_empty());
  1275. if (d.has("hint")) {
  1276. pinfo.hint = PropertyHint(d["hint"].operator int());
  1277. }
  1278. if (d.has("hint_string")) {
  1279. pinfo.hint_string = d["hint_string"];
  1280. }
  1281. if (d.has("usage")) {
  1282. pinfo.usage = d["usage"];
  1283. }
  1284. if (d.has("class_name")) {
  1285. pinfo.class_name = d["class_name"];
  1286. }
  1287. props.push_back(pinfo);
  1288. }
  1289. }
  1290. }
  1291. //instance a fake script for editing the values
  1292. Vector<_GDScriptMemberSort> msort;
  1293. for (const KeyValue<StringName, PropertyInfo> &F : sptr->member_info) {
  1294. _GDScriptMemberSort ms;
  1295. ERR_CONTINUE(!sptr->member_indices.has(F.key));
  1296. ms.index = sptr->member_indices[F.key].index;
  1297. ms.name = F.key;
  1298. msort.push_back(ms);
  1299. }
  1300. msort.sort();
  1301. msort.reverse();
  1302. for (int i = 0; i < msort.size(); i++) {
  1303. props.push_front(sptr->member_info[msort[i].name]);
  1304. }
  1305. #ifdef TOOLS_ENABLED
  1306. p_properties->push_back(sptr->get_class_category());
  1307. #endif // TOOLS_ENABLED
  1308. for (const PropertyInfo &prop : props) {
  1309. p_properties->push_back(prop);
  1310. }
  1311. props.clear();
  1312. sptr = sptr->_base;
  1313. }
  1314. }
  1315. bool GDScriptInstance::property_can_revert(const StringName &p_name) const {
  1316. Variant name = p_name;
  1317. const Variant *args[1] = { &name };
  1318. const GDScript *sptr = script.ptr();
  1319. while (sptr) {
  1320. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._property_can_revert);
  1321. if (E) {
  1322. Callable::CallError err;
  1323. Variant ret = E->value->call(const_cast<GDScriptInstance *>(this), args, 1, err);
  1324. if (err.error == Callable::CallError::CALL_OK && ret.get_type() == Variant::BOOL && ret.operator bool()) {
  1325. return true;
  1326. }
  1327. }
  1328. sptr = sptr->_base;
  1329. }
  1330. return false;
  1331. }
  1332. bool GDScriptInstance::property_get_revert(const StringName &p_name, Variant &r_ret) const {
  1333. Variant name = p_name;
  1334. const Variant *args[1] = { &name };
  1335. const GDScript *sptr = script.ptr();
  1336. while (sptr) {
  1337. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._property_get_revert);
  1338. if (E) {
  1339. Callable::CallError err;
  1340. Variant ret = E->value->call(const_cast<GDScriptInstance *>(this), args, 1, err);
  1341. if (err.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1342. r_ret = ret;
  1343. return true;
  1344. }
  1345. }
  1346. sptr = sptr->_base;
  1347. }
  1348. return false;
  1349. }
  1350. void GDScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  1351. const GDScript *sptr = script.ptr();
  1352. while (sptr) {
  1353. for (const KeyValue<StringName, GDScriptFunction *> &E : sptr->member_functions) {
  1354. MethodInfo mi;
  1355. mi.name = E.key;
  1356. for (int i = 0; i < E.value->get_argument_count(); i++) {
  1357. mi.arguments.push_back(PropertyInfo(Variant::NIL, "arg" + itos(i)));
  1358. }
  1359. p_list->push_back(mi);
  1360. }
  1361. sptr = sptr->_base;
  1362. }
  1363. }
  1364. bool GDScriptInstance::has_method(const StringName &p_method) const {
  1365. const GDScript *sptr = script.ptr();
  1366. while (sptr) {
  1367. HashMap<StringName, GDScriptFunction *>::ConstIterator E = sptr->member_functions.find(p_method);
  1368. if (E) {
  1369. return true;
  1370. }
  1371. sptr = sptr->_base;
  1372. }
  1373. return false;
  1374. }
  1375. Variant GDScriptInstance::callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1376. GDScript *sptr = script.ptr();
  1377. if (unlikely(p_method == SNAME("_ready"))) {
  1378. // Call implicit ready first, including for the super classes.
  1379. while (sptr) {
  1380. if (sptr->implicit_ready) {
  1381. sptr->implicit_ready->call(this, nullptr, 0, r_error);
  1382. }
  1383. sptr = sptr->_base;
  1384. }
  1385. // Reset this back for the regular call.
  1386. sptr = script.ptr();
  1387. }
  1388. while (sptr) {
  1389. HashMap<StringName, GDScriptFunction *>::Iterator E = sptr->member_functions.find(p_method);
  1390. if (E) {
  1391. return E->value->call(this, p_args, p_argcount, r_error);
  1392. }
  1393. sptr = sptr->_base;
  1394. }
  1395. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1396. return Variant();
  1397. }
  1398. void GDScriptInstance::notification(int p_notification) {
  1399. //notification is not virtual, it gets called at ALL levels just like in C.
  1400. Variant value = p_notification;
  1401. const Variant *args[1] = { &value };
  1402. GDScript *sptr = script.ptr();
  1403. while (sptr) {
  1404. HashMap<StringName, GDScriptFunction *>::Iterator E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._notification);
  1405. if (E) {
  1406. Callable::CallError err;
  1407. E->value->call(this, args, 1, err);
  1408. if (err.error != Callable::CallError::CALL_OK) {
  1409. //print error about notification call
  1410. }
  1411. }
  1412. sptr = sptr->_base;
  1413. }
  1414. }
  1415. String GDScriptInstance::to_string(bool *r_valid) {
  1416. if (has_method(CoreStringNames::get_singleton()->_to_string)) {
  1417. Callable::CallError ce;
  1418. Variant ret = callp(CoreStringNames::get_singleton()->_to_string, nullptr, 0, ce);
  1419. if (ce.error == Callable::CallError::CALL_OK) {
  1420. if (ret.get_type() != Variant::STRING) {
  1421. if (r_valid) {
  1422. *r_valid = false;
  1423. }
  1424. ERR_FAIL_V_MSG(String(), "Wrong type for " + CoreStringNames::get_singleton()->_to_string + ", must be a String.");
  1425. }
  1426. if (r_valid) {
  1427. *r_valid = true;
  1428. }
  1429. return ret.operator String();
  1430. }
  1431. }
  1432. if (r_valid) {
  1433. *r_valid = false;
  1434. }
  1435. return String();
  1436. }
  1437. Ref<Script> GDScriptInstance::get_script() const {
  1438. return script;
  1439. }
  1440. ScriptLanguage *GDScriptInstance::get_language() {
  1441. return GDScriptLanguage::get_singleton();
  1442. }
  1443. const Variant GDScriptInstance::get_rpc_config() const {
  1444. return script->get_rpc_config();
  1445. }
  1446. void GDScriptInstance::reload_members() {
  1447. #ifdef DEBUG_ENABLED
  1448. Vector<Variant> new_members;
  1449. new_members.resize(script->member_indices.size());
  1450. //pass the values to the new indices
  1451. for (KeyValue<StringName, GDScript::MemberInfo> &E : script->member_indices) {
  1452. if (member_indices_cache.has(E.key)) {
  1453. Variant value = members[member_indices_cache[E.key]];
  1454. new_members.write[E.value.index] = value;
  1455. }
  1456. }
  1457. members.resize(new_members.size()); //resize
  1458. //apply
  1459. members = new_members;
  1460. //pass the values to the new indices
  1461. member_indices_cache.clear();
  1462. for (const KeyValue<StringName, GDScript::MemberInfo> &E : script->member_indices) {
  1463. member_indices_cache[E.key] = E.value.index;
  1464. }
  1465. #endif
  1466. }
  1467. GDScriptInstance::GDScriptInstance() {
  1468. owner = nullptr;
  1469. base_ref_counted = false;
  1470. }
  1471. GDScriptInstance::~GDScriptInstance() {
  1472. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1473. while (SelfList<GDScriptFunctionState> *E = pending_func_states.first()) {
  1474. // Order matters since clearing the stack may already cause
  1475. // the GDSCriptFunctionState to be destroyed and thus removed from the list.
  1476. pending_func_states.remove(E);
  1477. E->self()->_clear_stack();
  1478. }
  1479. if (script.is_valid() && owner) {
  1480. script->instances.erase(owner);
  1481. }
  1482. }
  1483. /************* SCRIPT LANGUAGE **************/
  1484. GDScriptLanguage *GDScriptLanguage::singleton = nullptr;
  1485. String GDScriptLanguage::get_name() const {
  1486. return "GDScript";
  1487. }
  1488. /* LANGUAGE FUNCTIONS */
  1489. void GDScriptLanguage::_add_global(const StringName &p_name, const Variant &p_value) {
  1490. if (globals.has(p_name)) {
  1491. //overwrite existing
  1492. global_array.write[globals[p_name]] = p_value;
  1493. return;
  1494. }
  1495. globals[p_name] = global_array.size();
  1496. global_array.push_back(p_value);
  1497. _global_array = global_array.ptrw();
  1498. }
  1499. void GDScriptLanguage::add_global_constant(const StringName &p_variable, const Variant &p_value) {
  1500. _add_global(p_variable, p_value);
  1501. }
  1502. void GDScriptLanguage::add_named_global_constant(const StringName &p_name, const Variant &p_value) {
  1503. named_globals[p_name] = p_value;
  1504. }
  1505. void GDScriptLanguage::remove_named_global_constant(const StringName &p_name) {
  1506. ERR_FAIL_COND(!named_globals.has(p_name));
  1507. named_globals.erase(p_name);
  1508. }
  1509. void GDScriptLanguage::init() {
  1510. //populate global constants
  1511. int gcc = CoreConstants::get_global_constant_count();
  1512. for (int i = 0; i < gcc; i++) {
  1513. _add_global(StaticCString::create(CoreConstants::get_global_constant_name(i)), CoreConstants::get_global_constant_value(i));
  1514. }
  1515. _add_global(StaticCString::create("PI"), Math_PI);
  1516. _add_global(StaticCString::create("TAU"), Math_TAU);
  1517. _add_global(StaticCString::create("INF"), INFINITY);
  1518. _add_global(StaticCString::create("NAN"), NAN);
  1519. //populate native classes
  1520. List<StringName> class_list;
  1521. ClassDB::get_class_list(&class_list);
  1522. for (const StringName &n : class_list) {
  1523. if (globals.has(n)) {
  1524. continue;
  1525. }
  1526. Ref<GDScriptNativeClass> nc = memnew(GDScriptNativeClass(n));
  1527. _add_global(n, nc);
  1528. }
  1529. //populate singletons
  1530. List<Engine::Singleton> singletons;
  1531. Engine::get_singleton()->get_singletons(&singletons);
  1532. for (const Engine::Singleton &E : singletons) {
  1533. _add_global(E.name, E.ptr);
  1534. }
  1535. #ifdef TESTS_ENABLED
  1536. GDScriptTests::GDScriptTestRunner::handle_cmdline();
  1537. #endif
  1538. }
  1539. String GDScriptLanguage::get_type() const {
  1540. return "GDScript";
  1541. }
  1542. String GDScriptLanguage::get_extension() const {
  1543. return "gd";
  1544. }
  1545. Error GDScriptLanguage::execute_file(const String &p_path) {
  1546. // ??
  1547. return OK;
  1548. }
  1549. void GDScriptLanguage::finish() {
  1550. }
  1551. void GDScriptLanguage::profiling_start() {
  1552. #ifdef DEBUG_ENABLED
  1553. MutexLock lock(this->lock);
  1554. SelfList<GDScriptFunction> *elem = function_list.first();
  1555. while (elem) {
  1556. elem->self()->profile.call_count = 0;
  1557. elem->self()->profile.self_time = 0;
  1558. elem->self()->profile.total_time = 0;
  1559. elem->self()->profile.frame_call_count = 0;
  1560. elem->self()->profile.frame_self_time = 0;
  1561. elem->self()->profile.frame_total_time = 0;
  1562. elem->self()->profile.last_frame_call_count = 0;
  1563. elem->self()->profile.last_frame_self_time = 0;
  1564. elem->self()->profile.last_frame_total_time = 0;
  1565. elem = elem->next();
  1566. }
  1567. profiling = true;
  1568. #endif
  1569. }
  1570. void GDScriptLanguage::profiling_stop() {
  1571. #ifdef DEBUG_ENABLED
  1572. MutexLock lock(this->lock);
  1573. profiling = false;
  1574. #endif
  1575. }
  1576. int GDScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1577. int current = 0;
  1578. #ifdef DEBUG_ENABLED
  1579. MutexLock lock(this->lock);
  1580. SelfList<GDScriptFunction> *elem = function_list.first();
  1581. while (elem) {
  1582. if (current >= p_info_max) {
  1583. break;
  1584. }
  1585. p_info_arr[current].call_count = elem->self()->profile.call_count;
  1586. p_info_arr[current].self_time = elem->self()->profile.self_time;
  1587. p_info_arr[current].total_time = elem->self()->profile.total_time;
  1588. p_info_arr[current].signature = elem->self()->profile.signature;
  1589. elem = elem->next();
  1590. current++;
  1591. }
  1592. #endif
  1593. return current;
  1594. }
  1595. int GDScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1596. int current = 0;
  1597. #ifdef DEBUG_ENABLED
  1598. MutexLock lock(this->lock);
  1599. SelfList<GDScriptFunction> *elem = function_list.first();
  1600. while (elem) {
  1601. if (current >= p_info_max) {
  1602. break;
  1603. }
  1604. if (elem->self()->profile.last_frame_call_count > 0) {
  1605. p_info_arr[current].call_count = elem->self()->profile.last_frame_call_count;
  1606. p_info_arr[current].self_time = elem->self()->profile.last_frame_self_time;
  1607. p_info_arr[current].total_time = elem->self()->profile.last_frame_total_time;
  1608. p_info_arr[current].signature = elem->self()->profile.signature;
  1609. current++;
  1610. }
  1611. elem = elem->next();
  1612. }
  1613. #endif
  1614. return current;
  1615. }
  1616. struct GDScriptDepSort {
  1617. //must support sorting so inheritance works properly (parent must be reloaded first)
  1618. bool operator()(const Ref<GDScript> &A, const Ref<GDScript> &B) const {
  1619. if (A == B) {
  1620. return false; //shouldn't happen but..
  1621. }
  1622. const GDScript *I = B->get_base().ptr();
  1623. while (I) {
  1624. if (I == A.ptr()) {
  1625. // A is a base of B
  1626. return true;
  1627. }
  1628. I = I->get_base().ptr();
  1629. }
  1630. return false; //not a base
  1631. }
  1632. };
  1633. void GDScriptLanguage::reload_all_scripts() {
  1634. #ifdef DEBUG_ENABLED
  1635. print_verbose("GDScript: Reloading all scripts");
  1636. List<Ref<GDScript>> scripts;
  1637. {
  1638. MutexLock lock(this->lock);
  1639. SelfList<GDScript> *elem = script_list.first();
  1640. while (elem) {
  1641. if (elem->self()->get_path().is_resource_file()) {
  1642. print_verbose("GDScript: Found: " + elem->self()->get_path());
  1643. scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
  1644. }
  1645. elem = elem->next();
  1646. }
  1647. }
  1648. //as scripts are going to be reloaded, must proceed without locking here
  1649. scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
  1650. for (Ref<GDScript> &script : scripts) {
  1651. print_verbose("GDScript: Reloading: " + script->get_path());
  1652. script->load_source_code(script->get_path());
  1653. script->reload(true);
  1654. }
  1655. #endif
  1656. }
  1657. void GDScriptLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
  1658. #ifdef DEBUG_ENABLED
  1659. List<Ref<GDScript>> scripts;
  1660. {
  1661. MutexLock lock(this->lock);
  1662. SelfList<GDScript> *elem = script_list.first();
  1663. while (elem) {
  1664. if (elem->self()->get_path().is_resource_file()) {
  1665. scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
  1666. }
  1667. elem = elem->next();
  1668. }
  1669. }
  1670. //when someone asks you why dynamically typed languages are easier to write....
  1671. HashMap<Ref<GDScript>, HashMap<ObjectID, List<Pair<StringName, Variant>>>> to_reload;
  1672. //as scripts are going to be reloaded, must proceed without locking here
  1673. scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
  1674. for (Ref<GDScript> &script : scripts) {
  1675. bool reload = script == p_script || to_reload.has(script->get_base());
  1676. if (!reload) {
  1677. continue;
  1678. }
  1679. to_reload.insert(script, HashMap<ObjectID, List<Pair<StringName, Variant>>>());
  1680. if (!p_soft_reload) {
  1681. //save state and remove script from instances
  1682. HashMap<ObjectID, List<Pair<StringName, Variant>>> &map = to_reload[script];
  1683. while (script->instances.front()) {
  1684. Object *obj = script->instances.front()->get();
  1685. //save instance info
  1686. List<Pair<StringName, Variant>> state;
  1687. if (obj->get_script_instance()) {
  1688. obj->get_script_instance()->get_property_state(state);
  1689. map[obj->get_instance_id()] = state;
  1690. obj->set_script(Variant());
  1691. }
  1692. }
  1693. //same thing for placeholders
  1694. #ifdef TOOLS_ENABLED
  1695. while (script->placeholders.size()) {
  1696. Object *obj = (*script->placeholders.begin())->get_owner();
  1697. //save instance info
  1698. if (obj->get_script_instance()) {
  1699. map.insert(obj->get_instance_id(), List<Pair<StringName, Variant>>());
  1700. List<Pair<StringName, Variant>> &state = map[obj->get_instance_id()];
  1701. obj->get_script_instance()->get_property_state(state);
  1702. obj->set_script(Variant());
  1703. } else {
  1704. // no instance found. Let's remove it so we don't loop forever
  1705. script->placeholders.erase(*script->placeholders.begin());
  1706. }
  1707. }
  1708. #endif
  1709. for (const KeyValue<ObjectID, List<Pair<StringName, Variant>>> &F : script->pending_reload_state) {
  1710. map[F.key] = F.value; //pending to reload, use this one instead
  1711. }
  1712. }
  1713. }
  1714. for (KeyValue<Ref<GDScript>, HashMap<ObjectID, List<Pair<StringName, Variant>>>> &E : to_reload) {
  1715. Ref<GDScript> scr = E.key;
  1716. scr->reload(p_soft_reload);
  1717. //restore state if saved
  1718. for (KeyValue<ObjectID, List<Pair<StringName, Variant>>> &F : E.value) {
  1719. List<Pair<StringName, Variant>> &saved_state = F.value;
  1720. Object *obj = ObjectDB::get_instance(F.key);
  1721. if (!obj) {
  1722. continue;
  1723. }
  1724. if (!p_soft_reload) {
  1725. //clear it just in case (may be a pending reload state)
  1726. obj->set_script(Variant());
  1727. }
  1728. obj->set_script(scr);
  1729. ScriptInstance *script_instance = obj->get_script_instance();
  1730. if (!script_instance) {
  1731. //failed, save reload state for next time if not saved
  1732. if (!scr->pending_reload_state.has(obj->get_instance_id())) {
  1733. scr->pending_reload_state[obj->get_instance_id()] = saved_state;
  1734. }
  1735. continue;
  1736. }
  1737. if (script_instance->is_placeholder() && scr->is_placeholder_fallback_enabled()) {
  1738. PlaceHolderScriptInstance *placeholder = static_cast<PlaceHolderScriptInstance *>(script_instance);
  1739. for (List<Pair<StringName, Variant>>::Element *G = saved_state.front(); G; G = G->next()) {
  1740. placeholder->property_set_fallback(G->get().first, G->get().second);
  1741. }
  1742. } else {
  1743. for (List<Pair<StringName, Variant>>::Element *G = saved_state.front(); G; G = G->next()) {
  1744. script_instance->set(G->get().first, G->get().second);
  1745. }
  1746. }
  1747. scr->pending_reload_state.erase(obj->get_instance_id()); //as it reloaded, remove pending state
  1748. }
  1749. //if instance states were saved, set them!
  1750. }
  1751. #endif
  1752. }
  1753. void GDScriptLanguage::frame() {
  1754. calls = 0;
  1755. #ifdef DEBUG_ENABLED
  1756. if (profiling) {
  1757. MutexLock lock(this->lock);
  1758. SelfList<GDScriptFunction> *elem = function_list.first();
  1759. while (elem) {
  1760. elem->self()->profile.last_frame_call_count = elem->self()->profile.frame_call_count;
  1761. elem->self()->profile.last_frame_self_time = elem->self()->profile.frame_self_time;
  1762. elem->self()->profile.last_frame_total_time = elem->self()->profile.frame_total_time;
  1763. elem->self()->profile.frame_call_count = 0;
  1764. elem->self()->profile.frame_self_time = 0;
  1765. elem->self()->profile.frame_total_time = 0;
  1766. elem = elem->next();
  1767. }
  1768. }
  1769. #endif
  1770. }
  1771. /* EDITOR FUNCTIONS */
  1772. void GDScriptLanguage::get_reserved_words(List<String> *p_words) const {
  1773. // TODO: Add annotations here?
  1774. static const char *_reserved_words[] = {
  1775. // operators
  1776. "and",
  1777. "in",
  1778. "not",
  1779. "or",
  1780. // types and values
  1781. "false",
  1782. "float",
  1783. "int",
  1784. "bool",
  1785. "null",
  1786. "PI",
  1787. "TAU",
  1788. "INF",
  1789. "NAN",
  1790. "self",
  1791. "true",
  1792. "void",
  1793. // functions
  1794. "as",
  1795. "assert",
  1796. "await",
  1797. "breakpoint",
  1798. "class",
  1799. "class_name",
  1800. "extends",
  1801. "is",
  1802. "func",
  1803. "preload",
  1804. "signal",
  1805. "super",
  1806. // var
  1807. "const",
  1808. "enum",
  1809. "static",
  1810. "var",
  1811. // control flow
  1812. "break",
  1813. "continue",
  1814. "if",
  1815. "elif",
  1816. "else",
  1817. "for",
  1818. "pass",
  1819. "return",
  1820. "match",
  1821. "while",
  1822. // These keywords are not implemented currently, but reserved for (potential) future use.
  1823. // We highlight them as keywords to make errors easier to understand.
  1824. "trait",
  1825. "namespace",
  1826. "yield",
  1827. nullptr
  1828. };
  1829. const char **w = _reserved_words;
  1830. while (*w) {
  1831. p_words->push_back(*w);
  1832. w++;
  1833. }
  1834. List<StringName> functions;
  1835. GDScriptUtilityFunctions::get_function_list(&functions);
  1836. for (const StringName &E : functions) {
  1837. p_words->push_back(String(E));
  1838. }
  1839. }
  1840. bool GDScriptLanguage::is_control_flow_keyword(String p_keyword) const {
  1841. return p_keyword == "break" ||
  1842. p_keyword == "continue" ||
  1843. p_keyword == "elif" ||
  1844. p_keyword == "else" ||
  1845. p_keyword == "if" ||
  1846. p_keyword == "for" ||
  1847. p_keyword == "match" ||
  1848. p_keyword == "pass" ||
  1849. p_keyword == "return" ||
  1850. p_keyword == "while";
  1851. }
  1852. bool GDScriptLanguage::handles_global_class_type(const String &p_type) const {
  1853. return p_type == "GDScript";
  1854. }
  1855. String GDScriptLanguage::get_global_class_name(const String &p_path, String *r_base_type, String *r_icon_path) const {
  1856. Vector<uint8_t> sourcef;
  1857. Error err;
  1858. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);
  1859. if (err) {
  1860. return String();
  1861. }
  1862. String source = f->get_as_utf8_string();
  1863. GDScriptParser parser;
  1864. err = parser.parse(source, p_path, false);
  1865. // TODO: Simplify this code by using the analyzer to get full inheritance.
  1866. if (err == OK) {
  1867. const GDScriptParser::ClassNode *c = parser.get_tree();
  1868. if (r_icon_path) {
  1869. if (c->icon_path.is_empty() || c->icon_path.is_absolute_path()) {
  1870. *r_icon_path = c->icon_path;
  1871. } else if (c->icon_path.is_relative_path()) {
  1872. *r_icon_path = p_path.get_base_dir().path_join(c->icon_path).simplify_path();
  1873. }
  1874. }
  1875. if (r_base_type) {
  1876. const GDScriptParser::ClassNode *subclass = c;
  1877. String path = p_path;
  1878. GDScriptParser subparser;
  1879. while (subclass) {
  1880. if (subclass->extends_used) {
  1881. if (!subclass->extends_path.is_empty()) {
  1882. if (subclass->extends.size() == 0) {
  1883. get_global_class_name(subclass->extends_path, r_base_type);
  1884. subclass = nullptr;
  1885. break;
  1886. } else {
  1887. Vector<StringName> extend_classes = subclass->extends;
  1888. Ref<FileAccess> subfile = FileAccess::open(subclass->extends_path, FileAccess::READ);
  1889. if (subfile.is_null()) {
  1890. break;
  1891. }
  1892. String subsource = subfile->get_as_utf8_string();
  1893. if (subsource.is_empty()) {
  1894. break;
  1895. }
  1896. String subpath = subclass->extends_path;
  1897. if (subpath.is_relative_path()) {
  1898. subpath = path.get_base_dir().path_join(subpath).simplify_path();
  1899. }
  1900. if (OK != subparser.parse(subsource, subpath, false)) {
  1901. break;
  1902. }
  1903. path = subpath;
  1904. subclass = subparser.get_tree();
  1905. while (extend_classes.size() > 0) {
  1906. bool found = false;
  1907. for (int i = 0; i < subclass->members.size(); i++) {
  1908. if (subclass->members[i].type != GDScriptParser::ClassNode::Member::CLASS) {
  1909. continue;
  1910. }
  1911. const GDScriptParser::ClassNode *inner_class = subclass->members[i].m_class;
  1912. if (inner_class->identifier->name == extend_classes[0]) {
  1913. extend_classes.remove_at(0);
  1914. found = true;
  1915. subclass = inner_class;
  1916. break;
  1917. }
  1918. }
  1919. if (!found) {
  1920. subclass = nullptr;
  1921. break;
  1922. }
  1923. }
  1924. }
  1925. } else if (subclass->extends.size() == 1) {
  1926. *r_base_type = subclass->extends[0];
  1927. subclass = nullptr;
  1928. } else {
  1929. break;
  1930. }
  1931. } else {
  1932. *r_base_type = "RefCounted";
  1933. subclass = nullptr;
  1934. }
  1935. }
  1936. }
  1937. return c->identifier != nullptr ? String(c->identifier->name) : String();
  1938. }
  1939. return String();
  1940. }
  1941. GDScriptLanguage::GDScriptLanguage() {
  1942. calls = 0;
  1943. ERR_FAIL_COND(singleton);
  1944. singleton = this;
  1945. strings._init = StaticCString::create("_init");
  1946. strings._notification = StaticCString::create("_notification");
  1947. strings._set = StaticCString::create("_set");
  1948. strings._get = StaticCString::create("_get");
  1949. strings._get_property_list = StaticCString::create("_get_property_list");
  1950. strings._property_can_revert = StaticCString::create("_property_can_revert");
  1951. strings._property_get_revert = StaticCString::create("_property_get_revert");
  1952. strings._script_source = StaticCString::create("script/source");
  1953. _debug_parse_err_line = -1;
  1954. _debug_parse_err_file = "";
  1955. profiling = false;
  1956. script_frame_time = 0;
  1957. _debug_call_stack_pos = 0;
  1958. int dmcs = GLOBAL_DEF("debug/settings/gdscript/max_call_stack", 1024);
  1959. 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
  1960. if (EngineDebugger::is_active()) {
  1961. //debugging enabled!
  1962. _debug_max_call_stack = dmcs;
  1963. _call_stack = memnew_arr(CallLevel, _debug_max_call_stack + 1);
  1964. } else {
  1965. _debug_max_call_stack = 0;
  1966. _call_stack = nullptr;
  1967. }
  1968. #ifdef DEBUG_ENABLED
  1969. GLOBAL_DEF("debug/gdscript/warnings/enable", true);
  1970. GLOBAL_DEF("debug/gdscript/warnings/treat_warnings_as_errors", false);
  1971. GLOBAL_DEF("debug/gdscript/warnings/exclude_addons", true);
  1972. for (int i = 0; i < (int)GDScriptWarning::WARNING_MAX; i++) {
  1973. GDScriptWarning::Code code = (GDScriptWarning::Code)i;
  1974. Variant default_enabled = GDScriptWarning::get_default_value(code);
  1975. String path = GDScriptWarning::get_settings_path_from_code(code);
  1976. GLOBAL_DEF(path, default_enabled);
  1977. PropertyInfo property_info = GDScriptWarning::get_property_info(code);
  1978. ProjectSettings::get_singleton()->set_custom_property_info(path, property_info);
  1979. }
  1980. #endif // DEBUG_ENABLED
  1981. }
  1982. GDScriptLanguage::~GDScriptLanguage() {
  1983. if (_call_stack) {
  1984. memdelete_arr(_call_stack);
  1985. }
  1986. // Clear dependencies between scripts, to ensure cyclic references are broken (to avoid leaks at exit).
  1987. SelfList<GDScript> *s = script_list.first();
  1988. while (s) {
  1989. GDScript *script = s->self();
  1990. // This ensures the current script is not released before we can check what's the next one
  1991. // in the list (we can't get the next upfront because we don't know if the reference breaking
  1992. // will cause it -or any other after it, for that matter- to be released so the next one
  1993. // is not the same as before).
  1994. script->reference();
  1995. for (KeyValue<StringName, GDScriptFunction *> &E : script->member_functions) {
  1996. GDScriptFunction *func = E.value;
  1997. for (int i = 0; i < func->argument_types.size(); i++) {
  1998. func->argument_types.write[i].script_type_ref = Ref<Script>();
  1999. }
  2000. func->return_type.script_type_ref = Ref<Script>();
  2001. }
  2002. for (KeyValue<StringName, GDScript::MemberInfo> &E : script->member_indices) {
  2003. E.value.data_type.script_type_ref = Ref<Script>();
  2004. }
  2005. s = s->next();
  2006. script->unreference();
  2007. }
  2008. singleton = nullptr;
  2009. }
  2010. void GDScriptLanguage::add_orphan_subclass(const String &p_qualified_name, const ObjectID &p_subclass) {
  2011. orphan_subclasses[p_qualified_name] = p_subclass;
  2012. }
  2013. Ref<GDScript> GDScriptLanguage::get_orphan_subclass(const String &p_qualified_name) {
  2014. HashMap<String, ObjectID>::Iterator orphan_subclass_element = orphan_subclasses.find(p_qualified_name);
  2015. if (!orphan_subclass_element) {
  2016. return Ref<GDScript>();
  2017. }
  2018. ObjectID orphan_subclass = orphan_subclass_element->value;
  2019. Object *obj = ObjectDB::get_instance(orphan_subclass);
  2020. orphan_subclasses.remove(orphan_subclass_element);
  2021. if (!obj) {
  2022. return Ref<GDScript>();
  2023. }
  2024. return Ref<GDScript>(Object::cast_to<GDScript>(obj));
  2025. }
  2026. /*************** RESOURCE ***************/
  2027. 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) {
  2028. if (r_error) {
  2029. *r_error = ERR_FILE_CANT_OPEN;
  2030. }
  2031. Error err;
  2032. Ref<GDScript> script = GDScriptCache::get_full_script(p_path, err, "", p_cache_mode == CACHE_MODE_IGNORE);
  2033. // TODO: Reintroduce binary and encrypted scripts.
  2034. if (script.is_null()) {
  2035. // Don't fail loading because of parsing error.
  2036. script.instantiate();
  2037. }
  2038. if (r_error) {
  2039. *r_error = OK;
  2040. }
  2041. return script;
  2042. }
  2043. void ResourceFormatLoaderGDScript::get_recognized_extensions(List<String> *p_extensions) const {
  2044. p_extensions->push_back("gd");
  2045. // TODO: Reintroduce binary and encrypted scripts.
  2046. // p_extensions->push_back("gdc");
  2047. // p_extensions->push_back("gde");
  2048. }
  2049. bool ResourceFormatLoaderGDScript::handles_type(const String &p_type) const {
  2050. return (p_type == "Script" || p_type == "GDScript");
  2051. }
  2052. String ResourceFormatLoaderGDScript::get_resource_type(const String &p_path) const {
  2053. String el = p_path.get_extension().to_lower();
  2054. // TODO: Reintroduce binary and encrypted scripts.
  2055. if (el == "gd" /*|| el == "gdc" || el == "gde"*/) {
  2056. return "GDScript";
  2057. }
  2058. return "";
  2059. }
  2060. void ResourceFormatLoaderGDScript::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
  2061. Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::READ);
  2062. ERR_FAIL_COND_MSG(file.is_null(), "Cannot open file '" + p_path + "'.");
  2063. String source = file->get_as_utf8_string();
  2064. if (source.is_empty()) {
  2065. return;
  2066. }
  2067. GDScriptParser parser;
  2068. if (OK != parser.parse(source, p_path, false)) {
  2069. return;
  2070. }
  2071. for (const String &E : parser.get_dependencies()) {
  2072. p_dependencies->push_back(E);
  2073. }
  2074. }
  2075. Error ResourceFormatSaverGDScript::save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags) {
  2076. Ref<GDScript> sqscr = p_resource;
  2077. ERR_FAIL_COND_V(sqscr.is_null(), ERR_INVALID_PARAMETER);
  2078. String source = sqscr->get_source_code();
  2079. {
  2080. Error err;
  2081. Ref<FileAccess> file = FileAccess::open(p_path, FileAccess::WRITE, &err);
  2082. ERR_FAIL_COND_V_MSG(err, err, "Cannot save GDScript file '" + p_path + "'.");
  2083. file->store_string(source);
  2084. if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
  2085. return ERR_CANT_CREATE;
  2086. }
  2087. }
  2088. if (ScriptServer::is_reload_scripts_on_save_enabled()) {
  2089. GDScriptLanguage::get_singleton()->reload_tool_script(p_resource, true);
  2090. }
  2091. return OK;
  2092. }
  2093. void ResourceFormatSaverGDScript::get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const {
  2094. if (Object::cast_to<GDScript>(*p_resource)) {
  2095. p_extensions->push_back("gd");
  2096. }
  2097. }
  2098. bool ResourceFormatSaverGDScript::recognize(const Ref<Resource> &p_resource) const {
  2099. return Object::cast_to<GDScript>(*p_resource) != nullptr;
  2100. }