gdscript_analyzer.cpp 147 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823
  1. /*************************************************************************/
  2. /* gdscript_analyzer.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 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/config/engine.h"
  32. #include "core/config/project_settings.h"
  33. #include "core/io/file_access.h"
  34. #include "core/io/resource_loader.h"
  35. #include "core/object/class_db.h"
  36. #include "core/object/script_language.h"
  37. #include "core/templates/hash_map.h"
  38. #include "gdscript.h"
  39. #include "gdscript_utility_functions.h"
  40. static MethodInfo info_from_utility_func(const StringName &p_function) {
  41. ERR_FAIL_COND_V(!Variant::has_utility_function(p_function), MethodInfo());
  42. MethodInfo info(p_function);
  43. if (Variant::has_utility_function_return_value(p_function)) {
  44. info.return_val.type = Variant::get_utility_function_return_type(p_function);
  45. if (info.return_val.type == Variant::NIL) {
  46. info.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  47. }
  48. }
  49. if (Variant::is_utility_function_vararg(p_function)) {
  50. info.flags |= METHOD_FLAG_VARARG;
  51. } else {
  52. for (int i = 0; i < Variant::get_utility_function_argument_count(p_function); i++) {
  53. PropertyInfo pi;
  54. #ifdef DEBUG_METHODS_ENABLED
  55. pi.name = Variant::get_utility_function_argument_name(p_function, i);
  56. #else
  57. pi.name = "arg" + itos(i + 1);
  58. #endif
  59. pi.type = Variant::get_utility_function_argument_type(p_function, i);
  60. if (pi.type == Variant::NIL) {
  61. pi.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  62. }
  63. info.arguments.push_back(pi);
  64. }
  65. }
  66. return info;
  67. }
  68. static GDScriptParser::DataType make_callable_type(const MethodInfo &p_info) {
  69. GDScriptParser::DataType type;
  70. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  71. type.kind = GDScriptParser::DataType::BUILTIN;
  72. type.builtin_type = Variant::CALLABLE;
  73. type.is_constant = true;
  74. type.method_info = p_info;
  75. return type;
  76. }
  77. static GDScriptParser::DataType make_signal_type(const MethodInfo &p_info) {
  78. GDScriptParser::DataType type;
  79. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  80. type.kind = GDScriptParser::DataType::BUILTIN;
  81. type.builtin_type = Variant::SIGNAL;
  82. type.is_constant = true;
  83. type.method_info = p_info;
  84. return type;
  85. }
  86. static GDScriptParser::DataType make_native_meta_type(const StringName &p_class_name) {
  87. GDScriptParser::DataType type;
  88. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  89. type.kind = GDScriptParser::DataType::NATIVE;
  90. type.builtin_type = Variant::OBJECT;
  91. type.is_constant = true;
  92. type.native_type = p_class_name;
  93. type.is_meta_type = true;
  94. return type;
  95. }
  96. static GDScriptParser::DataType make_native_enum_type(const StringName &p_native_class, const StringName &p_enum_name) {
  97. GDScriptParser::DataType type;
  98. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  99. type.kind = GDScriptParser::DataType::ENUM;
  100. type.builtin_type = Variant::OBJECT;
  101. type.is_constant = true;
  102. type.is_meta_type = true;
  103. List<StringName> enum_values;
  104. ClassDB::get_enum_constants(p_native_class, p_enum_name, &enum_values);
  105. for (const StringName &E : enum_values) {
  106. type.enum_values[E] = ClassDB::get_integer_constant(p_native_class, E);
  107. }
  108. return type;
  109. }
  110. static GDScriptParser::DataType make_builtin_meta_type(Variant::Type p_type) {
  111. GDScriptParser::DataType type;
  112. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  113. type.kind = GDScriptParser::DataType::BUILTIN;
  114. type.builtin_type = p_type;
  115. type.is_constant = true;
  116. type.is_meta_type = true;
  117. return type;
  118. }
  119. bool GDScriptAnalyzer::has_member_name_conflict_in_script_class(const StringName &p_member_name, const GDScriptParser::ClassNode *p_class) {
  120. if (p_class->members_indices.has(p_member_name)) {
  121. int index = p_class->members_indices[p_member_name];
  122. const GDScriptParser::ClassNode::Member *member = &p_class->members[index];
  123. if (member->type == GDScriptParser::ClassNode::Member::VARIABLE ||
  124. member->type == GDScriptParser::ClassNode::Member::CONSTANT ||
  125. member->type == GDScriptParser::ClassNode::Member::ENUM ||
  126. member->type == GDScriptParser::ClassNode::Member::ENUM_VALUE ||
  127. member->type == GDScriptParser::ClassNode::Member::CLASS ||
  128. member->type == GDScriptParser::ClassNode::Member::SIGNAL) {
  129. return true;
  130. }
  131. }
  132. return false;
  133. }
  134. bool GDScriptAnalyzer::has_member_name_conflict_in_native_type(const StringName &p_member_name, const StringName &p_native_type_string) {
  135. if (ClassDB::has_signal(p_native_type_string, p_member_name)) {
  136. return true;
  137. }
  138. if (ClassDB::has_property(p_native_type_string, p_member_name)) {
  139. return true;
  140. }
  141. if (ClassDB::has_integer_constant(p_native_type_string, p_member_name)) {
  142. return true;
  143. }
  144. return false;
  145. }
  146. Error GDScriptAnalyzer::check_native_member_name_conflict(const StringName &p_member_name, const GDScriptParser::Node *p_member_node, const StringName &p_native_type_string) {
  147. if (has_member_name_conflict_in_native_type(p_member_name, p_native_type_string)) {
  148. push_error(vformat(R"(Member "%s" redefined (original in native class '%s'))", p_member_name, p_native_type_string), p_member_node);
  149. return ERR_PARSE_ERROR;
  150. }
  151. if (class_exists(p_member_name)) {
  152. push_error(vformat(R"(The member "%s" shadows a native class.)", p_member_name), p_member_node);
  153. return ERR_PARSE_ERROR;
  154. }
  155. return OK;
  156. }
  157. Error GDScriptAnalyzer::check_class_member_name_conflict(const GDScriptParser::ClassNode *p_class_node, const StringName &p_member_name, const GDScriptParser::Node *p_member_node) {
  158. const GDScriptParser::DataType *current_data_type = &p_class_node->base_type;
  159. while (current_data_type && current_data_type->kind == GDScriptParser::DataType::Kind::CLASS) {
  160. GDScriptParser::ClassNode *current_class_node = current_data_type->class_type;
  161. if (has_member_name_conflict_in_script_class(p_member_name, current_class_node)) {
  162. push_error(vformat(R"(The member "%s" already exists in a parent class.)", p_member_name),
  163. p_member_node);
  164. return ERR_PARSE_ERROR;
  165. }
  166. current_data_type = &current_class_node->base_type;
  167. }
  168. if (current_data_type && current_data_type->kind == GDScriptParser::DataType::Kind::NATIVE) {
  169. if (current_data_type->native_type != StringName("")) {
  170. return check_native_member_name_conflict(
  171. p_member_name,
  172. p_member_node,
  173. current_data_type->native_type);
  174. }
  175. }
  176. return OK;
  177. }
  178. Error GDScriptAnalyzer::resolve_inheritance(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  179. if (p_class->base_type.is_set()) {
  180. // Already resolved
  181. return OK;
  182. }
  183. if (p_class == parser->head) {
  184. if (p_class->identifier) {
  185. p_class->fqcn = p_class->identifier->name;
  186. } else {
  187. p_class->fqcn = parser->script_path;
  188. }
  189. } else {
  190. p_class->fqcn = p_class->outer->fqcn + "::" + String(p_class->identifier->name);
  191. }
  192. if (p_class->identifier) {
  193. StringName class_name = p_class->identifier->name;
  194. if (class_exists(class_name)) {
  195. push_error(vformat(R"(Class "%s" hides a native class.)", class_name), p_class->identifier);
  196. } else if (ScriptServer::is_global_class(class_name) && (ScriptServer::get_global_class_path(class_name) != parser->script_path || p_class != parser->head)) {
  197. push_error(vformat(R"(Class "%s" hides a global script class.)", class_name), p_class->identifier);
  198. } else if (ProjectSettings::get_singleton()->has_autoload(class_name) && ProjectSettings::get_singleton()->get_autoload(class_name).is_singleton) {
  199. push_error(vformat(R"(Class "%s" hides an autoload singleton.)", class_name), p_class->identifier);
  200. }
  201. }
  202. GDScriptParser::DataType result;
  203. // Set datatype for class.
  204. GDScriptParser::DataType class_type;
  205. class_type.is_constant = true;
  206. class_type.is_meta_type = true;
  207. class_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  208. class_type.kind = GDScriptParser::DataType::CLASS;
  209. class_type.class_type = p_class;
  210. class_type.script_path = parser->script_path;
  211. p_class->set_datatype(class_type);
  212. if (!p_class->extends_used) {
  213. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  214. result.kind = GDScriptParser::DataType::NATIVE;
  215. result.native_type = "RefCounted";
  216. } else {
  217. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  218. GDScriptParser::DataType base;
  219. int extends_index = 0;
  220. if (!p_class->extends_path.is_empty()) {
  221. Ref<GDScriptParserRef> parser = get_parser_for(p_class->extends_path);
  222. if (parser.is_null()) {
  223. push_error(vformat(R"(Could not resolve super class path "%s".)", p_class->extends_path), p_class);
  224. return ERR_PARSE_ERROR;
  225. }
  226. Error err = parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED);
  227. if (err != OK) {
  228. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", p_class->extends_path), p_class);
  229. return err;
  230. }
  231. base = parser->get_parser()->head->get_datatype();
  232. } else {
  233. if (p_class->extends.is_empty()) {
  234. return ERR_PARSE_ERROR;
  235. }
  236. const StringName &name = p_class->extends[extends_index++];
  237. base.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  238. if (ScriptServer::is_global_class(name)) {
  239. String base_path = ScriptServer::get_global_class_path(name);
  240. if (base_path == parser->script_path) {
  241. base = parser->head->get_datatype();
  242. } else {
  243. Ref<GDScriptParserRef> parser = get_parser_for(base_path);
  244. if (parser.is_null()) {
  245. push_error(vformat(R"(Could not resolve super class "%s".)", name), p_class);
  246. return ERR_PARSE_ERROR;
  247. }
  248. Error err = parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED);
  249. if (err != OK) {
  250. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), p_class);
  251. return err;
  252. }
  253. base = parser->get_parser()->head->get_datatype();
  254. }
  255. } else if (ProjectSettings::get_singleton()->has_autoload(name) && ProjectSettings::get_singleton()->get_autoload(name).is_singleton) {
  256. const ProjectSettings::AutoloadInfo &info = ProjectSettings::get_singleton()->get_autoload(name);
  257. if (info.path.get_extension().to_lower() != ".gd") {
  258. push_error(vformat(R"(Singleton %s is not a GDScript.)", info.name), p_class);
  259. return ERR_PARSE_ERROR;
  260. }
  261. Ref<GDScriptParserRef> parser = get_parser_for(info.path);
  262. if (parser.is_null()) {
  263. push_error(vformat(R"(Could not parse singleton from "%s".)", info.path), p_class);
  264. return ERR_PARSE_ERROR;
  265. }
  266. Error err = parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED);
  267. if (err != OK) {
  268. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), p_class);
  269. return err;
  270. }
  271. } else if (class_exists(name) && ClassDB::can_instantiate(name)) {
  272. base.kind = GDScriptParser::DataType::NATIVE;
  273. base.native_type = name;
  274. } else {
  275. // Look for other classes in script.
  276. GDScriptParser::ClassNode *look_class = p_class;
  277. bool found = false;
  278. while (look_class != nullptr) {
  279. if (look_class->identifier && look_class->identifier->name == name) {
  280. if (!look_class->get_datatype().is_set()) {
  281. Error err = resolve_inheritance(look_class, false);
  282. if (err) {
  283. return err;
  284. }
  285. }
  286. base = look_class->get_datatype();
  287. found = true;
  288. break;
  289. }
  290. if (look_class->members_indices.has(name) && look_class->get_member(name).type == GDScriptParser::ClassNode::Member::CLASS) {
  291. GDScriptParser::ClassNode::Member member = look_class->get_member(name);
  292. if (!member.m_class->get_datatype().is_set()) {
  293. Error err = resolve_inheritance(member.m_class, false);
  294. if (err) {
  295. return err;
  296. }
  297. }
  298. base = member.m_class->get_datatype();
  299. found = true;
  300. break;
  301. }
  302. look_class = look_class->outer;
  303. }
  304. if (!found) {
  305. push_error(vformat(R"(Could not find base class "%s".)", name), p_class);
  306. return ERR_PARSE_ERROR;
  307. }
  308. }
  309. }
  310. for (int index = extends_index; index < p_class->extends.size(); index++) {
  311. if (base.kind != GDScriptParser::DataType::CLASS) {
  312. push_error(R"(Super type "%s" is not a GDScript. Cannot get nested types.)", p_class);
  313. return ERR_PARSE_ERROR;
  314. }
  315. // TODO: Extends could use identifier nodes. That way errors can be pointed out properly and it can be used here.
  316. GDScriptParser::IdentifierNode *id = parser->alloc_node<GDScriptParser::IdentifierNode>();
  317. id->name = p_class->extends[index];
  318. reduce_identifier_from_base(id, &base);
  319. GDScriptParser::DataType id_type = id->get_datatype();
  320. if (!id_type.is_set()) {
  321. push_error(vformat(R"(Could not find type "%s" under base "%s".)", id->name, base.to_string()), p_class);
  322. }
  323. base = id_type;
  324. }
  325. result = base;
  326. }
  327. if (!result.is_set()) {
  328. // TODO: More specific error messages.
  329. push_error(vformat(R"(Could not resolve inheritance for class "%s".)", p_class->identifier == nullptr ? "<main>" : p_class->identifier->name), p_class);
  330. return ERR_PARSE_ERROR;
  331. }
  332. // Check for cyclic inheritance.
  333. const GDScriptParser::ClassNode *base_class = result.class_type;
  334. while (base_class) {
  335. if (base_class->fqcn == p_class->fqcn) {
  336. push_error("Cyclic inheritance.", p_class);
  337. return ERR_PARSE_ERROR;
  338. }
  339. base_class = base_class->base_type.class_type;
  340. }
  341. p_class->base_type = result;
  342. class_type.native_type = result.native_type;
  343. p_class->set_datatype(class_type);
  344. if (p_recursive) {
  345. for (int i = 0; i < p_class->members.size(); i++) {
  346. if (p_class->members[i].type == GDScriptParser::ClassNode::Member::CLASS) {
  347. Error err = resolve_inheritance(p_class->members[i].m_class, true);
  348. if (err) {
  349. return err;
  350. }
  351. }
  352. }
  353. }
  354. return OK;
  355. }
  356. GDScriptParser::DataType GDScriptAnalyzer::resolve_datatype(GDScriptParser::TypeNode *p_type) {
  357. GDScriptParser::DataType result;
  358. if (p_type == nullptr) {
  359. result.kind = GDScriptParser::DataType::VARIANT;
  360. return result;
  361. }
  362. result.type_source = result.ANNOTATED_EXPLICIT;
  363. result.builtin_type = Variant::OBJECT;
  364. if (p_type->type_chain.is_empty()) {
  365. // void.
  366. result.kind = GDScriptParser::DataType::BUILTIN;
  367. result.builtin_type = Variant::NIL;
  368. p_type->set_datatype(result);
  369. return result;
  370. }
  371. StringName first = p_type->type_chain[0]->name;
  372. if (first == "Variant") {
  373. result.kind = GDScriptParser::DataType::VARIANT;
  374. if (p_type->type_chain.size() > 1) {
  375. push_error(R"("Variant" type don't contain nested types.)", p_type->type_chain[1]);
  376. return GDScriptParser::DataType();
  377. }
  378. return result;
  379. }
  380. if (first == "Object") {
  381. result.kind = GDScriptParser::DataType::NATIVE;
  382. result.native_type = "Object";
  383. if (p_type->type_chain.size() > 1) {
  384. push_error(R"("Object" type don't contain nested types.)", p_type->type_chain[1]);
  385. return GDScriptParser::DataType();
  386. }
  387. return result;
  388. }
  389. if (GDScriptParser::get_builtin_type(first) < Variant::VARIANT_MAX) {
  390. // Built-in types.
  391. if (p_type->type_chain.size() > 1) {
  392. push_error(R"(Built-in types don't contain nested types.)", p_type->type_chain[1]);
  393. return GDScriptParser::DataType();
  394. }
  395. result.kind = GDScriptParser::DataType::BUILTIN;
  396. result.builtin_type = GDScriptParser::get_builtin_type(first);
  397. if (result.builtin_type == Variant::ARRAY) {
  398. GDScriptParser::DataType container_type = resolve_datatype(p_type->container_type);
  399. if (container_type.kind != GDScriptParser::DataType::VARIANT) {
  400. result.set_container_element_type(container_type);
  401. }
  402. }
  403. } else if (class_exists(first)) {
  404. // Native engine classes.
  405. result.kind = GDScriptParser::DataType::NATIVE;
  406. result.native_type = first;
  407. } else if (ScriptServer::is_global_class(first)) {
  408. if (parser->script_path == ScriptServer::get_global_class_path(first)) {
  409. result = parser->head->get_datatype();
  410. } else {
  411. Ref<GDScriptParserRef> ref = get_parser_for(ScriptServer::get_global_class_path(first));
  412. if (ref->raise_status(GDScriptParserRef::INTERFACE_SOLVED) != OK) {
  413. push_error(vformat(R"(Could not parse global class "%s" from "%s".)", first, ScriptServer::get_global_class_path(first)), p_type);
  414. return GDScriptParser::DataType();
  415. }
  416. result = ref->get_parser()->head->get_datatype();
  417. }
  418. } else if (ProjectSettings::get_singleton()->has_autoload(first) && ProjectSettings::get_singleton()->get_autoload(first).is_singleton) {
  419. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(first);
  420. Ref<GDScriptParserRef> ref = get_parser_for(autoload.path);
  421. if (ref->raise_status(GDScriptParserRef::INTERFACE_SOLVED) != OK) {
  422. push_error(vformat(R"(Could not parse singleton "%s" from "%s".)", first, autoload.path), p_type);
  423. return GDScriptParser::DataType();
  424. }
  425. result = ref->get_parser()->head->get_datatype();
  426. } else if (ClassDB::has_enum(parser->current_class->base_type.native_type, first)) {
  427. // Native enum in current class.
  428. result = make_native_enum_type(parser->current_class->base_type.native_type, first);
  429. } else {
  430. // Classes in current scope.
  431. GDScriptParser::ClassNode *script_class = parser->current_class;
  432. bool found = false;
  433. while (!found && script_class != nullptr) {
  434. if (script_class->identifier && script_class->identifier->name == first) {
  435. result = script_class->get_datatype();
  436. found = true;
  437. break;
  438. }
  439. if (script_class->members_indices.has(first)) {
  440. GDScriptParser::ClassNode::Member member = script_class->members[script_class->members_indices[first]];
  441. switch (member.type) {
  442. case GDScriptParser::ClassNode::Member::CLASS:
  443. result = member.m_class->get_datatype();
  444. found = true;
  445. break;
  446. case GDScriptParser::ClassNode::Member::ENUM:
  447. result = member.m_enum->get_datatype();
  448. found = true;
  449. break;
  450. case GDScriptParser::ClassNode::Member::CONSTANT:
  451. if (member.constant->get_datatype().is_meta_type) {
  452. result = member.constant->get_datatype();
  453. result.is_meta_type = false;
  454. found = true;
  455. break;
  456. } else if (Ref<Script>(member.constant->initializer->reduced_value).is_valid()) {
  457. Ref<GDScript> gdscript = member.constant->initializer->reduced_value;
  458. if (gdscript.is_valid()) {
  459. Ref<GDScriptParserRef> ref = get_parser_for(gdscript->get_path());
  460. if (ref->raise_status(GDScriptParserRef::INTERFACE_SOLVED) != OK) {
  461. push_error(vformat(R"(Could not parse script from "%s".)", gdscript->get_path()), p_type);
  462. return GDScriptParser::DataType();
  463. }
  464. result = ref->get_parser()->head->get_datatype();
  465. result.is_meta_type = false;
  466. } else {
  467. Ref<GDScript> script = member.constant->initializer->reduced_value;
  468. result.kind = GDScriptParser::DataType::SCRIPT;
  469. result.builtin_type = Variant::OBJECT;
  470. result.script_type = script;
  471. result.script_path = script->get_path();
  472. result.native_type = script->get_instance_base_type();
  473. }
  474. break;
  475. }
  476. [[fallthrough]];
  477. default:
  478. push_error(vformat(R"("%s" is a %s but does not contain a type.)", first, member.get_type_name()), p_type);
  479. return GDScriptParser::DataType();
  480. }
  481. }
  482. script_class = script_class->outer;
  483. }
  484. }
  485. if (!result.is_set()) {
  486. push_error(vformat(R"("%s" was not found in the current scope.)", first), p_type);
  487. result.kind = GDScriptParser::DataType::VARIANT; // Leave Variant anyway so future type check don't use an unresolved type.
  488. return result;
  489. }
  490. if (p_type->type_chain.size() > 1) {
  491. if (result.kind == GDScriptParser::DataType::CLASS) {
  492. for (int i = 1; i < p_type->type_chain.size(); i++) {
  493. GDScriptParser::DataType base = result;
  494. reduce_identifier_from_base(p_type->type_chain[i], &base);
  495. result = p_type->type_chain[i]->get_datatype();
  496. if (!result.is_set()) {
  497. 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]);
  498. result.kind = GDScriptParser::DataType::VARIANT; // Leave Variant anyway so future type check don't use an unresolved type.
  499. return result;
  500. } else if (!result.is_meta_type) {
  501. 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]);
  502. result.kind = GDScriptParser::DataType::VARIANT; // Leave Variant anyway so future type check don't use an unresolved type.
  503. return result;
  504. }
  505. }
  506. } else if (result.kind == GDScriptParser::DataType::NATIVE) {
  507. // Only enums allowed for native.
  508. if (ClassDB::has_enum(result.native_type, p_type->type_chain[1]->name)) {
  509. if (p_type->type_chain.size() > 2) {
  510. push_error(R"(Enums cannot contain nested types.)", p_type->type_chain[2]);
  511. } else {
  512. result = make_native_enum_type(result.native_type, p_type->type_chain[1]->name);
  513. }
  514. }
  515. } else {
  516. 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]);
  517. result.kind = GDScriptParser::DataType::VARIANT; // Leave Variant anyway so future type check don't use an unresolved type.
  518. return result;
  519. }
  520. }
  521. if (result.builtin_type != Variant::ARRAY && p_type->container_type != nullptr) {
  522. push_error("Only arrays can specify the collection element type.", p_type);
  523. }
  524. p_type->set_datatype(result);
  525. return result;
  526. }
  527. void GDScriptAnalyzer::resolve_class_interface(GDScriptParser::ClassNode *p_class) {
  528. if (p_class->resolved_interface) {
  529. return;
  530. }
  531. p_class->resolved_interface = true;
  532. GDScriptParser::ClassNode *previous_class = parser->current_class;
  533. parser->current_class = p_class;
  534. for (int i = 0; i < p_class->members.size(); i++) {
  535. GDScriptParser::ClassNode::Member member = p_class->members[i];
  536. switch (member.type) {
  537. case GDScriptParser::ClassNode::Member::VARIABLE: {
  538. check_class_member_name_conflict(p_class, member.variable->identifier->name, member.variable);
  539. GDScriptParser::DataType datatype;
  540. datatype.kind = GDScriptParser::DataType::VARIANT;
  541. datatype.type_source = GDScriptParser::DataType::UNDETECTED;
  542. GDScriptParser::DataType specified_type;
  543. if (member.variable->datatype_specifier != nullptr) {
  544. specified_type = resolve_datatype(member.variable->datatype_specifier);
  545. specified_type.is_meta_type = false;
  546. }
  547. if (member.variable->initializer != nullptr) {
  548. member.variable->set_datatype(datatype); // Allow recursive usage.
  549. reduce_expression(member.variable->initializer);
  550. if ((member.variable->infer_datatype || (member.variable->datatype_specifier != nullptr && specified_type.has_container_element_type())) && member.variable->initializer->type == GDScriptParser::Node::ARRAY) {
  551. // Typed array.
  552. GDScriptParser::ArrayNode *array = static_cast<GDScriptParser::ArrayNode *>(member.variable->initializer);
  553. // Can only infer typed array if it has elements.
  554. if ((member.variable->infer_datatype && array->elements.size() > 0) || member.variable->datatype_specifier != nullptr) {
  555. update_array_literal_element_type(specified_type, array);
  556. }
  557. }
  558. datatype = member.variable->initializer->get_datatype();
  559. if (datatype.type_source != GDScriptParser::DataType::UNDETECTED) {
  560. datatype.type_source = GDScriptParser::DataType::INFERRED;
  561. }
  562. }
  563. if (member.variable->datatype_specifier != nullptr) {
  564. datatype = specified_type;
  565. if (member.variable->initializer != nullptr) {
  566. if (!is_type_compatible(datatype, member.variable->initializer->get_datatype(), true)) {
  567. // Try reverse test since it can be a masked subtype.
  568. if (!is_type_compatible(member.variable->initializer->get_datatype(), datatype, true)) {
  569. 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);
  570. } else {
  571. // TODO: Add warning.
  572. mark_node_unsafe(member.variable->initializer);
  573. member.variable->use_conversion_assign = true;
  574. }
  575. } else if (datatype.builtin_type == Variant::INT && member.variable->initializer->get_datatype().builtin_type == Variant::FLOAT) {
  576. #ifdef DEBUG_ENABLED
  577. parser->push_warning(member.variable->initializer, GDScriptWarning::NARROWING_CONVERSION);
  578. #endif
  579. }
  580. if (member.variable->initializer->get_datatype().is_variant()) {
  581. // TODO: Warn unsafe assign.
  582. mark_node_unsafe(member.variable->initializer);
  583. member.variable->use_conversion_assign = true;
  584. }
  585. }
  586. } else if (member.variable->infer_datatype) {
  587. if (member.variable->initializer == nullptr) {
  588. push_error(vformat(R"(Cannot infer the type of "%s" variable because there's no default value.)", member.variable->identifier->name), member.variable->identifier);
  589. } else if (!datatype.is_set() || datatype.has_no_type()) {
  590. 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);
  591. } else if (datatype.is_variant()) {
  592. 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);
  593. } else if (datatype.builtin_type == Variant::NIL) {
  594. push_error(vformat(R"(Cannot infer the type of "%s" variable because the initial value is "null".)", member.variable->identifier->name), member.variable->initializer);
  595. }
  596. datatype.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  597. }
  598. datatype.is_constant = false;
  599. member.variable->set_datatype(datatype);
  600. // Apply annotations.
  601. for (GDScriptParser::AnnotationNode *&E : member.variable->annotations) {
  602. E->apply(parser, member.variable);
  603. }
  604. } break;
  605. case GDScriptParser::ClassNode::Member::CONSTANT: {
  606. check_class_member_name_conflict(p_class, member.constant->identifier->name, member.constant);
  607. reduce_expression(member.constant->initializer);
  608. GDScriptParser::DataType specified_type;
  609. if (member.constant->datatype_specifier != nullptr) {
  610. specified_type = resolve_datatype(member.constant->datatype_specifier);
  611. specified_type.is_meta_type = false;
  612. }
  613. GDScriptParser::DataType datatype;
  614. if (member.constant->initializer) {
  615. datatype = member.constant->initializer->get_datatype();
  616. if (member.constant->initializer->type == GDScriptParser::Node::ARRAY) {
  617. GDScriptParser::ArrayNode *array = static_cast<GDScriptParser::ArrayNode *>(member.constant->initializer);
  618. const_fold_array(array);
  619. // Can only infer typed array if it has elements.
  620. if (array->elements.size() > 0 || (member.constant->datatype_specifier != nullptr && specified_type.has_container_element_type())) {
  621. update_array_literal_element_type(specified_type, array);
  622. }
  623. } else if (member.constant->initializer->type == GDScriptParser::Node::DICTIONARY) {
  624. const_fold_dictionary(static_cast<GDScriptParser::DictionaryNode *>(member.constant->initializer));
  625. }
  626. if (!member.constant->initializer->is_constant) {
  627. push_error(R"(Initializer for a constant must be a constant expression.)", member.constant->initializer);
  628. }
  629. if (member.constant->datatype_specifier != nullptr) {
  630. datatype = specified_type;
  631. if (!is_type_compatible(datatype, member.constant->initializer->get_datatype(), true)) {
  632. 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);
  633. } else if (datatype.builtin_type == Variant::INT && member.constant->initializer->get_datatype().builtin_type == Variant::FLOAT) {
  634. #ifdef DEBUG_ENABLED
  635. parser->push_warning(member.constant->initializer, GDScriptWarning::NARROWING_CONVERSION);
  636. #endif
  637. }
  638. }
  639. }
  640. datatype.is_constant = true;
  641. member.constant->set_datatype(datatype);
  642. // Apply annotations.
  643. for (GDScriptParser::AnnotationNode *&E : member.constant->annotations) {
  644. E->apply(parser, member.constant);
  645. }
  646. } break;
  647. case GDScriptParser::ClassNode::Member::SIGNAL: {
  648. check_class_member_name_conflict(p_class, member.signal->identifier->name, member.signal);
  649. for (int j = 0; j < member.signal->parameters.size(); j++) {
  650. GDScriptParser::DataType signal_type = resolve_datatype(member.signal->parameters[j]->datatype_specifier);
  651. signal_type.is_meta_type = false;
  652. member.signal->parameters[j]->set_datatype(signal_type);
  653. }
  654. // TODO: Make MethodInfo from signal.
  655. GDScriptParser::DataType signal_type;
  656. signal_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  657. signal_type.kind = GDScriptParser::DataType::BUILTIN;
  658. signal_type.builtin_type = Variant::SIGNAL;
  659. member.signal->set_datatype(signal_type);
  660. // Apply annotations.
  661. for (GDScriptParser::AnnotationNode *&E : member.signal->annotations) {
  662. E->apply(parser, member.signal);
  663. }
  664. } break;
  665. case GDScriptParser::ClassNode::Member::ENUM: {
  666. check_class_member_name_conflict(p_class, member.m_enum->identifier->name, member.m_enum);
  667. GDScriptParser::DataType enum_type;
  668. enum_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  669. enum_type.kind = GDScriptParser::DataType::ENUM;
  670. enum_type.builtin_type = Variant::DICTIONARY;
  671. enum_type.enum_type = member.m_enum->identifier->name;
  672. enum_type.native_type = p_class->fqcn + "." + member.m_enum->identifier->name;
  673. enum_type.is_meta_type = true;
  674. enum_type.is_constant = true;
  675. // Enums can't be nested, so we can safely override this.
  676. current_enum = member.m_enum;
  677. for (int j = 0; j < member.m_enum->values.size(); j++) {
  678. GDScriptParser::EnumNode::Value &element = member.m_enum->values.write[j];
  679. if (element.custom_value) {
  680. reduce_expression(element.custom_value);
  681. if (!element.custom_value->is_constant) {
  682. push_error(R"(Enum values must be constant.)", element.custom_value);
  683. } else if (element.custom_value->reduced_value.get_type() != Variant::INT) {
  684. push_error(R"(Enum values must be integers.)", element.custom_value);
  685. } else {
  686. element.value = element.custom_value->reduced_value;
  687. element.resolved = true;
  688. }
  689. } else {
  690. if (element.index > 0) {
  691. element.value = element.parent_enum->values[element.index - 1].value + 1;
  692. } else {
  693. element.value = 0;
  694. }
  695. element.resolved = true;
  696. }
  697. enum_type.enum_values[element.identifier->name] = element.value;
  698. }
  699. current_enum = nullptr;
  700. member.m_enum->set_datatype(enum_type);
  701. // Apply annotations.
  702. for (GDScriptParser::AnnotationNode *&E : member.m_enum->annotations) {
  703. E->apply(parser, member.m_enum);
  704. }
  705. } break;
  706. case GDScriptParser::ClassNode::Member::FUNCTION:
  707. resolve_function_signature(member.function);
  708. break;
  709. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  710. if (member.enum_value.custom_value) {
  711. check_class_member_name_conflict(p_class, member.enum_value.identifier->name, member.enum_value.custom_value);
  712. current_enum = member.enum_value.parent_enum;
  713. reduce_expression(member.enum_value.custom_value);
  714. current_enum = nullptr;
  715. if (!member.enum_value.custom_value->is_constant) {
  716. push_error(R"(Enum values must be constant.)", member.enum_value.custom_value);
  717. } else if (member.enum_value.custom_value->reduced_value.get_type() != Variant::INT) {
  718. push_error(R"(Enum values must be integers.)", member.enum_value.custom_value);
  719. } else {
  720. member.enum_value.value = member.enum_value.custom_value->reduced_value;
  721. member.enum_value.resolved = true;
  722. }
  723. } else {
  724. check_class_member_name_conflict(p_class, member.enum_value.identifier->name, member.enum_value.parent_enum);
  725. if (member.enum_value.index > 0) {
  726. member.enum_value.value = member.enum_value.parent_enum->values[member.enum_value.index - 1].value + 1;
  727. } else {
  728. member.enum_value.value = 0;
  729. }
  730. member.enum_value.resolved = true;
  731. }
  732. // Also update the original references.
  733. member.enum_value.parent_enum->values.write[member.enum_value.index] = member.enum_value;
  734. p_class->members.write[i].enum_value = member.enum_value;
  735. } break;
  736. case GDScriptParser::ClassNode::Member::CLASS:
  737. check_class_member_name_conflict(p_class, member.m_class->identifier->name, member.m_class);
  738. break;
  739. case GDScriptParser::ClassNode::Member::UNDEFINED:
  740. ERR_PRINT("Trying to resolve undefined member.");
  741. break;
  742. }
  743. }
  744. // Recurse nested classes.
  745. for (int i = 0; i < p_class->members.size(); i++) {
  746. GDScriptParser::ClassNode::Member member = p_class->members[i];
  747. if (member.type != GDScriptParser::ClassNode::Member::CLASS) {
  748. continue;
  749. }
  750. resolve_class_interface(member.m_class);
  751. }
  752. parser->current_class = previous_class;
  753. }
  754. void GDScriptAnalyzer::resolve_class_body(GDScriptParser::ClassNode *p_class) {
  755. if (p_class->resolved_body) {
  756. return;
  757. }
  758. p_class->resolved_body = true;
  759. GDScriptParser::ClassNode *previous_class = parser->current_class;
  760. parser->current_class = p_class;
  761. // Do functions now.
  762. for (int i = 0; i < p_class->members.size(); i++) {
  763. GDScriptParser::ClassNode::Member member = p_class->members[i];
  764. if (member.type != GDScriptParser::ClassNode::Member::FUNCTION) {
  765. continue;
  766. }
  767. resolve_function_body(member.function);
  768. // Apply annotations.
  769. for (GDScriptParser::AnnotationNode *&E : member.function->annotations) {
  770. E->apply(parser, member.function);
  771. }
  772. }
  773. parser->current_class = previous_class;
  774. // Recurse nested classes.
  775. for (int i = 0; i < p_class->members.size(); i++) {
  776. GDScriptParser::ClassNode::Member member = p_class->members[i];
  777. if (member.type != GDScriptParser::ClassNode::Member::CLASS) {
  778. continue;
  779. }
  780. resolve_class_body(member.m_class);
  781. }
  782. // Check unused variables.
  783. for (int i = 0; i < p_class->members.size(); i++) {
  784. GDScriptParser::ClassNode::Member member = p_class->members[i];
  785. if (member.type != GDScriptParser::ClassNode::Member::VARIABLE) {
  786. continue;
  787. }
  788. #ifdef DEBUG_ENABLED
  789. if (member.variable->usages == 0 && String(member.variable->identifier->name).begins_with("_")) {
  790. parser->push_warning(member.variable->identifier, GDScriptWarning::UNUSED_PRIVATE_CLASS_VARIABLE, member.variable->identifier->name);
  791. }
  792. #endif
  793. }
  794. }
  795. void GDScriptAnalyzer::resolve_node(GDScriptParser::Node *p_node) {
  796. ERR_FAIL_COND_MSG(p_node == nullptr, "Trying to resolve type of a null node.");
  797. switch (p_node->type) {
  798. case GDScriptParser::Node::NONE:
  799. break; // Unreachable.
  800. case GDScriptParser::Node::CLASS:
  801. resolve_class_interface(static_cast<GDScriptParser::ClassNode *>(p_node));
  802. resolve_class_body(static_cast<GDScriptParser::ClassNode *>(p_node));
  803. break;
  804. case GDScriptParser::Node::CONSTANT:
  805. resolve_constant(static_cast<GDScriptParser::ConstantNode *>(p_node));
  806. break;
  807. case GDScriptParser::Node::FOR:
  808. resolve_for(static_cast<GDScriptParser::ForNode *>(p_node));
  809. break;
  810. case GDScriptParser::Node::FUNCTION:
  811. resolve_function_signature(static_cast<GDScriptParser::FunctionNode *>(p_node));
  812. resolve_function_body(static_cast<GDScriptParser::FunctionNode *>(p_node));
  813. break;
  814. case GDScriptParser::Node::IF:
  815. resolve_if(static_cast<GDScriptParser::IfNode *>(p_node));
  816. break;
  817. case GDScriptParser::Node::SUITE:
  818. resolve_suite(static_cast<GDScriptParser::SuiteNode *>(p_node));
  819. break;
  820. case GDScriptParser::Node::VARIABLE:
  821. resolve_variable(static_cast<GDScriptParser::VariableNode *>(p_node));
  822. break;
  823. case GDScriptParser::Node::WHILE:
  824. resolve_while(static_cast<GDScriptParser::WhileNode *>(p_node));
  825. break;
  826. case GDScriptParser::Node::ANNOTATION:
  827. resolve_annotation(static_cast<GDScriptParser::AnnotationNode *>(p_node));
  828. break;
  829. case GDScriptParser::Node::ASSERT:
  830. resolve_assert(static_cast<GDScriptParser::AssertNode *>(p_node));
  831. break;
  832. case GDScriptParser::Node::MATCH:
  833. resolve_match(static_cast<GDScriptParser::MatchNode *>(p_node));
  834. break;
  835. case GDScriptParser::Node::MATCH_BRANCH:
  836. resolve_match_branch(static_cast<GDScriptParser::MatchBranchNode *>(p_node), nullptr);
  837. break;
  838. case GDScriptParser::Node::PARAMETER:
  839. resolve_parameter(static_cast<GDScriptParser::ParameterNode *>(p_node));
  840. break;
  841. case GDScriptParser::Node::PATTERN:
  842. resolve_match_pattern(static_cast<GDScriptParser::PatternNode *>(p_node), nullptr);
  843. break;
  844. case GDScriptParser::Node::RETURN:
  845. resolve_return(static_cast<GDScriptParser::ReturnNode *>(p_node));
  846. break;
  847. case GDScriptParser::Node::TYPE:
  848. resolve_datatype(static_cast<GDScriptParser::TypeNode *>(p_node));
  849. break;
  850. // Resolving expression is the same as reducing them.
  851. case GDScriptParser::Node::ARRAY:
  852. case GDScriptParser::Node::ASSIGNMENT:
  853. case GDScriptParser::Node::AWAIT:
  854. case GDScriptParser::Node::BINARY_OPERATOR:
  855. case GDScriptParser::Node::CALL:
  856. case GDScriptParser::Node::CAST:
  857. case GDScriptParser::Node::DICTIONARY:
  858. case GDScriptParser::Node::GET_NODE:
  859. case GDScriptParser::Node::IDENTIFIER:
  860. case GDScriptParser::Node::LAMBDA:
  861. case GDScriptParser::Node::LITERAL:
  862. case GDScriptParser::Node::PRELOAD:
  863. case GDScriptParser::Node::SELF:
  864. case GDScriptParser::Node::SUBSCRIPT:
  865. case GDScriptParser::Node::TERNARY_OPERATOR:
  866. case GDScriptParser::Node::UNARY_OPERATOR:
  867. reduce_expression(static_cast<GDScriptParser::ExpressionNode *>(p_node));
  868. break;
  869. case GDScriptParser::Node::BREAK:
  870. case GDScriptParser::Node::BREAKPOINT:
  871. case GDScriptParser::Node::CONTINUE:
  872. case GDScriptParser::Node::ENUM:
  873. case GDScriptParser::Node::PASS:
  874. case GDScriptParser::Node::SIGNAL:
  875. // Nothing to do.
  876. break;
  877. }
  878. }
  879. void GDScriptAnalyzer::resolve_annotation(GDScriptParser::AnnotationNode *p_annotation) {
  880. // TODO: Add second validation function for annotations, so they can use checked types.
  881. }
  882. void GDScriptAnalyzer::resolve_function_signature(GDScriptParser::FunctionNode *p_function) {
  883. if (p_function->resolved_signature) {
  884. return;
  885. }
  886. p_function->resolved_signature = true;
  887. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  888. parser->current_function = p_function;
  889. for (int i = 0; i < p_function->parameters.size(); i++) {
  890. resolve_parameter(p_function->parameters[i]);
  891. #ifdef DEBUG_ENABLED
  892. if (p_function->parameters[i]->usages == 0 && !String(p_function->parameters[i]->identifier->name).begins_with("_")) {
  893. parser->push_warning(p_function->parameters[i]->identifier, GDScriptWarning::UNUSED_PARAMETER, p_function->identifier->name, p_function->parameters[i]->identifier->name);
  894. }
  895. is_shadowing(p_function->parameters[i]->identifier, "function parameter");
  896. #endif // DEBUG_ENABLED
  897. #ifdef TOOLS_ENABLED
  898. if (p_function->parameters[i]->default_value && p_function->parameters[i]->default_value->is_constant) {
  899. p_function->default_arg_values.push_back(p_function->parameters[i]->default_value->reduced_value);
  900. }
  901. #endif // TOOLS_ENABLED
  902. }
  903. if (p_function->identifier->name == "_init") {
  904. // Constructor.
  905. GDScriptParser::DataType return_type = parser->current_class->get_datatype();
  906. return_type.is_meta_type = false;
  907. p_function->set_datatype(return_type);
  908. if (p_function->return_type) {
  909. push_error("Constructor cannot have an explicit return type.", p_function->return_type);
  910. }
  911. } else {
  912. GDScriptParser::DataType return_type = resolve_datatype(p_function->return_type);
  913. p_function->set_datatype(return_type);
  914. }
  915. parser->current_function = previous_function;
  916. }
  917. void GDScriptAnalyzer::resolve_function_body(GDScriptParser::FunctionNode *p_function) {
  918. if (p_function->resolved_body) {
  919. return;
  920. }
  921. p_function->resolved_body = true;
  922. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  923. parser->current_function = p_function;
  924. resolve_suite(p_function->body);
  925. GDScriptParser::DataType return_type = p_function->body->get_datatype();
  926. if (p_function->get_datatype().has_no_type() && return_type.is_set()) {
  927. // Use the suite inferred type if return isn't explicitly set.
  928. return_type.type_source = GDScriptParser::DataType::INFERRED;
  929. p_function->set_datatype(p_function->body->get_datatype());
  930. } 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)) {
  931. if (!p_function->body->has_return && p_function->identifier->name != GDScriptLanguage::get_singleton()->strings._init) {
  932. push_error(R"(Not all code paths return a value.)", p_function);
  933. }
  934. }
  935. parser->current_function = previous_function;
  936. }
  937. void GDScriptAnalyzer::decide_suite_type(GDScriptParser::Node *p_suite, GDScriptParser::Node *p_statement) {
  938. if (p_statement == nullptr) {
  939. return;
  940. }
  941. switch (p_statement->type) {
  942. case GDScriptParser::Node::IF:
  943. case GDScriptParser::Node::FOR:
  944. case GDScriptParser::Node::MATCH:
  945. case GDScriptParser::Node::PATTERN:
  946. case GDScriptParser::Node::RETURN:
  947. case GDScriptParser::Node::WHILE:
  948. // Use return or nested suite type as this suite type.
  949. if (p_suite->get_datatype().is_set() && (p_suite->get_datatype() != p_statement->get_datatype())) {
  950. // Mixed types.
  951. // TODO: This could use the common supertype instead.
  952. p_suite->datatype.kind = GDScriptParser::DataType::VARIANT;
  953. p_suite->datatype.type_source = GDScriptParser::DataType::UNDETECTED;
  954. } else {
  955. p_suite->set_datatype(p_statement->get_datatype());
  956. p_suite->datatype.type_source = GDScriptParser::DataType::INFERRED;
  957. }
  958. break;
  959. default:
  960. break;
  961. }
  962. }
  963. void GDScriptAnalyzer::resolve_suite(GDScriptParser::SuiteNode *p_suite) {
  964. for (int i = 0; i < p_suite->statements.size(); i++) {
  965. GDScriptParser::Node *stmt = p_suite->statements[i];
  966. resolve_node(stmt);
  967. decide_suite_type(p_suite, stmt);
  968. }
  969. }
  970. void GDScriptAnalyzer::resolve_if(GDScriptParser::IfNode *p_if) {
  971. reduce_expression(p_if->condition);
  972. resolve_suite(p_if->true_block);
  973. p_if->set_datatype(p_if->true_block->get_datatype());
  974. if (p_if->false_block != nullptr) {
  975. resolve_suite(p_if->false_block);
  976. decide_suite_type(p_if, p_if->false_block);
  977. }
  978. }
  979. void GDScriptAnalyzer::resolve_for(GDScriptParser::ForNode *p_for) {
  980. bool list_resolved = false;
  981. // Optimize constant range() call to not allocate an array.
  982. // Use int, Vector2, Vector3 instead, which also can be used as range iterators.
  983. if (p_for->list && p_for->list->type == GDScriptParser::Node::CALL) {
  984. GDScriptParser::CallNode *call = static_cast<GDScriptParser::CallNode *>(p_for->list);
  985. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  986. if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  987. GDScriptParser::IdentifierNode *callee = static_cast<GDScriptParser::IdentifierNode *>(call->callee);
  988. if (callee->name == "range") {
  989. list_resolved = true;
  990. if (call->arguments.size() < 1) {
  991. push_error(R"*(Invalid call for "range()" function. Expected at least 1 argument, none given.)*", call->callee);
  992. } else if (call->arguments.size() > 3) {
  993. push_error(vformat(R"*(Invalid call for "range()" function. Expected at most 3 arguments, %d given.)*", call->arguments.size()), call->callee);
  994. } else {
  995. // Now we can optimize it.
  996. bool all_is_constant = true;
  997. Vector<Variant> args;
  998. args.resize(call->arguments.size());
  999. for (int i = 0; i < call->arguments.size(); i++) {
  1000. reduce_expression(call->arguments[i]);
  1001. if (!call->arguments[i]->is_constant) {
  1002. all_is_constant = false;
  1003. } else if (all_is_constant) {
  1004. args.write[i] = call->arguments[i]->reduced_value;
  1005. }
  1006. GDScriptParser::DataType arg_type = call->arguments[i]->get_datatype();
  1007. if (!arg_type.is_variant()) {
  1008. if (arg_type.kind != GDScriptParser::DataType::BUILTIN) {
  1009. all_is_constant = false;
  1010. 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]);
  1011. } else if (arg_type.builtin_type != Variant::INT && arg_type.builtin_type != Variant::FLOAT) {
  1012. all_is_constant = false;
  1013. 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]);
  1014. }
  1015. }
  1016. }
  1017. Variant reduced;
  1018. if (all_is_constant) {
  1019. switch (args.size()) {
  1020. case 1:
  1021. reduced = args[0];
  1022. break;
  1023. case 2:
  1024. reduced = Vector2i(args[0], args[1]);
  1025. break;
  1026. case 3:
  1027. reduced = Vector3i(args[0], args[1], args[2]);
  1028. break;
  1029. }
  1030. p_for->list->is_constant = true;
  1031. p_for->list->reduced_value = reduced;
  1032. }
  1033. }
  1034. if (p_for->list->is_constant) {
  1035. p_for->list->set_datatype(type_from_variant(p_for->list->reduced_value, p_for->list));
  1036. } else {
  1037. GDScriptParser::DataType list_type;
  1038. list_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1039. list_type.kind = GDScriptParser::DataType::BUILTIN;
  1040. list_type.builtin_type = Variant::ARRAY;
  1041. p_for->list->set_datatype(list_type);
  1042. }
  1043. }
  1044. }
  1045. }
  1046. if (!list_resolved) {
  1047. resolve_node(p_for->list);
  1048. }
  1049. // TODO: If list is a typed array, the variable should be an element.
  1050. // Also applicable for constant range() (so variable is int or float).
  1051. resolve_suite(p_for->loop);
  1052. p_for->set_datatype(p_for->loop->get_datatype());
  1053. #ifdef DEBUG_ENABLED
  1054. if (p_for->variable) {
  1055. is_shadowing(p_for->variable, R"("for" iterator variable)");
  1056. }
  1057. #endif
  1058. }
  1059. void GDScriptAnalyzer::resolve_while(GDScriptParser::WhileNode *p_while) {
  1060. resolve_node(p_while->condition);
  1061. resolve_suite(p_while->loop);
  1062. p_while->set_datatype(p_while->loop->get_datatype());
  1063. }
  1064. void GDScriptAnalyzer::resolve_variable(GDScriptParser::VariableNode *p_variable) {
  1065. GDScriptParser::DataType type;
  1066. type.kind = GDScriptParser::DataType::VARIANT; // By default.
  1067. GDScriptParser::DataType specified_type;
  1068. if (p_variable->datatype_specifier != nullptr) {
  1069. specified_type = resolve_datatype(p_variable->datatype_specifier);
  1070. specified_type.is_meta_type = false;
  1071. }
  1072. if (p_variable->initializer != nullptr) {
  1073. reduce_expression(p_variable->initializer);
  1074. if ((p_variable->infer_datatype || (p_variable->datatype_specifier != nullptr && specified_type.has_container_element_type())) && p_variable->initializer->type == GDScriptParser::Node::ARRAY) {
  1075. // Typed array.
  1076. GDScriptParser::ArrayNode *array = static_cast<GDScriptParser::ArrayNode *>(p_variable->initializer);
  1077. // Can only infer typed array if it has elements.
  1078. if ((p_variable->infer_datatype && array->elements.size() > 0) || p_variable->datatype_specifier != nullptr) {
  1079. update_array_literal_element_type(specified_type, array);
  1080. }
  1081. }
  1082. type = p_variable->initializer->get_datatype();
  1083. if (p_variable->infer_datatype) {
  1084. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1085. if (type.has_no_type()) {
  1086. 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);
  1087. } else if (type.is_variant()) {
  1088. 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);
  1089. } else if (type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL) {
  1090. 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);
  1091. }
  1092. } else {
  1093. type.type_source = GDScriptParser::DataType::INFERRED;
  1094. }
  1095. #ifdef DEBUG_ENABLED
  1096. if (p_variable->initializer->type == GDScriptParser::Node::CALL && type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL) {
  1097. parser->push_warning(p_variable->initializer, GDScriptWarning::VOID_ASSIGNMENT, static_cast<GDScriptParser::CallNode *>(p_variable->initializer)->function_name);
  1098. }
  1099. #endif
  1100. }
  1101. if (p_variable->datatype_specifier != nullptr) {
  1102. type = specified_type;
  1103. type.is_meta_type = false;
  1104. if (p_variable->initializer != nullptr) {
  1105. if (!is_type_compatible(type, p_variable->initializer->get_datatype(), true)) {
  1106. // Try reverse test since it can be a masked subtype.
  1107. if (!is_type_compatible(p_variable->initializer->get_datatype(), type, true)) {
  1108. 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);
  1109. } else {
  1110. // TODO: Add warning.
  1111. mark_node_unsafe(p_variable->initializer);
  1112. p_variable->use_conversion_assign = true;
  1113. }
  1114. #ifdef DEBUG_ENABLED
  1115. } else if (type.builtin_type == Variant::INT && p_variable->initializer->get_datatype().builtin_type == Variant::FLOAT) {
  1116. parser->push_warning(p_variable->initializer, GDScriptWarning::NARROWING_CONVERSION);
  1117. #endif
  1118. }
  1119. if (p_variable->initializer->get_datatype().is_variant()) {
  1120. // TODO: Warn unsafe assign.
  1121. mark_node_unsafe(p_variable->initializer);
  1122. p_variable->use_conversion_assign = true;
  1123. }
  1124. }
  1125. } else if (p_variable->infer_datatype) {
  1126. if (type.has_no_type()) {
  1127. 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);
  1128. }
  1129. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1130. }
  1131. type.is_constant = false;
  1132. p_variable->set_datatype(type);
  1133. #ifdef DEBUG_ENABLED
  1134. if (p_variable->usages == 0 && !String(p_variable->identifier->name).begins_with("_")) {
  1135. parser->push_warning(p_variable, GDScriptWarning::UNUSED_VARIABLE, p_variable->identifier->name);
  1136. } else if (p_variable->assignments == 0) {
  1137. parser->push_warning(p_variable, GDScriptWarning::UNASSIGNED_VARIABLE, p_variable->identifier->name);
  1138. }
  1139. is_shadowing(p_variable->identifier, "variable");
  1140. #endif
  1141. }
  1142. void GDScriptAnalyzer::resolve_constant(GDScriptParser::ConstantNode *p_constant) {
  1143. GDScriptParser::DataType type;
  1144. if (p_constant->initializer != nullptr) {
  1145. reduce_expression(p_constant->initializer);
  1146. if (p_constant->initializer->type == GDScriptParser::Node::ARRAY) {
  1147. const_fold_array(static_cast<GDScriptParser::ArrayNode *>(p_constant->initializer));
  1148. } else if (p_constant->initializer->type == GDScriptParser::Node::DICTIONARY) {
  1149. const_fold_dictionary(static_cast<GDScriptParser::DictionaryNode *>(p_constant->initializer));
  1150. }
  1151. if (!p_constant->initializer->is_constant) {
  1152. push_error(vformat(R"(Assigned value for constant "%s" isn't a constant expression.)", p_constant->identifier->name), p_constant->initializer);
  1153. }
  1154. type = p_constant->initializer->get_datatype();
  1155. #ifdef DEBUG_ENABLED
  1156. if (p_constant->initializer->type == GDScriptParser::Node::CALL && type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL) {
  1157. parser->push_warning(p_constant->initializer, GDScriptWarning::VOID_ASSIGNMENT, static_cast<GDScriptParser::CallNode *>(p_constant->initializer)->function_name);
  1158. }
  1159. #endif
  1160. }
  1161. if (p_constant->datatype_specifier != nullptr) {
  1162. GDScriptParser::DataType explicit_type = resolve_datatype(p_constant->datatype_specifier);
  1163. explicit_type.is_meta_type = false;
  1164. if (!is_type_compatible(explicit_type, type)) {
  1165. 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);
  1166. #ifdef DEBUG_ENABLED
  1167. } else if (explicit_type.builtin_type == Variant::INT && type.builtin_type == Variant::FLOAT) {
  1168. parser->push_warning(p_constant->initializer, GDScriptWarning::NARROWING_CONVERSION);
  1169. #endif
  1170. }
  1171. type = explicit_type;
  1172. } else if (p_constant->infer_datatype) {
  1173. if (type.has_no_type()) {
  1174. 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);
  1175. }
  1176. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1177. }
  1178. type.is_constant = true;
  1179. p_constant->set_datatype(type);
  1180. #ifdef DEBUG_ENABLED
  1181. if (p_constant->usages == 0) {
  1182. parser->push_warning(p_constant, GDScriptWarning::UNUSED_LOCAL_CONSTANT, p_constant->identifier->name);
  1183. }
  1184. is_shadowing(p_constant->identifier, "constant");
  1185. #endif
  1186. }
  1187. void GDScriptAnalyzer::resolve_assert(GDScriptParser::AssertNode *p_assert) {
  1188. reduce_expression(p_assert->condition);
  1189. if (p_assert->message != nullptr) {
  1190. reduce_expression(p_assert->message);
  1191. if (!p_assert->message->is_constant || p_assert->message->reduced_value.get_type() != Variant::STRING) {
  1192. push_error(R"(Expected constant string for assert error message.)", p_assert->message);
  1193. }
  1194. }
  1195. p_assert->set_datatype(p_assert->condition->get_datatype());
  1196. #ifdef DEBUG_ENABLED
  1197. if (p_assert->condition->is_constant) {
  1198. if (p_assert->condition->reduced_value.booleanize()) {
  1199. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_TRUE);
  1200. } else {
  1201. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_FALSE);
  1202. }
  1203. }
  1204. #endif
  1205. }
  1206. void GDScriptAnalyzer::resolve_match(GDScriptParser::MatchNode *p_match) {
  1207. reduce_expression(p_match->test);
  1208. for (int i = 0; i < p_match->branches.size(); i++) {
  1209. resolve_match_branch(p_match->branches[i], p_match->test);
  1210. decide_suite_type(p_match, p_match->branches[i]);
  1211. }
  1212. }
  1213. void GDScriptAnalyzer::resolve_match_branch(GDScriptParser::MatchBranchNode *p_match_branch, GDScriptParser::ExpressionNode *p_match_test) {
  1214. for (int i = 0; i < p_match_branch->patterns.size(); i++) {
  1215. resolve_match_pattern(p_match_branch->patterns[i], p_match_test);
  1216. }
  1217. resolve_suite(p_match_branch->block);
  1218. decide_suite_type(p_match_branch, p_match_branch->block);
  1219. }
  1220. void GDScriptAnalyzer::resolve_match_pattern(GDScriptParser::PatternNode *p_match_pattern, GDScriptParser::ExpressionNode *p_match_test) {
  1221. if (p_match_pattern == nullptr) {
  1222. return;
  1223. }
  1224. GDScriptParser::DataType result;
  1225. switch (p_match_pattern->pattern_type) {
  1226. case GDScriptParser::PatternNode::PT_LITERAL:
  1227. if (p_match_pattern->literal) {
  1228. reduce_literal(p_match_pattern->literal);
  1229. result = p_match_pattern->literal->get_datatype();
  1230. }
  1231. break;
  1232. case GDScriptParser::PatternNode::PT_EXPRESSION:
  1233. if (p_match_pattern->expression) {
  1234. reduce_expression(p_match_pattern->expression);
  1235. if (!p_match_pattern->expression->is_constant) {
  1236. push_error(R"(Expression in match pattern must be a constant.)", p_match_pattern->expression);
  1237. }
  1238. result = p_match_pattern->expression->get_datatype();
  1239. }
  1240. break;
  1241. case GDScriptParser::PatternNode::PT_BIND:
  1242. if (p_match_test != nullptr) {
  1243. result = p_match_test->get_datatype();
  1244. } else {
  1245. result.kind = GDScriptParser::DataType::VARIANT;
  1246. }
  1247. p_match_pattern->bind->set_datatype(result);
  1248. #ifdef DEBUG_ENABLED
  1249. is_shadowing(p_match_pattern->bind, "pattern bind");
  1250. if (p_match_pattern->bind->usages == 0) {
  1251. parser->push_warning(p_match_pattern->bind, GDScriptWarning::UNASSIGNED_VARIABLE, p_match_pattern->bind->name);
  1252. }
  1253. #endif
  1254. break;
  1255. case GDScriptParser::PatternNode::PT_ARRAY:
  1256. for (int i = 0; i < p_match_pattern->array.size(); i++) {
  1257. resolve_match_pattern(p_match_pattern->array[i], nullptr);
  1258. decide_suite_type(p_match_pattern, p_match_pattern->array[i]);
  1259. }
  1260. result = p_match_pattern->get_datatype();
  1261. break;
  1262. case GDScriptParser::PatternNode::PT_DICTIONARY:
  1263. for (int i = 0; i < p_match_pattern->dictionary.size(); i++) {
  1264. if (p_match_pattern->dictionary[i].key) {
  1265. reduce_expression(p_match_pattern->dictionary[i].key);
  1266. if (!p_match_pattern->dictionary[i].key->is_constant) {
  1267. push_error(R"(Expression in dictionary pattern key must be a constant.)", p_match_pattern->expression);
  1268. }
  1269. }
  1270. if (p_match_pattern->dictionary[i].value_pattern) {
  1271. resolve_match_pattern(p_match_pattern->dictionary[i].value_pattern, nullptr);
  1272. decide_suite_type(p_match_pattern, p_match_pattern->dictionary[i].value_pattern);
  1273. }
  1274. }
  1275. result = p_match_pattern->get_datatype();
  1276. break;
  1277. case GDScriptParser::PatternNode::PT_WILDCARD:
  1278. case GDScriptParser::PatternNode::PT_REST:
  1279. result.kind = GDScriptParser::DataType::VARIANT;
  1280. break;
  1281. }
  1282. p_match_pattern->set_datatype(result);
  1283. }
  1284. void GDScriptAnalyzer::resolve_parameter(GDScriptParser::ParameterNode *p_parameter) {
  1285. GDScriptParser::DataType result;
  1286. result.kind = GDScriptParser::DataType::VARIANT;
  1287. if (p_parameter->default_value != nullptr) {
  1288. reduce_expression(p_parameter->default_value);
  1289. result = p_parameter->default_value->get_datatype();
  1290. if (p_parameter->infer_datatype) {
  1291. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1292. } else {
  1293. result.type_source = GDScriptParser::DataType::INFERRED;
  1294. }
  1295. result.is_constant = false;
  1296. }
  1297. if (p_parameter->datatype_specifier != nullptr) {
  1298. resolve_datatype(p_parameter->datatype_specifier);
  1299. result = p_parameter->datatype_specifier->get_datatype();
  1300. result.is_meta_type = false;
  1301. if (p_parameter->default_value != nullptr) {
  1302. if (!is_type_compatible(result, p_parameter->default_value->get_datatype())) {
  1303. push_error(vformat(R"(Type of default value for parameter "%s" (%s) is not compatible with parameter 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);
  1304. } else if (p_parameter->default_value->get_datatype().is_variant()) {
  1305. mark_node_unsafe(p_parameter);
  1306. }
  1307. }
  1308. }
  1309. if (result.builtin_type == Variant::Type::NIL && result.type_source == GDScriptParser::DataType::ANNOTATED_INFERRED && p_parameter->datatype_specifier == nullptr) {
  1310. push_error(vformat(R"(Could not infer the type of the variable "%s" because the initial value is "null".)", p_parameter->identifier->name), p_parameter->default_value);
  1311. }
  1312. p_parameter->set_datatype(result);
  1313. }
  1314. void GDScriptAnalyzer::resolve_return(GDScriptParser::ReturnNode *p_return) {
  1315. GDScriptParser::DataType result;
  1316. if (p_return->return_value != nullptr) {
  1317. reduce_expression(p_return->return_value);
  1318. if (p_return->return_value->type == GDScriptParser::Node::ARRAY) {
  1319. // Check if assigned value is an array literal, so we can make it a typed array too if appropriate.
  1320. if (parser->current_function->get_datatype().has_container_element_type() && p_return->return_value->type == GDScriptParser::Node::ARRAY) {
  1321. update_array_literal_element_type(parser->current_function->get_datatype(), static_cast<GDScriptParser::ArrayNode *>(p_return->return_value));
  1322. }
  1323. }
  1324. result = p_return->return_value->get_datatype();
  1325. } else {
  1326. // Return type is null by default.
  1327. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1328. result.kind = GDScriptParser::DataType::BUILTIN;
  1329. result.builtin_type = Variant::NIL;
  1330. result.is_constant = true;
  1331. }
  1332. GDScriptParser::DataType function_type = parser->current_function->get_datatype();
  1333. function_type.is_meta_type = false;
  1334. if (function_type.is_hard_type()) {
  1335. if (!is_type_compatible(function_type, result)) {
  1336. // Try other way. Okay but not safe.
  1337. if (!is_type_compatible(result, function_type)) {
  1338. 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);
  1339. } else {
  1340. // TODO: Add warning.
  1341. mark_node_unsafe(p_return);
  1342. }
  1343. #ifdef DEBUG_ENABLED
  1344. } else if (function_type.builtin_type == Variant::INT && result.builtin_type == Variant::FLOAT) {
  1345. parser->push_warning(p_return, GDScriptWarning::NARROWING_CONVERSION);
  1346. } else if (result.is_variant()) {
  1347. mark_node_unsafe(p_return);
  1348. #endif
  1349. }
  1350. }
  1351. p_return->set_datatype(result);
  1352. }
  1353. void GDScriptAnalyzer::reduce_expression(GDScriptParser::ExpressionNode *p_expression) {
  1354. // This one makes some magic happen.
  1355. if (p_expression == nullptr) {
  1356. return;
  1357. }
  1358. if (p_expression->reduced) {
  1359. // Don't do this more than once.
  1360. return;
  1361. }
  1362. p_expression->reduced = true;
  1363. switch (p_expression->type) {
  1364. case GDScriptParser::Node::ARRAY:
  1365. reduce_array(static_cast<GDScriptParser::ArrayNode *>(p_expression));
  1366. break;
  1367. case GDScriptParser::Node::ASSIGNMENT:
  1368. reduce_assignment(static_cast<GDScriptParser::AssignmentNode *>(p_expression));
  1369. break;
  1370. case GDScriptParser::Node::AWAIT:
  1371. reduce_await(static_cast<GDScriptParser::AwaitNode *>(p_expression));
  1372. break;
  1373. case GDScriptParser::Node::BINARY_OPERATOR:
  1374. reduce_binary_op(static_cast<GDScriptParser::BinaryOpNode *>(p_expression));
  1375. break;
  1376. case GDScriptParser::Node::CALL:
  1377. reduce_call(static_cast<GDScriptParser::CallNode *>(p_expression));
  1378. break;
  1379. case GDScriptParser::Node::CAST:
  1380. reduce_cast(static_cast<GDScriptParser::CastNode *>(p_expression));
  1381. break;
  1382. case GDScriptParser::Node::DICTIONARY:
  1383. reduce_dictionary(static_cast<GDScriptParser::DictionaryNode *>(p_expression));
  1384. break;
  1385. case GDScriptParser::Node::GET_NODE:
  1386. reduce_get_node(static_cast<GDScriptParser::GetNodeNode *>(p_expression));
  1387. break;
  1388. case GDScriptParser::Node::IDENTIFIER:
  1389. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_expression));
  1390. break;
  1391. case GDScriptParser::Node::LAMBDA:
  1392. reduce_lambda(static_cast<GDScriptParser::LambdaNode *>(p_expression));
  1393. break;
  1394. case GDScriptParser::Node::LITERAL:
  1395. reduce_literal(static_cast<GDScriptParser::LiteralNode *>(p_expression));
  1396. break;
  1397. case GDScriptParser::Node::PRELOAD:
  1398. reduce_preload(static_cast<GDScriptParser::PreloadNode *>(p_expression));
  1399. break;
  1400. case GDScriptParser::Node::SELF:
  1401. reduce_self(static_cast<GDScriptParser::SelfNode *>(p_expression));
  1402. break;
  1403. case GDScriptParser::Node::SUBSCRIPT:
  1404. reduce_subscript(static_cast<GDScriptParser::SubscriptNode *>(p_expression));
  1405. break;
  1406. case GDScriptParser::Node::TERNARY_OPERATOR:
  1407. reduce_ternary_op(static_cast<GDScriptParser::TernaryOpNode *>(p_expression));
  1408. break;
  1409. case GDScriptParser::Node::UNARY_OPERATOR:
  1410. reduce_unary_op(static_cast<GDScriptParser::UnaryOpNode *>(p_expression));
  1411. break;
  1412. // Non-expressions. Here only to make sure new nodes aren't forgotten.
  1413. case GDScriptParser::Node::NONE:
  1414. case GDScriptParser::Node::ANNOTATION:
  1415. case GDScriptParser::Node::ASSERT:
  1416. case GDScriptParser::Node::BREAK:
  1417. case GDScriptParser::Node::BREAKPOINT:
  1418. case GDScriptParser::Node::CLASS:
  1419. case GDScriptParser::Node::CONSTANT:
  1420. case GDScriptParser::Node::CONTINUE:
  1421. case GDScriptParser::Node::ENUM:
  1422. case GDScriptParser::Node::FOR:
  1423. case GDScriptParser::Node::FUNCTION:
  1424. case GDScriptParser::Node::IF:
  1425. case GDScriptParser::Node::MATCH:
  1426. case GDScriptParser::Node::MATCH_BRANCH:
  1427. case GDScriptParser::Node::PARAMETER:
  1428. case GDScriptParser::Node::PASS:
  1429. case GDScriptParser::Node::PATTERN:
  1430. case GDScriptParser::Node::RETURN:
  1431. case GDScriptParser::Node::SIGNAL:
  1432. case GDScriptParser::Node::SUITE:
  1433. case GDScriptParser::Node::TYPE:
  1434. case GDScriptParser::Node::VARIABLE:
  1435. case GDScriptParser::Node::WHILE:
  1436. ERR_FAIL_MSG("Reaching unreachable case");
  1437. }
  1438. }
  1439. void GDScriptAnalyzer::reduce_array(GDScriptParser::ArrayNode *p_array) {
  1440. for (int i = 0; i < p_array->elements.size(); i++) {
  1441. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  1442. reduce_expression(element);
  1443. }
  1444. // It's array in any case.
  1445. GDScriptParser::DataType arr_type;
  1446. arr_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1447. arr_type.kind = GDScriptParser::DataType::BUILTIN;
  1448. arr_type.builtin_type = Variant::ARRAY;
  1449. arr_type.is_constant = true;
  1450. p_array->set_datatype(arr_type);
  1451. }
  1452. // When an array literal is stored (or passed as function argument) to a typed context, we then assume the array is typed.
  1453. // This function determines which type is that (if any).
  1454. void GDScriptAnalyzer::update_array_literal_element_type(const GDScriptParser::DataType &p_base_type, GDScriptParser::ArrayNode *p_array_literal) {
  1455. GDScriptParser::DataType array_type = p_array_literal->get_datatype();
  1456. if (p_array_literal->elements.size() == 0) {
  1457. // Empty array literal, just make the same type as the storage.
  1458. array_type.set_container_element_type(p_base_type.get_container_element_type());
  1459. } else {
  1460. // Check if elements match.
  1461. bool all_same_type = true;
  1462. bool all_have_type = true;
  1463. GDScriptParser::DataType element_type;
  1464. for (int i = 0; i < p_array_literal->elements.size(); i++) {
  1465. if (i == 0) {
  1466. element_type = p_array_literal->elements[0]->get_datatype();
  1467. } else {
  1468. GDScriptParser::DataType this_element_type = p_array_literal->elements[i]->get_datatype();
  1469. if (this_element_type.has_no_type()) {
  1470. all_same_type = false;
  1471. all_have_type = false;
  1472. break;
  1473. } else if (element_type != this_element_type) {
  1474. if (!is_type_compatible(element_type, this_element_type, false)) {
  1475. if (is_type_compatible(this_element_type, element_type, false)) {
  1476. // This element is a super-type to the previous type, so we use the super-type.
  1477. element_type = this_element_type;
  1478. } else {
  1479. // It's incompatible.
  1480. all_same_type = false;
  1481. break;
  1482. }
  1483. }
  1484. }
  1485. }
  1486. }
  1487. if (all_same_type) {
  1488. array_type.set_container_element_type(element_type);
  1489. } else if (all_have_type) {
  1490. push_error(vformat(R"(Variant array is not compatible with an array of type "%s".)", p_base_type.get_container_element_type().to_string()), p_array_literal);
  1491. }
  1492. }
  1493. // Update the type on the value itself.
  1494. p_array_literal->set_datatype(array_type);
  1495. }
  1496. void GDScriptAnalyzer::reduce_assignment(GDScriptParser::AssignmentNode *p_assignment) {
  1497. reduce_expression(p_assignment->assignee);
  1498. reduce_expression(p_assignment->assigned_value);
  1499. if (p_assignment->assigned_value == nullptr || p_assignment->assignee == nullptr) {
  1500. return;
  1501. }
  1502. GDScriptParser::DataType assignee_type = p_assignment->assignee->get_datatype();
  1503. // Check if assigned value is an array literal, so we can make it a typed array too if appropriate.
  1504. if (assignee_type.has_container_element_type() && p_assignment->assigned_value->type == GDScriptParser::Node::ARRAY) {
  1505. update_array_literal_element_type(assignee_type, static_cast<GDScriptParser::ArrayNode *>(p_assignment->assigned_value));
  1506. }
  1507. GDScriptParser::DataType assigned_value_type = p_assignment->assigned_value->get_datatype();
  1508. if (assignee_type.is_constant) {
  1509. push_error("Cannot assign a new value to a constant.", p_assignment->assignee);
  1510. }
  1511. if (!assignee_type.is_variant() && !assigned_value_type.is_variant()) {
  1512. bool compatible = true;
  1513. GDScriptParser::DataType op_type = assigned_value_type;
  1514. if (p_assignment->operation != GDScriptParser::AssignmentNode::OP_NONE) {
  1515. op_type = get_operation_type(p_assignment->variant_op, assignee_type, assigned_value_type, compatible, p_assignment->assigned_value);
  1516. }
  1517. if (compatible) {
  1518. compatible = is_type_compatible(assignee_type, op_type, true);
  1519. if (!compatible) {
  1520. if (assignee_type.is_hard_type()) {
  1521. // Try reverse test since it can be a masked subtype.
  1522. if (!is_type_compatible(op_type, assignee_type, true)) {
  1523. push_error(vformat(R"(Cannot assign a value of type "%s" to a target of type "%s".)", assigned_value_type.to_string(), assignee_type.to_string()), p_assignment->assigned_value);
  1524. } else {
  1525. // TODO: Add warning.
  1526. mark_node_unsafe(p_assignment);
  1527. p_assignment->use_conversion_assign = true;
  1528. }
  1529. } else {
  1530. // TODO: Warning in this case.
  1531. mark_node_unsafe(p_assignment);
  1532. p_assignment->use_conversion_assign = true;
  1533. }
  1534. }
  1535. } else {
  1536. push_error(vformat(R"(Invalid operands "%s" and "%s" for assignment operator.)", assignee_type.to_string(), assigned_value_type.to_string()), p_assignment);
  1537. }
  1538. }
  1539. if (assignee_type.has_no_type() || assigned_value_type.is_variant()) {
  1540. mark_node_unsafe(p_assignment);
  1541. if (assignee_type.is_hard_type()) {
  1542. p_assignment->use_conversion_assign = true;
  1543. }
  1544. }
  1545. if (p_assignment->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  1546. // Change source type so it's not wrongly detected later.
  1547. GDScriptParser::IdentifierNode *identifier = static_cast<GDScriptParser::IdentifierNode *>(p_assignment->assignee);
  1548. switch (identifier->source) {
  1549. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE: {
  1550. GDScriptParser::DataType id_type = identifier->variable_source->get_datatype();
  1551. if (!id_type.is_hard_type()) {
  1552. id_type.kind = GDScriptParser::DataType::VARIANT;
  1553. id_type.type_source = GDScriptParser::DataType::UNDETECTED;
  1554. identifier->variable_source->set_datatype(id_type);
  1555. }
  1556. } break;
  1557. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE: {
  1558. GDScriptParser::DataType id_type = identifier->variable_source->get_datatype();
  1559. if (!id_type.is_hard_type()) {
  1560. id_type = assigned_value_type;
  1561. id_type.type_source = GDScriptParser::DataType::INFERRED;
  1562. id_type.is_constant = false;
  1563. identifier->variable_source->set_datatype(id_type);
  1564. }
  1565. } break;
  1566. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR: {
  1567. GDScriptParser::DataType id_type = identifier->bind_source->get_datatype();
  1568. if (!id_type.is_hard_type()) {
  1569. id_type = assigned_value_type;
  1570. id_type.type_source = GDScriptParser::DataType::INFERRED;
  1571. id_type.is_constant = false;
  1572. identifier->variable_source->set_datatype(id_type);
  1573. }
  1574. } break;
  1575. default:
  1576. // Nothing to do.
  1577. break;
  1578. }
  1579. }
  1580. #ifdef DEBUG_ENABLED
  1581. if (p_assignment->assigned_value->type == GDScriptParser::Node::CALL && assigned_value_type.kind == GDScriptParser::DataType::BUILTIN && assigned_value_type.builtin_type == Variant::NIL) {
  1582. parser->push_warning(p_assignment->assigned_value, GDScriptWarning::VOID_ASSIGNMENT, static_cast<GDScriptParser::CallNode *>(p_assignment->assigned_value)->function_name);
  1583. } else if (assignee_type.is_hard_type() && assignee_type.builtin_type == Variant::INT && assigned_value_type.builtin_type == Variant::FLOAT) {
  1584. parser->push_warning(p_assignment->assigned_value, GDScriptWarning::NARROWING_CONVERSION);
  1585. }
  1586. #endif
  1587. }
  1588. void GDScriptAnalyzer::reduce_await(GDScriptParser::AwaitNode *p_await) {
  1589. if (p_await->to_await == nullptr) {
  1590. GDScriptParser::DataType await_type;
  1591. await_type.kind = GDScriptParser::DataType::VARIANT;
  1592. p_await->set_datatype(await_type);
  1593. return;
  1594. }
  1595. if (p_await->to_await->type == GDScriptParser::Node::CALL) {
  1596. reduce_call(static_cast<GDScriptParser::CallNode *>(p_await->to_await), true);
  1597. } else {
  1598. reduce_expression(p_await->to_await);
  1599. }
  1600. p_await->is_constant = p_await->to_await->is_constant;
  1601. p_await->reduced_value = p_await->to_await->reduced_value;
  1602. GDScriptParser::DataType awaiting_type = p_await->to_await->get_datatype();
  1603. p_await->set_datatype(awaiting_type);
  1604. #ifdef DEBUG_ENABLED
  1605. if (!awaiting_type.is_coroutine && awaiting_type.builtin_type != Variant::SIGNAL) {
  1606. parser->push_warning(p_await, GDScriptWarning::REDUNDANT_AWAIT);
  1607. }
  1608. #endif
  1609. }
  1610. void GDScriptAnalyzer::reduce_binary_op(GDScriptParser::BinaryOpNode *p_binary_op) {
  1611. reduce_expression(p_binary_op->left_operand);
  1612. if (p_binary_op->operation == GDScriptParser::BinaryOpNode::OP_TYPE_TEST && p_binary_op->right_operand && p_binary_op->right_operand->type == GDScriptParser::Node::IDENTIFIER) {
  1613. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_binary_op->right_operand), true);
  1614. } else {
  1615. reduce_expression(p_binary_op->right_operand);
  1616. }
  1617. // TODO: Right operand must be a valid type with the `is` operator. Need to check here.
  1618. GDScriptParser::DataType left_type;
  1619. if (p_binary_op->left_operand) {
  1620. left_type = p_binary_op->left_operand->get_datatype();
  1621. }
  1622. GDScriptParser::DataType right_type;
  1623. if (p_binary_op->right_operand) {
  1624. right_type = p_binary_op->right_operand->get_datatype();
  1625. }
  1626. if (!left_type.is_set() || !right_type.is_set()) {
  1627. return;
  1628. }
  1629. #ifdef DEBUG_ENABLED
  1630. if (p_binary_op->variant_op == Variant::OP_DIVIDE && left_type.builtin_type == Variant::INT && right_type.builtin_type == Variant::INT) {
  1631. parser->push_warning(p_binary_op, GDScriptWarning::INTEGER_DIVISION);
  1632. }
  1633. #endif
  1634. if (p_binary_op->left_operand->is_constant && p_binary_op->right_operand->is_constant) {
  1635. p_binary_op->is_constant = true;
  1636. if (p_binary_op->variant_op < Variant::OP_MAX) {
  1637. bool valid = false;
  1638. 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);
  1639. if (!valid) {
  1640. if (p_binary_op->reduced_value.get_type() == Variant::STRING) {
  1641. 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);
  1642. } else {
  1643. push_error(vformat(R"(Invalid operands to operator %s, %s and %s.)",
  1644. Variant::get_operator_name(p_binary_op->variant_op),
  1645. Variant::get_type_name(p_binary_op->left_operand->reduced_value.get_type()),
  1646. Variant::get_type_name(p_binary_op->right_operand->reduced_value.get_type())),
  1647. p_binary_op);
  1648. }
  1649. }
  1650. } else {
  1651. if (p_binary_op->operation == GDScriptParser::BinaryOpNode::OP_TYPE_TEST) {
  1652. GDScriptParser::DataType test_type = right_type;
  1653. test_type.is_meta_type = false;
  1654. if (!is_type_compatible(test_type, p_binary_op->left_operand->get_datatype(), false)) {
  1655. push_error(vformat(R"(Expression is of type "%s" so it can't be of type "%s".)"), p_binary_op->left_operand);
  1656. p_binary_op->reduced_value = false;
  1657. } else {
  1658. p_binary_op->reduced_value = true;
  1659. }
  1660. } else {
  1661. ERR_PRINT("Parser bug: unknown binary operation.");
  1662. }
  1663. }
  1664. p_binary_op->set_datatype(type_from_variant(p_binary_op->reduced_value, p_binary_op));
  1665. return;
  1666. }
  1667. GDScriptParser::DataType result;
  1668. if (left_type.is_variant() || right_type.is_variant()) {
  1669. // Cannot infer type because one operand can be anything.
  1670. result.kind = GDScriptParser::DataType::VARIANT;
  1671. mark_node_unsafe(p_binary_op);
  1672. } else {
  1673. if (p_binary_op->variant_op < Variant::OP_MAX) {
  1674. bool valid = false;
  1675. result = get_operation_type(p_binary_op->variant_op, left_type, right_type, valid, p_binary_op);
  1676. if (!valid) {
  1677. push_error(vformat(R"(Invalid operands "%s" and "%s" for "%s" operator.)", left_type.to_string(), right_type.to_string(), Variant::get_operator_name(p_binary_op->variant_op)), p_binary_op);
  1678. }
  1679. } else {
  1680. if (p_binary_op->operation == GDScriptParser::BinaryOpNode::OP_TYPE_TEST) {
  1681. GDScriptParser::DataType test_type = right_type;
  1682. test_type.is_meta_type = false;
  1683. if (!is_type_compatible(test_type, p_binary_op->left_operand->get_datatype(), false)) {
  1684. // Test reverse as well to consider for subtypes.
  1685. if (!is_type_compatible(p_binary_op->left_operand->get_datatype(), test_type, false)) {
  1686. if (p_binary_op->left_operand->get_datatype().is_hard_type()) {
  1687. 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);
  1688. } else {
  1689. // TODO: Warning.
  1690. mark_node_unsafe(p_binary_op);
  1691. }
  1692. }
  1693. }
  1694. // "is" operator is always a boolean anyway.
  1695. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1696. result.kind = GDScriptParser::DataType::BUILTIN;
  1697. result.builtin_type = Variant::BOOL;
  1698. } else {
  1699. ERR_PRINT("Parser bug: unknown binary operation.");
  1700. }
  1701. }
  1702. }
  1703. p_binary_op->set_datatype(result);
  1704. }
  1705. void GDScriptAnalyzer::reduce_call(GDScriptParser::CallNode *p_call, bool is_await) {
  1706. bool all_is_constant = true;
  1707. Map<int, GDScriptParser::ArrayNode *> arrays; // For array literal to potentially type when passing.
  1708. for (int i = 0; i < p_call->arguments.size(); i++) {
  1709. reduce_expression(p_call->arguments[i]);
  1710. if (p_call->arguments[i]->type == GDScriptParser::Node::ARRAY) {
  1711. arrays[i] = static_cast<GDScriptParser::ArrayNode *>(p_call->arguments[i]);
  1712. }
  1713. all_is_constant = all_is_constant && p_call->arguments[i]->is_constant;
  1714. }
  1715. GDScriptParser::Node::Type callee_type = p_call->get_callee_type();
  1716. GDScriptParser::DataType call_type;
  1717. if (!p_call->is_super && callee_type == GDScriptParser::Node::IDENTIFIER) {
  1718. // Call to name directly.
  1719. StringName function_name = p_call->function_name;
  1720. Variant::Type builtin_type = GDScriptParser::get_builtin_type(function_name);
  1721. if (builtin_type < Variant::VARIANT_MAX) {
  1722. // Is a builtin constructor.
  1723. call_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1724. call_type.kind = GDScriptParser::DataType::BUILTIN;
  1725. call_type.builtin_type = builtin_type;
  1726. if (builtin_type == Variant::OBJECT) {
  1727. call_type.kind = GDScriptParser::DataType::NATIVE;
  1728. call_type.native_type = function_name; // "Object".
  1729. }
  1730. bool safe_to_fold = true;
  1731. switch (builtin_type) {
  1732. // Those are stored by reference so not suited for compile-time construction.
  1733. // Because in this case they would be the same reference in all constructed values.
  1734. case Variant::OBJECT:
  1735. case Variant::DICTIONARY:
  1736. case Variant::ARRAY:
  1737. case Variant::PACKED_BYTE_ARRAY:
  1738. case Variant::PACKED_INT32_ARRAY:
  1739. case Variant::PACKED_INT64_ARRAY:
  1740. case Variant::PACKED_FLOAT32_ARRAY:
  1741. case Variant::PACKED_FLOAT64_ARRAY:
  1742. case Variant::PACKED_STRING_ARRAY:
  1743. case Variant::PACKED_VECTOR2_ARRAY:
  1744. case Variant::PACKED_VECTOR3_ARRAY:
  1745. case Variant::PACKED_COLOR_ARRAY:
  1746. safe_to_fold = false;
  1747. break;
  1748. default:
  1749. break;
  1750. }
  1751. if (all_is_constant && safe_to_fold) {
  1752. // Construct here.
  1753. Vector<const Variant *> args;
  1754. for (int i = 0; i < p_call->arguments.size(); i++) {
  1755. args.push_back(&(p_call->arguments[i]->reduced_value));
  1756. }
  1757. Callable::CallError err;
  1758. Variant value;
  1759. Variant::construct(builtin_type, value, (const Variant **)args.ptr(), args.size(), err);
  1760. switch (err.error) {
  1761. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  1762. 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,
  1763. Variant::get_type_name(Variant::Type(err.expected)), p_call->arguments[err.argument]->get_datatype().to_string()),
  1764. p_call->arguments[err.argument]);
  1765. break;
  1766. case Callable::CallError::CALL_ERROR_INVALID_METHOD: {
  1767. String signature = Variant::get_type_name(builtin_type) + "(";
  1768. for (int i = 0; i < p_call->arguments.size(); i++) {
  1769. if (i > 0) {
  1770. signature += ", ";
  1771. }
  1772. signature += p_call->arguments[i]->get_datatype().to_string();
  1773. }
  1774. signature += ")";
  1775. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call->callee);
  1776. } break;
  1777. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  1778. 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);
  1779. break;
  1780. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  1781. 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);
  1782. break;
  1783. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  1784. break; // Can't happen in a builtin constructor.
  1785. case Callable::CallError::CALL_OK:
  1786. p_call->is_constant = true;
  1787. p_call->reduced_value = value;
  1788. break;
  1789. }
  1790. } else {
  1791. // TODO: Check constructors without constants.
  1792. // If there's one argument, try to use copy constructor (those aren't explicitly defined).
  1793. if (p_call->arguments.size() == 1) {
  1794. GDScriptParser::DataType arg_type = p_call->arguments[0]->get_datatype();
  1795. if (arg_type.is_variant()) {
  1796. mark_node_unsafe(p_call->arguments[0]);
  1797. } else {
  1798. if (arg_type.kind == GDScriptParser::DataType::BUILTIN && arg_type.builtin_type == builtin_type) {
  1799. // Okay.
  1800. p_call->set_datatype(call_type);
  1801. return;
  1802. }
  1803. }
  1804. }
  1805. List<MethodInfo> constructors;
  1806. Variant::get_constructor_list(builtin_type, &constructors);
  1807. bool match = false;
  1808. for (const MethodInfo &info : constructors) {
  1809. if (p_call->arguments.size() < info.arguments.size() - info.default_arguments.size()) {
  1810. continue;
  1811. }
  1812. if (p_call->arguments.size() > info.arguments.size()) {
  1813. continue;
  1814. }
  1815. bool types_match = true;
  1816. for (int i = 0; i < p_call->arguments.size(); i++) {
  1817. GDScriptParser::DataType par_type = type_from_property(info.arguments[i]);
  1818. if (!is_type_compatible(par_type, p_call->arguments[i]->get_datatype(), true)) {
  1819. types_match = false;
  1820. break;
  1821. #ifdef DEBUG_ENABLED
  1822. } else {
  1823. if (par_type.builtin_type == Variant::INT && p_call->arguments[i]->get_datatype().builtin_type == Variant::FLOAT) {
  1824. parser->push_warning(p_call, GDScriptWarning::NARROWING_CONVERSION, p_call->function_name);
  1825. }
  1826. #endif
  1827. }
  1828. }
  1829. if (types_match) {
  1830. match = true;
  1831. call_type = type_from_property(info.return_val);
  1832. break;
  1833. }
  1834. }
  1835. if (!match) {
  1836. String signature = Variant::get_type_name(builtin_type) + "(";
  1837. for (int i = 0; i < p_call->arguments.size(); i++) {
  1838. if (i > 0) {
  1839. signature += ", ";
  1840. }
  1841. signature += p_call->arguments[i]->get_datatype().to_string();
  1842. }
  1843. signature += ")";
  1844. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call);
  1845. }
  1846. }
  1847. p_call->set_datatype(call_type);
  1848. return;
  1849. } else if (GDScriptUtilityFunctions::function_exists(function_name)) {
  1850. MethodInfo function_info = GDScriptUtilityFunctions::get_function_info(function_name);
  1851. if (all_is_constant && GDScriptUtilityFunctions::is_function_constant(function_name)) {
  1852. // Can call on compilation.
  1853. Vector<const Variant *> args;
  1854. for (int i = 0; i < p_call->arguments.size(); i++) {
  1855. args.push_back(&(p_call->arguments[i]->reduced_value));
  1856. }
  1857. Variant value;
  1858. Callable::CallError err;
  1859. GDScriptUtilityFunctions::get_function(function_name)(&value, (const Variant **)args.ptr(), args.size(), err);
  1860. switch (err.error) {
  1861. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  1862. PropertyInfo wrong_arg = function_info.arguments[err.argument];
  1863. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be %s but is %s.)*", function_name, err.argument + 1,
  1864. type_from_property(wrong_arg).to_string(), p_call->arguments[err.argument]->get_datatype().to_string()),
  1865. p_call->arguments[err.argument]);
  1866. } break;
  1867. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  1868. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  1869. break;
  1870. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  1871. push_error(vformat(R"*(Too many arguments for "%s()" call. Expected at most %d but received %d.)*", function_name, err.expected, p_call->arguments.size()), p_call);
  1872. break;
  1873. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  1874. push_error(vformat(R"*(Too few arguments for "%s()" call. Expected at least %d but received %d.)*", function_name, err.expected, p_call->arguments.size()), p_call);
  1875. break;
  1876. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  1877. break; // Can't happen in a builtin constructor.
  1878. case Callable::CallError::CALL_OK:
  1879. p_call->is_constant = true;
  1880. p_call->reduced_value = value;
  1881. break;
  1882. }
  1883. } else {
  1884. validate_call_arg(function_info, p_call);
  1885. }
  1886. p_call->set_datatype(type_from_property(function_info.return_val));
  1887. return;
  1888. } else if (Variant::has_utility_function(function_name)) {
  1889. MethodInfo function_info = info_from_utility_func(function_name);
  1890. if (all_is_constant && Variant::get_utility_function_type(function_name) == Variant::UTILITY_FUNC_TYPE_MATH) {
  1891. // Can call on compilation.
  1892. Vector<const Variant *> args;
  1893. for (int i = 0; i < p_call->arguments.size(); i++) {
  1894. args.push_back(&(p_call->arguments[i]->reduced_value));
  1895. }
  1896. Variant value;
  1897. Callable::CallError err;
  1898. Variant::call_utility_function(function_name, &value, (const Variant **)args.ptr(), args.size(), err);
  1899. switch (err.error) {
  1900. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  1901. PropertyInfo wrong_arg = function_info.arguments[err.argument];
  1902. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be %s but is %s.)*", function_name, err.argument + 1,
  1903. type_from_property(wrong_arg).to_string(), p_call->arguments[err.argument]->get_datatype().to_string()),
  1904. p_call->arguments[err.argument]);
  1905. } break;
  1906. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  1907. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  1908. break;
  1909. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  1910. push_error(vformat(R"*(Too many arguments for "%s()" call. Expected at most %d but received %d.)*", function_name, err.expected, p_call->arguments.size()), p_call);
  1911. break;
  1912. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  1913. push_error(vformat(R"*(Too few arguments for "%s()" call. Expected at least %d but received %d.)*", function_name, err.expected, p_call->arguments.size()), p_call);
  1914. break;
  1915. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  1916. break; // Can't happen in a builtin constructor.
  1917. case Callable::CallError::CALL_OK:
  1918. p_call->is_constant = true;
  1919. p_call->reduced_value = value;
  1920. break;
  1921. }
  1922. } else {
  1923. validate_call_arg(function_info, p_call);
  1924. }
  1925. p_call->set_datatype(type_from_property(function_info.return_val));
  1926. return;
  1927. }
  1928. }
  1929. GDScriptParser::DataType base_type;
  1930. call_type.kind = GDScriptParser::DataType::VARIANT;
  1931. bool is_self = false;
  1932. if (p_call->is_super) {
  1933. base_type = parser->current_class->base_type;
  1934. base_type.is_meta_type = false;
  1935. is_self = true;
  1936. } else if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  1937. base_type = parser->current_class->get_datatype();
  1938. base_type.is_meta_type = false;
  1939. is_self = true;
  1940. } else if (callee_type == GDScriptParser::Node::SUBSCRIPT) {
  1941. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee);
  1942. if (subscript->base == nullptr) {
  1943. // Invalid syntax, error already set on parser.
  1944. p_call->set_datatype(call_type);
  1945. mark_node_unsafe(p_call);
  1946. return;
  1947. }
  1948. if (!subscript->is_attribute) {
  1949. // Invalid call. Error already sent in parser.
  1950. // TODO: Could check if Callable here.
  1951. p_call->set_datatype(call_type);
  1952. mark_node_unsafe(p_call);
  1953. return;
  1954. }
  1955. if (subscript->attribute == nullptr) {
  1956. // Invalid call. Error already sent in parser.
  1957. p_call->set_datatype(call_type);
  1958. mark_node_unsafe(p_call);
  1959. return;
  1960. }
  1961. GDScriptParser::IdentifierNode *base_id = nullptr;
  1962. if (subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  1963. base_id = static_cast<GDScriptParser::IdentifierNode *>(subscript->base);
  1964. }
  1965. if (base_id && GDScriptParser::get_builtin_type(base_id->name) < Variant::VARIANT_MAX) {
  1966. base_type = make_builtin_meta_type(GDScriptParser::get_builtin_type(base_id->name));
  1967. } else {
  1968. reduce_expression(subscript->base);
  1969. base_type = subscript->base->get_datatype();
  1970. }
  1971. } else {
  1972. // Invalid call. Error already sent in parser.
  1973. // TODO: Could check if Callable here too.
  1974. p_call->set_datatype(call_type);
  1975. mark_node_unsafe(p_call);
  1976. return;
  1977. }
  1978. bool is_static = false;
  1979. bool is_vararg = false;
  1980. int default_arg_count = 0;
  1981. GDScriptParser::DataType return_type;
  1982. List<GDScriptParser::DataType> par_types;
  1983. if (get_function_signature(p_call, base_type, p_call->function_name, return_type, par_types, default_arg_count, is_static, is_vararg)) {
  1984. // If the function require typed arrays we must make literals be typed.
  1985. for (Map<int, GDScriptParser::ArrayNode *>::Element *E = arrays.front(); E; E = E->next()) {
  1986. int index = E->key();
  1987. if (index < par_types.size() && par_types[index].has_container_element_type()) {
  1988. update_array_literal_element_type(par_types[index], E->get());
  1989. }
  1990. }
  1991. validate_call_arg(par_types, default_arg_count, is_vararg, p_call);
  1992. if (is_self && parser->current_function != nullptr && parser->current_function->is_static && !is_static) {
  1993. 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);
  1994. } else if (!is_self && base_type.is_meta_type && !is_static) {
  1995. base_type.is_meta_type = false; // For `to_string()`.
  1996. push_error(vformat(R"*(Cannot call non-static function "%s()" on the class "%s" directly. Make an instance instead.)*", p_call->function_name, base_type.to_string()), p_call->callee);
  1997. } else if (is_self && !is_static && !lambda_stack.is_empty()) {
  1998. push_error(vformat(R"*(Cannot call non-static function "%s()" from a lambda function.)*", p_call->function_name), p_call->callee);
  1999. }
  2000. call_type = return_type;
  2001. } else {
  2002. // Check if the name exists as something else.
  2003. bool found = false;
  2004. if (!p_call->is_super && callee_type != GDScriptParser::Node::NONE) {
  2005. GDScriptParser::IdentifierNode *callee_id;
  2006. if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  2007. callee_id = static_cast<GDScriptParser::IdentifierNode *>(p_call->callee);
  2008. } else {
  2009. // Can only be attribute.
  2010. callee_id = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee)->attribute;
  2011. }
  2012. if (callee_id) {
  2013. reduce_identifier_from_base(callee_id, &base_type);
  2014. GDScriptParser::DataType callee_datatype = callee_id->get_datatype();
  2015. if (callee_datatype.is_set() && !callee_datatype.is_variant()) {
  2016. found = true;
  2017. if (callee_datatype.builtin_type == Variant::CALLABLE) {
  2018. 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);
  2019. } else {
  2020. push_error(vformat(R"*(Name "%s" called as a function but is a "%s".)*", p_call->function_name, callee_datatype.to_string()), p_call->callee);
  2021. }
  2022. #ifdef DEBUG_ENABLED
  2023. } else if (!is_self && !(base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN)) {
  2024. parser->push_warning(p_call, GDScriptWarning::UNSAFE_METHOD_ACCESS, p_call->function_name, base_type.to_string());
  2025. mark_node_unsafe(p_call);
  2026. #endif
  2027. }
  2028. }
  2029. }
  2030. if (!found && (is_self || (base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN))) {
  2031. String base_name = is_self && !p_call->is_super ? "self" : base_type.to_string();
  2032. 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);
  2033. }
  2034. }
  2035. if (call_type.is_coroutine && !is_await) {
  2036. push_error(vformat(R"*(Function "%s()" is a coroutine, so it must be called with "await".)*", p_call->function_name), p_call->callee);
  2037. }
  2038. p_call->set_datatype(call_type);
  2039. }
  2040. void GDScriptAnalyzer::reduce_cast(GDScriptParser::CastNode *p_cast) {
  2041. reduce_expression(p_cast->operand);
  2042. GDScriptParser::DataType cast_type = resolve_datatype(p_cast->cast_type);
  2043. if (!cast_type.is_set()) {
  2044. return;
  2045. }
  2046. cast_type.is_meta_type = false; // The casted value won't be a type name.
  2047. p_cast->set_datatype(cast_type);
  2048. if (!cast_type.is_variant()) {
  2049. GDScriptParser::DataType op_type = p_cast->operand->get_datatype();
  2050. if (!op_type.is_variant()) {
  2051. bool valid = false;
  2052. if (op_type.kind == GDScriptParser::DataType::BUILTIN && cast_type.kind == GDScriptParser::DataType::BUILTIN) {
  2053. valid = Variant::can_convert(op_type.builtin_type, cast_type.builtin_type);
  2054. } else if (op_type.kind != GDScriptParser::DataType::BUILTIN && cast_type.kind != GDScriptParser::DataType::BUILTIN) {
  2055. valid = is_type_compatible(cast_type, op_type) || is_type_compatible(op_type, cast_type);
  2056. }
  2057. if (!valid) {
  2058. push_error(vformat(R"(Invalid cast. Cannot convert from "%s" to "%s".)", op_type.to_string(), cast_type.to_string()), p_cast->cast_type);
  2059. }
  2060. }
  2061. } else {
  2062. mark_node_unsafe(p_cast);
  2063. }
  2064. #ifdef DEBUG_ENABLED
  2065. if (p_cast->operand->get_datatype().is_variant()) {
  2066. parser->push_warning(p_cast, GDScriptWarning::UNSAFE_CAST, cast_type.to_string());
  2067. mark_node_unsafe(p_cast);
  2068. }
  2069. #endif
  2070. // TODO: Perform cast on constants.
  2071. }
  2072. void GDScriptAnalyzer::reduce_dictionary(GDScriptParser::DictionaryNode *p_dictionary) {
  2073. HashMap<Variant, GDScriptParser::ExpressionNode *, VariantHasher, VariantComparator> elements;
  2074. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  2075. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  2076. if (p_dictionary->style == GDScriptParser::DictionaryNode::PYTHON_DICT) {
  2077. reduce_expression(element.key);
  2078. }
  2079. reduce_expression(element.value);
  2080. if (element.key->is_constant) {
  2081. if (elements.has(element.key->reduced_value)) {
  2082. push_error(vformat(R"(Key "%s" was already used in this dictionary (at line %d).)", element.key->reduced_value, elements[element.key->reduced_value]->start_line), element.key);
  2083. } else {
  2084. elements[element.key->reduced_value] = element.value;
  2085. }
  2086. }
  2087. }
  2088. // It's dictionary in any case.
  2089. GDScriptParser::DataType dict_type;
  2090. dict_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2091. dict_type.kind = GDScriptParser::DataType::BUILTIN;
  2092. dict_type.builtin_type = Variant::DICTIONARY;
  2093. dict_type.is_constant = true;
  2094. p_dictionary->set_datatype(dict_type);
  2095. }
  2096. void GDScriptAnalyzer::reduce_get_node(GDScriptParser::GetNodeNode *p_get_node) {
  2097. GDScriptParser::DataType result;
  2098. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2099. result.kind = GDScriptParser::DataType::NATIVE;
  2100. result.native_type = "Node";
  2101. result.builtin_type = Variant::OBJECT;
  2102. if (!ClassDB::is_parent_class(parser->current_class->base_type.native_type, result.native_type)) {
  2103. push_error(R"*(Cannot use shorthand "get_node()" notation ("$") on a class that isn't a node.)*", p_get_node);
  2104. } else if (!lambda_stack.is_empty()) {
  2105. push_error(R"*(Cannot use shorthand "get_node()" notation ("$") inside a lambda. Use a captured variable instead.)*", p_get_node);
  2106. }
  2107. p_get_node->set_datatype(result);
  2108. }
  2109. GDScriptParser::DataType GDScriptAnalyzer::make_global_class_meta_type(const StringName &p_class_name, const GDScriptParser::Node *p_source) {
  2110. Ref<GDScriptParserRef> ref = get_parser_for(ScriptServer::get_global_class_path(p_class_name));
  2111. Error err = ref->raise_status(GDScriptParserRef::INTERFACE_SOLVED);
  2112. if (err) {
  2113. push_error(vformat(R"(Could not resolve class "%s", because of a parser error.)", p_class_name), p_source);
  2114. GDScriptParser::DataType type;
  2115. type.type_source = GDScriptParser::DataType::UNDETECTED;
  2116. type.kind = GDScriptParser::DataType::VARIANT;
  2117. return type;
  2118. }
  2119. GDScriptParser::DataType type;
  2120. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2121. type.kind = GDScriptParser::DataType::CLASS;
  2122. type.builtin_type = Variant::OBJECT;
  2123. type.native_type = ScriptServer::get_global_class_native_base(p_class_name);
  2124. type.class_type = ref->get_parser()->head;
  2125. type.script_path = ref->get_parser()->script_path;
  2126. type.is_constant = true;
  2127. type.is_meta_type = true;
  2128. return type;
  2129. }
  2130. void GDScriptAnalyzer::reduce_identifier_from_base(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType *p_base) {
  2131. GDScriptParser::DataType base;
  2132. if (p_base == nullptr) {
  2133. base = type_from_metatype(parser->current_class->get_datatype());
  2134. } else {
  2135. base = *p_base;
  2136. }
  2137. const StringName &name = p_identifier->name;
  2138. if (base.kind == GDScriptParser::DataType::BUILTIN) {
  2139. if (base.is_meta_type) {
  2140. bool valid = true;
  2141. Variant result = Variant::get_constant_value(base.builtin_type, name, &valid);
  2142. if (valid) {
  2143. p_identifier->is_constant = true;
  2144. p_identifier->reduced_value = result;
  2145. p_identifier->set_datatype(type_from_variant(result, p_identifier));
  2146. } else {
  2147. push_error(vformat(R"(Cannot find constant "%s" on type "%s".)", name, base.to_string()), p_identifier);
  2148. }
  2149. } else {
  2150. switch (base.builtin_type) {
  2151. case Variant::NIL: {
  2152. push_error(vformat(R"(Invalid get index "%s" on base Nil)", name), p_identifier);
  2153. return;
  2154. }
  2155. case Variant::DICTIONARY: {
  2156. GDScriptParser::DataType dummy;
  2157. dummy.kind = GDScriptParser::DataType::VARIANT;
  2158. p_identifier->set_datatype(dummy);
  2159. return;
  2160. }
  2161. default: {
  2162. Callable::CallError temp;
  2163. Variant dummy;
  2164. Variant::construct(base.builtin_type, dummy, nullptr, 0, temp);
  2165. List<PropertyInfo> properties;
  2166. dummy.get_property_list(&properties);
  2167. for (const PropertyInfo &prop : properties) {
  2168. if (prop.name == name) {
  2169. p_identifier->set_datatype(type_from_property(prop));
  2170. return;
  2171. }
  2172. }
  2173. push_error(vformat(R"(Cannot find property "%s" on base "%s".)", name, base.to_string()), p_identifier);
  2174. }
  2175. }
  2176. }
  2177. return;
  2178. }
  2179. if (base.kind == GDScriptParser::DataType::ENUM) {
  2180. if (base.is_meta_type) {
  2181. if (base.enum_values.has(name)) {
  2182. p_identifier->is_constant = true;
  2183. p_identifier->reduced_value = base.enum_values[name];
  2184. GDScriptParser::DataType result;
  2185. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2186. result.kind = GDScriptParser::DataType::ENUM_VALUE;
  2187. result.builtin_type = base.builtin_type;
  2188. result.native_type = base.native_type;
  2189. result.enum_type = name;
  2190. p_identifier->set_datatype(result);
  2191. } else {
  2192. push_error(vformat(R"(Cannot find value "%s" in "%s".)", name, base.to_string()), p_identifier);
  2193. }
  2194. } else {
  2195. push_error(R"(Cannot get property from enum value.)", p_identifier);
  2196. }
  2197. return;
  2198. }
  2199. GDScriptParser::ClassNode *base_class = base.class_type;
  2200. // TODO: Switch current class/function/suite here to avoid misrepresenting identifiers (in recursive reduce calls).
  2201. while (base_class != nullptr) {
  2202. if (base_class->identifier && base_class->identifier->name == name) {
  2203. p_identifier->set_datatype(base_class->get_datatype());
  2204. return;
  2205. }
  2206. if (base_class->has_member(name)) {
  2207. const GDScriptParser::ClassNode::Member &member = base_class->get_member(name);
  2208. p_identifier->set_datatype(member.get_datatype());
  2209. switch (member.type) {
  2210. case GDScriptParser::ClassNode::Member::CONSTANT:
  2211. // For out-of-order resolution:
  2212. reduce_expression(member.constant->initializer);
  2213. p_identifier->is_constant = true;
  2214. p_identifier->reduced_value = member.constant->initializer->reduced_value;
  2215. p_identifier->set_datatype(member.constant->initializer->get_datatype());
  2216. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  2217. p_identifier->constant_source = member.constant;
  2218. break;
  2219. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  2220. p_identifier->is_constant = true;
  2221. p_identifier->reduced_value = member.enum_value.value;
  2222. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  2223. break;
  2224. case GDScriptParser::ClassNode::Member::VARIABLE:
  2225. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_VARIABLE;
  2226. p_identifier->variable_source = member.variable;
  2227. member.variable->usages += 1;
  2228. break;
  2229. case GDScriptParser::ClassNode::Member::FUNCTION:
  2230. resolve_function_signature(member.function);
  2231. p_identifier->set_datatype(make_callable_type(member.function->info));
  2232. break;
  2233. case GDScriptParser::ClassNode::Member::CLASS:
  2234. // For out-of-order resolution:
  2235. resolve_class_interface(member.m_class);
  2236. p_identifier->set_datatype(member.m_class->get_datatype());
  2237. break;
  2238. default:
  2239. break; // Type already set.
  2240. }
  2241. return;
  2242. }
  2243. // Check outer constants.
  2244. // TODO: Allow outer static functions.
  2245. GDScriptParser::ClassNode *outer = base_class->outer;
  2246. while (outer != nullptr) {
  2247. if (outer->has_member(name)) {
  2248. const GDScriptParser::ClassNode::Member &member = outer->get_member(name);
  2249. switch (member.type) {
  2250. case GDScriptParser::ClassNode::Member::CONSTANT: {
  2251. // TODO: Make sure loops won't cause problem. And make special error message for those.
  2252. // For out-of-order resolution:
  2253. reduce_expression(member.constant->initializer);
  2254. p_identifier->set_datatype(member.get_datatype());
  2255. p_identifier->is_constant = true;
  2256. p_identifier->reduced_value = member.constant->initializer->reduced_value;
  2257. return;
  2258. } break;
  2259. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  2260. p_identifier->set_datatype(member.get_datatype());
  2261. p_identifier->is_constant = true;
  2262. p_identifier->reduced_value = member.enum_value.value;
  2263. return;
  2264. } break;
  2265. case GDScriptParser::ClassNode::Member::ENUM: {
  2266. p_identifier->set_datatype(member.get_datatype());
  2267. p_identifier->is_constant = false;
  2268. return;
  2269. } break;
  2270. default:
  2271. break;
  2272. }
  2273. }
  2274. outer = outer->outer;
  2275. }
  2276. base_class = base_class->base_type.class_type;
  2277. }
  2278. // Check native members.
  2279. const StringName &native = base.native_type;
  2280. if (class_exists(native)) {
  2281. PropertyInfo prop_info;
  2282. MethodInfo method_info;
  2283. if (ClassDB::get_property_info(native, name, &prop_info)) {
  2284. p_identifier->set_datatype(type_from_property(prop_info));
  2285. return;
  2286. }
  2287. if (ClassDB::get_method_info(native, name, &method_info)) {
  2288. // Method is callable.
  2289. p_identifier->set_datatype(make_callable_type(method_info));
  2290. return;
  2291. }
  2292. if (ClassDB::get_signal(native, name, &method_info)) {
  2293. // Signal is a type too.
  2294. p_identifier->set_datatype(make_signal_type(method_info));
  2295. return;
  2296. }
  2297. if (ClassDB::has_enum(native, name)) {
  2298. p_identifier->set_datatype(make_native_enum_type(native, name));
  2299. return;
  2300. }
  2301. bool valid = false;
  2302. int int_constant = ClassDB::get_integer_constant(native, name, &valid);
  2303. if (valid) {
  2304. p_identifier->is_constant = true;
  2305. p_identifier->reduced_value = int_constant;
  2306. p_identifier->set_datatype(type_from_variant(int_constant, p_identifier));
  2307. return;
  2308. }
  2309. }
  2310. }
  2311. void GDScriptAnalyzer::reduce_identifier(GDScriptParser::IdentifierNode *p_identifier, bool can_be_builtin) {
  2312. // TODO: This is opportunity to further infer types.
  2313. // Check if we are inside and enum. This allows enum values to access other elements of the same enum.
  2314. if (current_enum) {
  2315. for (int i = 0; i < current_enum->values.size(); i++) {
  2316. const GDScriptParser::EnumNode::Value &element = current_enum->values[i];
  2317. if (element.identifier->name == p_identifier->name) {
  2318. GDScriptParser::DataType type;
  2319. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2320. type.kind = element.parent_enum->identifier ? GDScriptParser::DataType::ENUM_VALUE : GDScriptParser::DataType::BUILTIN;
  2321. type.builtin_type = Variant::INT;
  2322. type.is_constant = true;
  2323. if (element.parent_enum->identifier) {
  2324. type.enum_type = element.parent_enum->identifier->name;
  2325. }
  2326. p_identifier->set_datatype(type);
  2327. if (element.resolved) {
  2328. p_identifier->is_constant = true;
  2329. p_identifier->reduced_value = element.value;
  2330. } else {
  2331. push_error(R"(Cannot use another enum element before it was declared.)", p_identifier);
  2332. }
  2333. return; // Found anyway.
  2334. }
  2335. }
  2336. }
  2337. bool found_source = false;
  2338. // Check if identifier is local.
  2339. // If that's the case, the declaration already was solved before.
  2340. switch (p_identifier->source) {
  2341. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER:
  2342. p_identifier->set_datatype(p_identifier->parameter_source->get_datatype());
  2343. found_source = true;
  2344. break;
  2345. case GDScriptParser::IdentifierNode::LOCAL_CONSTANT:
  2346. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  2347. p_identifier->set_datatype(p_identifier->constant_source->get_datatype());
  2348. p_identifier->is_constant = true;
  2349. // TODO: Constant should have a value on the node itself.
  2350. p_identifier->reduced_value = p_identifier->constant_source->initializer->reduced_value;
  2351. found_source = true;
  2352. break;
  2353. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  2354. p_identifier->variable_source->usages++;
  2355. [[fallthrough]];
  2356. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE:
  2357. p_identifier->set_datatype(p_identifier->variable_source->get_datatype());
  2358. found_source = true;
  2359. break;
  2360. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR:
  2361. p_identifier->set_datatype(p_identifier->bind_source->get_datatype());
  2362. found_source = true;
  2363. break;
  2364. case GDScriptParser::IdentifierNode::LOCAL_BIND: {
  2365. GDScriptParser::DataType result = p_identifier->bind_source->get_datatype();
  2366. result.is_constant = true;
  2367. p_identifier->set_datatype(result);
  2368. found_source = true;
  2369. } break;
  2370. case GDScriptParser::IdentifierNode::UNDEFINED_SOURCE:
  2371. break;
  2372. }
  2373. // Not a local, so check members.
  2374. if (!found_source) {
  2375. reduce_identifier_from_base(p_identifier);
  2376. if (p_identifier->source != GDScriptParser::IdentifierNode::UNDEFINED_SOURCE || p_identifier->get_datatype().is_set()) {
  2377. // Found.
  2378. found_source = true;
  2379. }
  2380. }
  2381. if (found_source) {
  2382. // If the identifier is local, check if it's any kind of capture by comparing their source function.
  2383. // Only capture locals and members and enum values. Constants are still accessible from the lambda using the script reference.
  2384. if (p_identifier->source == GDScriptParser::IdentifierNode::UNDEFINED_SOURCE || p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_CONSTANT || lambda_stack.is_empty()) {
  2385. return;
  2386. }
  2387. GDScriptParser::FunctionNode *function_test = lambda_stack.back()->get()->function;
  2388. while (function_test != nullptr && function_test != p_identifier->source_function && function_test->source_lambda != nullptr && !function_test->source_lambda->captures_indices.has(p_identifier->name)) {
  2389. function_test->source_lambda->captures_indices[p_identifier->name] = function_test->source_lambda->captures.size();
  2390. function_test->source_lambda->captures.push_back(p_identifier);
  2391. function_test = function_test->source_lambda->parent_function;
  2392. }
  2393. return;
  2394. }
  2395. StringName name = p_identifier->name;
  2396. p_identifier->source = GDScriptParser::IdentifierNode::UNDEFINED_SOURCE;
  2397. // Check globals. We make an exception for Variant::OBJECT because it's the base class for
  2398. // non-builtin types so we allow doing e.g. Object.new()
  2399. Variant::Type builtin_type = GDScriptParser::get_builtin_type(name);
  2400. if (builtin_type != Variant::OBJECT && builtin_type < Variant::VARIANT_MAX) {
  2401. if (can_be_builtin) {
  2402. p_identifier->set_datatype(make_builtin_meta_type(builtin_type));
  2403. return;
  2404. } else {
  2405. push_error(R"(Builtin type cannot be used as a name on its own.)", p_identifier);
  2406. }
  2407. }
  2408. if (class_exists(name)) {
  2409. p_identifier->set_datatype(make_native_meta_type(name));
  2410. return;
  2411. }
  2412. if (ScriptServer::is_global_class(name)) {
  2413. p_identifier->set_datatype(make_global_class_meta_type(name, p_identifier));
  2414. return;
  2415. }
  2416. // Try singletons.
  2417. // Do this before globals because this might be a singleton loading another one before it's compiled.
  2418. if (ProjectSettings::get_singleton()->has_autoload(name)) {
  2419. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(name);
  2420. if (autoload.is_singleton) {
  2421. // Singleton exists, so it's at least a Node.
  2422. GDScriptParser::DataType result;
  2423. result.kind = GDScriptParser::DataType::NATIVE;
  2424. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2425. if (autoload.path.to_lower().ends_with(GDScriptLanguage::get_singleton()->get_extension())) {
  2426. Ref<GDScriptParserRef> parser = get_parser_for(autoload.path);
  2427. if (parser.is_valid()) {
  2428. Error err = parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED);
  2429. if (err == OK) {
  2430. result = type_from_metatype(parser->get_parser()->head->get_datatype());
  2431. }
  2432. }
  2433. }
  2434. result.is_constant = true;
  2435. p_identifier->set_datatype(result);
  2436. return;
  2437. }
  2438. }
  2439. if (GDScriptLanguage::get_singleton()->get_global_map().has(name)) {
  2440. int idx = GDScriptLanguage::get_singleton()->get_global_map()[name];
  2441. Variant constant = GDScriptLanguage::get_singleton()->get_global_array()[idx];
  2442. p_identifier->set_datatype(type_from_variant(constant, p_identifier));
  2443. p_identifier->is_constant = true;
  2444. p_identifier->reduced_value = constant;
  2445. return;
  2446. }
  2447. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(name)) {
  2448. Variant constant = GDScriptLanguage::get_singleton()->get_named_globals_map()[name];
  2449. p_identifier->set_datatype(type_from_variant(constant, p_identifier));
  2450. p_identifier->is_constant = true;
  2451. p_identifier->reduced_value = constant;
  2452. return;
  2453. }
  2454. // Not found.
  2455. // Check if it's a builtin function.
  2456. if (GDScriptUtilityFunctions::function_exists(name)) {
  2457. push_error(vformat(R"(Built-in function "%s" cannot be used as an identifier.)", name), p_identifier);
  2458. } else {
  2459. push_error(vformat(R"(Identifier "%s" not declared in the current scope.)", name), p_identifier);
  2460. }
  2461. GDScriptParser::DataType dummy;
  2462. dummy.kind = GDScriptParser::DataType::VARIANT;
  2463. p_identifier->set_datatype(dummy); // Just so type is set to something.
  2464. }
  2465. void GDScriptAnalyzer::reduce_lambda(GDScriptParser::LambdaNode *p_lambda) {
  2466. // Lambda is always a Callable.
  2467. GDScriptParser::DataType lambda_type;
  2468. lambda_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  2469. lambda_type.kind = GDScriptParser::DataType::BUILTIN;
  2470. lambda_type.builtin_type = Variant::CALLABLE;
  2471. p_lambda->set_datatype(lambda_type);
  2472. if (p_lambda->function == nullptr) {
  2473. return;
  2474. }
  2475. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  2476. parser->current_function = p_lambda->function;
  2477. lambda_stack.push_back(p_lambda);
  2478. for (int i = 0; i < p_lambda->function->parameters.size(); i++) {
  2479. resolve_parameter(p_lambda->function->parameters[i]);
  2480. }
  2481. resolve_suite(p_lambda->function->body);
  2482. int captures_amount = p_lambda->captures.size();
  2483. if (captures_amount > 0) {
  2484. // Create space for lambda parameters.
  2485. // At the beginning to not mess with optional parameters.
  2486. int param_count = p_lambda->function->parameters.size();
  2487. p_lambda->function->parameters.resize(param_count + captures_amount);
  2488. for (int i = param_count - 1; i >= 0; i--) {
  2489. p_lambda->function->parameters.write[i + captures_amount] = p_lambda->function->parameters[i];
  2490. p_lambda->function->parameters_indices[p_lambda->function->parameters[i]->identifier->name] = i + captures_amount;
  2491. }
  2492. // Add captures as extra parameters at the beginning.
  2493. for (int i = 0; i < p_lambda->captures.size(); i++) {
  2494. GDScriptParser::IdentifierNode *capture = p_lambda->captures[i];
  2495. GDScriptParser::ParameterNode *capture_param = parser->alloc_node<GDScriptParser::ParameterNode>();
  2496. capture_param->identifier = capture;
  2497. capture_param->usages = capture->usages;
  2498. capture_param->set_datatype(capture->get_datatype());
  2499. p_lambda->function->parameters.write[i] = capture_param;
  2500. p_lambda->function->parameters_indices[capture->name] = i;
  2501. }
  2502. }
  2503. lambda_stack.pop_back();
  2504. parser->current_function = previous_function;
  2505. }
  2506. void GDScriptAnalyzer::reduce_literal(GDScriptParser::LiteralNode *p_literal) {
  2507. p_literal->reduced_value = p_literal->value;
  2508. p_literal->is_constant = true;
  2509. p_literal->set_datatype(type_from_variant(p_literal->reduced_value, p_literal));
  2510. }
  2511. void GDScriptAnalyzer::reduce_preload(GDScriptParser::PreloadNode *p_preload) {
  2512. if (!p_preload->path) {
  2513. return;
  2514. }
  2515. reduce_expression(p_preload->path);
  2516. if (!p_preload->path->is_constant) {
  2517. push_error("Preloaded path must be a constant string.", p_preload->path);
  2518. return;
  2519. }
  2520. if (p_preload->path->reduced_value.get_type() != Variant::STRING) {
  2521. push_error("Preloaded path must be a constant string.", p_preload->path);
  2522. } else {
  2523. p_preload->resolved_path = p_preload->path->reduced_value;
  2524. // TODO: Save this as script dependency.
  2525. if (p_preload->resolved_path.is_relative_path()) {
  2526. p_preload->resolved_path = parser->script_path.get_base_dir().plus_file(p_preload->resolved_path);
  2527. }
  2528. p_preload->resolved_path = p_preload->resolved_path.simplify_path();
  2529. if (!FileAccess::exists(p_preload->resolved_path)) {
  2530. push_error(vformat(R"(Preload file "%s" does not exist.)", p_preload->resolved_path), p_preload->path);
  2531. } else {
  2532. // TODO: Don't load if validating: use completion cache.
  2533. p_preload->resource = ResourceLoader::load(p_preload->resolved_path);
  2534. if (p_preload->resource.is_null()) {
  2535. push_error(vformat(R"(Could not p_preload resource file "%s".)", p_preload->resolved_path), p_preload->path);
  2536. }
  2537. }
  2538. }
  2539. p_preload->is_constant = true;
  2540. p_preload->reduced_value = p_preload->resource;
  2541. p_preload->set_datatype(type_from_variant(p_preload->reduced_value, p_preload));
  2542. }
  2543. void GDScriptAnalyzer::reduce_self(GDScriptParser::SelfNode *p_self) {
  2544. p_self->is_constant = false;
  2545. p_self->set_datatype(type_from_metatype(parser->current_class->get_datatype()));
  2546. }
  2547. void GDScriptAnalyzer::reduce_subscript(GDScriptParser::SubscriptNode *p_subscript) {
  2548. if (p_subscript->base == nullptr) {
  2549. return;
  2550. }
  2551. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  2552. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base), true);
  2553. } else {
  2554. reduce_expression(p_subscript->base);
  2555. }
  2556. GDScriptParser::DataType result_type;
  2557. if (p_subscript->is_attribute) {
  2558. if (p_subscript->attribute == nullptr) {
  2559. return;
  2560. }
  2561. if (p_subscript->base->is_constant) {
  2562. // Just try to get it.
  2563. bool valid = false;
  2564. Variant value = p_subscript->base->reduced_value.get_named(p_subscript->attribute->name, valid);
  2565. if (!valid) {
  2566. push_error(vformat(R"(Cannot get member "%s" from "%s".)", p_subscript->attribute->name, p_subscript->base->reduced_value), p_subscript->index);
  2567. } else {
  2568. p_subscript->is_constant = true;
  2569. p_subscript->reduced_value = value;
  2570. result_type = type_from_variant(value, p_subscript);
  2571. }
  2572. result_type.kind = GDScriptParser::DataType::VARIANT;
  2573. } else {
  2574. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  2575. if (base_type.is_variant()) {
  2576. result_type.kind = GDScriptParser::DataType::VARIANT;
  2577. mark_node_unsafe(p_subscript);
  2578. } else {
  2579. reduce_identifier_from_base(p_subscript->attribute, &base_type);
  2580. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  2581. if (attr_type.is_set()) {
  2582. result_type = attr_type;
  2583. p_subscript->is_constant = p_subscript->attribute->is_constant;
  2584. p_subscript->reduced_value = p_subscript->attribute->reduced_value;
  2585. } else {
  2586. if (base_type.kind == GDScriptParser::DataType::BUILTIN) {
  2587. push_error(vformat(R"(Cannot find member "%s" in base "%s".)", p_subscript->attribute->name, base_type.to_string()), p_subscript->attribute);
  2588. #ifdef DEBUG_ENABLED
  2589. } else {
  2590. parser->push_warning(p_subscript, GDScriptWarning::UNSAFE_PROPERTY_ACCESS, p_subscript->attribute->name, base_type.to_string());
  2591. #endif
  2592. }
  2593. result_type.kind = GDScriptParser::DataType::VARIANT;
  2594. }
  2595. }
  2596. }
  2597. } else {
  2598. if (p_subscript->index == nullptr) {
  2599. return;
  2600. }
  2601. reduce_expression(p_subscript->index);
  2602. if (p_subscript->base->is_constant && p_subscript->index->is_constant) {
  2603. // Just try to get it.
  2604. bool valid = false;
  2605. Variant value = p_subscript->base->reduced_value.get(p_subscript->index->reduced_value, &valid);
  2606. if (!valid) {
  2607. push_error(vformat(R"(Cannot get index "%s" from "%s".)", p_subscript->index->reduced_value, p_subscript->base->reduced_value), p_subscript->index);
  2608. } else {
  2609. p_subscript->is_constant = true;
  2610. p_subscript->reduced_value = value;
  2611. result_type = type_from_variant(value, p_subscript);
  2612. }
  2613. result_type.kind = GDScriptParser::DataType::VARIANT;
  2614. } else {
  2615. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  2616. GDScriptParser::DataType index_type = p_subscript->index->get_datatype();
  2617. if (base_type.is_variant()) {
  2618. result_type.kind = GDScriptParser::DataType::VARIANT;
  2619. mark_node_unsafe(p_subscript);
  2620. } else {
  2621. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  2622. // Check if indexing is valid.
  2623. bool error = index_type.kind != GDScriptParser::DataType::BUILTIN && base_type.builtin_type != Variant::DICTIONARY;
  2624. if (!error) {
  2625. switch (base_type.builtin_type) {
  2626. // Expect int or real as index.
  2627. case Variant::PACKED_BYTE_ARRAY:
  2628. case Variant::PACKED_COLOR_ARRAY:
  2629. case Variant::PACKED_FLOAT32_ARRAY:
  2630. case Variant::PACKED_FLOAT64_ARRAY:
  2631. case Variant::PACKED_INT32_ARRAY:
  2632. case Variant::PACKED_INT64_ARRAY:
  2633. case Variant::PACKED_STRING_ARRAY:
  2634. case Variant::PACKED_VECTOR2_ARRAY:
  2635. case Variant::PACKED_VECTOR3_ARRAY:
  2636. case Variant::ARRAY:
  2637. case Variant::STRING:
  2638. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT;
  2639. break;
  2640. // Expect String only.
  2641. case Variant::RECT2:
  2642. case Variant::RECT2I:
  2643. case Variant::PLANE:
  2644. case Variant::QUATERNION:
  2645. case Variant::AABB:
  2646. case Variant::OBJECT:
  2647. error = index_type.builtin_type != Variant::STRING;
  2648. break;
  2649. // Expect String or number.
  2650. case Variant::BASIS:
  2651. case Variant::VECTOR2:
  2652. case Variant::VECTOR2I:
  2653. case Variant::VECTOR3:
  2654. case Variant::VECTOR3I:
  2655. case Variant::TRANSFORM2D:
  2656. case Variant::TRANSFORM3D:
  2657. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT &&
  2658. index_type.builtin_type != Variant::STRING;
  2659. break;
  2660. // Expect String or int.
  2661. case Variant::COLOR:
  2662. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::STRING;
  2663. break;
  2664. // Don't support indexing, but we will check it later.
  2665. case Variant::RID:
  2666. case Variant::BOOL:
  2667. case Variant::CALLABLE:
  2668. case Variant::FLOAT:
  2669. case Variant::INT:
  2670. case Variant::NIL:
  2671. case Variant::NODE_PATH:
  2672. case Variant::SIGNAL:
  2673. case Variant::STRING_NAME:
  2674. break;
  2675. // Here for completeness.
  2676. case Variant::DICTIONARY:
  2677. case Variant::VARIANT_MAX:
  2678. break;
  2679. }
  2680. if (error) {
  2681. 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);
  2682. }
  2683. }
  2684. } else if (base_type.kind != GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  2685. if (index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME) {
  2686. 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);
  2687. }
  2688. }
  2689. // Check resulting type if possible.
  2690. result_type.builtin_type = Variant::NIL;
  2691. result_type.kind = GDScriptParser::DataType::BUILTIN;
  2692. result_type.type_source = base_type.is_hard_type() ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  2693. switch (base_type.builtin_type) {
  2694. // Can't index at all.
  2695. case Variant::RID:
  2696. case Variant::BOOL:
  2697. case Variant::CALLABLE:
  2698. case Variant::FLOAT:
  2699. case Variant::INT:
  2700. case Variant::NIL:
  2701. case Variant::NODE_PATH:
  2702. case Variant::SIGNAL:
  2703. case Variant::STRING_NAME:
  2704. result_type.kind = GDScriptParser::DataType::VARIANT;
  2705. push_error(vformat(R"(Cannot use subscript operator on a base of type "%s".)", base_type.to_string()), p_subscript->base);
  2706. break;
  2707. // Return int.
  2708. case Variant::PACKED_BYTE_ARRAY:
  2709. case Variant::PACKED_INT32_ARRAY:
  2710. case Variant::PACKED_INT64_ARRAY:
  2711. case Variant::VECTOR2I:
  2712. case Variant::VECTOR3I:
  2713. result_type.builtin_type = Variant::INT;
  2714. break;
  2715. // Return float.
  2716. case Variant::PACKED_FLOAT32_ARRAY:
  2717. case Variant::PACKED_FLOAT64_ARRAY:
  2718. case Variant::VECTOR2:
  2719. case Variant::VECTOR3:
  2720. case Variant::QUATERNION:
  2721. result_type.builtin_type = Variant::FLOAT;
  2722. break;
  2723. // Return Color.
  2724. case Variant::PACKED_COLOR_ARRAY:
  2725. result_type.builtin_type = Variant::COLOR;
  2726. break;
  2727. // Return String.
  2728. case Variant::PACKED_STRING_ARRAY:
  2729. case Variant::STRING:
  2730. result_type.builtin_type = Variant::STRING;
  2731. break;
  2732. // Return Vector2.
  2733. case Variant::PACKED_VECTOR2_ARRAY:
  2734. case Variant::TRANSFORM2D:
  2735. case Variant::RECT2:
  2736. result_type.builtin_type = Variant::VECTOR2;
  2737. break;
  2738. // Return Vector2I.
  2739. case Variant::RECT2I:
  2740. result_type.builtin_type = Variant::VECTOR2I;
  2741. break;
  2742. // Return Vector3.
  2743. case Variant::PACKED_VECTOR3_ARRAY:
  2744. case Variant::AABB:
  2745. case Variant::BASIS:
  2746. result_type.builtin_type = Variant::VECTOR3;
  2747. break;
  2748. // Depends on the index.
  2749. case Variant::TRANSFORM3D:
  2750. case Variant::PLANE:
  2751. case Variant::COLOR:
  2752. case Variant::DICTIONARY:
  2753. result_type.kind = GDScriptParser::DataType::VARIANT;
  2754. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  2755. break;
  2756. // Can have an element type.
  2757. case Variant::ARRAY:
  2758. if (base_type.has_container_element_type()) {
  2759. result_type = base_type.get_container_element_type();
  2760. result_type.type_source = base_type.type_source;
  2761. } else {
  2762. result_type.kind = GDScriptParser::DataType::VARIANT;
  2763. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  2764. }
  2765. break;
  2766. // Here for completeness.
  2767. case Variant::OBJECT:
  2768. case Variant::VARIANT_MAX:
  2769. break;
  2770. }
  2771. }
  2772. }
  2773. }
  2774. p_subscript->set_datatype(result_type);
  2775. }
  2776. void GDScriptAnalyzer::reduce_ternary_op(GDScriptParser::TernaryOpNode *p_ternary_op) {
  2777. reduce_expression(p_ternary_op->condition);
  2778. reduce_expression(p_ternary_op->true_expr);
  2779. reduce_expression(p_ternary_op->false_expr);
  2780. GDScriptParser::DataType result;
  2781. 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) {
  2782. p_ternary_op->is_constant = true;
  2783. if (p_ternary_op->condition->reduced_value.booleanize()) {
  2784. p_ternary_op->reduced_value = p_ternary_op->true_expr->reduced_value;
  2785. } else {
  2786. p_ternary_op->reduced_value = p_ternary_op->false_expr->reduced_value;
  2787. }
  2788. }
  2789. GDScriptParser::DataType true_type;
  2790. if (p_ternary_op->true_expr) {
  2791. true_type = p_ternary_op->true_expr->get_datatype();
  2792. } else {
  2793. true_type.kind = GDScriptParser::DataType::VARIANT;
  2794. }
  2795. GDScriptParser::DataType false_type;
  2796. if (p_ternary_op->false_expr) {
  2797. false_type = p_ternary_op->false_expr->get_datatype();
  2798. } else {
  2799. false_type.kind = GDScriptParser::DataType::VARIANT;
  2800. }
  2801. if (true_type.is_variant() || false_type.is_variant()) {
  2802. result.kind = GDScriptParser::DataType::VARIANT;
  2803. } else {
  2804. result = true_type;
  2805. if (!is_type_compatible(true_type, false_type)) {
  2806. result = false_type;
  2807. if (!is_type_compatible(false_type, true_type)) {
  2808. result.type_source = GDScriptParser::DataType::UNDETECTED;
  2809. result.kind = GDScriptParser::DataType::VARIANT;
  2810. #ifdef DEBUG_ENABLED
  2811. parser->push_warning(p_ternary_op, GDScriptWarning::INCOMPATIBLE_TERNARY);
  2812. #endif
  2813. }
  2814. }
  2815. }
  2816. p_ternary_op->set_datatype(result);
  2817. }
  2818. void GDScriptAnalyzer::reduce_unary_op(GDScriptParser::UnaryOpNode *p_unary_op) {
  2819. reduce_expression(p_unary_op->operand);
  2820. GDScriptParser::DataType result;
  2821. if (p_unary_op->operand == nullptr) {
  2822. result.kind = GDScriptParser::DataType::VARIANT;
  2823. p_unary_op->set_datatype(result);
  2824. return;
  2825. }
  2826. if (p_unary_op->operand->is_constant) {
  2827. p_unary_op->is_constant = true;
  2828. p_unary_op->reduced_value = Variant::evaluate(p_unary_op->variant_op, p_unary_op->operand->reduced_value, Variant());
  2829. result = type_from_variant(p_unary_op->reduced_value, p_unary_op);
  2830. } else if (p_unary_op->operand->get_datatype().is_variant()) {
  2831. result.kind = GDScriptParser::DataType::VARIANT;
  2832. mark_node_unsafe(p_unary_op);
  2833. } else {
  2834. bool valid = false;
  2835. result = get_operation_type(p_unary_op->variant_op, p_unary_op->operand->get_datatype(), valid, p_unary_op);
  2836. if (!valid) {
  2837. 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);
  2838. }
  2839. }
  2840. p_unary_op->set_datatype(result);
  2841. }
  2842. void GDScriptAnalyzer::const_fold_array(GDScriptParser::ArrayNode *p_array) {
  2843. bool all_is_constant = true;
  2844. for (int i = 0; i < p_array->elements.size(); i++) {
  2845. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  2846. all_is_constant = all_is_constant && element->is_constant;
  2847. if (!all_is_constant) {
  2848. return;
  2849. }
  2850. }
  2851. Array array;
  2852. array.resize(p_array->elements.size());
  2853. for (int i = 0; i < p_array->elements.size(); i++) {
  2854. array[i] = p_array->elements[i]->reduced_value;
  2855. }
  2856. p_array->is_constant = true;
  2857. p_array->reduced_value = array;
  2858. }
  2859. void GDScriptAnalyzer::const_fold_dictionary(GDScriptParser::DictionaryNode *p_dictionary) {
  2860. bool all_is_constant = true;
  2861. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  2862. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  2863. all_is_constant = all_is_constant && element.key->is_constant && element.value->is_constant;
  2864. if (!all_is_constant) {
  2865. return;
  2866. }
  2867. }
  2868. Dictionary dict;
  2869. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  2870. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  2871. dict[element.key->reduced_value] = element.value->reduced_value;
  2872. }
  2873. p_dictionary->is_constant = true;
  2874. p_dictionary->reduced_value = dict;
  2875. }
  2876. GDScriptParser::DataType GDScriptAnalyzer::type_from_variant(const Variant &p_value, const GDScriptParser::Node *p_source) {
  2877. GDScriptParser::DataType result;
  2878. result.is_constant = true;
  2879. result.kind = GDScriptParser::DataType::BUILTIN;
  2880. result.builtin_type = p_value.get_type();
  2881. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT; // Constant has explicit type.
  2882. if (p_value.get_type() == Variant::OBJECT) {
  2883. Object *obj = p_value;
  2884. if (!obj) {
  2885. return GDScriptParser::DataType();
  2886. }
  2887. result.native_type = obj->get_class_name();
  2888. Ref<Script> scr = p_value; // Check if value is a script itself.
  2889. if (scr.is_valid()) {
  2890. result.is_meta_type = true;
  2891. } else {
  2892. result.is_meta_type = false;
  2893. scr = obj->get_script();
  2894. }
  2895. if (scr.is_valid()) {
  2896. if (scr->is_valid()) {
  2897. result.script_type = scr;
  2898. result.script_path = scr->get_path();
  2899. Ref<GDScript> gds = scr;
  2900. if (gds.is_valid()) {
  2901. result.kind = GDScriptParser::DataType::CLASS;
  2902. // This might be an inner class, so we want to get the parser for the root.
  2903. // But still get the inner class from that tree.
  2904. GDScript *current = gds.ptr();
  2905. List<StringName> class_chain;
  2906. while (current->_owner) {
  2907. // Push to front so it's in reverse.
  2908. class_chain.push_front(current->name);
  2909. current = current->_owner;
  2910. }
  2911. Ref<GDScriptParserRef> ref = get_parser_for(current->path);
  2912. ref->raise_status(GDScriptParserRef::INTERFACE_SOLVED);
  2913. GDScriptParser::ClassNode *found = ref->get_parser()->head;
  2914. // It should be okay to assume this exists, since we have a complete script already.
  2915. for (const StringName &E : class_chain) {
  2916. found = found->get_member(E).m_class;
  2917. }
  2918. result.class_type = found;
  2919. result.script_path = ref->get_parser()->script_path;
  2920. } else {
  2921. result.kind = GDScriptParser::DataType::SCRIPT;
  2922. }
  2923. result.native_type = scr->get_instance_base_type();
  2924. } else {
  2925. push_error(vformat(R"(Constant value uses script from "%s" which is loaded but not compiled.)", scr->get_path()), p_source);
  2926. result.kind = GDScriptParser::DataType::VARIANT;
  2927. result.type_source = GDScriptParser::DataType::UNDETECTED;
  2928. result.is_meta_type = false;
  2929. }
  2930. } else {
  2931. result.kind = GDScriptParser::DataType::NATIVE;
  2932. if (result.native_type == GDScriptNativeClass::get_class_static()) {
  2933. result.is_meta_type = true;
  2934. }
  2935. }
  2936. }
  2937. return result;
  2938. }
  2939. GDScriptParser::DataType GDScriptAnalyzer::type_from_metatype(const GDScriptParser::DataType &p_meta_type) const {
  2940. GDScriptParser::DataType result = p_meta_type;
  2941. result.is_meta_type = false;
  2942. result.is_constant = false;
  2943. return result;
  2944. }
  2945. GDScriptParser::DataType GDScriptAnalyzer::type_from_property(const PropertyInfo &p_property) const {
  2946. GDScriptParser::DataType result;
  2947. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2948. if (p_property.type == Variant::NIL && (p_property.usage & PROPERTY_USAGE_NIL_IS_VARIANT)) {
  2949. // Variant
  2950. result.kind = GDScriptParser::DataType::VARIANT;
  2951. return result;
  2952. }
  2953. result.builtin_type = p_property.type;
  2954. if (p_property.type == Variant::OBJECT) {
  2955. result.kind = GDScriptParser::DataType::NATIVE;
  2956. result.native_type = p_property.class_name == StringName() ? "Object" : p_property.class_name;
  2957. } else {
  2958. result.kind = GDScriptParser::DataType::BUILTIN;
  2959. result.builtin_type = p_property.type;
  2960. if (p_property.type == Variant::ARRAY && p_property.hint == PROPERTY_HINT_ARRAY_TYPE) {
  2961. // Check element type.
  2962. StringName elem_type_name = p_property.hint_string;
  2963. GDScriptParser::DataType elem_type;
  2964. elem_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2965. Variant::Type elem_builtin_type = GDScriptParser::get_builtin_type(elem_type_name);
  2966. if (elem_builtin_type < Variant::VARIANT_MAX) {
  2967. // Builtin type.
  2968. elem_type.kind = GDScriptParser::DataType::BUILTIN;
  2969. elem_type.builtin_type = elem_builtin_type;
  2970. } else if (class_exists(elem_type_name)) {
  2971. elem_type.kind = GDScriptParser::DataType::NATIVE;
  2972. elem_type.builtin_type = Variant::OBJECT;
  2973. elem_type.native_type = p_property.hint_string;
  2974. } else if (ScriptServer::is_global_class(elem_type_name)) {
  2975. // Just load this as it shouldn't be a GDScript.
  2976. Ref<Script> script = ResourceLoader::load(ScriptServer::get_global_class_path(elem_type_name));
  2977. elem_type.kind = GDScriptParser::DataType::SCRIPT;
  2978. elem_type.builtin_type = Variant::OBJECT;
  2979. elem_type.native_type = script->get_instance_base_type();
  2980. elem_type.script_type = script;
  2981. } else {
  2982. ERR_FAIL_V_MSG(result, "Could not find element type from property hint of a typed array.");
  2983. }
  2984. result.set_container_element_type(elem_type);
  2985. }
  2986. }
  2987. return result;
  2988. }
  2989. bool GDScriptAnalyzer::get_function_signature(GDScriptParser::CallNode *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) {
  2990. r_static = false;
  2991. r_vararg = false;
  2992. r_default_arg_count = 0;
  2993. StringName function_name = p_function;
  2994. if (p_base_type.kind == GDScriptParser::DataType::BUILTIN) {
  2995. // Construct a base type to get methods.
  2996. Callable::CallError err;
  2997. Variant dummy;
  2998. Variant::construct(p_base_type.builtin_type, dummy, nullptr, 0, err);
  2999. if (err.error != Callable::CallError::CALL_OK) {
  3000. ERR_FAIL_V_MSG(false, "Could not construct base Variant type.");
  3001. }
  3002. List<MethodInfo> methods;
  3003. dummy.get_method_list(&methods);
  3004. for (const MethodInfo &E : methods) {
  3005. if (E.name == p_function) {
  3006. function_signature_from_info(E, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  3007. r_static = Variant::is_builtin_method_static(p_base_type.builtin_type, function_name);
  3008. return true;
  3009. }
  3010. }
  3011. return false;
  3012. }
  3013. bool is_constructor = (p_base_type.is_meta_type || (p_source->callee && p_source->callee->type == GDScriptParser::Node::IDENTIFIER)) && p_function == StaticCString::create("new");
  3014. if (is_constructor) {
  3015. function_name = "_init";
  3016. r_static = true;
  3017. }
  3018. GDScriptParser::ClassNode *base_class = p_base_type.class_type;
  3019. GDScriptParser::FunctionNode *found_function = nullptr;
  3020. while (found_function == nullptr && base_class != nullptr) {
  3021. if (base_class->has_member(function_name)) {
  3022. if (base_class->get_member(function_name).type != GDScriptParser::ClassNode::Member::FUNCTION) {
  3023. // TODO: If this is Callable it can have a better error message.
  3024. push_error(vformat(R"(Member "%s" is not a function.)", function_name), p_source);
  3025. return false;
  3026. }
  3027. found_function = base_class->get_member(function_name).function;
  3028. }
  3029. base_class = base_class->base_type.class_type;
  3030. }
  3031. if (found_function != nullptr) {
  3032. r_static = is_constructor || found_function->is_static;
  3033. for (int i = 0; i < found_function->parameters.size(); i++) {
  3034. r_par_types.push_back(found_function->parameters[i]->get_datatype());
  3035. if (found_function->parameters[i]->default_value != nullptr) {
  3036. r_default_arg_count++;
  3037. }
  3038. }
  3039. r_return_type = found_function->get_datatype();
  3040. r_return_type.is_meta_type = false;
  3041. r_return_type.is_coroutine = found_function->is_coroutine;
  3042. return true;
  3043. }
  3044. Ref<Script> base_script = p_base_type.script_type;
  3045. while (base_script.is_valid() && base_script->is_valid()) {
  3046. MethodInfo info = base_script->get_method_info(function_name);
  3047. if (!(info == MethodInfo())) {
  3048. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  3049. }
  3050. base_script = base_script->get_base_script();
  3051. }
  3052. // If the base is a script, it might be trying to access members of the Script class itself.
  3053. if (p_base_type.is_meta_type && !is_constructor && (p_base_type.kind == GDScriptParser::DataType::SCRIPT || p_base_type.kind == GDScriptParser::DataType::CLASS)) {
  3054. MethodInfo info;
  3055. StringName script_class = p_base_type.kind == GDScriptParser::DataType::SCRIPT ? p_base_type.script_type->get_class_name() : StringName(GDScript::get_class_static());
  3056. if (ClassDB::get_method_info(script_class, function_name, &info)) {
  3057. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  3058. }
  3059. }
  3060. StringName base_native = p_base_type.native_type;
  3061. #ifdef DEBUG_ENABLED
  3062. if (base_native != StringName()) {
  3063. // Empty native class might happen in some Script implementations.
  3064. // Just ignore it.
  3065. if (!class_exists(base_native)) {
  3066. ERR_FAIL_V_MSG(false, vformat("Native class %s used in script doesn't exist or isn't exposed.", base_native));
  3067. }
  3068. }
  3069. #endif
  3070. if (is_constructor) {
  3071. // Native types always have a default constructor.
  3072. r_return_type = p_base_type;
  3073. r_return_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3074. r_return_type.is_meta_type = false;
  3075. return true;
  3076. }
  3077. MethodInfo info;
  3078. if (ClassDB::get_method_info(base_native, function_name, &info)) {
  3079. bool valid = function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  3080. if (valid && Engine::get_singleton()->has_singleton(base_native)) {
  3081. r_static = true;
  3082. }
  3083. return valid;
  3084. }
  3085. return false;
  3086. }
  3087. 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) {
  3088. r_return_type = type_from_property(p_info.return_val);
  3089. r_default_arg_count = p_info.default_arguments.size();
  3090. r_vararg = (p_info.flags & METHOD_FLAG_VARARG) != 0;
  3091. for (const PropertyInfo &E : p_info.arguments) {
  3092. r_par_types.push_back(type_from_property(E));
  3093. }
  3094. return true;
  3095. }
  3096. bool GDScriptAnalyzer::validate_call_arg(const MethodInfo &p_method, const GDScriptParser::CallNode *p_call) {
  3097. List<GDScriptParser::DataType> arg_types;
  3098. for (const PropertyInfo &E : p_method.arguments) {
  3099. arg_types.push_back(type_from_property(E));
  3100. }
  3101. return validate_call_arg(arg_types, p_method.default_arguments.size(), (p_method.flags & METHOD_FLAG_VARARG) != 0, p_call);
  3102. }
  3103. 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) {
  3104. bool valid = true;
  3105. if (p_call->arguments.size() < p_par_types.size() - p_default_args_count) {
  3106. 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);
  3107. valid = false;
  3108. }
  3109. if (!p_is_vararg && p_call->arguments.size() > p_par_types.size()) {
  3110. 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()]);
  3111. valid = false;
  3112. }
  3113. for (int i = 0; i < p_call->arguments.size(); i++) {
  3114. if (i >= p_par_types.size()) {
  3115. // Already on vararg place.
  3116. break;
  3117. }
  3118. GDScriptParser::DataType par_type = p_par_types[i];
  3119. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  3120. if (arg_type.is_variant()) {
  3121. // Argument can be anything, so this is unsafe.
  3122. mark_node_unsafe(p_call->arguments[i]);
  3123. } else if (par_type.is_hard_type() && !is_type_compatible(par_type, arg_type, true)) {
  3124. // Supertypes are acceptable for dynamic compliance, but it's unsafe.
  3125. mark_node_unsafe(p_call);
  3126. if (!is_type_compatible(arg_type, par_type)) {
  3127. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be %s but is %s.)*",
  3128. p_call->function_name, i + 1, par_type.to_string(), arg_type.to_string()),
  3129. p_call->arguments[i]);
  3130. valid = false;
  3131. }
  3132. #ifdef DEBUG_ENABLED
  3133. } else {
  3134. 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) {
  3135. parser->push_warning(p_call, GDScriptWarning::NARROWING_CONVERSION, p_call->function_name);
  3136. }
  3137. #endif
  3138. }
  3139. }
  3140. return valid;
  3141. }
  3142. #ifdef DEBUG_ENABLED
  3143. bool GDScriptAnalyzer::is_shadowing(GDScriptParser::IdentifierNode *p_local, const String &p_context) {
  3144. const StringName &name = p_local->name;
  3145. GDScriptParser::DataType base = parser->current_class->get_datatype();
  3146. GDScriptParser::ClassNode *base_class = base.class_type;
  3147. while (base_class != nullptr) {
  3148. if (base_class->has_member(name)) {
  3149. 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()));
  3150. return true;
  3151. }
  3152. base_class = base_class->base_type.class_type;
  3153. }
  3154. StringName base_native = base.native_type;
  3155. ERR_FAIL_COND_V_MSG(!class_exists(base_native), false, "Non-existent native base class.");
  3156. StringName parent = base_native;
  3157. while (parent != StringName()) {
  3158. if (ClassDB::has_method(parent, name, true)) {
  3159. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "method", parent);
  3160. return true;
  3161. } else if (ClassDB::has_signal(parent, name, true)) {
  3162. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "signal", parent);
  3163. return true;
  3164. } else if (ClassDB::has_property(parent, name, true)) {
  3165. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "property", parent);
  3166. return true;
  3167. } else if (ClassDB::has_integer_constant(parent, name, true)) {
  3168. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "constant", parent);
  3169. return true;
  3170. } else if (ClassDB::has_enum(parent, name, true)) {
  3171. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "enum", parent);
  3172. return true;
  3173. }
  3174. parent = ClassDB::get_parent_class(parent);
  3175. }
  3176. return false;
  3177. }
  3178. #endif
  3179. GDScriptParser::DataType GDScriptAnalyzer::get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, bool &r_valid, const GDScriptParser::Node *p_source) {
  3180. // Unary version.
  3181. GDScriptParser::DataType nil_type;
  3182. nil_type.builtin_type = Variant::NIL;
  3183. return get_operation_type(p_operation, p_a, nil_type, r_valid, p_source);
  3184. }
  3185. GDScriptParser::DataType GDScriptAnalyzer::get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, const GDScriptParser::DataType &p_b, bool &r_valid, const GDScriptParser::Node *p_source) {
  3186. GDScriptParser::DataType result;
  3187. result.kind = GDScriptParser::DataType::VARIANT;
  3188. Variant::Type a_type = p_a.builtin_type;
  3189. Variant::Type b_type = p_b.builtin_type;
  3190. Variant::ValidatedOperatorEvaluator op_eval = Variant::get_validated_operator_evaluator(p_operation, a_type, b_type);
  3191. if (op_eval == nullptr) {
  3192. r_valid = false;
  3193. return result;
  3194. }
  3195. r_valid = true;
  3196. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  3197. result.kind = GDScriptParser::DataType::BUILTIN;
  3198. result.builtin_type = Variant::get_operator_return_type(p_operation, a_type, b_type);
  3199. return result;
  3200. }
  3201. // TODO: Add safe/unsafe return variable (for variant cases)
  3202. bool GDScriptAnalyzer::is_type_compatible(const GDScriptParser::DataType &p_target, const GDScriptParser::DataType &p_source, bool p_allow_implicit_conversion) const {
  3203. // These return "true" so it doesn't affect users negatively.
  3204. ERR_FAIL_COND_V_MSG(!p_target.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset target type");
  3205. ERR_FAIL_COND_V_MSG(!p_source.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset value type");
  3206. if (p_target.kind == GDScriptParser::DataType::VARIANT) {
  3207. // Variant can receive anything.
  3208. return true;
  3209. }
  3210. if (p_source.kind == GDScriptParser::DataType::VARIANT) {
  3211. // TODO: This is acceptable but unsafe. Make sure unsafe line is set.
  3212. return true;
  3213. }
  3214. if (p_target.kind == GDScriptParser::DataType::BUILTIN) {
  3215. bool valid = p_source.kind == GDScriptParser::DataType::BUILTIN && p_target.builtin_type == p_source.builtin_type;
  3216. if (!valid && p_allow_implicit_conversion) {
  3217. valid = Variant::can_convert_strict(p_source.builtin_type, p_target.builtin_type);
  3218. }
  3219. if (!valid && p_target.builtin_type == Variant::INT && p_source.kind == GDScriptParser::DataType::ENUM_VALUE) {
  3220. // Enum value is also integer.
  3221. valid = true;
  3222. }
  3223. if (valid && p_target.builtin_type == Variant::ARRAY && p_source.builtin_type == Variant::ARRAY) {
  3224. // Check the element type.
  3225. if (p_target.has_container_element_type()) {
  3226. if (!p_source.has_container_element_type()) {
  3227. // TODO: Maybe this is valid but unsafe?
  3228. // Variant array can't be appended to typed array.
  3229. valid = false;
  3230. } else {
  3231. valid = is_type_compatible(p_target.get_container_element_type(), p_source.get_container_element_type(), false);
  3232. }
  3233. }
  3234. }
  3235. return valid;
  3236. }
  3237. if (p_target.kind == GDScriptParser::DataType::ENUM) {
  3238. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::INT) {
  3239. return true;
  3240. }
  3241. if (p_source.kind == GDScriptParser::DataType::ENUM_VALUE) {
  3242. if (p_source.native_type == p_target.native_type && p_target.enum_values.has(p_source.enum_type)) {
  3243. return true;
  3244. }
  3245. }
  3246. return false;
  3247. }
  3248. // From here on the target type is an object, so we have to test polymorphism.
  3249. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::NIL) {
  3250. // null is acceptable in object.
  3251. return true;
  3252. }
  3253. StringName src_native;
  3254. Ref<Script> src_script;
  3255. const GDScriptParser::ClassNode *src_class = nullptr;
  3256. switch (p_source.kind) {
  3257. case GDScriptParser::DataType::NATIVE:
  3258. if (p_target.kind != GDScriptParser::DataType::NATIVE) {
  3259. // Non-native class cannot be supertype of native.
  3260. return false;
  3261. }
  3262. if (p_source.is_meta_type) {
  3263. src_native = GDScriptNativeClass::get_class_static();
  3264. } else {
  3265. src_native = p_source.native_type;
  3266. }
  3267. break;
  3268. case GDScriptParser::DataType::SCRIPT:
  3269. if (p_target.kind == GDScriptParser::DataType::CLASS) {
  3270. // A script type cannot be a subtype of a GDScript class.
  3271. return false;
  3272. }
  3273. if (p_source.is_meta_type) {
  3274. src_native = p_source.script_type->get_class_name();
  3275. } else {
  3276. src_script = p_source.script_type;
  3277. src_native = src_script->get_instance_base_type();
  3278. }
  3279. break;
  3280. case GDScriptParser::DataType::CLASS:
  3281. if (p_source.is_meta_type) {
  3282. src_native = GDScript::get_class_static();
  3283. } else {
  3284. src_class = p_source.class_type;
  3285. const GDScriptParser::ClassNode *base = src_class;
  3286. while (base->base_type.kind == GDScriptParser::DataType::CLASS) {
  3287. base = base->base_type.class_type;
  3288. }
  3289. src_native = base->base_type.native_type;
  3290. src_script = base->base_type.script_type;
  3291. }
  3292. break;
  3293. case GDScriptParser::DataType::VARIANT:
  3294. case GDScriptParser::DataType::BUILTIN:
  3295. case GDScriptParser::DataType::ENUM:
  3296. case GDScriptParser::DataType::ENUM_VALUE:
  3297. case GDScriptParser::DataType::UNRESOLVED:
  3298. break; // Already solved before.
  3299. }
  3300. switch (p_target.kind) {
  3301. case GDScriptParser::DataType::NATIVE: {
  3302. if (p_target.is_meta_type) {
  3303. return ClassDB::is_parent_class(src_native, GDScriptNativeClass::get_class_static());
  3304. }
  3305. return ClassDB::is_parent_class(src_native, p_target.native_type);
  3306. }
  3307. case GDScriptParser::DataType::SCRIPT:
  3308. if (p_target.is_meta_type) {
  3309. return ClassDB::is_parent_class(src_native, p_target.script_type->get_class_name());
  3310. }
  3311. while (src_script.is_valid()) {
  3312. if (src_script == p_target.script_type) {
  3313. return true;
  3314. }
  3315. src_script = src_script->get_base_script();
  3316. }
  3317. return false;
  3318. case GDScriptParser::DataType::CLASS:
  3319. if (p_target.is_meta_type) {
  3320. return ClassDB::is_parent_class(src_native, GDScript::get_class_static());
  3321. }
  3322. while (src_class != nullptr) {
  3323. if (src_class->fqcn == p_target.class_type->fqcn) {
  3324. return true;
  3325. }
  3326. src_class = src_class->base_type.class_type;
  3327. }
  3328. return false;
  3329. case GDScriptParser::DataType::VARIANT:
  3330. case GDScriptParser::DataType::BUILTIN:
  3331. case GDScriptParser::DataType::ENUM:
  3332. case GDScriptParser::DataType::ENUM_VALUE:
  3333. case GDScriptParser::DataType::UNRESOLVED:
  3334. break; // Already solved before.
  3335. }
  3336. return false;
  3337. }
  3338. void GDScriptAnalyzer::push_error(const String &p_message, const GDScriptParser::Node *p_origin) {
  3339. mark_node_unsafe(p_origin);
  3340. parser->push_error(p_message, p_origin);
  3341. }
  3342. void GDScriptAnalyzer::mark_node_unsafe(const GDScriptParser::Node *p_node) {
  3343. #ifdef DEBUG_ENABLED
  3344. for (int i = p_node->start_line; i <= p_node->end_line; i++) {
  3345. parser->unsafe_lines.insert(i);
  3346. }
  3347. #endif
  3348. }
  3349. bool GDScriptAnalyzer::class_exists(const StringName &p_class) const {
  3350. return ClassDB::class_exists(p_class) && ClassDB::is_class_exposed(p_class);
  3351. }
  3352. Ref<GDScriptParserRef> GDScriptAnalyzer::get_parser_for(const String &p_path) {
  3353. Ref<GDScriptParserRef> ref;
  3354. if (depended_parsers.has(p_path)) {
  3355. ref = depended_parsers[p_path];
  3356. } else {
  3357. Error err = OK;
  3358. ref = GDScriptCache::get_parser(p_path, GDScriptParserRef::EMPTY, err, parser->script_path);
  3359. depended_parsers[p_path] = ref;
  3360. }
  3361. return ref;
  3362. }
  3363. Error GDScriptAnalyzer::resolve_inheritance() {
  3364. return resolve_inheritance(parser->head);
  3365. }
  3366. Error GDScriptAnalyzer::resolve_interface() {
  3367. resolve_class_interface(parser->head);
  3368. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  3369. }
  3370. Error GDScriptAnalyzer::resolve_body() {
  3371. resolve_class_body(parser->head);
  3372. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  3373. }
  3374. Error GDScriptAnalyzer::resolve_program() {
  3375. resolve_class_interface(parser->head);
  3376. resolve_class_body(parser->head);
  3377. List<String> parser_keys;
  3378. depended_parsers.get_key_list(&parser_keys);
  3379. for (const String &E : parser_keys) {
  3380. if (depended_parsers[E].is_null()) {
  3381. return ERR_PARSE_ERROR;
  3382. }
  3383. depended_parsers[E]->raise_status(GDScriptParserRef::FULLY_SOLVED);
  3384. }
  3385. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  3386. }
  3387. Error GDScriptAnalyzer::analyze() {
  3388. parser->errors.clear();
  3389. Error err = resolve_inheritance(parser->head);
  3390. if (err) {
  3391. return err;
  3392. }
  3393. return resolve_program();
  3394. }
  3395. GDScriptAnalyzer::GDScriptAnalyzer(GDScriptParser *p_parser) {
  3396. parser = p_parser;
  3397. }