2
0

gdscript_analyzer.cpp 118 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144
  1. /*************************************************************************/
  2. /* gdscript_analyzer.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "gdscript_analyzer.h"
  31. #include "core/class_db.h"
  32. #include "core/hash_map.h"
  33. #include "core/io/resource_loader.h"
  34. #include "core/project_settings.h"
  35. #include "core/script_language.h"
  36. #include "gdscript.h"
  37. // TODO: Move this to a central location (maybe core?).
  38. static HashMap<StringName, StringName> underscore_map;
  39. static const char *underscore_classes[] = {
  40. "ClassDB",
  41. "Directory",
  42. "Engine",
  43. "File",
  44. "Geometry",
  45. "GodotSharp",
  46. "JSON",
  47. "Marshalls",
  48. "Mutex",
  49. "OS",
  50. "ResourceLoader",
  51. "ResourceSaver",
  52. "Semaphore",
  53. "Thread",
  54. "VisualScriptEditor",
  55. nullptr,
  56. };
  57. static StringName get_real_class_name(const StringName &p_source) {
  58. if (underscore_map.empty()) {
  59. const char **class_name = underscore_classes;
  60. while (*class_name != nullptr) {
  61. underscore_map[*class_name] = String("_") + *class_name;
  62. class_name++;
  63. }
  64. }
  65. if (underscore_map.has(p_source)) {
  66. return underscore_map[p_source];
  67. }
  68. return p_source;
  69. }
  70. void GDScriptAnalyzer::cleanup() {
  71. underscore_map.clear();
  72. }
  73. static GDScriptParser::DataType make_callable_type(const MethodInfo &p_info) {
  74. GDScriptParser::DataType type;
  75. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  76. type.kind = GDScriptParser::DataType::BUILTIN;
  77. type.builtin_type = Variant::CALLABLE;
  78. type.is_constant = true;
  79. type.method_info = p_info;
  80. return type;
  81. }
  82. static GDScriptParser::DataType make_signal_type(const MethodInfo &p_info) {
  83. GDScriptParser::DataType type;
  84. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  85. type.kind = GDScriptParser::DataType::BUILTIN;
  86. type.builtin_type = Variant::SIGNAL;
  87. type.is_constant = true;
  88. type.method_info = p_info;
  89. return type;
  90. }
  91. static GDScriptParser::DataType make_native_meta_type(const StringName &p_class_name) {
  92. GDScriptParser::DataType type;
  93. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  94. type.kind = GDScriptParser::DataType::NATIVE;
  95. type.builtin_type = Variant::OBJECT;
  96. type.is_constant = true;
  97. type.native_type = p_class_name;
  98. type.is_meta_type = true;
  99. return type;
  100. }
  101. static GDScriptParser::DataType make_native_enum_type(const StringName &p_native_class, const StringName &p_enum_name) {
  102. GDScriptParser::DataType type;
  103. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  104. type.kind = GDScriptParser::DataType::ENUM;
  105. type.builtin_type = Variant::OBJECT;
  106. type.is_constant = true;
  107. type.is_meta_type = true;
  108. List<StringName> enum_values;
  109. StringName real_native_name = get_real_class_name(p_native_class);
  110. ClassDB::get_enum_constants(real_native_name, p_enum_name, &enum_values);
  111. for (const List<StringName>::Element *E = enum_values.front(); E != nullptr; E = E->next()) {
  112. type.enum_values[E->get()] = ClassDB::get_integer_constant(real_native_name, E->get());
  113. }
  114. return type;
  115. }
  116. static GDScriptParser::DataType make_builtin_meta_type(Variant::Type p_type) {
  117. GDScriptParser::DataType type;
  118. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  119. type.kind = GDScriptParser::DataType::BUILTIN;
  120. type.builtin_type = p_type;
  121. type.is_constant = true;
  122. type.is_meta_type = true;
  123. return type;
  124. }
  125. Error GDScriptAnalyzer::resolve_inheritance(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  126. if (p_class->base_type.is_set()) {
  127. // Already resolved
  128. return OK;
  129. }
  130. if (p_class == parser->head) {
  131. if (p_class->identifier) {
  132. p_class->fqcn = p_class->identifier->name;
  133. } else {
  134. p_class->fqcn = parser->script_path;
  135. }
  136. } else {
  137. p_class->fqcn = p_class->outer->fqcn + "::" + String(p_class->identifier->name);
  138. }
  139. GDScriptParser::DataType result;
  140. // Set datatype for class.
  141. GDScriptParser::DataType class_type;
  142. class_type.is_constant = true;
  143. class_type.is_meta_type = true;
  144. class_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  145. class_type.kind = GDScriptParser::DataType::CLASS;
  146. class_type.class_type = p_class;
  147. class_type.script_path = parser->script_path;
  148. p_class->set_datatype(class_type);
  149. if (!p_class->extends_used) {
  150. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  151. result.kind = GDScriptParser::DataType::NATIVE;
  152. result.native_type = "Reference";
  153. } else {
  154. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  155. GDScriptParser::DataType base;
  156. int extends_index = 0;
  157. if (!p_class->extends_path.empty()) {
  158. Ref<GDScriptParserRef> parser = get_parser_for(p_class->extends_path);
  159. if (parser.is_null()) {
  160. push_error(vformat(R"(Could not resolve super class path "%s".)", p_class->extends_path), p_class);
  161. return ERR_PARSE_ERROR;
  162. }
  163. Error err = parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  164. if (err != OK) {
  165. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", p_class->extends_path), p_class);
  166. return err;
  167. }
  168. base = parser->get_parser()->head->get_datatype();
  169. } else {
  170. if (p_class->extends.empty()) {
  171. return ERR_PARSE_ERROR;
  172. }
  173. const StringName &name = p_class->extends[extends_index++];
  174. base.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  175. if (ScriptServer::is_global_class(name)) {
  176. String base_path = ScriptServer::get_global_class_path(name);
  177. if (base_path == parser->script_path) {
  178. base = parser->head->get_datatype();
  179. } else {
  180. Ref<GDScriptParserRef> parser = get_parser_for(base_path);
  181. if (parser.is_null()) {
  182. push_error(vformat(R"(Could not resolve super class "%s".)", name), p_class);
  183. return ERR_PARSE_ERROR;
  184. }
  185. Error err = parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  186. if (err != OK) {
  187. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), p_class);
  188. return err;
  189. }
  190. }
  191. } else if (ProjectSettings::get_singleton()->has_autoload(name) && ProjectSettings::get_singleton()->get_autoload(name).is_singleton) {
  192. const ProjectSettings::AutoloadInfo &info = ProjectSettings::get_singleton()->get_autoload(name);
  193. if (info.path.get_extension().to_lower() != ".gd") {
  194. push_error(vformat(R"(Singleton %s is not a GDScript.)", info.name), p_class);
  195. return ERR_PARSE_ERROR;
  196. }
  197. Ref<GDScriptParserRef> parser = get_parser_for(info.path);
  198. if (parser.is_null()) {
  199. push_error(vformat(R"(Could not parse singleton from "%s".)", info.path), p_class);
  200. return ERR_PARSE_ERROR;
  201. }
  202. Error err = parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  203. if (err != OK) {
  204. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), p_class);
  205. return err;
  206. }
  207. } else if (class_exists(name) && ClassDB::can_instance(get_real_class_name(name))) {
  208. base.kind = GDScriptParser::DataType::NATIVE;
  209. base.native_type = name;
  210. } else {
  211. // Look for other classes in script.
  212. GDScriptParser::ClassNode *look_class = p_class;
  213. bool found = false;
  214. while (look_class != nullptr) {
  215. if (look_class->identifier && look_class->identifier->name == name) {
  216. if (!look_class->get_datatype().is_set()) {
  217. Error err = resolve_inheritance(look_class, false);
  218. if (err) {
  219. return err;
  220. }
  221. }
  222. base = look_class->get_datatype();
  223. found = true;
  224. break;
  225. }
  226. if (look_class->members_indices.has(name) && look_class->get_member(name).type == GDScriptParser::ClassNode::Member::CLASS) {
  227. GDScriptParser::ClassNode::Member member = look_class->get_member(name);
  228. if (!member.m_class->get_datatype().is_set()) {
  229. Error err = resolve_inheritance(member.m_class, false);
  230. if (err) {
  231. return err;
  232. }
  233. }
  234. base = member.m_class->get_datatype();
  235. found = true;
  236. break;
  237. }
  238. look_class = look_class->outer;
  239. }
  240. if (!found) {
  241. push_error(vformat(R"(Could not find base class "%s".)", name), p_class);
  242. return ERR_PARSE_ERROR;
  243. }
  244. }
  245. }
  246. for (int index = extends_index; index < p_class->extends.size(); index++) {
  247. if (base.kind != GDScriptParser::DataType::CLASS) {
  248. push_error(R"(Super type "%s" is not a GDScript. Cannot get nested types.)", p_class);
  249. return ERR_PARSE_ERROR;
  250. }
  251. // TODO: Extends could use identifier nodes. That way errors can be pointed out properly and it can be used here.
  252. GDScriptParser::IdentifierNode *id = parser->alloc_node<GDScriptParser::IdentifierNode>();
  253. id->name = p_class->extends[index];
  254. reduce_identifier_from_base(id, &base);
  255. GDScriptParser::DataType id_type = id->get_datatype();
  256. if (!id_type.is_set()) {
  257. push_error(vformat(R"(Could not find type "%s" under base "%s".)", id->name, base.to_string()), p_class);
  258. }
  259. base = id_type;
  260. }
  261. result = base;
  262. }
  263. if (!result.is_set()) {
  264. // TODO: More specific error messages.
  265. push_error(vformat(R"(Could not resolve inheritance for class "%s".)", p_class->identifier == nullptr ? "<main>" : p_class->identifier->name), p_class);
  266. return ERR_PARSE_ERROR;
  267. }
  268. p_class->base_type = result;
  269. class_type.native_type = result.native_type;
  270. p_class->set_datatype(class_type);
  271. if (p_recursive) {
  272. for (int i = 0; i < p_class->members.size(); i++) {
  273. if (p_class->members[i].type == GDScriptParser::ClassNode::Member::CLASS) {
  274. resolve_inheritance(p_class->members[i].m_class, true);
  275. }
  276. }
  277. }
  278. return OK;
  279. }
  280. GDScriptParser::DataType GDScriptAnalyzer::resolve_datatype(GDScriptParser::TypeNode *p_type) {
  281. GDScriptParser::DataType result;
  282. if (p_type == nullptr) {
  283. result.kind = GDScriptParser::DataType::VARIANT;
  284. return result;
  285. }
  286. result.type_source = result.ANNOTATED_EXPLICIT;
  287. result.builtin_type = Variant::OBJECT;
  288. if (p_type->type_chain.empty()) {
  289. // void.
  290. result.kind = GDScriptParser::DataType::BUILTIN;
  291. result.builtin_type = Variant::NIL;
  292. p_type->set_datatype(result);
  293. return result;
  294. }
  295. StringName first = p_type->type_chain[0]->name;
  296. if (first == "Variant") {
  297. result.kind = GDScriptParser::DataType::VARIANT;
  298. if (p_type->type_chain.size() > 1) {
  299. push_error(R"("Variant" type don't contain nested types.)", p_type->type_chain[1]);
  300. return GDScriptParser::DataType();
  301. }
  302. return result;
  303. }
  304. if (first == "Object") {
  305. result.kind = GDScriptParser::DataType::NATIVE;
  306. result.native_type = "Object";
  307. if (p_type->type_chain.size() > 1) {
  308. push_error(R"("Object" type don't contain nested types.)", p_type->type_chain[1]);
  309. return GDScriptParser::DataType();
  310. }
  311. return result;
  312. }
  313. if (GDScriptParser::get_builtin_type(first) < Variant::VARIANT_MAX) {
  314. // Built-in types.
  315. if (p_type->type_chain.size() > 1) {
  316. push_error(R"(Built-in types don't contain nested types.)", p_type->type_chain[1]);
  317. return GDScriptParser::DataType();
  318. }
  319. result.kind = GDScriptParser::DataType::BUILTIN;
  320. result.builtin_type = GDScriptParser::get_builtin_type(first);
  321. } else if (class_exists(first)) {
  322. // Native engine classes.
  323. result.kind = GDScriptParser::DataType::NATIVE;
  324. result.native_type = first;
  325. } else if (ScriptServer::is_global_class(first)) {
  326. if (parser->script_path == ScriptServer::get_global_class_path(first)) {
  327. result = parser->head->get_datatype();
  328. } else {
  329. Ref<GDScriptParserRef> ref = get_parser_for(ScriptServer::get_global_class_path(first));
  330. if (ref->raise_status(GDScriptParserRef::INTERFACE_SOLVED) != OK) {
  331. push_error(vformat(R"(Could not parse global class "%s" from "%s".)", first, ScriptServer::get_global_class_path(first)), p_type);
  332. return GDScriptParser::DataType();
  333. }
  334. result = ref->get_parser()->head->get_datatype();
  335. }
  336. } else if (ProjectSettings::get_singleton()->has_autoload(first) && ProjectSettings::get_singleton()->get_autoload(first).is_singleton) {
  337. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(first);
  338. Ref<GDScriptParserRef> ref = get_parser_for(autoload.path);
  339. if (ref->raise_status(GDScriptParserRef::INTERFACE_SOLVED) != OK) {
  340. push_error(vformat(R"(Could not parse singleton "%s" from "%s".)", first, autoload.path), p_type);
  341. return GDScriptParser::DataType();
  342. }
  343. result = ref->get_parser()->head->get_datatype();
  344. } else if (ClassDB::has_enum(get_real_class_name(parser->current_class->base_type.native_type), first)) {
  345. // Native enum in current class.
  346. result = make_native_enum_type(parser->current_class->base_type.native_type, first);
  347. } else {
  348. // Classes in current scope.
  349. GDScriptParser::ClassNode *script_class = parser->current_class;
  350. bool found = false;
  351. while (!found && script_class != nullptr) {
  352. if (script_class->identifier && script_class->identifier->name == first) {
  353. result = script_class->get_datatype();
  354. found = true;
  355. break;
  356. }
  357. if (script_class->members_indices.has(first)) {
  358. GDScriptParser::ClassNode::Member member = script_class->members[script_class->members_indices[first]];
  359. switch (member.type) {
  360. case GDScriptParser::ClassNode::Member::CLASS:
  361. result = member.m_class->get_datatype();
  362. found = true;
  363. break;
  364. case GDScriptParser::ClassNode::Member::ENUM:
  365. result = member.m_enum->get_datatype();
  366. found = true;
  367. break;
  368. case GDScriptParser::ClassNode::Member::CONSTANT:
  369. if (member.constant->get_datatype().is_meta_type) {
  370. result = member.constant->get_datatype();
  371. found = true;
  372. break;
  373. }
  374. [[fallthrough]];
  375. default:
  376. push_error(vformat(R"("%s" is a %s but does not contain a type.)", first, member.get_type_name()), p_type);
  377. return GDScriptParser::DataType();
  378. }
  379. }
  380. script_class = script_class->outer;
  381. }
  382. }
  383. if (!result.is_set()) {
  384. push_error(vformat(R"("%s" was not found in the current scope.)", first), p_type);
  385. result.kind = GDScriptParser::DataType::VARIANT; // Leave Variant anyway so future type check don't use an unresolved type.
  386. return result;
  387. }
  388. if (p_type->type_chain.size() > 1) {
  389. if (result.kind == GDScriptParser::DataType::CLASS) {
  390. for (int i = 1; i < p_type->type_chain.size(); i++) {
  391. GDScriptParser::DataType base = result;
  392. reduce_identifier_from_base(p_type->type_chain[i], &base);
  393. result = p_type->type_chain[i]->get_datatype();
  394. if (!result.is_set()) {
  395. push_error(vformat(R"(Could not find type "%s" under base "%s".)", p_type->type_chain[i]->name, base.to_string()), p_type->type_chain[1]);
  396. result.kind = GDScriptParser::DataType::VARIANT; // Leave Variant anyway so future type check don't use an unresolved type.
  397. return result;
  398. } else if (!result.is_meta_type) {
  399. push_error(vformat(R"(Member "%s" under base "%s" is not a valid type.)", p_type->type_chain[i]->name, base.to_string()), p_type->type_chain[1]);
  400. result.kind = GDScriptParser::DataType::VARIANT; // Leave Variant anyway so future type check don't use an unresolved type.
  401. return result;
  402. }
  403. }
  404. } else if (result.kind == GDScriptParser::DataType::NATIVE) {
  405. // Only enums allowed for native.
  406. if (ClassDB::has_enum(get_real_class_name(result.native_type), p_type->type_chain[1]->name)) {
  407. if (p_type->type_chain.size() > 2) {
  408. push_error(R"(Enums cannot contain nested types.)", p_type->type_chain[2]);
  409. } else {
  410. result = make_native_enum_type(result.native_type, p_type->type_chain[1]->name);
  411. }
  412. }
  413. } else {
  414. push_error(vformat(R"(Could not find nested type "%s" under base "%s".)", p_type->type_chain[1]->name, result.to_string()), p_type->type_chain[1]);
  415. result.kind = GDScriptParser::DataType::VARIANT; // Leave Variant anyway so future type check don't use an unresolved type.
  416. return result;
  417. }
  418. }
  419. p_type->set_datatype(result);
  420. return result;
  421. }
  422. void GDScriptAnalyzer::resolve_class_interface(GDScriptParser::ClassNode *p_class) {
  423. if (p_class->resolved_interface) {
  424. return;
  425. }
  426. p_class->resolved_interface = true;
  427. GDScriptParser::ClassNode *previous_class = parser->current_class;
  428. parser->current_class = p_class;
  429. for (int i = 0; i < p_class->members.size(); i++) {
  430. GDScriptParser::ClassNode::Member member = p_class->members[i];
  431. switch (member.type) {
  432. case GDScriptParser::ClassNode::Member::VARIABLE: {
  433. GDScriptParser::DataType datatype;
  434. datatype.kind = GDScriptParser::DataType::VARIANT;
  435. datatype.type_source = GDScriptParser::DataType::UNDETECTED;
  436. if (member.variable->initializer != nullptr) {
  437. member.variable->set_datatype(datatype); // Allow recursive usage.
  438. reduce_expression(member.variable->initializer);
  439. datatype = member.variable->initializer->get_datatype();
  440. }
  441. if (member.variable->datatype_specifier != nullptr) {
  442. datatype = resolve_datatype(member.variable->datatype_specifier);
  443. datatype.is_meta_type = false;
  444. if (member.variable->initializer != nullptr) {
  445. if (!is_type_compatible(datatype, member.variable->initializer->get_datatype(), true)) {
  446. push_error(vformat(R"(Value of type "%s" cannot be assigned to a variable of type "%s".)", member.variable->initializer->get_datatype().to_string(), datatype.to_string()), member.variable->initializer);
  447. } else if (datatype.builtin_type == Variant::INT && member.variable->initializer->get_datatype().builtin_type == Variant::FLOAT) {
  448. #ifdef DEBUG_ENABLED
  449. parser->push_warning(member.variable->initializer, GDScriptWarning::NARROWING_CONVERSION);
  450. #endif
  451. }
  452. if (member.variable->initializer->get_datatype().is_variant()) {
  453. // TODO: Warn unsafe assign.
  454. mark_node_unsafe(member.variable->initializer);
  455. }
  456. }
  457. } else if (member.variable->infer_datatype) {
  458. if (member.variable->initializer == nullptr) {
  459. push_error(vformat(R"(Cannot infer the type of "%s" variable because there's no default value.)", member.variable->identifier->name), member.variable->identifier);
  460. } else if (!datatype.is_set() || datatype.has_no_type()) {
  461. push_error(vformat(R"(Cannot infer the type of "%s" variable because the initial value doesn't have a set type.)", member.variable->identifier->name), member.variable->initializer);
  462. } else if (datatype.is_variant()) {
  463. push_error(vformat(R"(Cannot infer the type of "%s" variable because the initial value is Variant. Use explicit "Variant" type if this is intended.)", member.variable->identifier->name), member.variable->initializer);
  464. } else if (datatype.builtin_type == Variant::NIL) {
  465. push_error(vformat(R"(Cannot infer the type of "%s" variable because the initial value is "null".)", member.variable->identifier->name), member.variable->initializer);
  466. }
  467. }
  468. datatype.is_constant = false;
  469. member.variable->set_datatype(datatype);
  470. if (!datatype.has_no_type()) {
  471. // TODO: Move this out into a routine specific to validate annotations.
  472. if (member.variable->export_info.hint == PROPERTY_HINT_TYPE_STRING) {
  473. // @export annotation.
  474. switch (datatype.kind) {
  475. case GDScriptParser::DataType::BUILTIN:
  476. member.variable->export_info.hint_string = Variant::get_type_name(datatype.builtin_type);
  477. break;
  478. case GDScriptParser::DataType::NATIVE:
  479. if (ClassDB::is_parent_class(get_real_class_name(datatype.native_type), "Resource")) {
  480. member.variable->export_info.hint_string = get_real_class_name(datatype.native_type);
  481. } else {
  482. push_error(R"(Export type can only be built-in or a resource.)", member.variable);
  483. }
  484. break;
  485. default:
  486. // TODO: Allow custom user resources.
  487. push_error(R"(Export type can only be built-in or a resource.)", member.variable);
  488. break;
  489. }
  490. }
  491. }
  492. } break;
  493. case GDScriptParser::ClassNode::Member::CONSTANT: {
  494. reduce_expression(member.constant->initializer);
  495. GDScriptParser::DataType datatype = member.constant->get_datatype();
  496. if (member.constant->initializer) {
  497. if (!member.constant->initializer->is_constant) {
  498. push_error(R"(Initializer for a constant must be a constant expression.)", member.constant->initializer);
  499. }
  500. if (member.constant->datatype_specifier != nullptr) {
  501. datatype = resolve_datatype(member.constant->datatype_specifier);
  502. datatype.is_meta_type = false;
  503. if (!is_type_compatible(datatype, member.constant->initializer->get_datatype(), true)) {
  504. push_error(vformat(R"(Value of type "%s" cannot be initialized to constant of type "%s".)", member.constant->initializer->get_datatype().to_string(), datatype.to_string()), member.constant->initializer);
  505. } else if (datatype.builtin_type == Variant::INT && member.constant->initializer->get_datatype().builtin_type == Variant::FLOAT) {
  506. #ifdef DEBUG_ENABLED
  507. parser->push_warning(member.constant->initializer, GDScriptWarning::NARROWING_CONVERSION);
  508. #endif
  509. }
  510. }
  511. }
  512. datatype.is_constant = true;
  513. member.constant->set_datatype(datatype);
  514. } break;
  515. case GDScriptParser::ClassNode::Member::SIGNAL: {
  516. for (int j = 0; j < member.signal->parameters.size(); j++) {
  517. GDScriptParser::DataType signal_type = resolve_datatype(member.signal->parameters[j]->datatype_specifier);
  518. signal_type.is_meta_type = false;
  519. member.signal->parameters[j]->set_datatype(signal_type);
  520. }
  521. // TODO: Make MethodInfo from signal.
  522. GDScriptParser::DataType signal_type;
  523. signal_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  524. signal_type.kind = GDScriptParser::DataType::BUILTIN;
  525. signal_type.builtin_type = Variant::SIGNAL;
  526. member.signal->set_datatype(signal_type);
  527. } break;
  528. case GDScriptParser::ClassNode::Member::ENUM: {
  529. GDScriptParser::DataType enum_type;
  530. enum_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  531. enum_type.kind = GDScriptParser::DataType::ENUM;
  532. enum_type.builtin_type = Variant::DICTIONARY;
  533. enum_type.enum_type = member.m_enum->identifier->name;
  534. enum_type.native_type = p_class->fqcn + "." + member.m_enum->identifier->name;
  535. enum_type.is_meta_type = true;
  536. enum_type.is_constant = true;
  537. for (int j = 0; j < member.m_enum->values.size(); j++) {
  538. enum_type.enum_values[member.m_enum->values[j].identifier->name] = member.m_enum->values[j].value;
  539. }
  540. member.m_enum->set_datatype(enum_type);
  541. } break;
  542. case GDScriptParser::ClassNode::Member::FUNCTION:
  543. resolve_function_signature(member.function);
  544. break;
  545. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  546. break; // Nothing to do, type and value set in parser.
  547. case GDScriptParser::ClassNode::Member::CLASS:
  548. break; // Done later.
  549. case GDScriptParser::ClassNode::Member::UNDEFINED:
  550. ERR_PRINT("Trying to resolve undefined member.");
  551. break;
  552. }
  553. }
  554. // Recurse nested classes.
  555. for (int i = 0; i < p_class->members.size(); i++) {
  556. GDScriptParser::ClassNode::Member member = p_class->members[i];
  557. if (member.type != GDScriptParser::ClassNode::Member::CLASS) {
  558. continue;
  559. }
  560. resolve_class_interface(member.m_class);
  561. }
  562. parser->current_class = previous_class;
  563. }
  564. void GDScriptAnalyzer::resolve_class_body(GDScriptParser::ClassNode *p_class) {
  565. if (p_class->resolved_body) {
  566. return;
  567. }
  568. p_class->resolved_body = true;
  569. GDScriptParser::ClassNode *previous_class = parser->current_class;
  570. parser->current_class = p_class;
  571. // Do functions now.
  572. for (int i = 0; i < p_class->members.size(); i++) {
  573. GDScriptParser::ClassNode::Member member = p_class->members[i];
  574. if (member.type != GDScriptParser::ClassNode::Member::FUNCTION) {
  575. continue;
  576. }
  577. resolve_function_body(member.function);
  578. }
  579. parser->current_class = previous_class;
  580. // Recurse nested classes.
  581. for (int i = 0; i < p_class->members.size(); i++) {
  582. GDScriptParser::ClassNode::Member member = p_class->members[i];
  583. if (member.type != GDScriptParser::ClassNode::Member::CLASS) {
  584. continue;
  585. }
  586. resolve_class_body(member.m_class);
  587. }
  588. // Check unused variables.
  589. for (int i = 0; i < p_class->members.size(); i++) {
  590. GDScriptParser::ClassNode::Member member = p_class->members[i];
  591. if (member.type != GDScriptParser::ClassNode::Member::VARIABLE) {
  592. continue;
  593. }
  594. #ifdef DEBUG_ENABLED
  595. if (member.variable->usages == 0 && String(member.variable->identifier->name).begins_with("_")) {
  596. parser->push_warning(member.variable->identifier, GDScriptWarning::UNUSED_PRIVATE_CLASS_VARIABLE, member.variable->identifier->name);
  597. }
  598. #endif
  599. }
  600. }
  601. void GDScriptAnalyzer::resolve_node(GDScriptParser::Node *p_node) {
  602. ERR_FAIL_COND_MSG(p_node == nullptr, "Trying to resolve type of a null node.");
  603. switch (p_node->type) {
  604. case GDScriptParser::Node::NONE:
  605. break; // Unreachable.
  606. case GDScriptParser::Node::CLASS:
  607. resolve_class_interface(static_cast<GDScriptParser::ClassNode *>(p_node));
  608. resolve_class_body(static_cast<GDScriptParser::ClassNode *>(p_node));
  609. break;
  610. case GDScriptParser::Node::CONSTANT:
  611. resolve_constant(static_cast<GDScriptParser::ConstantNode *>(p_node));
  612. break;
  613. case GDScriptParser::Node::FOR:
  614. resolve_for(static_cast<GDScriptParser::ForNode *>(p_node));
  615. break;
  616. case GDScriptParser::Node::FUNCTION:
  617. resolve_function_signature(static_cast<GDScriptParser::FunctionNode *>(p_node));
  618. resolve_function_body(static_cast<GDScriptParser::FunctionNode *>(p_node));
  619. break;
  620. case GDScriptParser::Node::IF:
  621. resolve_if(static_cast<GDScriptParser::IfNode *>(p_node));
  622. break;
  623. case GDScriptParser::Node::SUITE:
  624. resolve_suite(static_cast<GDScriptParser::SuiteNode *>(p_node));
  625. break;
  626. case GDScriptParser::Node::VARIABLE:
  627. resolve_variable(static_cast<GDScriptParser::VariableNode *>(p_node));
  628. break;
  629. case GDScriptParser::Node::WHILE:
  630. resolve_while(static_cast<GDScriptParser::WhileNode *>(p_node));
  631. break;
  632. case GDScriptParser::Node::ANNOTATION:
  633. resolve_annotation(static_cast<GDScriptParser::AnnotationNode *>(p_node));
  634. break;
  635. case GDScriptParser::Node::ASSERT:
  636. resolve_assert(static_cast<GDScriptParser::AssertNode *>(p_node));
  637. break;
  638. case GDScriptParser::Node::MATCH:
  639. resolve_match(static_cast<GDScriptParser::MatchNode *>(p_node));
  640. break;
  641. case GDScriptParser::Node::MATCH_BRANCH:
  642. resolve_match_branch(static_cast<GDScriptParser::MatchBranchNode *>(p_node), nullptr);
  643. break;
  644. case GDScriptParser::Node::PARAMETER:
  645. resolve_pararameter(static_cast<GDScriptParser::ParameterNode *>(p_node));
  646. break;
  647. case GDScriptParser::Node::PATTERN:
  648. resolve_match_pattern(static_cast<GDScriptParser::PatternNode *>(p_node), nullptr);
  649. break;
  650. case GDScriptParser::Node::RETURN:
  651. resolve_return(static_cast<GDScriptParser::ReturnNode *>(p_node));
  652. break;
  653. case GDScriptParser::Node::TYPE:
  654. resolve_datatype(static_cast<GDScriptParser::TypeNode *>(p_node));
  655. break;
  656. // Resolving expression is the same as reducing them.
  657. case GDScriptParser::Node::ARRAY:
  658. case GDScriptParser::Node::ASSIGNMENT:
  659. case GDScriptParser::Node::AWAIT:
  660. case GDScriptParser::Node::BINARY_OPERATOR:
  661. case GDScriptParser::Node::CALL:
  662. case GDScriptParser::Node::CAST:
  663. case GDScriptParser::Node::DICTIONARY:
  664. case GDScriptParser::Node::GET_NODE:
  665. case GDScriptParser::Node::IDENTIFIER:
  666. case GDScriptParser::Node::LITERAL:
  667. case GDScriptParser::Node::PRELOAD:
  668. case GDScriptParser::Node::SELF:
  669. case GDScriptParser::Node::SUBSCRIPT:
  670. case GDScriptParser::Node::TERNARY_OPERATOR:
  671. case GDScriptParser::Node::UNARY_OPERATOR:
  672. reduce_expression(static_cast<GDScriptParser::ExpressionNode *>(p_node));
  673. break;
  674. case GDScriptParser::Node::BREAK:
  675. case GDScriptParser::Node::BREAKPOINT:
  676. case GDScriptParser::Node::CONTINUE:
  677. case GDScriptParser::Node::ENUM:
  678. case GDScriptParser::Node::PASS:
  679. case GDScriptParser::Node::SIGNAL:
  680. // Nothing to do.
  681. break;
  682. }
  683. }
  684. void GDScriptAnalyzer::resolve_annotation(GDScriptParser::AnnotationNode *p_annotation) {
  685. // TODO: Add second validation function for annotations, so they can use checked types.
  686. }
  687. void GDScriptAnalyzer::resolve_function_signature(GDScriptParser::FunctionNode *p_function) {
  688. if (p_function->resolved_signature) {
  689. return;
  690. }
  691. p_function->resolved_signature = true;
  692. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  693. parser->current_function = p_function;
  694. for (int i = 0; i < p_function->parameters.size(); i++) {
  695. resolve_pararameter(p_function->parameters[i]);
  696. #ifdef DEBUG_ENABLED
  697. if (p_function->parameters[i]->usages == 0 && !String(p_function->parameters[i]->identifier->name).begins_with("_")) {
  698. parser->push_warning(p_function->parameters[i]->identifier, GDScriptWarning::UNUSED_PARAMETER, p_function->identifier->name, p_function->parameters[i]->identifier->name);
  699. }
  700. is_shadowing(p_function->parameters[i]->identifier, "function parameter");
  701. #endif
  702. }
  703. if (p_function->identifier->name == "_init") {
  704. // Constructor.
  705. GDScriptParser::DataType return_type = parser->current_class->get_datatype();
  706. return_type.is_meta_type = false;
  707. p_function->set_datatype(return_type);
  708. if (p_function->return_type) {
  709. push_error("Constructor cannot have an explicit return type.", p_function->return_type);
  710. }
  711. } else {
  712. GDScriptParser::DataType return_type = resolve_datatype(p_function->return_type);
  713. p_function->set_datatype(return_type);
  714. }
  715. parser->current_function = previous_function;
  716. }
  717. void GDScriptAnalyzer::resolve_function_body(GDScriptParser::FunctionNode *p_function) {
  718. if (p_function->resolved_body) {
  719. return;
  720. }
  721. p_function->resolved_body = true;
  722. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  723. parser->current_function = p_function;
  724. resolve_suite(p_function->body);
  725. GDScriptParser::DataType return_type = p_function->body->get_datatype();
  726. if (p_function->get_datatype().has_no_type() && return_type.is_set()) {
  727. // Use the suite inferred type if return isn't explicitly set.
  728. return_type.type_source = GDScriptParser::DataType::INFERRED;
  729. p_function->set_datatype(p_function->body->get_datatype());
  730. } else if (p_function->get_datatype().is_hard_type() && (p_function->get_datatype().kind != GDScriptParser::DataType::BUILTIN || p_function->get_datatype().builtin_type != Variant::NIL)) {
  731. if (!p_function->body->has_return && p_function->identifier->name != GDScriptLanguage::get_singleton()->strings._init) {
  732. push_error(R"(Not all code paths return a value.)", p_function);
  733. }
  734. }
  735. parser->current_function = previous_function;
  736. }
  737. void GDScriptAnalyzer::decide_suite_type(GDScriptParser::Node *p_suite, GDScriptParser::Node *p_statement) {
  738. if (p_statement == nullptr) {
  739. return;
  740. }
  741. switch (p_statement->type) {
  742. case GDScriptParser::Node::IF:
  743. case GDScriptParser::Node::FOR:
  744. case GDScriptParser::Node::MATCH:
  745. case GDScriptParser::Node::PATTERN:
  746. case GDScriptParser::Node::RETURN:
  747. case GDScriptParser::Node::WHILE:
  748. // Use return or nested suite type as this suite type.
  749. if (p_suite->get_datatype().is_set() && (p_suite->get_datatype() != p_statement->get_datatype())) {
  750. // Mixed types.
  751. // TODO: This could use the common supertype instead.
  752. p_suite->datatype.kind = GDScriptParser::DataType::VARIANT;
  753. p_suite->datatype.type_source = GDScriptParser::DataType::UNDETECTED;
  754. } else {
  755. p_suite->set_datatype(p_statement->get_datatype());
  756. }
  757. break;
  758. default:
  759. break;
  760. }
  761. }
  762. void GDScriptAnalyzer::resolve_suite(GDScriptParser::SuiteNode *p_suite) {
  763. for (int i = 0; i < p_suite->statements.size(); i++) {
  764. GDScriptParser::Node *stmt = p_suite->statements[i];
  765. resolve_node(stmt);
  766. decide_suite_type(p_suite, stmt);
  767. }
  768. }
  769. void GDScriptAnalyzer::resolve_if(GDScriptParser::IfNode *p_if) {
  770. reduce_expression(p_if->condition);
  771. resolve_suite(p_if->true_block);
  772. p_if->set_datatype(p_if->true_block->get_datatype());
  773. if (p_if->false_block != nullptr) {
  774. resolve_suite(p_if->false_block);
  775. decide_suite_type(p_if, p_if->false_block);
  776. }
  777. }
  778. void GDScriptAnalyzer::resolve_for(GDScriptParser::ForNode *p_for) {
  779. bool list_resolved = false;
  780. // Optimize constant range() call to not allocate an array.
  781. // Use int, Vector2, Vector3 instead, which also can be used as range iterators.
  782. if (p_for->list && p_for->list->type == GDScriptParser::Node::CALL) {
  783. GDScriptParser::CallNode *call = static_cast<GDScriptParser::CallNode *>(p_for->list);
  784. if (call->callee->type == GDScriptParser::Node::IDENTIFIER) {
  785. GDScriptParser::IdentifierNode *callee = static_cast<GDScriptParser::IdentifierNode *>(call->callee);
  786. if (callee->name == "range") {
  787. list_resolved = true;
  788. if (call->arguments.size() < 1) {
  789. push_error(R"*(Invalid call for "range()" function. Expected at least 1 argument, none given.)*", call->callee);
  790. } else if (call->arguments.size() > 3) {
  791. push_error(vformat(R"*(Invalid call for "range()" function. Expected at most 3 arguments, %d given.)*", call->arguments.size()), call->callee);
  792. } else {
  793. // Now we can optimize it.
  794. bool all_is_constant = true;
  795. Vector<Variant> args;
  796. args.resize(call->arguments.size());
  797. for (int i = 0; i < call->arguments.size(); i++) {
  798. reduce_expression(call->arguments[i]);
  799. if (!call->arguments[i]->is_constant) {
  800. all_is_constant = false;
  801. } else {
  802. args.write[i] = call->arguments[i]->reduced_value;
  803. }
  804. GDScriptParser::DataType arg_type = call->arguments[i]->get_datatype();
  805. if (arg_type.kind != GDScriptParser::DataType::BUILTIN) {
  806. all_is_constant = false;
  807. push_error(vformat(R"*(Invalid argument for "range()" call. Argument %d should be int or float but "%s" was given.)*", i + 1, arg_type.to_string()), call->arguments[i]);
  808. } else if (arg_type.builtin_type != Variant::INT && arg_type.builtin_type != Variant::FLOAT) {
  809. all_is_constant = false;
  810. push_error(vformat(R"*(Invalid argument for "range()" call. Argument %d should be int or float but "%s" was given.)*", i + 1, arg_type.to_string()), call->arguments[i]);
  811. }
  812. }
  813. Variant reduced;
  814. if (all_is_constant) {
  815. switch (args.size()) {
  816. case 1:
  817. reduced = args[0];
  818. break;
  819. case 2:
  820. reduced = Vector2i(args[0], args[1]);
  821. break;
  822. case 3:
  823. reduced = Vector3i(args[0], args[1], args[2]);
  824. break;
  825. }
  826. p_for->list->is_constant = true;
  827. p_for->list->reduced_value = reduced;
  828. }
  829. }
  830. GDScriptParser::DataType list_type;
  831. list_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  832. list_type.kind = GDScriptParser::DataType::BUILTIN;
  833. list_type.builtin_type = Variant::ARRAY;
  834. p_for->list->set_datatype(list_type);
  835. }
  836. }
  837. }
  838. if (!list_resolved) {
  839. resolve_node(p_for->list);
  840. }
  841. // TODO: If list is a typed array, the variable should be an element.
  842. // Also applicable for constant range() (so variable is int or float).
  843. resolve_suite(p_for->loop);
  844. p_for->set_datatype(p_for->loop->get_datatype());
  845. #ifdef DEBUG_ENABLED
  846. if (p_for->variable) {
  847. is_shadowing(p_for->variable, R"("for" iterator variable)");
  848. }
  849. #endif
  850. }
  851. void GDScriptAnalyzer::resolve_while(GDScriptParser::WhileNode *p_while) {
  852. resolve_node(p_while->condition);
  853. resolve_suite(p_while->loop);
  854. p_while->set_datatype(p_while->loop->get_datatype());
  855. }
  856. void GDScriptAnalyzer::resolve_variable(GDScriptParser::VariableNode *p_variable) {
  857. GDScriptParser::DataType type;
  858. type.kind = GDScriptParser::DataType::VARIANT; // By default.
  859. if (p_variable->initializer != nullptr) {
  860. reduce_expression(p_variable->initializer);
  861. type = p_variable->initializer->get_datatype();
  862. if (p_variable->infer_datatype) {
  863. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  864. if (type.has_no_type()) {
  865. push_error(vformat(R"(Could not infer the type of the variable "%s" because the initial value does not have a set type.)", p_variable->identifier->name), p_variable->initializer);
  866. } else if (type.is_variant()) {
  867. push_error(vformat(R"(Could not infer the type of the variable "%s" because the initial value is a variant. Use explicit "Variant" type if this is intended.)", p_variable->identifier->name), p_variable->initializer);
  868. } else if (type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL) {
  869. push_error(vformat(R"(Could not infer the type of the variable "%s" because the initial value is "null".)", p_variable->identifier->name), p_variable->initializer);
  870. }
  871. } else {
  872. type.type_source = GDScriptParser::DataType::INFERRED;
  873. }
  874. #ifdef DEBUG_ENABLED
  875. if (p_variable->initializer->type == GDScriptParser::Node::CALL && type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL) {
  876. parser->push_warning(p_variable->initializer, GDScriptWarning::VOID_ASSIGNMENT, static_cast<GDScriptParser::CallNode *>(p_variable->initializer)->function_name);
  877. }
  878. #endif
  879. }
  880. if (p_variable->datatype_specifier != nullptr) {
  881. type = resolve_datatype(p_variable->datatype_specifier);
  882. type.is_meta_type = false;
  883. if (p_variable->initializer != nullptr) {
  884. if (!is_type_compatible(type, p_variable->initializer->get_datatype(), true)) {
  885. push_error(vformat(R"(Value of type "%s" cannot be assigned to a variable of type "%s".)", p_variable->initializer->get_datatype().to_string(), type.to_string()), p_variable->initializer);
  886. #ifdef DEBUG_ENABLED
  887. } else if (type.builtin_type == Variant::INT && p_variable->initializer->get_datatype().builtin_type == Variant::FLOAT) {
  888. parser->push_warning(p_variable->initializer, GDScriptWarning::NARROWING_CONVERSION);
  889. #endif
  890. }
  891. if (p_variable->initializer->get_datatype().is_variant()) {
  892. // TODO: Warn unsafe assign.
  893. mark_node_unsafe(p_variable->initializer);
  894. }
  895. }
  896. } else if (p_variable->infer_datatype) {
  897. if (type.has_no_type()) {
  898. push_error(vformat(R"(Cannot infer the type of variable "%s" because the initial value doesn't have a set type.)", p_variable->identifier->name), p_variable->identifier);
  899. }
  900. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  901. }
  902. type.is_constant = false;
  903. p_variable->set_datatype(type);
  904. #ifdef DEBUG_ENABLED
  905. if (p_variable->usages == 0 && !String(p_variable->identifier->name).begins_with("_")) {
  906. parser->push_warning(p_variable, GDScriptWarning::UNUSED_VARIABLE, p_variable->identifier->name);
  907. } else if (p_variable->assignments == 0) {
  908. parser->push_warning(p_variable, GDScriptWarning::UNASSIGNED_VARIABLE, p_variable->identifier->name);
  909. }
  910. is_shadowing(p_variable->identifier, "variable");
  911. #endif
  912. }
  913. void GDScriptAnalyzer::resolve_constant(GDScriptParser::ConstantNode *p_constant) {
  914. GDScriptParser::DataType type;
  915. reduce_expression(p_constant->initializer);
  916. if (!p_constant->initializer->is_constant) {
  917. push_error(vformat(R"(Assigned value for constant "%s" isn't a constant expression.)", p_constant->identifier->name), p_constant->initializer);
  918. }
  919. type = p_constant->initializer->get_datatype();
  920. #ifdef DEBUG_ENABLED
  921. if (p_constant->initializer->type == GDScriptParser::Node::CALL && type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL) {
  922. parser->push_warning(p_constant->initializer, GDScriptWarning::VOID_ASSIGNMENT, static_cast<GDScriptParser::CallNode *>(p_constant->initializer)->function_name);
  923. }
  924. #endif
  925. if (p_constant->datatype_specifier != nullptr) {
  926. GDScriptParser::DataType explicit_type = resolve_datatype(p_constant->datatype_specifier);
  927. explicit_type.is_meta_type = false;
  928. if (!is_type_compatible(explicit_type, type)) {
  929. push_error(vformat(R"(Assigned value for constant "%s" has type %s which is not compatible with defined type %s.)", p_constant->identifier->name, type.to_string(), explicit_type.to_string()), p_constant->initializer);
  930. #ifdef DEBUG_ENABLED
  931. } else if (explicit_type.builtin_type == Variant::INT && type.builtin_type == Variant::FLOAT) {
  932. parser->push_warning(p_constant->initializer, GDScriptWarning::NARROWING_CONVERSION);
  933. #endif
  934. }
  935. type = explicit_type;
  936. } else if (p_constant->infer_datatype) {
  937. if (type.has_no_type()) {
  938. push_error(vformat(R"(Cannot infer the type of constant "%s" because the initial value doesn't have a set type.)", p_constant->identifier->name), p_constant->identifier);
  939. }
  940. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  941. }
  942. type.is_constant = true;
  943. p_constant->set_datatype(type);
  944. #ifdef DEBUG_ENABLED
  945. if (p_constant->usages == 0) {
  946. parser->push_warning(p_constant, GDScriptWarning::UNUSED_LOCAL_CONSTANT, p_constant->identifier->name);
  947. }
  948. is_shadowing(p_constant->identifier, "constant");
  949. #endif
  950. }
  951. void GDScriptAnalyzer::resolve_assert(GDScriptParser::AssertNode *p_assert) {
  952. reduce_expression(p_assert->condition);
  953. if (p_assert->message != nullptr) {
  954. reduce_literal(p_assert->message);
  955. }
  956. p_assert->set_datatype(p_assert->condition->get_datatype());
  957. #ifdef DEBUG_ENABLED
  958. if (p_assert->condition->is_constant) {
  959. if (p_assert->condition->reduced_value.booleanize()) {
  960. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_TRUE);
  961. } else {
  962. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_FALSE);
  963. }
  964. }
  965. #endif
  966. }
  967. void GDScriptAnalyzer::resolve_match(GDScriptParser::MatchNode *p_match) {
  968. reduce_expression(p_match->test);
  969. for (int i = 0; i < p_match->branches.size(); i++) {
  970. resolve_match_branch(p_match->branches[i], p_match->test);
  971. decide_suite_type(p_match, p_match->branches[i]);
  972. }
  973. }
  974. void GDScriptAnalyzer::resolve_match_branch(GDScriptParser::MatchBranchNode *p_match_branch, GDScriptParser::ExpressionNode *p_match_test) {
  975. for (int i = 0; i < p_match_branch->patterns.size(); i++) {
  976. resolve_match_pattern(p_match_branch->patterns[i], p_match_test);
  977. }
  978. resolve_suite(p_match_branch->block);
  979. decide_suite_type(p_match_branch, p_match_branch->block);
  980. }
  981. void GDScriptAnalyzer::resolve_match_pattern(GDScriptParser::PatternNode *p_match_pattern, GDScriptParser::ExpressionNode *p_match_test) {
  982. if (p_match_pattern == nullptr) {
  983. return;
  984. }
  985. GDScriptParser::DataType result;
  986. switch (p_match_pattern->pattern_type) {
  987. case GDScriptParser::PatternNode::PT_LITERAL:
  988. if (p_match_pattern->literal) {
  989. reduce_literal(p_match_pattern->literal);
  990. result = p_match_pattern->literal->get_datatype();
  991. }
  992. break;
  993. case GDScriptParser::PatternNode::PT_EXPRESSION:
  994. if (p_match_pattern->expression) {
  995. reduce_expression(p_match_pattern->expression);
  996. if (!p_match_pattern->expression->is_constant) {
  997. push_error(R"(Expression in match pattern must be a constant.)", p_match_pattern->expression);
  998. }
  999. result = p_match_pattern->expression->get_datatype();
  1000. }
  1001. break;
  1002. case GDScriptParser::PatternNode::PT_BIND:
  1003. if (p_match_test != nullptr) {
  1004. result = p_match_test->get_datatype();
  1005. } else {
  1006. result.kind = GDScriptParser::DataType::VARIANT;
  1007. }
  1008. p_match_pattern->bind->set_datatype(result);
  1009. #ifdef DEBUG_ENABLED
  1010. is_shadowing(p_match_pattern->bind, "pattern bind");
  1011. if (p_match_pattern->bind->usages == 0) {
  1012. parser->push_warning(p_match_pattern->bind, GDScriptWarning::UNASSIGNED_VARIABLE, p_match_pattern->bind->name);
  1013. }
  1014. #endif
  1015. break;
  1016. case GDScriptParser::PatternNode::PT_ARRAY:
  1017. for (int i = 0; i < p_match_pattern->array.size(); i++) {
  1018. resolve_match_pattern(p_match_pattern->array[i], nullptr);
  1019. decide_suite_type(p_match_pattern, p_match_pattern->array[i]);
  1020. }
  1021. result = p_match_pattern->get_datatype();
  1022. break;
  1023. case GDScriptParser::PatternNode::PT_DICTIONARY:
  1024. for (int i = 0; i < p_match_pattern->dictionary.size(); i++) {
  1025. if (p_match_pattern->dictionary[i].key) {
  1026. reduce_expression(p_match_pattern->dictionary[i].key);
  1027. if (!p_match_pattern->dictionary[i].key->is_constant) {
  1028. push_error(R"(Expression in dictionary pattern key must be a constant.)", p_match_pattern->expression);
  1029. }
  1030. }
  1031. if (p_match_pattern->dictionary[i].value_pattern) {
  1032. resolve_match_pattern(p_match_pattern->dictionary[i].value_pattern, nullptr);
  1033. decide_suite_type(p_match_pattern, p_match_pattern->dictionary[i].value_pattern);
  1034. }
  1035. }
  1036. result = p_match_pattern->get_datatype();
  1037. break;
  1038. case GDScriptParser::PatternNode::PT_WILDCARD:
  1039. case GDScriptParser::PatternNode::PT_REST:
  1040. result.kind = GDScriptParser::DataType::VARIANT;
  1041. break;
  1042. }
  1043. p_match_pattern->set_datatype(result);
  1044. }
  1045. void GDScriptAnalyzer::resolve_pararameter(GDScriptParser::ParameterNode *p_parameter) {
  1046. GDScriptParser::DataType result;
  1047. result.kind = GDScriptParser::DataType::VARIANT;
  1048. if (p_parameter->default_value != nullptr) {
  1049. reduce_expression(p_parameter->default_value);
  1050. result = p_parameter->default_value->get_datatype();
  1051. result.type_source = GDScriptParser::DataType::INFERRED;
  1052. }
  1053. if (p_parameter->datatype_specifier != nullptr) {
  1054. resolve_datatype(p_parameter->datatype_specifier);
  1055. result = p_parameter->datatype_specifier->get_datatype();
  1056. result.is_meta_type = false;
  1057. if (p_parameter->default_value != nullptr) {
  1058. if (!is_type_compatible(result, p_parameter->default_value->get_datatype())) {
  1059. push_error(vformat(R"(Type of default value for parameter "%s" (%s) is not compatible with paremeter type (%s).)", p_parameter->identifier->name, p_parameter->default_value->get_datatype().to_string(), p_parameter->datatype_specifier->get_datatype().to_string()), p_parameter->default_value);
  1060. } else if (p_parameter->default_value->get_datatype().is_variant()) {
  1061. mark_node_unsafe(p_parameter);
  1062. }
  1063. }
  1064. }
  1065. p_parameter->set_datatype(result);
  1066. }
  1067. void GDScriptAnalyzer::resolve_return(GDScriptParser::ReturnNode *p_return) {
  1068. GDScriptParser::DataType result;
  1069. if (p_return->return_value != nullptr) {
  1070. reduce_expression(p_return->return_value);
  1071. result = p_return->return_value->get_datatype();
  1072. } else {
  1073. // Return type is null by default.
  1074. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1075. result.kind = GDScriptParser::DataType::BUILTIN;
  1076. result.builtin_type = Variant::NIL;
  1077. result.is_constant = true;
  1078. }
  1079. GDScriptParser::DataType function_type = parser->current_function->get_datatype();
  1080. function_type.is_meta_type = false;
  1081. if (function_type.is_hard_type()) {
  1082. if (!is_type_compatible(function_type, result)) {
  1083. // Try other way. Okay but not safe.
  1084. if (!is_type_compatible(result, function_type)) {
  1085. push_error(vformat(R"(Cannot return value of type "%s" because the function return type is "%s".)", result.to_string(), function_type.to_string()), p_return);
  1086. } else {
  1087. // TODO: Add warning.
  1088. mark_node_unsafe(p_return);
  1089. }
  1090. #ifdef DEBUG_ENABLED
  1091. } else if (function_type.builtin_type == Variant::INT && result.builtin_type == Variant::FLOAT) {
  1092. parser->push_warning(p_return, GDScriptWarning::NARROWING_CONVERSION);
  1093. } else if (result.is_variant()) {
  1094. mark_node_unsafe(p_return);
  1095. #endif
  1096. }
  1097. }
  1098. p_return->set_datatype(result);
  1099. }
  1100. void GDScriptAnalyzer::reduce_expression(GDScriptParser::ExpressionNode *p_expression) {
  1101. // This one makes some magic happen.
  1102. if (p_expression == nullptr) {
  1103. return;
  1104. }
  1105. if (p_expression->reduced) {
  1106. // Don't do this more than once.
  1107. return;
  1108. }
  1109. p_expression->reduced = true;
  1110. switch (p_expression->type) {
  1111. case GDScriptParser::Node::ARRAY:
  1112. reduce_array(static_cast<GDScriptParser::ArrayNode *>(p_expression));
  1113. break;
  1114. case GDScriptParser::Node::ASSIGNMENT:
  1115. reduce_assignment(static_cast<GDScriptParser::AssignmentNode *>(p_expression));
  1116. break;
  1117. case GDScriptParser::Node::AWAIT:
  1118. reduce_await(static_cast<GDScriptParser::AwaitNode *>(p_expression));
  1119. break;
  1120. case GDScriptParser::Node::BINARY_OPERATOR:
  1121. reduce_binary_op(static_cast<GDScriptParser::BinaryOpNode *>(p_expression));
  1122. break;
  1123. case GDScriptParser::Node::CALL:
  1124. reduce_call(static_cast<GDScriptParser::CallNode *>(p_expression));
  1125. break;
  1126. case GDScriptParser::Node::CAST:
  1127. reduce_cast(static_cast<GDScriptParser::CastNode *>(p_expression));
  1128. break;
  1129. case GDScriptParser::Node::DICTIONARY:
  1130. reduce_dictionary(static_cast<GDScriptParser::DictionaryNode *>(p_expression));
  1131. break;
  1132. case GDScriptParser::Node::GET_NODE:
  1133. reduce_get_node(static_cast<GDScriptParser::GetNodeNode *>(p_expression));
  1134. break;
  1135. case GDScriptParser::Node::IDENTIFIER:
  1136. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_expression));
  1137. break;
  1138. case GDScriptParser::Node::LITERAL:
  1139. reduce_literal(static_cast<GDScriptParser::LiteralNode *>(p_expression));
  1140. break;
  1141. case GDScriptParser::Node::PRELOAD:
  1142. reduce_preload(static_cast<GDScriptParser::PreloadNode *>(p_expression));
  1143. break;
  1144. case GDScriptParser::Node::SELF:
  1145. reduce_self(static_cast<GDScriptParser::SelfNode *>(p_expression));
  1146. break;
  1147. case GDScriptParser::Node::SUBSCRIPT:
  1148. reduce_subscript(static_cast<GDScriptParser::SubscriptNode *>(p_expression));
  1149. break;
  1150. case GDScriptParser::Node::TERNARY_OPERATOR:
  1151. reduce_ternary_op(static_cast<GDScriptParser::TernaryOpNode *>(p_expression));
  1152. break;
  1153. case GDScriptParser::Node::UNARY_OPERATOR:
  1154. reduce_unary_op(static_cast<GDScriptParser::UnaryOpNode *>(p_expression));
  1155. break;
  1156. // Non-expressions. Here only to make sure new nodes aren't forgotten.
  1157. case GDScriptParser::Node::NONE:
  1158. case GDScriptParser::Node::ANNOTATION:
  1159. case GDScriptParser::Node::ASSERT:
  1160. case GDScriptParser::Node::BREAK:
  1161. case GDScriptParser::Node::BREAKPOINT:
  1162. case GDScriptParser::Node::CLASS:
  1163. case GDScriptParser::Node::CONSTANT:
  1164. case GDScriptParser::Node::CONTINUE:
  1165. case GDScriptParser::Node::ENUM:
  1166. case GDScriptParser::Node::FOR:
  1167. case GDScriptParser::Node::FUNCTION:
  1168. case GDScriptParser::Node::IF:
  1169. case GDScriptParser::Node::MATCH:
  1170. case GDScriptParser::Node::MATCH_BRANCH:
  1171. case GDScriptParser::Node::PARAMETER:
  1172. case GDScriptParser::Node::PASS:
  1173. case GDScriptParser::Node::PATTERN:
  1174. case GDScriptParser::Node::RETURN:
  1175. case GDScriptParser::Node::SIGNAL:
  1176. case GDScriptParser::Node::SUITE:
  1177. case GDScriptParser::Node::TYPE:
  1178. case GDScriptParser::Node::VARIABLE:
  1179. case GDScriptParser::Node::WHILE:
  1180. ERR_FAIL_MSG("Reaching unreachable case");
  1181. }
  1182. }
  1183. void GDScriptAnalyzer::reduce_array(GDScriptParser::ArrayNode *p_array) {
  1184. bool all_is_constant = true;
  1185. for (int i = 0; i < p_array->elements.size(); i++) {
  1186. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  1187. reduce_expression(element);
  1188. all_is_constant = all_is_constant && element->is_constant;
  1189. }
  1190. if (all_is_constant) {
  1191. Array array;
  1192. array.resize(p_array->elements.size());
  1193. for (int i = 0; i < p_array->elements.size(); i++) {
  1194. array[i] = p_array->elements[i]->reduced_value;
  1195. }
  1196. p_array->is_constant = true;
  1197. p_array->reduced_value = array;
  1198. }
  1199. // It's array in any case.
  1200. GDScriptParser::DataType arr_type;
  1201. arr_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1202. arr_type.kind = GDScriptParser::DataType::BUILTIN;
  1203. arr_type.builtin_type = Variant::ARRAY;
  1204. arr_type.is_constant = true;
  1205. p_array->set_datatype(arr_type);
  1206. }
  1207. void GDScriptAnalyzer::reduce_assignment(GDScriptParser::AssignmentNode *p_assignment) {
  1208. reduce_expression(p_assignment->assignee);
  1209. reduce_expression(p_assignment->assigned_value);
  1210. if (p_assignment->assigned_value == nullptr || p_assignment->assignee == nullptr) {
  1211. return;
  1212. }
  1213. if (p_assignment->assignee->get_datatype().is_constant) {
  1214. push_error("Cannot assign a new value to a constant.", p_assignment->assignee);
  1215. }
  1216. Variant::Operator vop = Variant::Operator::OP_EQUAL;
  1217. switch (p_assignment->operation) {
  1218. case GDScriptParser::AssignmentNode::OP_NONE:
  1219. vop = Variant::Operator::OP_EQUAL;
  1220. break;
  1221. case GDScriptParser::AssignmentNode::OP_ADDITION:
  1222. vop = Variant::Operator::OP_ADD;
  1223. break;
  1224. case GDScriptParser::AssignmentNode::OP_SUBTRACTION:
  1225. vop = Variant::Operator::OP_SUBTRACT;
  1226. break;
  1227. case GDScriptParser::AssignmentNode::OP_MULTIPLICATION:
  1228. vop = Variant::Operator::OP_MULTIPLY;
  1229. break;
  1230. case GDScriptParser::AssignmentNode::OP_DIVISION:
  1231. vop = Variant::Operator::OP_DIVIDE;
  1232. break;
  1233. case GDScriptParser::AssignmentNode::OP_MODULO:
  1234. vop = Variant::Operator::OP_MODULE;
  1235. break;
  1236. case GDScriptParser::AssignmentNode::OP_BIT_SHIFT_LEFT:
  1237. vop = Variant::Operator::OP_SHIFT_LEFT;
  1238. break;
  1239. case GDScriptParser::AssignmentNode::OP_BIT_SHIFT_RIGHT:
  1240. vop = Variant::Operator::OP_SHIFT_RIGHT;
  1241. break;
  1242. case GDScriptParser::AssignmentNode::OP_BIT_AND:
  1243. vop = Variant::Operator::OP_BIT_AND;
  1244. break;
  1245. case GDScriptParser::AssignmentNode::OP_BIT_OR:
  1246. vop = Variant::Operator::OP_BIT_OR;
  1247. break;
  1248. case GDScriptParser::AssignmentNode::OP_BIT_XOR:
  1249. vop = Variant::Operator::OP_BIT_XOR;
  1250. break;
  1251. }
  1252. if (!p_assignment->assignee->get_datatype().is_variant() && !p_assignment->assigned_value->get_datatype().is_variant()) {
  1253. bool compatible = true;
  1254. GDScriptParser::DataType op_type = p_assignment->assigned_value->get_datatype();
  1255. if (vop != Variant::OP_EQUAL) {
  1256. op_type = get_operation_type(vop, p_assignment->assignee->get_datatype(), p_assignment->assigned_value->get_datatype(), compatible);
  1257. }
  1258. if (compatible) {
  1259. compatible = is_type_compatible(p_assignment->assignee->get_datatype(), op_type, true);
  1260. if (!compatible) {
  1261. if (p_assignment->assignee->get_datatype().is_hard_type()) {
  1262. push_error(vformat(R"(Cannot assign a value of type "%s" to a target of type "%s".)", p_assignment->assigned_value->get_datatype().to_string(), p_assignment->assignee->get_datatype().to_string()), p_assignment->assigned_value);
  1263. } else {
  1264. // TODO: Warning in this case.
  1265. }
  1266. }
  1267. } else {
  1268. push_error(vformat(R"(Invalid operands "%s" and "%s" for assignment operator.)", p_assignment->assignee->get_datatype().to_string(), p_assignment->assigned_value->get_datatype().to_string()), p_assignment);
  1269. }
  1270. }
  1271. if (p_assignment->assignee->get_datatype().has_no_type() || p_assignment->assigned_value->get_datatype().is_variant()) {
  1272. mark_node_unsafe(p_assignment);
  1273. }
  1274. if (p_assignment->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  1275. // Change source type so it's not wrongly detected later.
  1276. GDScriptParser::IdentifierNode *identifier = static_cast<GDScriptParser::IdentifierNode *>(p_assignment->assignee);
  1277. switch (identifier->source) {
  1278. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE: {
  1279. GDScriptParser::DataType id_type = identifier->variable_source->get_datatype();
  1280. if (!id_type.is_hard_type()) {
  1281. id_type.kind = GDScriptParser::DataType::VARIANT;
  1282. id_type.type_source = GDScriptParser::DataType::UNDETECTED;
  1283. identifier->variable_source->set_datatype(id_type);
  1284. }
  1285. } break;
  1286. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE: {
  1287. GDScriptParser::DataType id_type = identifier->variable_source->get_datatype();
  1288. if (!id_type.is_hard_type()) {
  1289. id_type = p_assignment->assigned_value->get_datatype();
  1290. id_type.type_source = GDScriptParser::DataType::INFERRED;
  1291. id_type.is_constant = false;
  1292. identifier->variable_source->set_datatype(id_type);
  1293. }
  1294. } break;
  1295. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR: {
  1296. GDScriptParser::DataType id_type = identifier->bind_source->get_datatype();
  1297. if (!id_type.is_hard_type()) {
  1298. id_type = p_assignment->assigned_value->get_datatype();
  1299. id_type.type_source = GDScriptParser::DataType::INFERRED;
  1300. id_type.is_constant = false;
  1301. identifier->variable_source->set_datatype(id_type);
  1302. }
  1303. } break;
  1304. default:
  1305. // Nothing to do.
  1306. break;
  1307. }
  1308. }
  1309. GDScriptParser::DataType assignee_type = p_assignment->assignee->get_datatype();
  1310. GDScriptParser::DataType assigned_type = p_assignment->assigned_value->get_datatype();
  1311. #ifdef DEBUG_ENABLED
  1312. if (p_assignment->assigned_value->type == GDScriptParser::Node::CALL && assigned_type.kind == GDScriptParser::DataType::BUILTIN && assigned_type.builtin_type == Variant::NIL) {
  1313. parser->push_warning(p_assignment->assigned_value, GDScriptWarning::VOID_ASSIGNMENT, static_cast<GDScriptParser::CallNode *>(p_assignment->assigned_value)->function_name);
  1314. } else if (assignee_type.is_hard_type() && assignee_type.builtin_type == Variant::INT && assigned_type.builtin_type == Variant::FLOAT) {
  1315. parser->push_warning(p_assignment->assigned_value, GDScriptWarning::NARROWING_CONVERSION);
  1316. }
  1317. #endif
  1318. }
  1319. void GDScriptAnalyzer::reduce_await(GDScriptParser::AwaitNode *p_await) {
  1320. if (p_await->to_await == nullptr) {
  1321. GDScriptParser::DataType await_type;
  1322. await_type.kind = GDScriptParser::DataType::VARIANT;
  1323. p_await->set_datatype(await_type);
  1324. return;
  1325. }
  1326. if (p_await->to_await->type == GDScriptParser::Node::CALL) {
  1327. reduce_call(static_cast<GDScriptParser::CallNode *>(p_await->to_await), true);
  1328. } else {
  1329. reduce_expression(p_await->to_await);
  1330. }
  1331. p_await->is_constant = p_await->to_await->is_constant;
  1332. p_await->reduced_value = p_await->to_await->reduced_value;
  1333. GDScriptParser::DataType awaiting_type = p_await->to_await->get_datatype();
  1334. p_await->set_datatype(awaiting_type);
  1335. #ifdef DEBUG_ENABLED
  1336. if (!awaiting_type.is_coroutine && awaiting_type.builtin_type != Variant::SIGNAL) {
  1337. parser->push_warning(p_await, GDScriptWarning::REDUNDANT_AWAIT);
  1338. }
  1339. #endif
  1340. }
  1341. void GDScriptAnalyzer::reduce_binary_op(GDScriptParser::BinaryOpNode *p_binary_op) {
  1342. reduce_expression(p_binary_op->left_operand);
  1343. if (p_binary_op->operation == GDScriptParser::BinaryOpNode::OP_TYPE_TEST && p_binary_op->right_operand && p_binary_op->right_operand->type == GDScriptParser::Node::IDENTIFIER) {
  1344. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_binary_op->right_operand), true);
  1345. } else {
  1346. reduce_expression(p_binary_op->right_operand);
  1347. }
  1348. // TODO: Right operand must be a valid type with the `is` operator. Need to check here.
  1349. GDScriptParser::DataType left_type;
  1350. if (p_binary_op->left_operand) {
  1351. left_type = p_binary_op->left_operand->get_datatype();
  1352. }
  1353. GDScriptParser::DataType right_type;
  1354. if (p_binary_op->right_operand) {
  1355. right_type = p_binary_op->right_operand->get_datatype();
  1356. }
  1357. if (!left_type.is_set() || !right_type.is_set()) {
  1358. return;
  1359. }
  1360. #ifdef DEBUG_ENABLED
  1361. if (p_binary_op->variant_op == Variant::OP_DIVIDE && left_type.builtin_type == Variant::INT && right_type.builtin_type == Variant::INT) {
  1362. parser->push_warning(p_binary_op, GDScriptWarning::INTEGER_DIVISION);
  1363. }
  1364. #endif
  1365. if (p_binary_op->left_operand->is_constant && p_binary_op->right_operand->is_constant) {
  1366. p_binary_op->is_constant = true;
  1367. if (p_binary_op->variant_op < Variant::OP_MAX) {
  1368. bool valid = false;
  1369. Variant::evaluate(p_binary_op->variant_op, p_binary_op->left_operand->reduced_value, p_binary_op->right_operand->reduced_value, p_binary_op->reduced_value, valid);
  1370. if (!valid) {
  1371. if (p_binary_op->reduced_value.get_type() == Variant::STRING) {
  1372. push_error(vformat(R"(%s in operator %s.)", p_binary_op->reduced_value, Variant::get_operator_name(p_binary_op->variant_op)), p_binary_op);
  1373. } else {
  1374. push_error(vformat(R"(Invalid operands to operator %s, %s and %s.".)",
  1375. Variant::get_operator_name(p_binary_op->variant_op),
  1376. Variant::get_type_name(p_binary_op->left_operand->reduced_value.get_type()),
  1377. Variant::get_type_name(p_binary_op->right_operand->reduced_value.get_type())),
  1378. p_binary_op);
  1379. }
  1380. }
  1381. } else {
  1382. if (p_binary_op->operation == GDScriptParser::BinaryOpNode::OP_TYPE_TEST) {
  1383. GDScriptParser::DataType test_type = right_type;
  1384. test_type.is_meta_type = false;
  1385. if (!is_type_compatible(test_type, p_binary_op->left_operand->get_datatype(), false)) {
  1386. push_error(vformat(R"(Expression is of type "%s" so it can't be of type "%s".)"), p_binary_op->left_operand);
  1387. p_binary_op->reduced_value = false;
  1388. } else {
  1389. p_binary_op->reduced_value = true;
  1390. }
  1391. } else {
  1392. ERR_PRINT("Parser bug: unknown binary operation.");
  1393. }
  1394. }
  1395. p_binary_op->set_datatype(type_from_variant(p_binary_op->reduced_value));
  1396. return;
  1397. }
  1398. GDScriptParser::DataType result;
  1399. if (left_type.is_variant() || right_type.is_variant()) {
  1400. // Cannot infer type because one operand can be anything.
  1401. result.kind = GDScriptParser::DataType::VARIANT;
  1402. mark_node_unsafe(p_binary_op);
  1403. } else {
  1404. if (p_binary_op->variant_op < Variant::OP_MAX) {
  1405. bool valid = false;
  1406. result = get_operation_type(p_binary_op->variant_op, p_binary_op->left_operand->get_datatype(), right_type, valid);
  1407. if (!valid) {
  1408. push_error(vformat(R"(Invalid operands "%s" and "%s" for "%s" operator.)", p_binary_op->left_operand->get_datatype().to_string(), right_type.to_string(), Variant::get_operator_name(p_binary_op->variant_op)), p_binary_op);
  1409. }
  1410. } else {
  1411. if (p_binary_op->operation == GDScriptParser::BinaryOpNode::OP_TYPE_TEST) {
  1412. GDScriptParser::DataType test_type = right_type;
  1413. test_type.is_meta_type = false;
  1414. if (!is_type_compatible(test_type, p_binary_op->left_operand->get_datatype(), false)) {
  1415. // Test reverse as well to consider for subtypes.
  1416. if (!is_type_compatible(p_binary_op->left_operand->get_datatype(), test_type, false)) {
  1417. if (p_binary_op->left_operand->get_datatype().is_hard_type()) {
  1418. push_error(vformat(R"(Expression is of type "%s" so it can't be of type "%s".)", p_binary_op->left_operand->get_datatype().to_string(), test_type.to_string()), p_binary_op->left_operand);
  1419. } else {
  1420. // TODO: Warning.
  1421. mark_node_unsafe(p_binary_op);
  1422. }
  1423. }
  1424. }
  1425. // "is" operator is always a boolean anyway.
  1426. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1427. result.kind = GDScriptParser::DataType::BUILTIN;
  1428. result.builtin_type = Variant::BOOL;
  1429. } else {
  1430. ERR_PRINT("Parser bug: unknown binary operation.");
  1431. }
  1432. }
  1433. }
  1434. p_binary_op->set_datatype(result);
  1435. }
  1436. void GDScriptAnalyzer::reduce_call(GDScriptParser::CallNode *p_call, bool is_await) {
  1437. bool all_is_constant = true;
  1438. for (int i = 0; i < p_call->arguments.size(); i++) {
  1439. reduce_expression(p_call->arguments[i]);
  1440. all_is_constant = all_is_constant && p_call->arguments[i]->is_constant;
  1441. }
  1442. GDScriptParser::DataType call_type;
  1443. if (!p_call->is_super && p_call->callee->type == GDScriptParser::Node::IDENTIFIER) {
  1444. // Call to name directly.
  1445. StringName function_name = p_call->function_name;
  1446. Variant::Type builtin_type = GDScriptParser::get_builtin_type(function_name);
  1447. GDScriptFunctions::Function builtin_function = GDScriptParser::get_builtin_function(function_name);
  1448. if (builtin_type < Variant::VARIANT_MAX) {
  1449. // Is a builtin constructor.
  1450. call_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1451. call_type.kind = GDScriptParser::DataType::BUILTIN;
  1452. call_type.builtin_type = builtin_type;
  1453. if (builtin_type == Variant::OBJECT) {
  1454. call_type.kind = GDScriptParser::DataType::NATIVE;
  1455. call_type.native_type = function_name; // "Object".
  1456. }
  1457. if (all_is_constant) {
  1458. // Construct here.
  1459. Vector<const Variant *> args;
  1460. for (int i = 0; i < p_call->arguments.size(); i++) {
  1461. args.push_back(&(p_call->arguments[i]->reduced_value));
  1462. }
  1463. Callable::CallError err;
  1464. Variant value = Variant::construct(builtin_type, (const Variant **)args.ptr(), args.size(), err);
  1465. switch (err.error) {
  1466. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  1467. push_error(vformat(R"(Invalid argument for %s constructor: argument %d should be %s but is %s.)", Variant::get_type_name(builtin_type), err.argument + 1,
  1468. Variant::get_type_name(Variant::Type(err.expected)), p_call->arguments[err.argument]->get_datatype().to_string()),
  1469. p_call->arguments[err.argument]);
  1470. break;
  1471. case Callable::CallError::CALL_ERROR_INVALID_METHOD: {
  1472. String signature = Variant::get_type_name(builtin_type) + "(";
  1473. for (int i = 0; i < p_call->arguments.size(); i++) {
  1474. if (i > 0) {
  1475. signature += ", ";
  1476. }
  1477. signature += p_call->arguments[i]->get_datatype().to_string();
  1478. }
  1479. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call->callee);
  1480. } break;
  1481. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  1482. push_error(vformat(R"(Too many arguments for %s constructor. Received %d but expected %d.)", Variant::get_type_name(builtin_type), p_call->arguments.size(), err.expected), p_call);
  1483. break;
  1484. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  1485. push_error(vformat(R"(Too few arguments for %s constructor. Received %d but expected %d.)", Variant::get_type_name(builtin_type), p_call->arguments.size(), err.expected), p_call);
  1486. break;
  1487. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  1488. break; // Can't happen in a builtin constructor.
  1489. case Callable::CallError::CALL_OK:
  1490. p_call->is_constant = true;
  1491. p_call->reduced_value = value;
  1492. break;
  1493. }
  1494. } else {
  1495. // TODO: Check constructors without constants.
  1496. // If there's one argument, try to use copy constructor (those aren't explicitly defined).
  1497. if (p_call->arguments.size() == 1) {
  1498. GDScriptParser::DataType arg_type = p_call->arguments[0]->get_datatype();
  1499. if (arg_type.is_variant()) {
  1500. mark_node_unsafe(p_call->arguments[0]);
  1501. } else {
  1502. if (arg_type.kind == GDScriptParser::DataType::BUILTIN && arg_type.builtin_type == builtin_type) {
  1503. // Okay.
  1504. p_call->set_datatype(call_type);
  1505. return;
  1506. }
  1507. }
  1508. }
  1509. List<MethodInfo> constructors;
  1510. Variant::get_constructor_list(builtin_type, &constructors);
  1511. bool match = false;
  1512. for (const List<MethodInfo>::Element *E = constructors.front(); E != nullptr; E = E->next()) {
  1513. const MethodInfo &info = E->get();
  1514. if (p_call->arguments.size() < info.arguments.size() - info.default_arguments.size()) {
  1515. continue;
  1516. }
  1517. if (p_call->arguments.size() > info.arguments.size()) {
  1518. continue;
  1519. }
  1520. bool types_match = true;
  1521. for (int i = 0; i < p_call->arguments.size(); i++) {
  1522. GDScriptParser::DataType par_type = type_from_property(info.arguments[i]);
  1523. if (!is_type_compatible(par_type, p_call->arguments[i]->get_datatype())) {
  1524. types_match = false;
  1525. break;
  1526. #ifdef DEBUG_ENABLED
  1527. } else {
  1528. if (par_type.builtin_type == Variant::INT && p_call->arguments[i]->get_datatype().builtin_type == Variant::FLOAT) {
  1529. parser->push_warning(p_call, GDScriptWarning::NARROWING_CONVERSION, p_call->function_name);
  1530. }
  1531. #endif
  1532. }
  1533. }
  1534. if (types_match) {
  1535. match = true;
  1536. call_type = type_from_property(info.return_val);
  1537. break;
  1538. }
  1539. }
  1540. if (!match) {
  1541. String signature = Variant::get_type_name(builtin_type) + "(";
  1542. for (int i = 0; i < p_call->arguments.size(); i++) {
  1543. if (i > 0) {
  1544. signature += ", ";
  1545. }
  1546. signature += p_call->arguments[i]->get_datatype().to_string();
  1547. }
  1548. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call);
  1549. }
  1550. }
  1551. p_call->set_datatype(call_type);
  1552. return;
  1553. } else if (builtin_function < GDScriptFunctions::FUNC_MAX) {
  1554. MethodInfo function_info = GDScriptFunctions::get_info(builtin_function);
  1555. if (all_is_constant && GDScriptFunctions::is_deterministic(builtin_function)) {
  1556. // Can call on compilation.
  1557. Vector<const Variant *> args;
  1558. for (int i = 0; i < p_call->arguments.size(); i++) {
  1559. args.push_back(&(p_call->arguments[i]->reduced_value));
  1560. }
  1561. Variant value;
  1562. Callable::CallError err;
  1563. GDScriptFunctions::call(builtin_function, (const Variant **)args.ptr(), args.size(), value, err);
  1564. switch (err.error) {
  1565. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  1566. PropertyInfo wrong_arg = function_info.arguments[err.argument];
  1567. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be %s but is %s.)*", GDScriptFunctions::get_func_name(builtin_function), err.argument + 1,
  1568. type_from_property(wrong_arg).to_string(), p_call->arguments[err.argument]->get_datatype().to_string()),
  1569. p_call->arguments[err.argument]);
  1570. } break;
  1571. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  1572. push_error(vformat(R"(Invalid call for function "%s".)", GDScriptFunctions::get_func_name(builtin_function)), p_call);
  1573. break;
  1574. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  1575. push_error(vformat(R"*(Too many arguments for "%s()" call. Expected at most %d but received %d.)*", GDScriptFunctions::get_func_name(builtin_function), err.expected, p_call->arguments.size()), p_call);
  1576. break;
  1577. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  1578. push_error(vformat(R"*(Too few arguments for "%s()" call. Expected at least %d but received %d.)*", GDScriptFunctions::get_func_name(builtin_function), err.expected, p_call->arguments.size()), p_call);
  1579. break;
  1580. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  1581. break; // Can't happen in a builtin constructor.
  1582. case Callable::CallError::CALL_OK:
  1583. p_call->is_constant = true;
  1584. p_call->reduced_value = value;
  1585. break;
  1586. }
  1587. } else {
  1588. validate_call_arg(function_info, p_call);
  1589. }
  1590. p_call->set_datatype(type_from_property(function_info.return_val));
  1591. return;
  1592. }
  1593. }
  1594. GDScriptParser::DataType base_type;
  1595. call_type.kind = GDScriptParser::DataType::VARIANT;
  1596. bool is_self = false;
  1597. if (p_call->is_super) {
  1598. base_type = parser->current_class->base_type;
  1599. is_self = true;
  1600. } else if (p_call->callee->type == GDScriptParser::Node::IDENTIFIER) {
  1601. base_type = parser->current_class->get_datatype();
  1602. is_self = true;
  1603. } else if (p_call->callee->type == GDScriptParser::Node::SUBSCRIPT) {
  1604. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee);
  1605. if (!subscript->is_attribute) {
  1606. // Invalid call. Error already sent in parser.
  1607. // TODO: Could check if Callable here.
  1608. p_call->set_datatype(call_type);
  1609. mark_node_unsafe(p_call);
  1610. return;
  1611. }
  1612. reduce_expression(subscript->base);
  1613. base_type = subscript->base->get_datatype();
  1614. } else {
  1615. // Invalid call. Error already sent in parser.
  1616. // TODO: Could check if Callable here too.
  1617. p_call->set_datatype(call_type);
  1618. mark_node_unsafe(p_call);
  1619. return;
  1620. }
  1621. bool is_static = false;
  1622. bool is_vararg = false;
  1623. int default_arg_count = 0;
  1624. GDScriptParser::DataType return_type;
  1625. List<GDScriptParser::DataType> par_types;
  1626. if (get_function_signature(p_call, base_type, p_call->function_name, return_type, par_types, default_arg_count, is_static, is_vararg)) {
  1627. validate_call_arg(par_types, default_arg_count, is_vararg, p_call);
  1628. if (is_self && parser->current_function != nullptr && parser->current_function->is_static && !is_static) {
  1629. push_error(vformat(R"*(Cannot call non-static function "%s()" from static function "%s()".)*", p_call->function_name, parser->current_function->identifier->name), p_call->callee);
  1630. }
  1631. call_type = return_type;
  1632. } else {
  1633. // Check if the name exists as something else.
  1634. bool found = false;
  1635. if (!p_call->is_super) {
  1636. GDScriptParser::IdentifierNode *callee_id;
  1637. if (p_call->callee->type == GDScriptParser::Node::IDENTIFIER) {
  1638. callee_id = static_cast<GDScriptParser::IdentifierNode *>(p_call->callee);
  1639. } else {
  1640. // Can only be attribute.
  1641. callee_id = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee)->attribute;
  1642. }
  1643. if (callee_id) {
  1644. reduce_identifier_from_base(callee_id, &base_type);
  1645. GDScriptParser::DataType callee_type = callee_id->get_datatype();
  1646. if (callee_type.is_set() && !callee_type.is_variant()) {
  1647. found = true;
  1648. if (callee_type.builtin_type == Variant::CALLABLE) {
  1649. push_error(vformat(R"*(Name "%s" is a Callable. You can call it with "%s.call()" instead.)*", p_call->function_name, p_call->function_name), p_call->callee);
  1650. } else {
  1651. push_error(vformat(R"*(Name "%s" called as a function but is a "%s".)*", p_call->function_name, callee_type.to_string()), p_call->callee);
  1652. }
  1653. #ifdef DEBUG_ENABLED
  1654. } else if (!is_self) {
  1655. parser->push_warning(p_call, GDScriptWarning::UNSAFE_METHOD_ACCESS, p_call->function_name, base_type.to_string());
  1656. mark_node_unsafe(p_call);
  1657. #endif
  1658. }
  1659. }
  1660. }
  1661. if (!found && is_self) {
  1662. String base_name = is_self && !p_call->is_super ? "self" : base_type.to_string();
  1663. push_error(vformat(R"*(Function "%s()" not found in base %s.)*", p_call->function_name, base_name), p_call->is_super ? p_call : p_call->callee);
  1664. }
  1665. }
  1666. if (call_type.is_coroutine && !is_await) {
  1667. push_error(vformat(R"*(Function "%s()" is a coroutine, so it must be called with "await".)*", p_call->function_name), p_call->callee);
  1668. }
  1669. p_call->set_datatype(call_type);
  1670. }
  1671. void GDScriptAnalyzer::reduce_cast(GDScriptParser::CastNode *p_cast) {
  1672. reduce_expression(p_cast->operand);
  1673. GDScriptParser::DataType cast_type = resolve_datatype(p_cast->cast_type);
  1674. if (!cast_type.is_set()) {
  1675. return;
  1676. }
  1677. cast_type.is_meta_type = false; // The casted value won't be a type name.
  1678. p_cast->set_datatype(cast_type);
  1679. if (!cast_type.is_variant()) {
  1680. GDScriptParser::DataType op_type = p_cast->operand->get_datatype();
  1681. if (!op_type.is_variant()) {
  1682. bool valid = false;
  1683. if (op_type.kind == GDScriptParser::DataType::BUILTIN && cast_type.kind == GDScriptParser::DataType::BUILTIN) {
  1684. valid = Variant::can_convert(op_type.builtin_type, cast_type.builtin_type);
  1685. } else if (op_type.kind != GDScriptParser::DataType::BUILTIN && cast_type.kind != GDScriptParser::DataType::BUILTIN) {
  1686. valid = is_type_compatible(cast_type, op_type) || is_type_compatible(op_type, cast_type);
  1687. }
  1688. if (!valid) {
  1689. push_error(vformat(R"(Invalid cast. Cannot convert from "%s" to "%s".)", op_type.to_string(), cast_type.to_string()), p_cast->cast_type);
  1690. }
  1691. }
  1692. } else {
  1693. mark_node_unsafe(p_cast);
  1694. }
  1695. #ifdef DEBUG_ENABLED
  1696. if (p_cast->operand->get_datatype().is_variant()) {
  1697. parser->push_warning(p_cast, GDScriptWarning::UNSAFE_CAST, cast_type.to_string());
  1698. mark_node_unsafe(p_cast);
  1699. }
  1700. #endif
  1701. // TODO: Perform cast on constants.
  1702. }
  1703. void GDScriptAnalyzer::reduce_dictionary(GDScriptParser::DictionaryNode *p_dictionary) {
  1704. bool all_is_constant = true;
  1705. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  1706. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  1707. if (p_dictionary->style == GDScriptParser::DictionaryNode::PYTHON_DICT) {
  1708. reduce_expression(element.key);
  1709. }
  1710. reduce_expression(element.value);
  1711. all_is_constant = all_is_constant && element.key->is_constant && element.value->is_constant;
  1712. }
  1713. if (all_is_constant) {
  1714. Dictionary dict;
  1715. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  1716. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  1717. dict[element.key->reduced_value] = element.value->reduced_value;
  1718. }
  1719. p_dictionary->is_constant = true;
  1720. p_dictionary->reduced_value = dict;
  1721. }
  1722. // It's dictionary in any case.
  1723. GDScriptParser::DataType dict_type;
  1724. dict_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1725. dict_type.kind = GDScriptParser::DataType::BUILTIN;
  1726. dict_type.builtin_type = Variant::DICTIONARY;
  1727. dict_type.is_constant = true;
  1728. p_dictionary->set_datatype(dict_type);
  1729. }
  1730. void GDScriptAnalyzer::reduce_get_node(GDScriptParser::GetNodeNode *p_get_node) {
  1731. GDScriptParser::DataType result;
  1732. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1733. result.kind = GDScriptParser::DataType::NATIVE;
  1734. result.native_type = "Node";
  1735. result.builtin_type = Variant::OBJECT;
  1736. if (!ClassDB::is_parent_class(get_real_class_name(parser->current_class->base_type.native_type), result.native_type)) {
  1737. push_error(R"*(Cannot use shorthand "get_node()" notation ("$") on a class that isn't a node.)*", p_get_node);
  1738. }
  1739. p_get_node->set_datatype(result);
  1740. }
  1741. GDScriptParser::DataType GDScriptAnalyzer::make_global_class_meta_type(const StringName &p_class_name) {
  1742. Ref<GDScriptParserRef> ref = get_parser_for(ScriptServer::get_global_class_path(p_class_name));
  1743. ref->raise_status(GDScriptParserRef::INTERFACE_SOLVED);
  1744. GDScriptParser::DataType type;
  1745. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1746. type.kind = GDScriptParser::DataType::CLASS;
  1747. type.builtin_type = Variant::OBJECT;
  1748. type.native_type = ScriptServer::get_global_class_native_base(p_class_name);
  1749. type.class_type = ref->get_parser()->head;
  1750. type.script_path = ref->get_parser()->script_path;
  1751. type.is_constant = true;
  1752. type.is_meta_type = true;
  1753. return type;
  1754. }
  1755. void GDScriptAnalyzer::reduce_identifier_from_base(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType *p_base) {
  1756. GDScriptParser::DataType base;
  1757. if (p_base == nullptr) {
  1758. base = type_from_metatype(parser->current_class->get_datatype());
  1759. } else {
  1760. base = *p_base;
  1761. }
  1762. const StringName &name = p_identifier->name;
  1763. if (base.kind == GDScriptParser::DataType::BUILTIN) {
  1764. if (base.is_meta_type) {
  1765. bool valid = true;
  1766. Variant result = Variant::get_constant_value(base.builtin_type, name, &valid);
  1767. if (valid) {
  1768. p_identifier->is_constant = true;
  1769. p_identifier->reduced_value = result;
  1770. p_identifier->set_datatype(type_from_variant(result));
  1771. } else {
  1772. push_error(vformat(R"(Cannot find constant "%s" on type "%s".)", name, base.to_string()), p_identifier);
  1773. }
  1774. } else {
  1775. Callable::CallError temp;
  1776. Variant dummy = Variant::construct(base.builtin_type, nullptr, 0, temp);
  1777. List<PropertyInfo> properties;
  1778. dummy.get_property_list(&properties);
  1779. for (const List<PropertyInfo>::Element *E = properties.front(); E != nullptr; E = E->next()) {
  1780. const PropertyInfo &prop = E->get();
  1781. if (prop.name == name) {
  1782. p_identifier->set_datatype(type_from_property(prop));
  1783. return;
  1784. }
  1785. }
  1786. push_error(vformat(R"(Cannot find property "%s" on base "%s".)", name, base.to_string()), p_identifier);
  1787. }
  1788. return;
  1789. }
  1790. if (base.kind == GDScriptParser::DataType::ENUM) {
  1791. if (base.is_meta_type) {
  1792. if (base.enum_values.has(name)) {
  1793. p_identifier->is_constant = true;
  1794. p_identifier->reduced_value = base.enum_values[name];
  1795. GDScriptParser::DataType result;
  1796. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1797. result.kind = GDScriptParser::DataType::ENUM_VALUE;
  1798. result.native_type = base.native_type;
  1799. result.enum_type = name;
  1800. p_identifier->set_datatype(result);
  1801. } else {
  1802. push_error(vformat(R"(Cannot find value "%s" in "%s".)", name, base.to_string()), p_identifier);
  1803. }
  1804. } else {
  1805. push_error(R"(Cannot get property from enum value.)", p_identifier);
  1806. }
  1807. return;
  1808. }
  1809. GDScriptParser::ClassNode *base_class = base.class_type;
  1810. // TODO: Switch current class/function/suite here to avoid misrepresenting identifiers (in recursive reduce calls).
  1811. while (base_class != nullptr) {
  1812. if (base_class->identifier && base_class->identifier->name == name) {
  1813. p_identifier->set_datatype(base_class->get_datatype());
  1814. return;
  1815. }
  1816. if (base_class->has_member(name)) {
  1817. const GDScriptParser::ClassNode::Member &member = base_class->get_member(name);
  1818. p_identifier->set_datatype(member.get_datatype());
  1819. switch (member.type) {
  1820. case GDScriptParser::ClassNode::Member::CONSTANT:
  1821. // For out-of-order resolution:
  1822. reduce_expression(member.constant->initializer);
  1823. p_identifier->is_constant = true;
  1824. p_identifier->reduced_value = member.constant->initializer->reduced_value;
  1825. p_identifier->set_datatype(member.constant->initializer->get_datatype());
  1826. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  1827. p_identifier->constant_source = member.constant;
  1828. break;
  1829. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  1830. p_identifier->is_constant = true;
  1831. p_identifier->reduced_value = member.enum_value.value;
  1832. break;
  1833. case GDScriptParser::ClassNode::Member::VARIABLE:
  1834. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_VARIABLE;
  1835. p_identifier->variable_source = member.variable;
  1836. break;
  1837. case GDScriptParser::ClassNode::Member::FUNCTION:
  1838. resolve_function_signature(member.function);
  1839. p_identifier->set_datatype(make_callable_type(member.function->info));
  1840. break;
  1841. default:
  1842. break; // Type already set.
  1843. }
  1844. return;
  1845. }
  1846. // Check outer constants.
  1847. // TODO: Allow outer static functions.
  1848. GDScriptParser::ClassNode *outer = base_class->outer;
  1849. while (outer != nullptr) {
  1850. if (outer->has_member(name)) {
  1851. const GDScriptParser::ClassNode::Member &member = outer->get_member(name);
  1852. if (member.type == GDScriptParser::ClassNode::Member::CONSTANT) {
  1853. // TODO: Make sure loops won't cause problem. And make special error message for those.
  1854. // For out-of-order resolution:
  1855. reduce_expression(member.constant->initializer);
  1856. p_identifier->set_datatype(member.get_datatype());
  1857. p_identifier->is_constant = true;
  1858. p_identifier->reduced_value = member.constant->initializer->reduced_value;
  1859. return;
  1860. }
  1861. }
  1862. outer = outer->outer;
  1863. }
  1864. base_class = base_class->base_type.class_type;
  1865. }
  1866. // Check native members.
  1867. const StringName &native = get_real_class_name(base.native_type);
  1868. if (class_exists(native)) {
  1869. PropertyInfo prop_info;
  1870. MethodInfo method_info;
  1871. if (ClassDB::get_property_info(native, name, &prop_info)) {
  1872. p_identifier->set_datatype(type_from_property(prop_info));
  1873. return;
  1874. }
  1875. if (ClassDB::get_method_info(native, name, &method_info)) {
  1876. // Method is callable.
  1877. p_identifier->set_datatype(make_callable_type(method_info));
  1878. return;
  1879. }
  1880. if (ClassDB::get_signal(native, name, &method_info)) {
  1881. // Signal is a type too.
  1882. p_identifier->set_datatype(make_signal_type(method_info));
  1883. return;
  1884. }
  1885. if (ClassDB::has_enum(native, name)) {
  1886. p_identifier->set_datatype(make_native_enum_type(native, name));
  1887. return;
  1888. }
  1889. bool valid = false;
  1890. int int_constant = ClassDB::get_integer_constant(native, name, &valid);
  1891. if (valid) {
  1892. p_identifier->is_constant = true;
  1893. p_identifier->reduced_value = int_constant;
  1894. p_identifier->set_datatype(type_from_variant(int_constant));
  1895. return;
  1896. }
  1897. }
  1898. }
  1899. void GDScriptAnalyzer::reduce_identifier(GDScriptParser::IdentifierNode *p_identifier, bool can_be_builtin) {
  1900. // TODO: This is opportunity to further infer types.
  1901. // Check if identifier is local.
  1902. // If that's the case, the declaration already was solved before.
  1903. switch (p_identifier->source) {
  1904. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER:
  1905. p_identifier->set_datatype(p_identifier->parameter_source->get_datatype());
  1906. return;
  1907. case GDScriptParser::IdentifierNode::LOCAL_CONSTANT:
  1908. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  1909. p_identifier->set_datatype(p_identifier->constant_source->get_datatype());
  1910. p_identifier->is_constant = true;
  1911. // TODO: Constant should have a value on the node itself.
  1912. p_identifier->reduced_value = p_identifier->constant_source->initializer->reduced_value;
  1913. return;
  1914. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  1915. p_identifier->variable_source->usages++;
  1916. [[fallthrough]];
  1917. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE:
  1918. p_identifier->set_datatype(p_identifier->variable_source->get_datatype());
  1919. return;
  1920. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR:
  1921. p_identifier->set_datatype(p_identifier->bind_source->get_datatype());
  1922. return;
  1923. case GDScriptParser::IdentifierNode::LOCAL_BIND: {
  1924. GDScriptParser::DataType result = p_identifier->bind_source->get_datatype();
  1925. result.is_constant = true;
  1926. p_identifier->set_datatype(result);
  1927. return;
  1928. }
  1929. case GDScriptParser::IdentifierNode::UNDEFINED_SOURCE:
  1930. break;
  1931. }
  1932. // Not a local, so check members.
  1933. reduce_identifier_from_base(p_identifier);
  1934. if (p_identifier->get_datatype().is_set()) {
  1935. // Found.
  1936. return;
  1937. }
  1938. StringName name = p_identifier->name;
  1939. p_identifier->source = GDScriptParser::IdentifierNode::UNDEFINED_SOURCE;
  1940. // Check globals.
  1941. if (GDScriptParser::get_builtin_type(name) < Variant::VARIANT_MAX) {
  1942. if (can_be_builtin) {
  1943. p_identifier->set_datatype(make_builtin_meta_type(GDScriptParser::get_builtin_type(name)));
  1944. return;
  1945. } else {
  1946. push_error(R"(Builtin type cannot be used as a name on its own.)", p_identifier);
  1947. }
  1948. }
  1949. if (class_exists(name)) {
  1950. p_identifier->set_datatype(make_native_meta_type(name));
  1951. return;
  1952. }
  1953. if (ScriptServer::is_global_class(name)) {
  1954. p_identifier->set_datatype(make_global_class_meta_type(name));
  1955. return;
  1956. }
  1957. if (GDScriptLanguage::get_singleton()->get_global_map().has(name)) {
  1958. int idx = GDScriptLanguage::get_singleton()->get_global_map()[name];
  1959. Variant constant = GDScriptLanguage::get_singleton()->get_global_array()[idx];
  1960. p_identifier->set_datatype(type_from_variant(constant));
  1961. p_identifier->is_constant = true;
  1962. p_identifier->reduced_value = constant;
  1963. return;
  1964. }
  1965. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(name)) {
  1966. Variant constant = GDScriptLanguage::get_singleton()->get_named_globals_map()[name];
  1967. p_identifier->set_datatype(type_from_variant(constant));
  1968. p_identifier->is_constant = true;
  1969. p_identifier->reduced_value = constant;
  1970. return;
  1971. }
  1972. // Not found.
  1973. // Check if it's a builtin function.
  1974. if (parser->get_builtin_function(name) < GDScriptFunctions::FUNC_MAX) {
  1975. push_error(vformat(R"(Built-in function "%s" cannot be used as an identifier.)", name), p_identifier);
  1976. } else {
  1977. push_error(vformat(R"(Identifier "%s" not declared in the current scope.)", name), p_identifier);
  1978. }
  1979. GDScriptParser::DataType dummy;
  1980. dummy.kind = GDScriptParser::DataType::VARIANT;
  1981. p_identifier->set_datatype(dummy); // Just so type is set to something.
  1982. }
  1983. void GDScriptAnalyzer::reduce_literal(GDScriptParser::LiteralNode *p_literal) {
  1984. p_literal->reduced_value = p_literal->value;
  1985. p_literal->is_constant = true;
  1986. p_literal->set_datatype(type_from_variant(p_literal->reduced_value));
  1987. }
  1988. void GDScriptAnalyzer::reduce_preload(GDScriptParser::PreloadNode *p_preload) {
  1989. p_preload->is_constant = true;
  1990. p_preload->reduced_value = p_preload->resource;
  1991. p_preload->set_datatype(type_from_variant(p_preload->reduced_value));
  1992. }
  1993. void GDScriptAnalyzer::reduce_self(GDScriptParser::SelfNode *p_self) {
  1994. p_self->is_constant = false;
  1995. p_self->set_datatype(type_from_metatype(parser->current_class->get_datatype()));
  1996. }
  1997. void GDScriptAnalyzer::reduce_subscript(GDScriptParser::SubscriptNode *p_subscript) {
  1998. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  1999. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base), true);
  2000. } else {
  2001. reduce_expression(p_subscript->base);
  2002. }
  2003. GDScriptParser::DataType result_type;
  2004. // Reduce index first. If it's a constant StringName, use attribute instead.
  2005. if (!p_subscript->is_attribute) {
  2006. if (p_subscript->index == nullptr) {
  2007. return;
  2008. }
  2009. reduce_expression(p_subscript->index);
  2010. if (p_subscript->index->is_constant && p_subscript->index->reduced_value.get_type() == Variant::STRING_NAME) {
  2011. GDScriptParser::IdentifierNode *attribute = parser->alloc_node<GDScriptParser::IdentifierNode>();
  2012. // Copy location for better error message.
  2013. attribute->start_line = p_subscript->index->start_line;
  2014. attribute->end_line = p_subscript->index->end_line;
  2015. attribute->leftmost_column = p_subscript->index->leftmost_column;
  2016. attribute->rightmost_column = p_subscript->index->rightmost_column;
  2017. p_subscript->is_attribute = true;
  2018. p_subscript->attribute = attribute;
  2019. }
  2020. }
  2021. if (p_subscript->is_attribute) {
  2022. if (p_subscript->attribute == nullptr) {
  2023. return;
  2024. }
  2025. if (p_subscript->base->is_constant) {
  2026. // Just try to get it.
  2027. bool valid = false;
  2028. Variant value = p_subscript->base->reduced_value.get_named(p_subscript->attribute->name, &valid);
  2029. if (!valid) {
  2030. push_error(vformat(R"(Cannot get member "%s" from "%s".)", p_subscript->attribute->name, p_subscript->base->reduced_value), p_subscript->index);
  2031. } else {
  2032. p_subscript->is_constant = true;
  2033. p_subscript->reduced_value = value;
  2034. result_type = type_from_variant(value);
  2035. }
  2036. result_type.kind = GDScriptParser::DataType::VARIANT;
  2037. } else {
  2038. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  2039. if (base_type.is_variant()) {
  2040. result_type.kind = GDScriptParser::DataType::VARIANT;
  2041. mark_node_unsafe(p_subscript);
  2042. } else {
  2043. reduce_identifier_from_base(p_subscript->attribute, &base_type);
  2044. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  2045. if (attr_type.is_set()) {
  2046. result_type = attr_type;
  2047. p_subscript->is_constant = p_subscript->attribute->is_constant;
  2048. p_subscript->reduced_value = p_subscript->attribute->reduced_value;
  2049. } else {
  2050. if (base_type.kind == GDScriptParser::DataType::BUILTIN) {
  2051. push_error(vformat(R"(Cannot find member "%s" in base "%s".)", p_subscript->attribute->name, base_type.to_string()), p_subscript->attribute);
  2052. #ifdef DEBUG_ENABLED
  2053. } else {
  2054. parser->push_warning(p_subscript, GDScriptWarning::UNSAFE_PROPERTY_ACCESS, p_subscript->attribute->name, base_type.to_string());
  2055. #endif
  2056. }
  2057. result_type.kind = GDScriptParser::DataType::VARIANT;
  2058. }
  2059. }
  2060. }
  2061. } else {
  2062. // Index was already reduced before.
  2063. if (p_subscript->base->is_constant && p_subscript->index->is_constant) {
  2064. // Just try to get it.
  2065. bool valid = false;
  2066. Variant value = p_subscript->base->reduced_value.get(p_subscript->index->reduced_value, &valid);
  2067. if (!valid) {
  2068. push_error(vformat(R"(Cannot get index "%s" from "%s".)", p_subscript->index->reduced_value, p_subscript->base->reduced_value), p_subscript->index);
  2069. } else {
  2070. p_subscript->is_constant = true;
  2071. p_subscript->reduced_value = value;
  2072. result_type = type_from_variant(value);
  2073. }
  2074. result_type.kind = GDScriptParser::DataType::VARIANT;
  2075. } else {
  2076. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  2077. GDScriptParser::DataType index_type = p_subscript->index->get_datatype();
  2078. if (base_type.is_variant()) {
  2079. result_type.kind = GDScriptParser::DataType::VARIANT;
  2080. mark_node_unsafe(p_subscript);
  2081. } else {
  2082. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  2083. // Check if indexing is valid.
  2084. bool error = index_type.kind != GDScriptParser::DataType::BUILTIN && base_type.builtin_type != Variant::DICTIONARY;
  2085. if (!error) {
  2086. switch (base_type.builtin_type) {
  2087. // Expect int or real as index.
  2088. case Variant::PACKED_BYTE_ARRAY:
  2089. case Variant::PACKED_COLOR_ARRAY:
  2090. case Variant::PACKED_FLOAT32_ARRAY:
  2091. case Variant::PACKED_FLOAT64_ARRAY:
  2092. case Variant::PACKED_INT32_ARRAY:
  2093. case Variant::PACKED_INT64_ARRAY:
  2094. case Variant::PACKED_STRING_ARRAY:
  2095. case Variant::PACKED_VECTOR2_ARRAY:
  2096. case Variant::PACKED_VECTOR3_ARRAY:
  2097. case Variant::ARRAY:
  2098. case Variant::STRING:
  2099. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT;
  2100. break;
  2101. // Expect String only.
  2102. case Variant::RECT2:
  2103. case Variant::RECT2I:
  2104. case Variant::PLANE:
  2105. case Variant::QUAT:
  2106. case Variant::AABB:
  2107. case Variant::OBJECT:
  2108. error = index_type.builtin_type != Variant::STRING;
  2109. break;
  2110. // Expect String or number.
  2111. case Variant::BASIS:
  2112. case Variant::VECTOR2:
  2113. case Variant::VECTOR2I:
  2114. case Variant::VECTOR3:
  2115. case Variant::VECTOR3I:
  2116. case Variant::TRANSFORM:
  2117. case Variant::TRANSFORM2D:
  2118. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT &&
  2119. index_type.builtin_type != Variant::STRING;
  2120. break;
  2121. // Expect String or int.
  2122. case Variant::COLOR:
  2123. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::STRING;
  2124. break;
  2125. // Don't support indexing, but we will check it later.
  2126. case Variant::_RID:
  2127. case Variant::BOOL:
  2128. case Variant::CALLABLE:
  2129. case Variant::FLOAT:
  2130. case Variant::INT:
  2131. case Variant::NIL:
  2132. case Variant::NODE_PATH:
  2133. case Variant::SIGNAL:
  2134. case Variant::STRING_NAME:
  2135. break;
  2136. // Here for completeness.
  2137. case Variant::DICTIONARY:
  2138. case Variant::VARIANT_MAX:
  2139. break;
  2140. }
  2141. if (error) {
  2142. push_error(vformat(R"(Invalid index type "%s" for a base of type "%s".)", index_type.to_string(), base_type.to_string()), p_subscript->index);
  2143. }
  2144. }
  2145. } else if (base_type.kind != GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  2146. if (index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME) {
  2147. push_error(vformat(R"(Only String or StringName can be used as index for type "%s", but received a "%s".)", base_type.to_string(), index_type.to_string()), p_subscript->index);
  2148. }
  2149. }
  2150. // Check resulting type if possible.
  2151. result_type.builtin_type = Variant::NIL;
  2152. result_type.kind = GDScriptParser::DataType::BUILTIN;
  2153. result_type.type_source = GDScriptParser::DataType::INFERRED;
  2154. switch (base_type.builtin_type) {
  2155. // Can't index at all.
  2156. case Variant::_RID:
  2157. case Variant::BOOL:
  2158. case Variant::CALLABLE:
  2159. case Variant::FLOAT:
  2160. case Variant::INT:
  2161. case Variant::NIL:
  2162. case Variant::NODE_PATH:
  2163. case Variant::SIGNAL:
  2164. case Variant::STRING_NAME:
  2165. result_type.kind = GDScriptParser::DataType::VARIANT;
  2166. push_error(vformat(R"(Cannot use subscript operator on a base of type "%s".)", base_type.to_string()), p_subscript->base);
  2167. break;
  2168. // Return int.
  2169. case Variant::PACKED_BYTE_ARRAY:
  2170. case Variant::PACKED_INT32_ARRAY:
  2171. case Variant::PACKED_INT64_ARRAY:
  2172. case Variant::VECTOR2I:
  2173. case Variant::VECTOR3I:
  2174. result_type.builtin_type = Variant::INT;
  2175. break;
  2176. // Return float.
  2177. case Variant::PACKED_FLOAT32_ARRAY:
  2178. case Variant::PACKED_FLOAT64_ARRAY:
  2179. case Variant::VECTOR2:
  2180. case Variant::VECTOR3:
  2181. case Variant::QUAT:
  2182. result_type.builtin_type = Variant::FLOAT;
  2183. break;
  2184. // Return Color.
  2185. case Variant::PACKED_COLOR_ARRAY:
  2186. result_type.builtin_type = Variant::COLOR;
  2187. break;
  2188. // Return String.
  2189. case Variant::PACKED_STRING_ARRAY:
  2190. case Variant::STRING:
  2191. result_type.builtin_type = Variant::STRING;
  2192. break;
  2193. // Return Vector2.
  2194. case Variant::PACKED_VECTOR2_ARRAY:
  2195. case Variant::TRANSFORM2D:
  2196. case Variant::RECT2:
  2197. result_type.builtin_type = Variant::VECTOR2;
  2198. break;
  2199. // Return Vector2I.
  2200. case Variant::RECT2I:
  2201. result_type.builtin_type = Variant::VECTOR2I;
  2202. break;
  2203. // Return Vector3.
  2204. case Variant::PACKED_VECTOR3_ARRAY:
  2205. case Variant::AABB:
  2206. case Variant::BASIS:
  2207. result_type.builtin_type = Variant::VECTOR3;
  2208. break;
  2209. // Depends on the index.
  2210. case Variant::TRANSFORM:
  2211. case Variant::PLANE:
  2212. case Variant::COLOR:
  2213. case Variant::ARRAY:
  2214. case Variant::DICTIONARY:
  2215. result_type.kind = GDScriptParser::DataType::VARIANT;
  2216. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  2217. break;
  2218. // Here for completeness.
  2219. case Variant::OBJECT:
  2220. case Variant::VARIANT_MAX:
  2221. break;
  2222. }
  2223. }
  2224. }
  2225. }
  2226. p_subscript->set_datatype(result_type);
  2227. }
  2228. void GDScriptAnalyzer::reduce_ternary_op(GDScriptParser::TernaryOpNode *p_ternary_op) {
  2229. reduce_expression(p_ternary_op->condition);
  2230. reduce_expression(p_ternary_op->true_expr);
  2231. reduce_expression(p_ternary_op->false_expr);
  2232. GDScriptParser::DataType result;
  2233. if (p_ternary_op->condition && p_ternary_op->condition->is_constant && p_ternary_op->true_expr->is_constant && p_ternary_op->false_expr && p_ternary_op->false_expr->is_constant) {
  2234. p_ternary_op->is_constant = true;
  2235. if (p_ternary_op->condition->reduced_value.booleanize()) {
  2236. p_ternary_op->reduced_value = p_ternary_op->true_expr->reduced_value;
  2237. } else {
  2238. p_ternary_op->reduced_value = p_ternary_op->false_expr->reduced_value;
  2239. }
  2240. }
  2241. GDScriptParser::DataType true_type;
  2242. if (p_ternary_op->true_expr) {
  2243. true_type = p_ternary_op->true_expr->get_datatype();
  2244. } else {
  2245. true_type.kind = GDScriptParser::DataType::VARIANT;
  2246. }
  2247. GDScriptParser::DataType false_type;
  2248. if (p_ternary_op->false_expr) {
  2249. false_type = p_ternary_op->false_expr->get_datatype();
  2250. } else {
  2251. false_type.kind = GDScriptParser::DataType::VARIANT;
  2252. }
  2253. if (true_type.is_variant() || false_type.is_variant()) {
  2254. result.kind = GDScriptParser::DataType::VARIANT;
  2255. } else {
  2256. result = true_type;
  2257. if (!is_type_compatible(true_type, false_type)) {
  2258. result = false_type;
  2259. if (!is_type_compatible(false_type, true_type)) {
  2260. result.type_source = GDScriptParser::DataType::UNDETECTED;
  2261. result.kind = GDScriptParser::DataType::VARIANT;
  2262. #ifdef DEBUG_ENABLED
  2263. parser->push_warning(p_ternary_op, GDScriptWarning::INCOMPATIBLE_TERNARY);
  2264. #endif
  2265. }
  2266. }
  2267. }
  2268. p_ternary_op->set_datatype(result);
  2269. }
  2270. void GDScriptAnalyzer::reduce_unary_op(GDScriptParser::UnaryOpNode *p_unary_op) {
  2271. reduce_expression(p_unary_op->operand);
  2272. GDScriptParser::DataType result;
  2273. if (p_unary_op->operand->is_constant) {
  2274. p_unary_op->is_constant = true;
  2275. p_unary_op->reduced_value = Variant::evaluate(p_unary_op->variant_op, p_unary_op->operand->reduced_value, Variant());
  2276. result = type_from_variant(p_unary_op->reduced_value);
  2277. } else if (p_unary_op->operand->get_datatype().is_variant()) {
  2278. result.kind = GDScriptParser::DataType::VARIANT;
  2279. mark_node_unsafe(p_unary_op);
  2280. } else {
  2281. bool valid = false;
  2282. result = get_operation_type(p_unary_op->variant_op, p_unary_op->operand->get_datatype(), p_unary_op->operand->get_datatype(), valid);
  2283. if (!valid) {
  2284. push_error(vformat(R"(Invalid operand of type "%s" for unary operator "%s".)", p_unary_op->operand->get_datatype().to_string(), Variant::get_operator_name(p_unary_op->variant_op)), p_unary_op->operand);
  2285. }
  2286. }
  2287. p_unary_op->set_datatype(result);
  2288. }
  2289. GDScriptParser::DataType GDScriptAnalyzer::type_from_variant(const Variant &p_value) {
  2290. GDScriptParser::DataType result;
  2291. result.is_constant = true;
  2292. result.kind = GDScriptParser::DataType::BUILTIN;
  2293. result.builtin_type = p_value.get_type();
  2294. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT; // Constant has explicit type.
  2295. if (p_value.get_type() == Variant::OBJECT) {
  2296. Object *obj = p_value;
  2297. if (!obj) {
  2298. return GDScriptParser::DataType();
  2299. }
  2300. result.native_type = obj->get_class_name();
  2301. Ref<Script> scr = p_value; // Check if value is a script itself.
  2302. if (scr.is_valid()) {
  2303. result.is_meta_type = true;
  2304. } else {
  2305. result.is_meta_type = false;
  2306. scr = obj->get_script();
  2307. }
  2308. if (scr.is_valid()) {
  2309. result.script_type = scr;
  2310. result.script_path = scr->get_path();
  2311. Ref<GDScript> gds = scr;
  2312. if (gds.is_valid()) {
  2313. result.kind = GDScriptParser::DataType::CLASS;
  2314. Ref<GDScriptParserRef> ref = get_parser_for(gds->get_path());
  2315. ref->raise_status(GDScriptParserRef::INTERFACE_SOLVED);
  2316. result.class_type = ref->get_parser()->head;
  2317. result.script_path = ref->get_parser()->script_path;
  2318. } else {
  2319. result.kind = GDScriptParser::DataType::SCRIPT;
  2320. }
  2321. result.native_type = scr->get_instance_base_type();
  2322. } else {
  2323. result.kind = GDScriptParser::DataType::NATIVE;
  2324. if (result.native_type == GDScriptNativeClass::get_class_static()) {
  2325. result.is_meta_type = true;
  2326. }
  2327. }
  2328. }
  2329. return result;
  2330. }
  2331. GDScriptParser::DataType GDScriptAnalyzer::type_from_metatype(const GDScriptParser::DataType &p_meta_type) const {
  2332. GDScriptParser::DataType result = p_meta_type;
  2333. result.is_meta_type = false;
  2334. result.is_constant = false;
  2335. return result;
  2336. }
  2337. GDScriptParser::DataType GDScriptAnalyzer::type_from_property(const PropertyInfo &p_property) const {
  2338. GDScriptParser::DataType result;
  2339. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2340. if (p_property.type == Variant::NIL && (p_property.usage & PROPERTY_USAGE_NIL_IS_VARIANT)) {
  2341. // Variant
  2342. result.kind = GDScriptParser::DataType::VARIANT;
  2343. return result;
  2344. }
  2345. result.builtin_type = p_property.type;
  2346. if (p_property.type == Variant::OBJECT) {
  2347. result.kind = GDScriptParser::DataType::NATIVE;
  2348. result.native_type = p_property.class_name == StringName() ? "Object" : p_property.class_name;
  2349. } else {
  2350. result.kind = GDScriptParser::DataType::BUILTIN;
  2351. }
  2352. return result;
  2353. }
  2354. bool GDScriptAnalyzer::get_function_signature(GDScriptParser::Node *p_source, GDScriptParser::DataType p_base_type, const StringName &p_function, GDScriptParser::DataType &r_return_type, List<GDScriptParser::DataType> &r_par_types, int &r_default_arg_count, bool &r_static, bool &r_vararg) {
  2355. r_static = false;
  2356. r_vararg = false;
  2357. r_default_arg_count = 0;
  2358. StringName function_name = p_function;
  2359. if (p_base_type.kind == GDScriptParser::DataType::BUILTIN) {
  2360. // Construct a base type to get methods.
  2361. Callable::CallError err;
  2362. Variant dummy = Variant::construct(p_base_type.builtin_type, nullptr, 0, err);
  2363. if (err.error != Callable::CallError::CALL_OK) {
  2364. ERR_FAIL_V_MSG(false, "Could not construct base Variant type.");
  2365. }
  2366. List<MethodInfo> methods;
  2367. dummy.get_method_list(&methods);
  2368. for (const List<MethodInfo>::Element *E = methods.front(); E != nullptr; E = E->next()) {
  2369. if (E->get().name == p_function) {
  2370. return function_signature_from_info(E->get(), r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  2371. }
  2372. }
  2373. return false;
  2374. }
  2375. bool is_constructor = p_base_type.is_meta_type && p_function == "new";
  2376. if (is_constructor) {
  2377. function_name = "_init";
  2378. r_static = true;
  2379. }
  2380. GDScriptParser::ClassNode *base_class = p_base_type.class_type;
  2381. GDScriptParser::FunctionNode *found_function = nullptr;
  2382. while (found_function == nullptr && base_class != nullptr) {
  2383. if (base_class->has_member(function_name)) {
  2384. if (base_class->get_member(function_name).type != GDScriptParser::ClassNode::Member::FUNCTION) {
  2385. // TODO: If this is Callable it can have a better error message.
  2386. push_error(vformat(R"(Member "%s" is not a function.)", function_name), p_source);
  2387. return false;
  2388. }
  2389. found_function = base_class->get_member(function_name).function;
  2390. }
  2391. base_class = base_class->base_type.class_type;
  2392. }
  2393. if (found_function != nullptr) {
  2394. r_static = is_constructor || found_function->is_static;
  2395. for (int i = 0; i < found_function->parameters.size(); i++) {
  2396. r_par_types.push_back(found_function->parameters[i]->get_datatype());
  2397. if (found_function->parameters[i]->default_value != nullptr) {
  2398. r_default_arg_count++;
  2399. }
  2400. }
  2401. r_return_type = found_function->get_datatype();
  2402. r_return_type.is_coroutine = found_function->is_coroutine;
  2403. return true;
  2404. }
  2405. Ref<Script> base_script = p_base_type.script_type;
  2406. while (base_script.is_valid() && base_script->is_valid()) {
  2407. MethodInfo info = base_script->get_method_info(function_name);
  2408. if (!(info == MethodInfo())) {
  2409. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  2410. }
  2411. base_script = base_script->get_base_script();
  2412. }
  2413. // If the base is a script, it might be trying to access members of the Script class itself.
  2414. if (p_base_type.is_meta_type && !is_constructor && (p_base_type.kind == GDScriptParser::DataType::SCRIPT || p_base_type.kind == GDScriptParser::DataType::CLASS)) {
  2415. MethodInfo info;
  2416. StringName script_class = p_base_type.kind == GDScriptParser::DataType::SCRIPT ? p_base_type.script_type->get_class_name() : StringName(GDScript::get_class_static());
  2417. if (ClassDB::get_method_info(script_class, function_name, &info)) {
  2418. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  2419. }
  2420. }
  2421. StringName base_native = p_base_type.native_type;
  2422. #ifdef DEBUG_ENABLED
  2423. if (base_native != StringName()) {
  2424. // Empty native class might happen in some Script implementations.
  2425. // Just ignore it.
  2426. if (!class_exists(base_native)) {
  2427. ERR_FAIL_V_MSG(false, vformat("Native class %s used in script doesn't exist or isn't exposed.", base_native));
  2428. }
  2429. }
  2430. #endif
  2431. if (is_constructor) {
  2432. // Native types always have a default constructor.
  2433. r_return_type = p_base_type;
  2434. r_return_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2435. r_return_type.is_meta_type = false;
  2436. return true;
  2437. }
  2438. StringName real_native = get_real_class_name(base_native);
  2439. MethodInfo info;
  2440. if (ClassDB::get_method_info(real_native, function_name, &info)) {
  2441. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  2442. }
  2443. return false;
  2444. }
  2445. bool GDScriptAnalyzer::function_signature_from_info(const MethodInfo &p_info, GDScriptParser::DataType &r_return_type, List<GDScriptParser::DataType> &r_par_types, int &r_default_arg_count, bool &r_static, bool &r_vararg) {
  2446. r_return_type = type_from_property(p_info.return_val);
  2447. r_default_arg_count = p_info.default_arguments.size();
  2448. r_vararg = (p_info.flags & METHOD_FLAG_VARARG) != 0;
  2449. for (const List<PropertyInfo>::Element *E = p_info.arguments.front(); E != nullptr; E = E->next()) {
  2450. r_par_types.push_back(type_from_property(E->get()));
  2451. }
  2452. return true;
  2453. }
  2454. bool GDScriptAnalyzer::validate_call_arg(const MethodInfo &p_method, const GDScriptParser::CallNode *p_call) {
  2455. List<GDScriptParser::DataType> arg_types;
  2456. for (const List<PropertyInfo>::Element *E = p_method.arguments.front(); E != nullptr; E = E->next()) {
  2457. arg_types.push_back(type_from_property(E->get()));
  2458. }
  2459. return validate_call_arg(arg_types, p_method.default_arguments.size(), (p_method.flags & METHOD_FLAG_VARARG) != 0, p_call);
  2460. }
  2461. bool GDScriptAnalyzer::validate_call_arg(const List<GDScriptParser::DataType> &p_par_types, int p_default_args_count, bool p_is_vararg, const GDScriptParser::CallNode *p_call) {
  2462. bool valid = true;
  2463. if (p_call->arguments.size() < p_par_types.size() - p_default_args_count) {
  2464. push_error(vformat(R"*(Too few arguments for "%s()" call. Expected at least %d but received %d.)*", p_call->function_name, p_par_types.size() - p_default_args_count, p_call->arguments.size()), p_call);
  2465. valid = false;
  2466. }
  2467. if (!p_is_vararg && p_call->arguments.size() > p_par_types.size()) {
  2468. push_error(vformat(R"*(Too many arguments for "%s()" call. Expected at most %d but received %d.)*", p_call->function_name, p_par_types.size(), p_call->arguments.size()), p_call->arguments[p_par_types.size()]);
  2469. valid = false;
  2470. }
  2471. for (int i = 0; i < p_call->arguments.size(); i++) {
  2472. if (i >= p_par_types.size()) {
  2473. // Already on vararg place.
  2474. break;
  2475. }
  2476. GDScriptParser::DataType par_type = p_par_types[i];
  2477. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  2478. if (arg_type.is_variant()) {
  2479. // Argument can be anything, so this is unsafe.
  2480. mark_node_unsafe(p_call->arguments[i]);
  2481. } else if (!is_type_compatible(par_type, arg_type, true)) {
  2482. // Supertypes are acceptable for dynamic compliance, but it's unsafe.
  2483. mark_node_unsafe(p_call);
  2484. if (!is_type_compatible(arg_type, par_type)) {
  2485. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be %s but is %s.)*",
  2486. p_call->function_name, i + 1, par_type.to_string(), arg_type.to_string()),
  2487. p_call->arguments[i]);
  2488. valid = false;
  2489. }
  2490. #ifdef DEBUG_ENABLED
  2491. } else {
  2492. if (par_type.kind == GDScriptParser::DataType::BUILTIN && par_type.builtin_type == Variant::INT && arg_type.kind == GDScriptParser::DataType::BUILTIN && arg_type.builtin_type == Variant::FLOAT) {
  2493. parser->push_warning(p_call, GDScriptWarning::NARROWING_CONVERSION, p_call->function_name);
  2494. }
  2495. #endif
  2496. }
  2497. }
  2498. return valid;
  2499. }
  2500. #ifdef DEBUG_ENABLED
  2501. bool GDScriptAnalyzer::is_shadowing(GDScriptParser::IdentifierNode *p_local, const String &p_context) {
  2502. const StringName &name = p_local->name;
  2503. GDScriptParser::DataType base = parser->current_class->get_datatype();
  2504. GDScriptParser::ClassNode *base_class = base.class_type;
  2505. while (base_class != nullptr) {
  2506. if (base_class->has_member(name)) {
  2507. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE, p_context, p_local->name, base_class->get_member(name).get_type_name(), itos(base_class->get_member(name).get_line()));
  2508. return true;
  2509. }
  2510. base_class = base_class->base_type.class_type;
  2511. }
  2512. StringName base_native = base.native_type;
  2513. ERR_FAIL_COND_V_MSG(!class_exists(base_native), false, "Non-existent native base class.");
  2514. StringName parent = base_native;
  2515. while (parent != StringName()) {
  2516. StringName real_class_name = get_real_class_name(parent);
  2517. if (ClassDB::has_method(real_class_name, name, true)) {
  2518. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "method", parent);
  2519. return true;
  2520. } else if (ClassDB::has_signal(real_class_name, name, true)) {
  2521. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "signal", parent);
  2522. return true;
  2523. } else if (ClassDB::has_property(real_class_name, name, true)) {
  2524. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "property", parent);
  2525. return true;
  2526. } else if (ClassDB::has_integer_constant(real_class_name, name, true)) {
  2527. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "constant", parent);
  2528. return true;
  2529. } else if (ClassDB::has_enum(real_class_name, name, true)) {
  2530. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "enum", parent);
  2531. return true;
  2532. }
  2533. parent = ClassDB::get_parent_class(real_class_name);
  2534. }
  2535. return false;
  2536. }
  2537. #endif
  2538. GDScriptParser::DataType GDScriptAnalyzer::get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, const GDScriptParser::DataType &p_b, bool &r_valid) {
  2539. // This function creates dummy variant values and apply the operation to those. Less error-prone than keeping a table of valid operations.
  2540. GDScriptParser::DataType result;
  2541. result.kind = GDScriptParser::DataType::VARIANT;
  2542. Variant::Type a_type = p_a.builtin_type;
  2543. Variant::Type b_type = p_b.builtin_type;
  2544. Variant a;
  2545. REF a_ref;
  2546. if (a_type == Variant::OBJECT) {
  2547. a_ref.instance();
  2548. a = a_ref;
  2549. } else {
  2550. Callable::CallError err;
  2551. a = Variant::construct(a_type, nullptr, 0, err);
  2552. if (err.error != Callable::CallError::CALL_OK) {
  2553. r_valid = false;
  2554. ERR_FAIL_V_MSG(result, vformat("Could not construct value of type %s", Variant::get_type_name(a_type)));
  2555. }
  2556. }
  2557. Variant b;
  2558. REF b_ref;
  2559. if (b_type == Variant::OBJECT) {
  2560. b_ref.instance();
  2561. b = b_ref;
  2562. } else {
  2563. Callable::CallError err;
  2564. b = Variant::construct(b_type, nullptr, 0, err);
  2565. if (err.error != Callable::CallError::CALL_OK) {
  2566. r_valid = false;
  2567. ERR_FAIL_V_MSG(result, vformat("Could not construct value of type %s", Variant::get_type_name(b_type)));
  2568. }
  2569. }
  2570. // Avoid division by zero.
  2571. switch (b_type) {
  2572. case Variant::INT:
  2573. b = 1;
  2574. break;
  2575. case Variant::FLOAT:
  2576. b = 1.0;
  2577. break;
  2578. case Variant::VECTOR2:
  2579. b = Vector2(1.0, 1.0);
  2580. break;
  2581. case Variant::VECTOR2I:
  2582. b = Vector2i(1, 1);
  2583. break;
  2584. case Variant::VECTOR3:
  2585. b = Vector3(1.0, 1.0, 1.0);
  2586. break;
  2587. case Variant::VECTOR3I:
  2588. b = Vector3i(1, 1, 1);
  2589. break;
  2590. case Variant::COLOR:
  2591. b = Color(1.0, 1.0, 1.0, 1.0);
  2592. break;
  2593. default:
  2594. // No change needed.
  2595. break;
  2596. }
  2597. // Avoid error in formatting operator (%) where it doesn't find a placeholder.
  2598. if (a_type == Variant::STRING) {
  2599. a = String("%s");
  2600. }
  2601. Variant ret;
  2602. Variant::evaluate(p_operation, a, b, ret, r_valid);
  2603. if (r_valid) {
  2604. return type_from_variant(ret);
  2605. }
  2606. return result;
  2607. }
  2608. // TODO: Add safe/unsafe return variable (for variant cases)
  2609. bool GDScriptAnalyzer::is_type_compatible(const GDScriptParser::DataType &p_target, const GDScriptParser::DataType &p_source, bool p_allow_implicit_conversion) const {
  2610. // These return "true" so it doesn't affect users negatively.
  2611. ERR_FAIL_COND_V_MSG(!p_target.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset target type");
  2612. ERR_FAIL_COND_V_MSG(!p_source.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset value type");
  2613. if (p_target.kind == GDScriptParser::DataType::VARIANT) {
  2614. // Variant can receive anything.
  2615. return true;
  2616. }
  2617. if (p_source.kind == GDScriptParser::DataType::VARIANT) {
  2618. // TODO: This is acceptable but unsafe. Make sure unsafe line is set.
  2619. return true;
  2620. }
  2621. if (p_target.kind == GDScriptParser::DataType::BUILTIN) {
  2622. bool valid = p_source.kind == GDScriptParser::DataType::BUILTIN && p_target.builtin_type == p_source.builtin_type;
  2623. if (!valid && p_allow_implicit_conversion) {
  2624. valid = Variant::can_convert_strict(p_source.builtin_type, p_target.builtin_type);
  2625. }
  2626. if (!valid && p_target.builtin_type == Variant::INT && p_source.kind == GDScriptParser::DataType::ENUM_VALUE) {
  2627. // Enum value is also integer.
  2628. valid = true;
  2629. }
  2630. return valid;
  2631. }
  2632. if (p_target.kind == GDScriptParser::DataType::ENUM) {
  2633. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::INT) {
  2634. return true;
  2635. }
  2636. if (p_source.kind == GDScriptParser::DataType::ENUM_VALUE) {
  2637. if (p_source.native_type == p_target.native_type && p_target.enum_values.has(p_source.enum_type)) {
  2638. return true;
  2639. }
  2640. }
  2641. return false;
  2642. }
  2643. // From here on the target type is an object, so we have to test polymorphism.
  2644. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::NIL) {
  2645. // null is acceptable in object.
  2646. return true;
  2647. }
  2648. StringName src_native;
  2649. Ref<Script> src_script;
  2650. const GDScriptParser::ClassNode *src_class = nullptr;
  2651. switch (p_source.kind) {
  2652. case GDScriptParser::DataType::NATIVE:
  2653. if (p_target.kind != GDScriptParser::DataType::NATIVE) {
  2654. // Non-native class cannot be supertype of native.
  2655. return false;
  2656. }
  2657. if (p_source.is_meta_type) {
  2658. src_native = GDScriptNativeClass::get_class_static();
  2659. } else {
  2660. src_native = p_source.native_type;
  2661. }
  2662. break;
  2663. case GDScriptParser::DataType::SCRIPT:
  2664. if (p_target.kind == GDScriptParser::DataType::CLASS) {
  2665. // A script type cannot be a subtype of a GDScript class.
  2666. return false;
  2667. }
  2668. if (p_source.is_meta_type) {
  2669. src_native = p_source.script_type->get_class_name();
  2670. } else {
  2671. src_script = p_source.script_type;
  2672. src_native = src_script->get_instance_base_type();
  2673. }
  2674. break;
  2675. case GDScriptParser::DataType::CLASS:
  2676. if (p_source.is_meta_type) {
  2677. src_native = GDScript::get_class_static();
  2678. } else {
  2679. src_class = p_source.class_type;
  2680. const GDScriptParser::ClassNode *base = src_class;
  2681. while (base->base_type.kind == GDScriptParser::DataType::CLASS) {
  2682. base = base->base_type.class_type;
  2683. }
  2684. src_native = base->base_type.native_type;
  2685. src_script = base->base_type.script_type;
  2686. }
  2687. break;
  2688. case GDScriptParser::DataType::VARIANT:
  2689. case GDScriptParser::DataType::BUILTIN:
  2690. case GDScriptParser::DataType::ENUM:
  2691. case GDScriptParser::DataType::ENUM_VALUE:
  2692. case GDScriptParser::DataType::UNRESOLVED:
  2693. break; // Already solved before.
  2694. }
  2695. // Get underscore-prefixed version for some classes.
  2696. src_native = get_real_class_name(src_native);
  2697. switch (p_target.kind) {
  2698. case GDScriptParser::DataType::NATIVE: {
  2699. if (p_target.is_meta_type) {
  2700. return ClassDB::is_parent_class(src_native, GDScriptNativeClass::get_class_static());
  2701. }
  2702. StringName tgt_native = get_real_class_name(p_target.native_type);
  2703. return ClassDB::is_parent_class(src_native, tgt_native);
  2704. }
  2705. case GDScriptParser::DataType::SCRIPT:
  2706. if (p_target.is_meta_type) {
  2707. return ClassDB::is_parent_class(src_native, p_target.script_type->get_class_name());
  2708. }
  2709. while (src_script.is_valid()) {
  2710. if (src_script == p_target.script_type) {
  2711. return true;
  2712. }
  2713. src_script = src_script->get_base_script();
  2714. }
  2715. return false;
  2716. case GDScriptParser::DataType::CLASS:
  2717. if (p_target.is_meta_type) {
  2718. return ClassDB::is_parent_class(src_native, GDScript::get_class_static());
  2719. }
  2720. while (src_class != nullptr) {
  2721. if (src_class->fqcn == p_target.class_type->fqcn) {
  2722. return true;
  2723. }
  2724. src_class = src_class->base_type.class_type;
  2725. }
  2726. return false;
  2727. case GDScriptParser::DataType::VARIANT:
  2728. case GDScriptParser::DataType::BUILTIN:
  2729. case GDScriptParser::DataType::ENUM:
  2730. case GDScriptParser::DataType::ENUM_VALUE:
  2731. case GDScriptParser::DataType::UNRESOLVED:
  2732. break; // Already solved before.
  2733. }
  2734. return false;
  2735. }
  2736. void GDScriptAnalyzer::push_error(const String &p_message, const GDScriptParser::Node *p_origin) {
  2737. mark_node_unsafe(p_origin);
  2738. parser->push_error(p_message, p_origin);
  2739. }
  2740. void GDScriptAnalyzer::mark_node_unsafe(const GDScriptParser::Node *p_node) {
  2741. #ifdef DEBUG_ENABLED
  2742. for (int i = p_node->start_line; i <= p_node->end_line; i++) {
  2743. parser->unsafe_lines.insert(i);
  2744. }
  2745. #endif
  2746. }
  2747. bool GDScriptAnalyzer::class_exists(const StringName &p_class) {
  2748. StringName real_name = get_real_class_name(p_class);
  2749. return ClassDB::class_exists(real_name) && ClassDB::is_class_exposed(real_name);
  2750. }
  2751. Ref<GDScriptParserRef> GDScriptAnalyzer::get_parser_for(const String &p_path) {
  2752. Ref<GDScriptParserRef> ref;
  2753. if (depended_parsers.has(p_path)) {
  2754. ref = depended_parsers[p_path];
  2755. } else {
  2756. Error err = OK;
  2757. ref = GDScriptCache::get_parser(p_path, GDScriptParserRef::EMPTY, err, parser->script_path);
  2758. depended_parsers[p_path] = ref;
  2759. }
  2760. return ref;
  2761. }
  2762. Error GDScriptAnalyzer::resolve_inheritance() {
  2763. return resolve_inheritance(parser->head);
  2764. }
  2765. Error GDScriptAnalyzer::resolve_interface() {
  2766. resolve_class_interface(parser->head);
  2767. return parser->errors.empty() ? OK : ERR_PARSE_ERROR;
  2768. }
  2769. Error GDScriptAnalyzer::resolve_body() {
  2770. resolve_class_body(parser->head);
  2771. return parser->errors.empty() ? OK : ERR_PARSE_ERROR;
  2772. }
  2773. Error GDScriptAnalyzer::resolve_program() {
  2774. resolve_class_interface(parser->head);
  2775. resolve_class_body(parser->head);
  2776. List<String> parser_keys;
  2777. depended_parsers.get_key_list(&parser_keys);
  2778. for (const List<String>::Element *E = parser_keys.front(); E != nullptr; E = E->next()) {
  2779. depended_parsers[E->get()]->raise_status(GDScriptParserRef::FULLY_SOLVED);
  2780. }
  2781. depended_parsers.clear();
  2782. return parser->errors.empty() ? OK : ERR_PARSE_ERROR;
  2783. }
  2784. Error GDScriptAnalyzer::analyze() {
  2785. parser->errors.clear();
  2786. Error err = resolve_inheritance(parser->head);
  2787. if (err) {
  2788. return err;
  2789. }
  2790. return resolve_program();
  2791. }
  2792. GDScriptAnalyzer::GDScriptAnalyzer(GDScriptParser *p_parser) {
  2793. parser = p_parser;
  2794. }