gdscript_analyzer.cpp 216 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503
  1. /**************************************************************************/
  2. /* gdscript_analyzer.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  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 "gdscript.h"
  32. #include "gdscript_utility_functions.h"
  33. #include "core/config/engine.h"
  34. #include "core/config/project_settings.h"
  35. #include "core/core_constants.h"
  36. #include "core/core_string_names.h"
  37. #include "core/io/file_access.h"
  38. #include "core/io/resource_loader.h"
  39. #include "core/object/class_db.h"
  40. #include "core/object/script_language.h"
  41. #include "core/templates/hash_map.h"
  42. #include "scene/resources/packed_scene.h"
  43. #if defined(TOOLS_ENABLED) && !defined(DISABLE_DEPRECATED)
  44. #define SUGGEST_GODOT4_RENAMES
  45. #include "editor/renames_map_3_to_4.h"
  46. #endif
  47. #define UNNAMED_ENUM "<anonymous enum>"
  48. #define ENUM_SEPARATOR "."
  49. static MethodInfo info_from_utility_func(const StringName &p_function) {
  50. ERR_FAIL_COND_V(!Variant::has_utility_function(p_function), MethodInfo());
  51. MethodInfo info(p_function);
  52. if (Variant::has_utility_function_return_value(p_function)) {
  53. info.return_val.type = Variant::get_utility_function_return_type(p_function);
  54. if (info.return_val.type == Variant::NIL) {
  55. info.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  56. }
  57. }
  58. if (Variant::is_utility_function_vararg(p_function)) {
  59. info.flags |= METHOD_FLAG_VARARG;
  60. } else {
  61. for (int i = 0; i < Variant::get_utility_function_argument_count(p_function); i++) {
  62. PropertyInfo pi;
  63. #ifdef DEBUG_METHODS_ENABLED
  64. pi.name = Variant::get_utility_function_argument_name(p_function, i);
  65. #else
  66. pi.name = "arg" + itos(i + 1);
  67. #endif
  68. pi.type = Variant::get_utility_function_argument_type(p_function, i);
  69. info.arguments.push_back(pi);
  70. }
  71. }
  72. return info;
  73. }
  74. static GDScriptParser::DataType make_callable_type(const MethodInfo &p_info) {
  75. GDScriptParser::DataType type;
  76. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  77. type.kind = GDScriptParser::DataType::BUILTIN;
  78. type.builtin_type = Variant::CALLABLE;
  79. type.is_constant = true;
  80. type.method_info = p_info;
  81. return type;
  82. }
  83. static GDScriptParser::DataType make_signal_type(const MethodInfo &p_info) {
  84. GDScriptParser::DataType type;
  85. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  86. type.kind = GDScriptParser::DataType::BUILTIN;
  87. type.builtin_type = Variant::SIGNAL;
  88. type.is_constant = true;
  89. type.method_info = p_info;
  90. return type;
  91. }
  92. static GDScriptParser::DataType make_native_meta_type(const StringName &p_class_name) {
  93. GDScriptParser::DataType type;
  94. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  95. type.kind = GDScriptParser::DataType::NATIVE;
  96. type.builtin_type = Variant::OBJECT;
  97. type.native_type = p_class_name;
  98. type.is_constant = true;
  99. type.is_meta_type = true;
  100. return type;
  101. }
  102. static GDScriptParser::DataType make_script_meta_type(const Ref<Script> &p_script) {
  103. GDScriptParser::DataType type;
  104. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  105. type.kind = GDScriptParser::DataType::SCRIPT;
  106. type.builtin_type = Variant::OBJECT;
  107. type.native_type = p_script->get_instance_base_type();
  108. type.script_type = p_script;
  109. type.script_path = p_script->get_path();
  110. type.is_constant = true;
  111. type.is_meta_type = true;
  112. return type;
  113. }
  114. // In enum types, native_type is used to store the class (native or otherwise) that the enum belongs to.
  115. // This disambiguates between similarly named enums in base classes or outer classes
  116. static GDScriptParser::DataType make_enum_type(const StringName &p_enum_name, const String &p_base_name, const bool p_meta = false) {
  117. GDScriptParser::DataType type;
  118. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  119. type.kind = GDScriptParser::DataType::ENUM;
  120. type.builtin_type = p_meta ? Variant::DICTIONARY : Variant::INT;
  121. type.enum_type = p_enum_name;
  122. type.is_constant = true;
  123. type.is_meta_type = p_meta;
  124. // For enums, native_type is only used to check compatibility in is_type_compatible()
  125. // We can set anything readable here for error messages, as long as it uniquely identifies the type of the enum
  126. if (p_base_name.is_empty()) {
  127. type.native_type = p_enum_name;
  128. } else {
  129. type.native_type = p_base_name + ENUM_SEPARATOR + p_enum_name;
  130. }
  131. return type;
  132. }
  133. static GDScriptParser::DataType make_native_enum_type(const StringName &p_enum_name, const StringName &p_native_class, bool p_meta = true) {
  134. // Find out which base class declared the enum, so the name is always the same even when coming from other contexts.
  135. StringName native_base = p_native_class;
  136. while (true && native_base != StringName()) {
  137. if (ClassDB::has_enum(native_base, p_enum_name, true)) {
  138. break;
  139. }
  140. native_base = ClassDB::get_parent_class_nocheck(native_base);
  141. }
  142. GDScriptParser::DataType type = make_enum_type(p_enum_name, native_base, p_meta);
  143. if (p_meta) {
  144. type.builtin_type = Variant::NIL; // Native enum types are not Dictionaries.
  145. }
  146. List<StringName> enum_values;
  147. ClassDB::get_enum_constants(native_base, p_enum_name, &enum_values, true);
  148. for (const StringName &E : enum_values) {
  149. type.enum_values[E] = ClassDB::get_integer_constant(native_base, E);
  150. }
  151. return type;
  152. }
  153. static GDScriptParser::DataType make_global_enum_type(const StringName &p_enum_name, const StringName &p_base, bool p_meta = true) {
  154. GDScriptParser::DataType type = make_enum_type(p_enum_name, p_base, p_meta);
  155. if (p_meta) {
  156. type.builtin_type = Variant::NIL; // Native enum types are not Dictionaries.
  157. type.is_pseudo_type = true;
  158. }
  159. HashMap<StringName, int64_t> enum_values;
  160. CoreConstants::get_enum_values(type.native_type, &enum_values);
  161. for (const KeyValue<StringName, int64_t> &element : enum_values) {
  162. type.enum_values[element.key] = element.value;
  163. }
  164. return type;
  165. }
  166. static GDScriptParser::DataType make_builtin_meta_type(Variant::Type p_type) {
  167. GDScriptParser::DataType type;
  168. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  169. type.kind = GDScriptParser::DataType::BUILTIN;
  170. type.builtin_type = p_type;
  171. type.is_constant = true;
  172. type.is_meta_type = true;
  173. return type;
  174. }
  175. bool GDScriptAnalyzer::has_member_name_conflict_in_script_class(const StringName &p_member_name, const GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_member) {
  176. if (p_class->members_indices.has(p_member_name)) {
  177. int index = p_class->members_indices[p_member_name];
  178. const GDScriptParser::ClassNode::Member *member = &p_class->members[index];
  179. if (member->type == GDScriptParser::ClassNode::Member::VARIABLE ||
  180. member->type == GDScriptParser::ClassNode::Member::CONSTANT ||
  181. member->type == GDScriptParser::ClassNode::Member::ENUM ||
  182. member->type == GDScriptParser::ClassNode::Member::ENUM_VALUE ||
  183. member->type == GDScriptParser::ClassNode::Member::CLASS ||
  184. member->type == GDScriptParser::ClassNode::Member::SIGNAL) {
  185. return true;
  186. }
  187. if (p_member->type != GDScriptParser::Node::FUNCTION && member->type == GDScriptParser::ClassNode::Member::FUNCTION) {
  188. return true;
  189. }
  190. }
  191. return false;
  192. }
  193. bool GDScriptAnalyzer::has_member_name_conflict_in_native_type(const StringName &p_member_name, const StringName &p_native_type_string) {
  194. if (ClassDB::has_signal(p_native_type_string, p_member_name)) {
  195. return true;
  196. }
  197. if (ClassDB::has_property(p_native_type_string, p_member_name)) {
  198. return true;
  199. }
  200. if (ClassDB::has_integer_constant(p_native_type_string, p_member_name)) {
  201. return true;
  202. }
  203. if (p_member_name == CoreStringNames::get_singleton()->_script) {
  204. return true;
  205. }
  206. return false;
  207. }
  208. Error GDScriptAnalyzer::check_native_member_name_conflict(const StringName &p_member_name, const GDScriptParser::Node *p_member_node, const StringName &p_native_type_string) {
  209. if (has_member_name_conflict_in_native_type(p_member_name, p_native_type_string)) {
  210. push_error(vformat(R"(Member "%s" redefined (original in native class '%s'))", p_member_name, p_native_type_string), p_member_node);
  211. return ERR_PARSE_ERROR;
  212. }
  213. if (class_exists(p_member_name)) {
  214. push_error(vformat(R"(The member "%s" shadows a native class.)", p_member_name), p_member_node);
  215. return ERR_PARSE_ERROR;
  216. }
  217. if (GDScriptParser::get_builtin_type(p_member_name) < Variant::VARIANT_MAX) {
  218. push_error(vformat(R"(The member "%s" cannot have the same name as a builtin type.)", p_member_name), p_member_node);
  219. return ERR_PARSE_ERROR;
  220. }
  221. return OK;
  222. }
  223. Error GDScriptAnalyzer::check_class_member_name_conflict(const GDScriptParser::ClassNode *p_class_node, const StringName &p_member_name, const GDScriptParser::Node *p_member_node) {
  224. // TODO check outer classes for static members only
  225. const GDScriptParser::DataType *current_data_type = &p_class_node->base_type;
  226. while (current_data_type && current_data_type->kind == GDScriptParser::DataType::Kind::CLASS) {
  227. GDScriptParser::ClassNode *current_class_node = current_data_type->class_type;
  228. if (has_member_name_conflict_in_script_class(p_member_name, current_class_node, p_member_node)) {
  229. String parent_class_name = current_class_node->fqcn;
  230. if (current_class_node->identifier != nullptr) {
  231. parent_class_name = current_class_node->identifier->name;
  232. }
  233. push_error(vformat(R"(The member "%s" already exists in parent class %s.)", p_member_name, parent_class_name), p_member_node);
  234. return ERR_PARSE_ERROR;
  235. }
  236. current_data_type = &current_class_node->base_type;
  237. }
  238. // No need for native class recursion because Node exposes all Object's properties.
  239. if (current_data_type && current_data_type->kind == GDScriptParser::DataType::Kind::NATIVE) {
  240. if (current_data_type->native_type != StringName()) {
  241. return check_native_member_name_conflict(
  242. p_member_name,
  243. p_member_node,
  244. current_data_type->native_type);
  245. }
  246. }
  247. return OK;
  248. }
  249. void GDScriptAnalyzer::get_class_node_current_scope_classes(GDScriptParser::ClassNode *p_node, List<GDScriptParser::ClassNode *> *p_list) {
  250. ERR_FAIL_NULL(p_node);
  251. ERR_FAIL_NULL(p_list);
  252. if (p_list->find(p_node) != nullptr) {
  253. return;
  254. }
  255. p_list->push_back(p_node);
  256. // TODO: Try to solve class inheritance if not yet resolving.
  257. // Prioritize node base type over its outer class
  258. if (p_node->base_type.class_type != nullptr) {
  259. get_class_node_current_scope_classes(p_node->base_type.class_type, p_list);
  260. }
  261. if (p_node->outer != nullptr) {
  262. get_class_node_current_scope_classes(p_node->outer, p_list);
  263. }
  264. }
  265. Error GDScriptAnalyzer::resolve_class_inheritance(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source) {
  266. if (p_source == nullptr && parser->has_class(p_class)) {
  267. p_source = p_class;
  268. }
  269. if (p_class->base_type.is_resolving()) {
  270. push_error(vformat(R"(Could not resolve class "%s": Cyclic reference.)", type_from_metatype(p_class->get_datatype()).to_string()), p_source);
  271. return ERR_PARSE_ERROR;
  272. }
  273. if (!p_class->base_type.has_no_type()) {
  274. // Already resolved.
  275. return OK;
  276. }
  277. if (!parser->has_class(p_class)) {
  278. String script_path = p_class->get_datatype().script_path;
  279. Ref<GDScriptParserRef> parser_ref = get_parser_for(script_path);
  280. if (parser_ref.is_null()) {
  281. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  282. return ERR_PARSE_ERROR;
  283. }
  284. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  285. if (err) {
  286. push_error(vformat(R"(Could not parse script "%s": %s.)", script_path, error_names[err]), p_source);
  287. return ERR_PARSE_ERROR;
  288. }
  289. ERR_FAIL_COND_V_MSG(!parser_ref->get_parser()->has_class(p_class), ERR_PARSE_ERROR, R"(Parser bug: Mismatched external parser.)");
  290. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  291. GDScriptParser *other_parser = parser_ref->get_parser();
  292. int error_count = other_parser->errors.size();
  293. other_analyzer->resolve_class_inheritance(p_class);
  294. if (other_parser->errors.size() > error_count) {
  295. push_error(vformat(R"(Could not resolve inheritance for class "%s".)", p_class->fqcn), p_source);
  296. return ERR_PARSE_ERROR;
  297. }
  298. return OK;
  299. }
  300. GDScriptParser::ClassNode *previous_class = parser->current_class;
  301. parser->current_class = p_class;
  302. if (p_class->identifier) {
  303. StringName class_name = p_class->identifier->name;
  304. if (GDScriptParser::get_builtin_type(class_name) < Variant::VARIANT_MAX) {
  305. push_error(vformat(R"(Class "%s" hides a built-in type.)", class_name), p_class->identifier);
  306. } else if (class_exists(class_name)) {
  307. push_error(vformat(R"(Class "%s" hides a native class.)", class_name), p_class->identifier);
  308. } else if (ScriptServer::is_global_class(class_name) && (ScriptServer::get_global_class_path(class_name) != parser->script_path || p_class != parser->head)) {
  309. push_error(vformat(R"(Class "%s" hides a global script class.)", class_name), p_class->identifier);
  310. } else if (ProjectSettings::get_singleton()->has_autoload(class_name) && ProjectSettings::get_singleton()->get_autoload(class_name).is_singleton) {
  311. push_error(vformat(R"(Class "%s" hides an autoload singleton.)", class_name), p_class->identifier);
  312. }
  313. }
  314. GDScriptParser::DataType resolving_datatype;
  315. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  316. p_class->base_type = resolving_datatype;
  317. // Set datatype for class.
  318. GDScriptParser::DataType class_type;
  319. class_type.is_constant = true;
  320. class_type.is_meta_type = true;
  321. class_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  322. class_type.kind = GDScriptParser::DataType::CLASS;
  323. class_type.class_type = p_class;
  324. class_type.script_path = parser->script_path;
  325. class_type.builtin_type = Variant::OBJECT;
  326. p_class->set_datatype(class_type);
  327. GDScriptParser::DataType result;
  328. if (!p_class->extends_used) {
  329. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  330. result.kind = GDScriptParser::DataType::NATIVE;
  331. result.native_type = SNAME("RefCounted");
  332. } else {
  333. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  334. GDScriptParser::DataType base;
  335. int extends_index = 0;
  336. if (!p_class->extends_path.is_empty()) {
  337. if (p_class->extends_path.is_relative_path()) {
  338. p_class->extends_path = class_type.script_path.get_base_dir().path_join(p_class->extends_path).simplify_path();
  339. }
  340. Ref<GDScriptParserRef> ext_parser = get_parser_for(p_class->extends_path);
  341. if (ext_parser.is_null()) {
  342. push_error(vformat(R"(Could not resolve super class path "%s".)", p_class->extends_path), p_class);
  343. return ERR_PARSE_ERROR;
  344. }
  345. Error err = ext_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  346. if (err != OK) {
  347. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", p_class->extends_path), p_class);
  348. return err;
  349. }
  350. base = ext_parser->get_parser()->head->get_datatype();
  351. } else {
  352. if (p_class->extends.is_empty()) {
  353. push_error("Could not resolve an empty super class path.", p_class);
  354. return ERR_PARSE_ERROR;
  355. }
  356. GDScriptParser::IdentifierNode *id = p_class->extends[extends_index++];
  357. const StringName &name = id->name;
  358. base.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  359. if (ScriptServer::is_global_class(name)) {
  360. String base_path = ScriptServer::get_global_class_path(name);
  361. if (base_path == parser->script_path) {
  362. base = parser->head->get_datatype();
  363. } else {
  364. Ref<GDScriptParserRef> base_parser = get_parser_for(base_path);
  365. if (base_parser.is_null()) {
  366. push_error(vformat(R"(Could not resolve super class "%s".)", name), id);
  367. return ERR_PARSE_ERROR;
  368. }
  369. Error err = base_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  370. if (err != OK) {
  371. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), id);
  372. return err;
  373. }
  374. base = base_parser->get_parser()->head->get_datatype();
  375. }
  376. } else if (ProjectSettings::get_singleton()->has_autoload(name) && ProjectSettings::get_singleton()->get_autoload(name).is_singleton) {
  377. const ProjectSettings::AutoloadInfo &info = ProjectSettings::get_singleton()->get_autoload(name);
  378. if (info.path.get_extension().to_lower() != GDScriptLanguage::get_singleton()->get_extension()) {
  379. push_error(vformat(R"(Singleton %s is not a GDScript.)", info.name), id);
  380. return ERR_PARSE_ERROR;
  381. }
  382. Ref<GDScriptParserRef> info_parser = get_parser_for(info.path);
  383. if (info_parser.is_null()) {
  384. push_error(vformat(R"(Could not parse singleton from "%s".)", info.path), id);
  385. return ERR_PARSE_ERROR;
  386. }
  387. Error err = info_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  388. if (err != OK) {
  389. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), id);
  390. return err;
  391. }
  392. base = info_parser->get_parser()->head->get_datatype();
  393. } else if (class_exists(name)) {
  394. if (Engine::get_singleton()->has_singleton(name)) {
  395. push_error(vformat(R"(Cannot inherit native class "%s" because it is an engine singleton.)", name), id);
  396. return ERR_PARSE_ERROR;
  397. }
  398. base.kind = GDScriptParser::DataType::NATIVE;
  399. base.native_type = name;
  400. } else {
  401. // Look for other classes in script.
  402. bool found = false;
  403. List<GDScriptParser::ClassNode *> script_classes;
  404. get_class_node_current_scope_classes(p_class, &script_classes);
  405. for (GDScriptParser::ClassNode *look_class : script_classes) {
  406. if (look_class->identifier && look_class->identifier->name == name) {
  407. if (!look_class->get_datatype().is_set()) {
  408. Error err = resolve_class_inheritance(look_class, id);
  409. if (err) {
  410. return err;
  411. }
  412. }
  413. base = look_class->get_datatype();
  414. found = true;
  415. break;
  416. }
  417. if (look_class->has_member(name)) {
  418. resolve_class_member(look_class, name, id);
  419. GDScriptParser::ClassNode::Member member = look_class->get_member(name);
  420. GDScriptParser::DataType member_datatype = member.get_datatype();
  421. switch (member.type) {
  422. case GDScriptParser::ClassNode::Member::CLASS:
  423. break; // OK.
  424. case GDScriptParser::ClassNode::Member::CONSTANT:
  425. if (member_datatype.kind != GDScriptParser::DataType::SCRIPT && member_datatype.kind != GDScriptParser::DataType::CLASS) {
  426. push_error(vformat(R"(Constant "%s" is not a preloaded script or class.)", name), id);
  427. return ERR_PARSE_ERROR;
  428. }
  429. break;
  430. default:
  431. push_error(vformat(R"(Cannot use %s "%s" in extends chain.)", member.get_type_name(), name), id);
  432. return ERR_PARSE_ERROR;
  433. }
  434. base = member_datatype;
  435. found = true;
  436. break;
  437. }
  438. }
  439. if (!found) {
  440. push_error(vformat(R"(Could not find base class "%s".)", name), id);
  441. return ERR_PARSE_ERROR;
  442. }
  443. }
  444. }
  445. for (int index = extends_index; index < p_class->extends.size(); index++) {
  446. GDScriptParser::IdentifierNode *id = p_class->extends[index];
  447. if (base.kind != GDScriptParser::DataType::CLASS) {
  448. push_error(vformat(R"(Cannot get nested types for extension from non-GDScript type "%s".)", base.to_string()), id);
  449. return ERR_PARSE_ERROR;
  450. }
  451. reduce_identifier_from_base(id, &base);
  452. GDScriptParser::DataType id_type = id->get_datatype();
  453. if (!id_type.is_set()) {
  454. push_error(vformat(R"(Could not find nested type "%s".)", id->name), id);
  455. return ERR_PARSE_ERROR;
  456. } else if (id_type.kind != GDScriptParser::DataType::SCRIPT && id_type.kind != GDScriptParser::DataType::CLASS) {
  457. push_error(vformat(R"(Identifier "%s" is not a preloaded script or class.)", id->name), id);
  458. return ERR_PARSE_ERROR;
  459. }
  460. base = id_type;
  461. }
  462. result = base;
  463. }
  464. if (!result.is_set() || result.has_no_type()) {
  465. // TODO: More specific error messages.
  466. push_error(vformat(R"(Could not resolve inheritance for class "%s".)", p_class->identifier == nullptr ? "<main>" : p_class->identifier->name), p_class);
  467. return ERR_PARSE_ERROR;
  468. }
  469. // Check for cyclic inheritance.
  470. const GDScriptParser::ClassNode *base_class = result.class_type;
  471. while (base_class) {
  472. if (base_class->fqcn == p_class->fqcn) {
  473. push_error("Cyclic inheritance.", p_class);
  474. return ERR_PARSE_ERROR;
  475. }
  476. base_class = base_class->base_type.class_type;
  477. }
  478. p_class->base_type = result;
  479. class_type.native_type = result.native_type;
  480. p_class->set_datatype(class_type);
  481. parser->current_class = previous_class;
  482. return OK;
  483. }
  484. Error GDScriptAnalyzer::resolve_class_inheritance(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  485. Error err = resolve_class_inheritance(p_class);
  486. if (err) {
  487. return err;
  488. }
  489. if (p_recursive) {
  490. for (int i = 0; i < p_class->members.size(); i++) {
  491. if (p_class->members[i].type == GDScriptParser::ClassNode::Member::CLASS) {
  492. err = resolve_class_inheritance(p_class->members[i].m_class, true);
  493. if (err) {
  494. return err;
  495. }
  496. }
  497. }
  498. }
  499. return OK;
  500. }
  501. GDScriptParser::DataType GDScriptAnalyzer::resolve_datatype(GDScriptParser::TypeNode *p_type) {
  502. GDScriptParser::DataType bad_type;
  503. bad_type.kind = GDScriptParser::DataType::VARIANT;
  504. bad_type.type_source = GDScriptParser::DataType::INFERRED;
  505. if (p_type == nullptr) {
  506. return bad_type;
  507. }
  508. if (p_type->get_datatype().is_resolving()) {
  509. push_error(R"(Could not resolve datatype: Cyclic reference.)", p_type);
  510. return bad_type;
  511. }
  512. if (!p_type->get_datatype().has_no_type()) {
  513. return p_type->get_datatype();
  514. }
  515. GDScriptParser::DataType resolving_datatype;
  516. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  517. p_type->set_datatype(resolving_datatype);
  518. GDScriptParser::DataType result;
  519. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  520. if (p_type->type_chain.is_empty()) {
  521. // void.
  522. result.kind = GDScriptParser::DataType::BUILTIN;
  523. result.builtin_type = Variant::NIL;
  524. p_type->set_datatype(result);
  525. return result;
  526. }
  527. const GDScriptParser::IdentifierNode *first_id = p_type->type_chain[0];
  528. StringName first = first_id->name;
  529. bool type_found = false;
  530. if (first_id->suite && first_id->suite->has_local(first)) {
  531. const GDScriptParser::SuiteNode::Local &local = first_id->suite->get_local(first);
  532. if (local.type == GDScriptParser::SuiteNode::Local::CONSTANT) {
  533. result = local.get_datatype();
  534. if (!result.is_set()) {
  535. // Don't try to resolve it as the constant can be declared below.
  536. push_error(vformat(R"(Local constant "%s" is not resolved at this point.)", first), first_id);
  537. return bad_type;
  538. }
  539. if (result.is_meta_type) {
  540. type_found = true;
  541. } else if (Ref<Script>(local.constant->initializer->reduced_value).is_valid()) {
  542. Ref<GDScript> gdscript = local.constant->initializer->reduced_value;
  543. if (gdscript.is_valid()) {
  544. Ref<GDScriptParserRef> ref = get_parser_for(gdscript->get_script_path());
  545. if (ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  546. push_error(vformat(R"(Could not parse script from "%s".)", gdscript->get_script_path()), first_id);
  547. return bad_type;
  548. }
  549. result = ref->get_parser()->head->get_datatype();
  550. } else {
  551. result = make_script_meta_type(local.constant->initializer->reduced_value);
  552. }
  553. type_found = true;
  554. } else {
  555. push_error(vformat(R"(Local constant "%s" is not a valid type.)", first), first_id);
  556. return bad_type;
  557. }
  558. } else {
  559. push_error(vformat(R"(Local %s "%s" cannot be used as a type.)", local.get_name(), first), first_id);
  560. return bad_type;
  561. }
  562. }
  563. if (!type_found) {
  564. if (first == SNAME("Variant")) {
  565. if (p_type->type_chain.size() == 2) {
  566. // May be nested enum.
  567. StringName enum_name = p_type->type_chain[1]->name;
  568. StringName qualified_name = String(first) + ENUM_SEPARATOR + String(p_type->type_chain[1]->name);
  569. if (CoreConstants::is_global_enum(qualified_name)) {
  570. result = make_global_enum_type(enum_name, first, true);
  571. return result;
  572. } else {
  573. push_error(vformat(R"(Name "%s" is not a nested type of "Variant".)", enum_name), p_type->type_chain[1]);
  574. return bad_type;
  575. }
  576. } else if (p_type->type_chain.size() > 2) {
  577. push_error(R"(Variant only contains enum types, which do not have nested types.)", p_type->type_chain[2]);
  578. return bad_type;
  579. }
  580. result.kind = GDScriptParser::DataType::VARIANT;
  581. } else if (GDScriptParser::get_builtin_type(first) < Variant::VARIANT_MAX) {
  582. // Built-in types.
  583. if (p_type->type_chain.size() > 1) {
  584. push_error(R"(Built-in types don't contain nested types.)", p_type->type_chain[1]);
  585. return bad_type;
  586. }
  587. result.kind = GDScriptParser::DataType::BUILTIN;
  588. result.builtin_type = GDScriptParser::get_builtin_type(first);
  589. if (result.builtin_type == Variant::ARRAY) {
  590. GDScriptParser::DataType container_type = type_from_metatype(resolve_datatype(p_type->container_type));
  591. if (container_type.kind != GDScriptParser::DataType::VARIANT) {
  592. container_type.is_constant = false;
  593. result.set_container_element_type(container_type);
  594. }
  595. }
  596. } else if (class_exists(first)) {
  597. // Native engine classes.
  598. result.kind = GDScriptParser::DataType::NATIVE;
  599. result.builtin_type = Variant::OBJECT;
  600. result.native_type = first;
  601. } else if (ScriptServer::is_global_class(first)) {
  602. if (parser->script_path == ScriptServer::get_global_class_path(first)) {
  603. result = parser->head->get_datatype();
  604. } else {
  605. String path = ScriptServer::get_global_class_path(first);
  606. String ext = path.get_extension();
  607. if (ext == GDScriptLanguage::get_singleton()->get_extension()) {
  608. Ref<GDScriptParserRef> ref = get_parser_for(path);
  609. if (!ref.is_valid() || ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  610. push_error(vformat(R"(Could not parse global class "%s" from "%s".)", first, ScriptServer::get_global_class_path(first)), p_type);
  611. return bad_type;
  612. }
  613. result = ref->get_parser()->head->get_datatype();
  614. } else {
  615. result = make_script_meta_type(ResourceLoader::load(path, "Script"));
  616. }
  617. }
  618. } else if (ProjectSettings::get_singleton()->has_autoload(first) && ProjectSettings::get_singleton()->get_autoload(first).is_singleton) {
  619. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(first);
  620. Ref<GDScriptParserRef> ref = get_parser_for(autoload.path);
  621. if (ref.is_null()) {
  622. push_error(vformat(R"(The referenced autoload "%s" (from "%s") could not be loaded.)", first, autoload.path), p_type);
  623. return bad_type;
  624. }
  625. if (ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  626. push_error(vformat(R"(Could not parse singleton "%s" from "%s".)", first, autoload.path), p_type);
  627. return bad_type;
  628. }
  629. result = ref->get_parser()->head->get_datatype();
  630. } else if (ClassDB::has_enum(parser->current_class->base_type.native_type, first)) {
  631. // Native enum in current class.
  632. result = make_native_enum_type(first, parser->current_class->base_type.native_type);
  633. } else if (CoreConstants::is_global_enum(first)) {
  634. if (p_type->type_chain.size() > 1) {
  635. push_error(R"(Enums cannot contain nested types.)", p_type->type_chain[1]);
  636. return bad_type;
  637. }
  638. result = make_global_enum_type(first, StringName());
  639. } else {
  640. // Classes in current scope.
  641. List<GDScriptParser::ClassNode *> script_classes;
  642. bool found = false;
  643. get_class_node_current_scope_classes(parser->current_class, &script_classes);
  644. for (GDScriptParser::ClassNode *script_class : script_classes) {
  645. if (found) {
  646. break;
  647. }
  648. if (script_class->identifier && script_class->identifier->name == first) {
  649. result = script_class->get_datatype();
  650. break;
  651. }
  652. if (script_class->members_indices.has(first)) {
  653. resolve_class_member(script_class, first, p_type);
  654. GDScriptParser::ClassNode::Member member = script_class->get_member(first);
  655. switch (member.type) {
  656. case GDScriptParser::ClassNode::Member::CLASS:
  657. result = member.get_datatype();
  658. found = true;
  659. break;
  660. case GDScriptParser::ClassNode::Member::ENUM:
  661. result = member.get_datatype();
  662. found = true;
  663. break;
  664. case GDScriptParser::ClassNode::Member::CONSTANT:
  665. if (member.get_datatype().is_meta_type) {
  666. result = member.get_datatype();
  667. found = true;
  668. break;
  669. } else if (Ref<Script>(member.constant->initializer->reduced_value).is_valid()) {
  670. Ref<GDScript> gdscript = member.constant->initializer->reduced_value;
  671. if (gdscript.is_valid()) {
  672. Ref<GDScriptParserRef> ref = get_parser_for(gdscript->get_script_path());
  673. if (ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  674. push_error(vformat(R"(Could not parse script from "%s".)", gdscript->get_script_path()), p_type);
  675. return bad_type;
  676. }
  677. result = ref->get_parser()->head->get_datatype();
  678. } else {
  679. result = make_script_meta_type(member.constant->initializer->reduced_value);
  680. }
  681. found = true;
  682. break;
  683. }
  684. [[fallthrough]];
  685. default:
  686. push_error(vformat(R"("%s" is a %s but does not contain a type.)", first, member.get_type_name()), p_type);
  687. return bad_type;
  688. }
  689. }
  690. }
  691. }
  692. }
  693. if (!result.is_set()) {
  694. push_error(vformat(R"(Could not find type "%s" in the current scope.)", first), p_type);
  695. return bad_type;
  696. }
  697. if (p_type->type_chain.size() > 1) {
  698. if (result.kind == GDScriptParser::DataType::CLASS) {
  699. for (int i = 1; i < p_type->type_chain.size(); i++) {
  700. GDScriptParser::DataType base = result;
  701. reduce_identifier_from_base(p_type->type_chain[i], &base);
  702. result = p_type->type_chain[i]->get_datatype();
  703. if (!result.is_set()) {
  704. 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]);
  705. return bad_type;
  706. } else if (!result.is_meta_type) {
  707. 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]);
  708. return bad_type;
  709. }
  710. }
  711. } else if (result.kind == GDScriptParser::DataType::NATIVE) {
  712. // Only enums allowed for native.
  713. if (ClassDB::has_enum(result.native_type, p_type->type_chain[1]->name)) {
  714. if (p_type->type_chain.size() > 2) {
  715. push_error(R"(Enums cannot contain nested types.)", p_type->type_chain[2]);
  716. return bad_type;
  717. } else {
  718. result = make_native_enum_type(p_type->type_chain[1]->name, result.native_type);
  719. }
  720. } else {
  721. push_error(vformat(R"(Could not find type "%s" in "%s".)", p_type->type_chain[1]->name, first), p_type->type_chain[1]);
  722. return bad_type;
  723. }
  724. } else {
  725. 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]);
  726. return bad_type;
  727. }
  728. }
  729. if (result.builtin_type != Variant::ARRAY && p_type->container_type != nullptr) {
  730. push_error("Only arrays can specify the collection element type.", p_type);
  731. }
  732. p_type->set_datatype(result);
  733. return result;
  734. }
  735. void GDScriptAnalyzer::resolve_class_member(GDScriptParser::ClassNode *p_class, StringName p_name, const GDScriptParser::Node *p_source) {
  736. ERR_FAIL_COND(!p_class->has_member(p_name));
  737. resolve_class_member(p_class, p_class->members_indices[p_name], p_source);
  738. }
  739. void GDScriptAnalyzer::resolve_class_member(GDScriptParser::ClassNode *p_class, int p_index, const GDScriptParser::Node *p_source) {
  740. ERR_FAIL_INDEX(p_index, p_class->members.size());
  741. GDScriptParser::ClassNode::Member &member = p_class->members.write[p_index];
  742. if (p_source == nullptr && parser->has_class(p_class)) {
  743. p_source = member.get_source_node();
  744. }
  745. if (member.get_datatype().is_resolving()) {
  746. push_error(vformat(R"(Could not resolve member "%s": Cyclic reference.)", member.get_name()), p_source);
  747. return;
  748. }
  749. if (member.get_datatype().is_set()) {
  750. return;
  751. }
  752. if (!parser->has_class(p_class)) {
  753. String script_path = p_class->get_datatype().script_path;
  754. Ref<GDScriptParserRef> parser_ref = get_parser_for(script_path);
  755. if (parser_ref.is_null()) {
  756. push_error(vformat(R"(Could not find script "%s" (While resolving "%s").)", script_path, member.get_name()), p_source);
  757. return;
  758. }
  759. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  760. if (err) {
  761. push_error(vformat(R"(Could not resolve script "%s": %s (While resolving "%s").)", script_path, error_names[err], member.get_name()), p_source);
  762. return;
  763. }
  764. ERR_FAIL_COND_MSG(!parser_ref->get_parser()->has_class(p_class), R"(Parser bug: Mismatched external parser.)");
  765. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  766. GDScriptParser *other_parser = parser_ref->get_parser();
  767. int error_count = other_parser->errors.size();
  768. other_analyzer->resolve_class_member(p_class, p_index);
  769. if (other_parser->errors.size() > error_count) {
  770. push_error(vformat(R"(Could not resolve member "%s".)", member.get_name()), p_source);
  771. }
  772. return;
  773. }
  774. // If it's already resolving, that's ok.
  775. if (!p_class->base_type.is_resolving()) {
  776. Error err = resolve_class_inheritance(p_class);
  777. if (err) {
  778. return;
  779. }
  780. }
  781. GDScriptParser::ClassNode *previous_class = parser->current_class;
  782. parser->current_class = p_class;
  783. GDScriptParser::DataType resolving_datatype;
  784. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  785. {
  786. #ifdef DEBUG_ENABLED
  787. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  788. GDScriptParser::Node *member_node = member.get_source_node();
  789. if (member_node && member_node->type != GDScriptParser::Node::ANNOTATION) {
  790. // Apply @warning_ignore annotations before resolving member.
  791. for (GDScriptParser::AnnotationNode *&E : member_node->annotations) {
  792. if (E->name == SNAME("@warning_ignore")) {
  793. resolve_annotation(E);
  794. E->apply(parser, member.variable);
  795. }
  796. }
  797. for (GDScriptWarning::Code ignored_warning : member_node->ignored_warnings) {
  798. parser->ignored_warnings.insert(ignored_warning);
  799. }
  800. }
  801. #endif
  802. switch (member.type) {
  803. case GDScriptParser::ClassNode::Member::VARIABLE: {
  804. bool previous_static_context = static_context;
  805. static_context = member.variable->is_static;
  806. check_class_member_name_conflict(p_class, member.variable->identifier->name, member.variable);
  807. member.variable->set_datatype(resolving_datatype);
  808. resolve_variable(member.variable, false);
  809. resolve_pending_lambda_bodies();
  810. // Apply annotations.
  811. for (GDScriptParser::AnnotationNode *&E : member.variable->annotations) {
  812. if (E->name != SNAME("@warning_ignore")) {
  813. resolve_annotation(E);
  814. E->apply(parser, member.variable);
  815. }
  816. }
  817. static_context = previous_static_context;
  818. #ifdef DEBUG_ENABLED
  819. if (member.variable->exported && member.variable->onready) {
  820. parser->push_warning(member.variable, GDScriptWarning::ONREADY_WITH_EXPORT);
  821. }
  822. if (member.variable->initializer) {
  823. // Check if it is call to get_node() on self (using shorthand $ or not), so we can check if @onready is needed.
  824. // This could be improved by traversing the expression fully and checking the presence of get_node at any level.
  825. if (!member.variable->is_static && !member.variable->onready && member.variable->initializer && (member.variable->initializer->type == GDScriptParser::Node::GET_NODE || member.variable->initializer->type == GDScriptParser::Node::CALL || member.variable->initializer->type == GDScriptParser::Node::CAST)) {
  826. GDScriptParser::Node *expr = member.variable->initializer;
  827. if (expr->type == GDScriptParser::Node::CAST) {
  828. expr = static_cast<GDScriptParser::CastNode *>(expr)->operand;
  829. }
  830. bool is_get_node = expr->type == GDScriptParser::Node::GET_NODE;
  831. bool is_using_shorthand = is_get_node;
  832. if (!is_get_node && expr->type == GDScriptParser::Node::CALL) {
  833. is_using_shorthand = false;
  834. GDScriptParser::CallNode *call = static_cast<GDScriptParser::CallNode *>(expr);
  835. if (call->function_name == SNAME("get_node")) {
  836. switch (call->get_callee_type()) {
  837. case GDScriptParser::Node::IDENTIFIER: {
  838. is_get_node = true;
  839. } break;
  840. case GDScriptParser::Node::SUBSCRIPT: {
  841. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(call->callee);
  842. is_get_node = subscript->is_attribute && subscript->base->type == GDScriptParser::Node::SELF;
  843. } break;
  844. default:
  845. break;
  846. }
  847. }
  848. }
  849. if (is_get_node) {
  850. parser->push_warning(member.variable, GDScriptWarning::GET_NODE_DEFAULT_WITHOUT_ONREADY, is_using_shorthand ? "$" : "get_node()");
  851. }
  852. }
  853. }
  854. #endif
  855. } break;
  856. case GDScriptParser::ClassNode::Member::CONSTANT: {
  857. check_class_member_name_conflict(p_class, member.constant->identifier->name, member.constant);
  858. member.constant->set_datatype(resolving_datatype);
  859. resolve_constant(member.constant, false);
  860. // Apply annotations.
  861. for (GDScriptParser::AnnotationNode *&E : member.constant->annotations) {
  862. resolve_annotation(E);
  863. E->apply(parser, member.constant);
  864. }
  865. } break;
  866. case GDScriptParser::ClassNode::Member::SIGNAL: {
  867. check_class_member_name_conflict(p_class, member.signal->identifier->name, member.signal);
  868. member.signal->set_datatype(resolving_datatype);
  869. // This is the _only_ way to declare a signal. Therefore, we can generate its
  870. // MethodInfo inline so it's a tiny bit more efficient.
  871. MethodInfo mi = MethodInfo(member.signal->identifier->name);
  872. for (int j = 0; j < member.signal->parameters.size(); j++) {
  873. GDScriptParser::ParameterNode *param = member.signal->parameters[j];
  874. GDScriptParser::DataType param_type = type_from_metatype(resolve_datatype(param->datatype_specifier));
  875. param->set_datatype(param_type);
  876. #ifdef DEBUG_ENABLED
  877. if (param->datatype_specifier == nullptr) {
  878. parser->push_warning(param, GDScriptWarning::UNTYPED_DECLARATION, "Parameter", param->identifier->name);
  879. }
  880. #endif
  881. mi.arguments.push_back(param_type.to_property_info(param->identifier->name));
  882. // Signals do not support parameter default values.
  883. }
  884. member.signal->set_datatype(make_signal_type(mi));
  885. member.signal->method_info = mi;
  886. // Apply annotations.
  887. for (GDScriptParser::AnnotationNode *&E : member.signal->annotations) {
  888. resolve_annotation(E);
  889. E->apply(parser, member.signal);
  890. }
  891. } break;
  892. case GDScriptParser::ClassNode::Member::ENUM: {
  893. check_class_member_name_conflict(p_class, member.m_enum->identifier->name, member.m_enum);
  894. member.m_enum->set_datatype(resolving_datatype);
  895. GDScriptParser::DataType enum_type = make_enum_type(member.m_enum->identifier->name, p_class->fqcn, true);
  896. const GDScriptParser::EnumNode *prev_enum = current_enum;
  897. current_enum = member.m_enum;
  898. Dictionary dictionary;
  899. for (int j = 0; j < member.m_enum->values.size(); j++) {
  900. GDScriptParser::EnumNode::Value &element = member.m_enum->values.write[j];
  901. if (element.custom_value) {
  902. reduce_expression(element.custom_value);
  903. if (!element.custom_value->is_constant) {
  904. push_error(R"(Enum values must be constant.)", element.custom_value);
  905. } else if (element.custom_value->reduced_value.get_type() != Variant::INT) {
  906. push_error(R"(Enum values must be integers.)", element.custom_value);
  907. } else {
  908. element.value = element.custom_value->reduced_value;
  909. element.resolved = true;
  910. }
  911. } else {
  912. if (element.index > 0) {
  913. element.value = element.parent_enum->values[element.index - 1].value + 1;
  914. } else {
  915. element.value = 0;
  916. }
  917. element.resolved = true;
  918. }
  919. enum_type.enum_values[element.identifier->name] = element.value;
  920. dictionary[String(element.identifier->name)] = element.value;
  921. }
  922. current_enum = prev_enum;
  923. dictionary.make_read_only();
  924. member.m_enum->set_datatype(enum_type);
  925. member.m_enum->dictionary = dictionary;
  926. // Apply annotations.
  927. for (GDScriptParser::AnnotationNode *&E : member.m_enum->annotations) {
  928. resolve_annotation(E);
  929. E->apply(parser, member.m_enum);
  930. }
  931. } break;
  932. case GDScriptParser::ClassNode::Member::FUNCTION:
  933. for (GDScriptParser::AnnotationNode *&E : member.function->annotations) {
  934. resolve_annotation(E);
  935. E->apply(parser, member.function);
  936. }
  937. resolve_function_signature(member.function, p_source);
  938. break;
  939. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  940. member.enum_value.identifier->set_datatype(resolving_datatype);
  941. if (member.enum_value.custom_value) {
  942. check_class_member_name_conflict(p_class, member.enum_value.identifier->name, member.enum_value.custom_value);
  943. const GDScriptParser::EnumNode *prev_enum = current_enum;
  944. current_enum = member.enum_value.parent_enum;
  945. reduce_expression(member.enum_value.custom_value);
  946. current_enum = prev_enum;
  947. if (!member.enum_value.custom_value->is_constant) {
  948. push_error(R"(Enum values must be constant.)", member.enum_value.custom_value);
  949. } else if (member.enum_value.custom_value->reduced_value.get_type() != Variant::INT) {
  950. push_error(R"(Enum values must be integers.)", member.enum_value.custom_value);
  951. } else {
  952. member.enum_value.value = member.enum_value.custom_value->reduced_value;
  953. member.enum_value.resolved = true;
  954. }
  955. } else {
  956. check_class_member_name_conflict(p_class, member.enum_value.identifier->name, member.enum_value.parent_enum);
  957. if (member.enum_value.index > 0) {
  958. const GDScriptParser::EnumNode::Value &prev_value = member.enum_value.parent_enum->values[member.enum_value.index - 1];
  959. resolve_class_member(p_class, prev_value.identifier->name, member.enum_value.identifier);
  960. member.enum_value.value = prev_value.value + 1;
  961. } else {
  962. member.enum_value.value = 0;
  963. }
  964. member.enum_value.resolved = true;
  965. }
  966. // Also update the original references.
  967. member.enum_value.parent_enum->values.set(member.enum_value.index, member.enum_value);
  968. member.enum_value.identifier->set_datatype(make_enum_type(UNNAMED_ENUM, p_class->fqcn, false));
  969. } break;
  970. case GDScriptParser::ClassNode::Member::CLASS:
  971. check_class_member_name_conflict(p_class, member.m_class->identifier->name, member.m_class);
  972. // If it's already resolving, that's ok.
  973. if (!member.m_class->base_type.is_resolving()) {
  974. resolve_class_inheritance(member.m_class, p_source);
  975. }
  976. break;
  977. case GDScriptParser::ClassNode::Member::GROUP:
  978. // No-op, but needed to silence warnings.
  979. break;
  980. case GDScriptParser::ClassNode::Member::UNDEFINED:
  981. ERR_PRINT("Trying to resolve undefined member.");
  982. break;
  983. }
  984. #ifdef DEBUG_ENABLED
  985. parser->ignored_warnings = previously_ignored_warnings;
  986. #endif
  987. }
  988. parser->current_class = previous_class;
  989. }
  990. void GDScriptAnalyzer::resolve_class_interface(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source) {
  991. if (p_source == nullptr && parser->has_class(p_class)) {
  992. p_source = p_class;
  993. }
  994. #ifdef DEBUG_ENABLED
  995. bool has_static_data = p_class->has_static_data;
  996. #endif
  997. if (!p_class->resolved_interface) {
  998. if (!parser->has_class(p_class)) {
  999. String script_path = p_class->get_datatype().script_path;
  1000. Ref<GDScriptParserRef> parser_ref = get_parser_for(script_path);
  1001. if (parser_ref.is_null()) {
  1002. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  1003. return;
  1004. }
  1005. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  1006. if (err) {
  1007. push_error(vformat(R"(Could not resolve script "%s": %s.)", script_path, error_names[err]), p_source);
  1008. return;
  1009. }
  1010. ERR_FAIL_COND_MSG(!parser_ref->get_parser()->has_class(p_class), R"(Parser bug: Mismatched external parser.)");
  1011. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  1012. GDScriptParser *other_parser = parser_ref->get_parser();
  1013. int error_count = other_parser->errors.size();
  1014. other_analyzer->resolve_class_interface(p_class);
  1015. if (other_parser->errors.size() > error_count) {
  1016. push_error(vformat(R"(Could not resolve class "%s".)", p_class->fqcn), p_source);
  1017. }
  1018. return;
  1019. }
  1020. p_class->resolved_interface = true;
  1021. if (resolve_class_inheritance(p_class) != OK) {
  1022. return;
  1023. }
  1024. GDScriptParser::DataType base_type = p_class->base_type;
  1025. if (base_type.kind == GDScriptParser::DataType::CLASS) {
  1026. GDScriptParser::ClassNode *base_class = base_type.class_type;
  1027. resolve_class_interface(base_class, p_class);
  1028. }
  1029. for (int i = 0; i < p_class->members.size(); i++) {
  1030. resolve_class_member(p_class, i);
  1031. #ifdef DEBUG_ENABLED
  1032. if (!has_static_data) {
  1033. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1034. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  1035. has_static_data = member.m_class->has_static_data;
  1036. }
  1037. }
  1038. #endif
  1039. }
  1040. #ifdef DEBUG_ENABLED
  1041. if (!has_static_data && p_class->annotated_static_unload) {
  1042. GDScriptParser::Node *static_unload = nullptr;
  1043. for (GDScriptParser::AnnotationNode *node : p_class->annotations) {
  1044. if (node->name == "@static_unload") {
  1045. static_unload = node;
  1046. break;
  1047. }
  1048. }
  1049. parser->push_warning(static_unload ? static_unload : p_class, GDScriptWarning::REDUNDANT_STATIC_UNLOAD);
  1050. }
  1051. #endif
  1052. }
  1053. }
  1054. void GDScriptAnalyzer::resolve_class_interface(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  1055. resolve_class_interface(p_class);
  1056. if (p_recursive) {
  1057. for (int i = 0; i < p_class->members.size(); i++) {
  1058. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1059. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  1060. resolve_class_interface(member.m_class, true);
  1061. }
  1062. }
  1063. }
  1064. }
  1065. void GDScriptAnalyzer::resolve_class_body(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source) {
  1066. if (p_source == nullptr && parser->has_class(p_class)) {
  1067. p_source = p_class;
  1068. }
  1069. if (p_class->resolved_body) {
  1070. return;
  1071. }
  1072. if (!parser->has_class(p_class)) {
  1073. String script_path = p_class->get_datatype().script_path;
  1074. Ref<GDScriptParserRef> parser_ref = get_parser_for(script_path);
  1075. if (parser_ref.is_null()) {
  1076. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  1077. return;
  1078. }
  1079. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  1080. if (err) {
  1081. push_error(vformat(R"(Could not resolve script "%s": %s.)", script_path, error_names[err]), p_source);
  1082. return;
  1083. }
  1084. ERR_FAIL_COND_MSG(!parser_ref->get_parser()->has_class(p_class), R"(Parser bug: Mismatched external parser.)");
  1085. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  1086. GDScriptParser *other_parser = parser_ref->get_parser();
  1087. int error_count = other_parser->errors.size();
  1088. other_analyzer->resolve_class_body(p_class);
  1089. if (other_parser->errors.size() > error_count) {
  1090. push_error(vformat(R"(Could not resolve class "%s".)", p_class->fqcn), p_source);
  1091. }
  1092. return;
  1093. }
  1094. p_class->resolved_body = true;
  1095. GDScriptParser::ClassNode *previous_class = parser->current_class;
  1096. parser->current_class = p_class;
  1097. resolve_class_interface(p_class, p_source);
  1098. GDScriptParser::DataType base_type = p_class->base_type;
  1099. if (base_type.kind == GDScriptParser::DataType::CLASS) {
  1100. GDScriptParser::ClassNode *base_class = base_type.class_type;
  1101. resolve_class_body(base_class, p_class);
  1102. }
  1103. // Do functions, properties, and groups now.
  1104. for (int i = 0; i < p_class->members.size(); i++) {
  1105. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1106. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION) {
  1107. // Apply annotations.
  1108. for (GDScriptParser::AnnotationNode *&E : member.function->annotations) {
  1109. resolve_annotation(E);
  1110. E->apply(parser, member.function);
  1111. }
  1112. resolve_function_body(member.function);
  1113. } else if (member.type == GDScriptParser::ClassNode::Member::VARIABLE && member.variable->property != GDScriptParser::VariableNode::PROP_NONE) {
  1114. if (member.variable->property == GDScriptParser::VariableNode::PROP_INLINE) {
  1115. if (member.variable->getter != nullptr) {
  1116. member.variable->getter->return_type = member.variable->datatype_specifier;
  1117. member.variable->getter->set_datatype(member.get_datatype());
  1118. resolve_function_body(member.variable->getter);
  1119. }
  1120. if (member.variable->setter != nullptr) {
  1121. ERR_CONTINUE(member.variable->setter->parameters.is_empty());
  1122. member.variable->setter->parameters[0]->datatype_specifier = member.variable->datatype_specifier;
  1123. member.variable->setter->parameters[0]->set_datatype(member.get_datatype());
  1124. resolve_function_body(member.variable->setter);
  1125. }
  1126. }
  1127. } else if (member.type == GDScriptParser::ClassNode::Member::GROUP) {
  1128. // Apply annotation (`@export_{category,group,subgroup}`).
  1129. resolve_annotation(member.annotation);
  1130. member.annotation->apply(parser, nullptr);
  1131. }
  1132. }
  1133. // Check unused variables and datatypes of property getters and setters.
  1134. for (int i = 0; i < p_class->members.size(); i++) {
  1135. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1136. if (member.type == GDScriptParser::ClassNode::Member::VARIABLE) {
  1137. #ifdef DEBUG_ENABLED
  1138. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  1139. for (GDScriptWarning::Code ignored_warning : member.variable->ignored_warnings) {
  1140. parser->ignored_warnings.insert(ignored_warning);
  1141. }
  1142. if (member.variable->usages == 0 && String(member.variable->identifier->name).begins_with("_")) {
  1143. parser->push_warning(member.variable->identifier, GDScriptWarning::UNUSED_PRIVATE_CLASS_VARIABLE, member.variable->identifier->name);
  1144. }
  1145. #endif
  1146. if (member.variable->property == GDScriptParser::VariableNode::PROP_SETGET) {
  1147. GDScriptParser::FunctionNode *getter_function = nullptr;
  1148. GDScriptParser::FunctionNode *setter_function = nullptr;
  1149. bool has_valid_getter = false;
  1150. bool has_valid_setter = false;
  1151. if (member.variable->getter_pointer != nullptr) {
  1152. if (p_class->has_function(member.variable->getter_pointer->name)) {
  1153. getter_function = p_class->get_member(member.variable->getter_pointer->name).function;
  1154. }
  1155. if (getter_function == nullptr) {
  1156. push_error(vformat(R"(Getter "%s" not found.)", member.variable->getter_pointer->name), member.variable);
  1157. } else {
  1158. GDScriptParser::DataType return_datatype = getter_function->datatype;
  1159. if (getter_function->return_type != nullptr) {
  1160. return_datatype = getter_function->return_type->datatype;
  1161. return_datatype.is_meta_type = false;
  1162. }
  1163. if (getter_function->parameters.size() != 0 || return_datatype.has_no_type()) {
  1164. push_error(vformat(R"(Function "%s" cannot be used as getter because of its signature.)", getter_function->identifier->name), member.variable);
  1165. } else if (!is_type_compatible(member.variable->datatype, return_datatype, true)) {
  1166. push_error(vformat(R"(Function with return type "%s" cannot be used as getter for a property of type "%s".)", return_datatype.to_string(), member.variable->datatype.to_string()), member.variable);
  1167. } else {
  1168. has_valid_getter = true;
  1169. #ifdef DEBUG_ENABLED
  1170. if (member.variable->datatype.builtin_type == Variant::INT && return_datatype.builtin_type == Variant::FLOAT) {
  1171. parser->push_warning(member.variable, GDScriptWarning::NARROWING_CONVERSION);
  1172. }
  1173. #endif
  1174. }
  1175. }
  1176. }
  1177. if (member.variable->setter_pointer != nullptr) {
  1178. if (p_class->has_function(member.variable->setter_pointer->name)) {
  1179. setter_function = p_class->get_member(member.variable->setter_pointer->name).function;
  1180. }
  1181. if (setter_function == nullptr) {
  1182. push_error(vformat(R"(Setter "%s" not found.)", member.variable->setter_pointer->name), member.variable);
  1183. } else if (setter_function->parameters.size() != 1) {
  1184. push_error(vformat(R"(Function "%s" cannot be used as setter because of its signature.)", setter_function->identifier->name), member.variable);
  1185. } else if (!is_type_compatible(member.variable->datatype, setter_function->parameters[0]->datatype, true)) {
  1186. push_error(vformat(R"(Function with argument type "%s" cannot be used as setter for a property of type "%s".)", setter_function->parameters[0]->datatype.to_string(), member.variable->datatype.to_string()), member.variable);
  1187. } else {
  1188. has_valid_setter = true;
  1189. #ifdef DEBUG_ENABLED
  1190. if (member.variable->datatype.builtin_type == Variant::FLOAT && setter_function->parameters[0]->datatype.builtin_type == Variant::INT) {
  1191. parser->push_warning(member.variable, GDScriptWarning::NARROWING_CONVERSION);
  1192. }
  1193. #endif
  1194. }
  1195. }
  1196. if (member.variable->datatype.is_variant() && has_valid_getter && has_valid_setter) {
  1197. if (!is_type_compatible(getter_function->datatype, setter_function->parameters[0]->datatype, true)) {
  1198. push_error(vformat(R"(Getter with type "%s" cannot be used along with setter of type "%s".)", getter_function->datatype.to_string(), setter_function->parameters[0]->datatype.to_string()), member.variable);
  1199. }
  1200. }
  1201. }
  1202. #ifdef DEBUG_ENABLED
  1203. parser->ignored_warnings = previously_ignored_warnings;
  1204. #endif // DEBUG_ENABLED
  1205. }
  1206. }
  1207. if (!pending_body_resolution_lambdas.is_empty()) {
  1208. ERR_PRINT("GDScript bug (please report): Not all pending lambda bodies were resolved in time.");
  1209. resolve_pending_lambda_bodies();
  1210. }
  1211. parser->current_class = previous_class;
  1212. }
  1213. void GDScriptAnalyzer::resolve_class_body(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  1214. resolve_class_body(p_class);
  1215. if (p_recursive) {
  1216. for (int i = 0; i < p_class->members.size(); i++) {
  1217. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1218. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  1219. resolve_class_body(member.m_class, true);
  1220. }
  1221. }
  1222. }
  1223. }
  1224. void GDScriptAnalyzer::resolve_node(GDScriptParser::Node *p_node, bool p_is_root) {
  1225. ERR_FAIL_NULL_MSG(p_node, "Trying to resolve type of a null node.");
  1226. switch (p_node->type) {
  1227. case GDScriptParser::Node::NONE:
  1228. break; // Unreachable.
  1229. case GDScriptParser::Node::CLASS:
  1230. if (OK == resolve_class_inheritance(static_cast<GDScriptParser::ClassNode *>(p_node), true)) {
  1231. resolve_class_interface(static_cast<GDScriptParser::ClassNode *>(p_node), true);
  1232. resolve_class_body(static_cast<GDScriptParser::ClassNode *>(p_node), true);
  1233. }
  1234. break;
  1235. case GDScriptParser::Node::CONSTANT:
  1236. resolve_constant(static_cast<GDScriptParser::ConstantNode *>(p_node), true);
  1237. break;
  1238. case GDScriptParser::Node::FOR:
  1239. resolve_for(static_cast<GDScriptParser::ForNode *>(p_node));
  1240. break;
  1241. case GDScriptParser::Node::IF:
  1242. resolve_if(static_cast<GDScriptParser::IfNode *>(p_node));
  1243. break;
  1244. case GDScriptParser::Node::SUITE:
  1245. resolve_suite(static_cast<GDScriptParser::SuiteNode *>(p_node));
  1246. break;
  1247. case GDScriptParser::Node::VARIABLE:
  1248. resolve_variable(static_cast<GDScriptParser::VariableNode *>(p_node), true);
  1249. break;
  1250. case GDScriptParser::Node::WHILE:
  1251. resolve_while(static_cast<GDScriptParser::WhileNode *>(p_node));
  1252. break;
  1253. case GDScriptParser::Node::ANNOTATION:
  1254. resolve_annotation(static_cast<GDScriptParser::AnnotationNode *>(p_node));
  1255. break;
  1256. case GDScriptParser::Node::ASSERT:
  1257. resolve_assert(static_cast<GDScriptParser::AssertNode *>(p_node));
  1258. break;
  1259. case GDScriptParser::Node::MATCH:
  1260. resolve_match(static_cast<GDScriptParser::MatchNode *>(p_node));
  1261. break;
  1262. case GDScriptParser::Node::MATCH_BRANCH:
  1263. resolve_match_branch(static_cast<GDScriptParser::MatchBranchNode *>(p_node), nullptr);
  1264. break;
  1265. case GDScriptParser::Node::PARAMETER:
  1266. resolve_parameter(static_cast<GDScriptParser::ParameterNode *>(p_node));
  1267. break;
  1268. case GDScriptParser::Node::PATTERN:
  1269. resolve_match_pattern(static_cast<GDScriptParser::PatternNode *>(p_node), nullptr);
  1270. break;
  1271. case GDScriptParser::Node::RETURN:
  1272. resolve_return(static_cast<GDScriptParser::ReturnNode *>(p_node));
  1273. break;
  1274. case GDScriptParser::Node::TYPE:
  1275. resolve_datatype(static_cast<GDScriptParser::TypeNode *>(p_node));
  1276. break;
  1277. // Resolving expression is the same as reducing them.
  1278. case GDScriptParser::Node::ARRAY:
  1279. case GDScriptParser::Node::ASSIGNMENT:
  1280. case GDScriptParser::Node::AWAIT:
  1281. case GDScriptParser::Node::BINARY_OPERATOR:
  1282. case GDScriptParser::Node::CALL:
  1283. case GDScriptParser::Node::CAST:
  1284. case GDScriptParser::Node::DICTIONARY:
  1285. case GDScriptParser::Node::GET_NODE:
  1286. case GDScriptParser::Node::IDENTIFIER:
  1287. case GDScriptParser::Node::LAMBDA:
  1288. case GDScriptParser::Node::LITERAL:
  1289. case GDScriptParser::Node::PRELOAD:
  1290. case GDScriptParser::Node::SELF:
  1291. case GDScriptParser::Node::SUBSCRIPT:
  1292. case GDScriptParser::Node::TERNARY_OPERATOR:
  1293. case GDScriptParser::Node::TYPE_TEST:
  1294. case GDScriptParser::Node::UNARY_OPERATOR:
  1295. reduce_expression(static_cast<GDScriptParser::ExpressionNode *>(p_node), p_is_root);
  1296. break;
  1297. case GDScriptParser::Node::BREAK:
  1298. case GDScriptParser::Node::BREAKPOINT:
  1299. case GDScriptParser::Node::CONTINUE:
  1300. case GDScriptParser::Node::ENUM:
  1301. case GDScriptParser::Node::FUNCTION:
  1302. case GDScriptParser::Node::PASS:
  1303. case GDScriptParser::Node::SIGNAL:
  1304. // Nothing to do.
  1305. break;
  1306. }
  1307. }
  1308. void GDScriptAnalyzer::resolve_annotation(GDScriptParser::AnnotationNode *p_annotation) {
  1309. ERR_FAIL_COND_MSG(!parser->valid_annotations.has(p_annotation->name), vformat(R"(Annotation "%s" not found to validate.)", p_annotation->name));
  1310. if (p_annotation->is_resolved) {
  1311. return;
  1312. }
  1313. p_annotation->is_resolved = true;
  1314. const MethodInfo &annotation_info = parser->valid_annotations[p_annotation->name].info;
  1315. const List<PropertyInfo>::Element *E = annotation_info.arguments.front();
  1316. for (int i = 0; i < p_annotation->arguments.size(); i++) {
  1317. GDScriptParser::ExpressionNode *argument = p_annotation->arguments[i];
  1318. const PropertyInfo &argument_info = E->get();
  1319. if (E->next() != nullptr) {
  1320. E = E->next();
  1321. }
  1322. reduce_expression(argument);
  1323. if (!argument->is_constant) {
  1324. push_error(vformat(R"(Argument %d of annotation "%s" isn't a constant expression.)", i + 1, p_annotation->name), argument);
  1325. return;
  1326. }
  1327. Variant value = argument->reduced_value;
  1328. if (value.get_type() != argument_info.type) {
  1329. #ifdef DEBUG_ENABLED
  1330. if (argument_info.type == Variant::INT && value.get_type() == Variant::FLOAT) {
  1331. parser->push_warning(argument, GDScriptWarning::NARROWING_CONVERSION);
  1332. }
  1333. #endif
  1334. if (!Variant::can_convert_strict(value.get_type(), argument_info.type)) {
  1335. push_error(vformat(R"(Invalid argument for annotation "%s": argument %d should be "%s" but is "%s".)", p_annotation->name, i + 1, Variant::get_type_name(argument_info.type), argument->get_datatype().to_string()), argument);
  1336. return;
  1337. }
  1338. Variant converted_to;
  1339. const Variant *converted_from = &value;
  1340. Callable::CallError call_error;
  1341. Variant::construct(argument_info.type, converted_to, &converted_from, 1, call_error);
  1342. if (call_error.error != Callable::CallError::CALL_OK) {
  1343. push_error(vformat(R"(Cannot convert argument %d of annotation "%s" from "%s" to "%s".)", i + 1, p_annotation->name, Variant::get_type_name(value.get_type()), Variant::get_type_name(argument_info.type)), argument);
  1344. return;
  1345. }
  1346. value = converted_to;
  1347. }
  1348. p_annotation->resolved_arguments.push_back(value);
  1349. }
  1350. }
  1351. void GDScriptAnalyzer::resolve_function_signature(GDScriptParser::FunctionNode *p_function, const GDScriptParser::Node *p_source, bool p_is_lambda) {
  1352. if (p_source == nullptr) {
  1353. p_source = p_function;
  1354. }
  1355. StringName function_name = p_function->identifier != nullptr ? p_function->identifier->name : StringName();
  1356. if (p_function->get_datatype().is_resolving()) {
  1357. push_error(vformat(R"(Could not resolve function "%s": Cyclic reference.)", function_name), p_source);
  1358. return;
  1359. }
  1360. if (p_function->resolved_signature) {
  1361. return;
  1362. }
  1363. p_function->resolved_signature = true;
  1364. #ifdef DEBUG_ENABLED
  1365. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  1366. for (GDScriptWarning::Code ignored_warning : p_function->ignored_warnings) {
  1367. parser->ignored_warnings.insert(ignored_warning);
  1368. }
  1369. #endif
  1370. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  1371. parser->current_function = p_function;
  1372. bool previous_static_context = static_context;
  1373. static_context = p_function->is_static;
  1374. GDScriptParser::DataType prev_datatype = p_function->get_datatype();
  1375. GDScriptParser::DataType resolving_datatype;
  1376. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  1377. p_function->set_datatype(resolving_datatype);
  1378. #ifdef TOOLS_ENABLED
  1379. int default_value_count = 0;
  1380. #endif // TOOLS_ENABLED
  1381. #ifdef DEBUG_ENABLED
  1382. String function_visible_name = function_name;
  1383. if (function_name == StringName()) {
  1384. function_visible_name = p_is_lambda ? "<anonymous lambda>" : "<unknown function>";
  1385. }
  1386. #endif
  1387. for (int i = 0; i < p_function->parameters.size(); i++) {
  1388. resolve_parameter(p_function->parameters[i]);
  1389. #ifdef DEBUG_ENABLED
  1390. if (p_function->parameters[i]->usages == 0 && !String(p_function->parameters[i]->identifier->name).begins_with("_")) {
  1391. parser->push_warning(p_function->parameters[i]->identifier, GDScriptWarning::UNUSED_PARAMETER, function_visible_name, p_function->parameters[i]->identifier->name);
  1392. }
  1393. is_shadowing(p_function->parameters[i]->identifier, "function parameter", true);
  1394. #endif // DEBUG_ENABLED
  1395. if (p_function->parameters[i]->initializer) {
  1396. #ifdef TOOLS_ENABLED
  1397. default_value_count++;
  1398. #endif // TOOLS_ENABLED
  1399. if (p_function->parameters[i]->initializer->is_constant) {
  1400. p_function->default_arg_values.push_back(p_function->parameters[i]->initializer->reduced_value);
  1401. } else {
  1402. p_function->default_arg_values.push_back(Variant()); // Prevent shift.
  1403. }
  1404. }
  1405. }
  1406. if (!p_is_lambda && function_name == GDScriptLanguage::get_singleton()->strings._init) {
  1407. // Constructor.
  1408. GDScriptParser::DataType return_type = parser->current_class->get_datatype();
  1409. return_type.is_meta_type = false;
  1410. p_function->set_datatype(return_type);
  1411. if (p_function->return_type) {
  1412. GDScriptParser::DataType declared_return = resolve_datatype(p_function->return_type);
  1413. if (declared_return.kind != GDScriptParser::DataType::BUILTIN || declared_return.builtin_type != Variant::NIL) {
  1414. push_error("Constructor cannot have an explicit return type.", p_function->return_type);
  1415. }
  1416. }
  1417. } else if (!p_is_lambda && function_name == GDScriptLanguage::get_singleton()->strings._static_init) {
  1418. // Static constructor.
  1419. GDScriptParser::DataType return_type;
  1420. return_type.kind = GDScriptParser::DataType::BUILTIN;
  1421. return_type.builtin_type = Variant::NIL;
  1422. p_function->set_datatype(return_type);
  1423. if (p_function->return_type) {
  1424. GDScriptParser::DataType declared_return = resolve_datatype(p_function->return_type);
  1425. if (declared_return.kind != GDScriptParser::DataType::BUILTIN || declared_return.builtin_type != Variant::NIL) {
  1426. push_error("Static constructor cannot have an explicit return type.", p_function->return_type);
  1427. }
  1428. }
  1429. } else {
  1430. if (p_function->return_type != nullptr) {
  1431. p_function->set_datatype(type_from_metatype(resolve_datatype(p_function->return_type)));
  1432. } else {
  1433. // In case the function is not typed, we can safely assume it's a Variant, so it's okay to mark as "inferred" here.
  1434. // It's not "undetected" to not mix up with unknown functions.
  1435. GDScriptParser::DataType return_type;
  1436. return_type.type_source = GDScriptParser::DataType::INFERRED;
  1437. return_type.kind = GDScriptParser::DataType::VARIANT;
  1438. p_function->set_datatype(return_type);
  1439. }
  1440. #ifdef TOOLS_ENABLED
  1441. // Check if the function signature matches the parent. If not it's an error since it breaks polymorphism.
  1442. // Not for the constructor which can vary in signature.
  1443. GDScriptParser::DataType base_type = parser->current_class->base_type;
  1444. base_type.is_meta_type = false;
  1445. GDScriptParser::DataType parent_return_type;
  1446. List<GDScriptParser::DataType> parameters_types;
  1447. int default_par_count = 0;
  1448. BitField<MethodFlags> method_flags;
  1449. StringName native_base;
  1450. if (!p_is_lambda && get_function_signature(p_function, false, base_type, function_name, parent_return_type, parameters_types, default_par_count, method_flags, &native_base)) {
  1451. bool valid = p_function->is_static == method_flags.has_flag(METHOD_FLAG_STATIC);
  1452. valid = valid && parent_return_type == p_function->get_datatype();
  1453. int par_count_diff = p_function->parameters.size() - parameters_types.size();
  1454. valid = valid && par_count_diff >= 0;
  1455. valid = valid && default_value_count >= default_par_count + par_count_diff;
  1456. int i = 0;
  1457. for (const GDScriptParser::DataType &par_type : parameters_types) {
  1458. valid = valid && par_type == p_function->parameters[i++]->get_datatype();
  1459. }
  1460. if (!valid) {
  1461. // Compute parent signature as a string to show in the error message.
  1462. String parent_signature = String(function_name) + "(";
  1463. int j = 0;
  1464. for (const GDScriptParser::DataType &par_type : parameters_types) {
  1465. if (j > 0) {
  1466. parent_signature += ", ";
  1467. }
  1468. String parameter = par_type.to_string();
  1469. if (parameter == "null") {
  1470. parameter = "Variant";
  1471. }
  1472. parent_signature += parameter;
  1473. if (j >= parameters_types.size() - default_par_count) {
  1474. parent_signature += " = <default>";
  1475. }
  1476. j++;
  1477. }
  1478. parent_signature += ") -> ";
  1479. const String return_type = parent_return_type.to_string_strict();
  1480. if (return_type == "null") {
  1481. parent_signature += "void";
  1482. } else {
  1483. parent_signature += return_type;
  1484. }
  1485. push_error(vformat(R"(The function signature doesn't match the parent. Parent signature is "%s".)", parent_signature), p_function);
  1486. }
  1487. #ifdef DEBUG_ENABLED
  1488. if (native_base != StringName()) {
  1489. parser->push_warning(p_function, GDScriptWarning::NATIVE_METHOD_OVERRIDE, function_name, native_base);
  1490. }
  1491. #endif
  1492. }
  1493. #endif // TOOLS_ENABLED
  1494. }
  1495. #ifdef DEBUG_ENABLED
  1496. if (p_function->return_type == nullptr) {
  1497. parser->push_warning(p_function, GDScriptWarning::UNTYPED_DECLARATION, "Function", function_visible_name);
  1498. }
  1499. #endif
  1500. if (p_function->get_datatype().is_resolving()) {
  1501. p_function->set_datatype(prev_datatype);
  1502. }
  1503. #ifdef DEBUG_ENABLED
  1504. parser->ignored_warnings = previously_ignored_warnings;
  1505. #endif
  1506. parser->current_function = previous_function;
  1507. static_context = previous_static_context;
  1508. }
  1509. void GDScriptAnalyzer::resolve_function_body(GDScriptParser::FunctionNode *p_function, bool p_is_lambda) {
  1510. if (p_function->resolved_body) {
  1511. return;
  1512. }
  1513. p_function->resolved_body = true;
  1514. #ifdef DEBUG_ENABLED
  1515. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  1516. for (GDScriptWarning::Code ignored_warning : p_function->ignored_warnings) {
  1517. parser->ignored_warnings.insert(ignored_warning);
  1518. }
  1519. #endif
  1520. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  1521. parser->current_function = p_function;
  1522. bool previous_static_context = static_context;
  1523. static_context = p_function->is_static;
  1524. resolve_suite(p_function->body);
  1525. if (!p_function->get_datatype().is_hard_type() && p_function->body->get_datatype().is_set()) {
  1526. // Use the suite inferred type if return isn't explicitly set.
  1527. p_function->set_datatype(p_function->body->get_datatype());
  1528. } 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)) {
  1529. if (!p_function->body->has_return && (p_is_lambda || p_function->identifier->name != GDScriptLanguage::get_singleton()->strings._init)) {
  1530. push_error(R"(Not all code paths return a value.)", p_function);
  1531. }
  1532. }
  1533. #ifdef DEBUG_ENABLED
  1534. parser->ignored_warnings = previously_ignored_warnings;
  1535. #endif
  1536. parser->current_function = previous_function;
  1537. static_context = previous_static_context;
  1538. }
  1539. void GDScriptAnalyzer::decide_suite_type(GDScriptParser::Node *p_suite, GDScriptParser::Node *p_statement) {
  1540. if (p_statement == nullptr) {
  1541. return;
  1542. }
  1543. switch (p_statement->type) {
  1544. case GDScriptParser::Node::IF:
  1545. case GDScriptParser::Node::FOR:
  1546. case GDScriptParser::Node::MATCH:
  1547. case GDScriptParser::Node::PATTERN:
  1548. case GDScriptParser::Node::RETURN:
  1549. case GDScriptParser::Node::WHILE:
  1550. // Use return or nested suite type as this suite type.
  1551. if (p_suite->get_datatype().is_set() && (p_suite->get_datatype() != p_statement->get_datatype())) {
  1552. // Mixed types.
  1553. // TODO: This could use the common supertype instead.
  1554. p_suite->datatype.kind = GDScriptParser::DataType::VARIANT;
  1555. p_suite->datatype.type_source = GDScriptParser::DataType::UNDETECTED;
  1556. } else {
  1557. p_suite->set_datatype(p_statement->get_datatype());
  1558. p_suite->datatype.type_source = GDScriptParser::DataType::INFERRED;
  1559. }
  1560. break;
  1561. default:
  1562. break;
  1563. }
  1564. }
  1565. void GDScriptAnalyzer::resolve_suite(GDScriptParser::SuiteNode *p_suite) {
  1566. for (int i = 0; i < p_suite->statements.size(); i++) {
  1567. GDScriptParser::Node *stmt = p_suite->statements[i];
  1568. // Apply annotations.
  1569. for (GDScriptParser::AnnotationNode *&E : stmt->annotations) {
  1570. resolve_annotation(E);
  1571. E->apply(parser, stmt);
  1572. }
  1573. #ifdef DEBUG_ENABLED
  1574. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  1575. for (GDScriptWarning::Code ignored_warning : stmt->ignored_warnings) {
  1576. parser->ignored_warnings.insert(ignored_warning);
  1577. }
  1578. #endif // DEBUG_ENABLED
  1579. resolve_node(stmt);
  1580. resolve_pending_lambda_bodies();
  1581. #ifdef DEBUG_ENABLED
  1582. parser->ignored_warnings = previously_ignored_warnings;
  1583. #endif // DEBUG_ENABLED
  1584. decide_suite_type(p_suite, stmt);
  1585. }
  1586. }
  1587. void GDScriptAnalyzer::resolve_assignable(GDScriptParser::AssignableNode *p_assignable, const char *p_kind) {
  1588. GDScriptParser::DataType type;
  1589. type.kind = GDScriptParser::DataType::VARIANT;
  1590. bool is_constant = p_assignable->type == GDScriptParser::Node::CONSTANT;
  1591. #ifdef DEBUG_ENABLED
  1592. if (p_assignable->identifier != nullptr && p_assignable->identifier->suite != nullptr && p_assignable->identifier->suite->parent_block != nullptr) {
  1593. if (p_assignable->identifier->suite->parent_block->has_local(p_assignable->identifier->name)) {
  1594. const GDScriptParser::SuiteNode::Local &local = p_assignable->identifier->suite->parent_block->get_local(p_assignable->identifier->name);
  1595. parser->push_warning(p_assignable->identifier, GDScriptWarning::CONFUSABLE_LOCAL_DECLARATION, local.get_name(), p_assignable->identifier->name);
  1596. }
  1597. }
  1598. #endif
  1599. GDScriptParser::DataType specified_type;
  1600. bool has_specified_type = p_assignable->datatype_specifier != nullptr;
  1601. if (has_specified_type) {
  1602. specified_type = type_from_metatype(resolve_datatype(p_assignable->datatype_specifier));
  1603. type = specified_type;
  1604. }
  1605. if (p_assignable->initializer != nullptr) {
  1606. reduce_expression(p_assignable->initializer);
  1607. if (p_assignable->initializer->type == GDScriptParser::Node::ARRAY) {
  1608. GDScriptParser::ArrayNode *array = static_cast<GDScriptParser::ArrayNode *>(p_assignable->initializer);
  1609. if (has_specified_type && specified_type.has_container_element_type()) {
  1610. update_array_literal_element_type(array, specified_type.get_container_element_type());
  1611. }
  1612. }
  1613. if (is_constant && !p_assignable->initializer->is_constant) {
  1614. bool is_initializer_value_reduced = false;
  1615. Variant initializer_value = make_expression_reduced_value(p_assignable->initializer, is_initializer_value_reduced);
  1616. if (is_initializer_value_reduced) {
  1617. p_assignable->initializer->is_constant = true;
  1618. p_assignable->initializer->reduced_value = initializer_value;
  1619. } else {
  1620. push_error(vformat(R"(Assigned value for %s "%s" isn't a constant expression.)", p_kind, p_assignable->identifier->name), p_assignable->initializer);
  1621. }
  1622. }
  1623. if (has_specified_type && p_assignable->initializer->is_constant) {
  1624. update_const_expression_builtin_type(p_assignable->initializer, specified_type, "assign");
  1625. }
  1626. GDScriptParser::DataType initializer_type = p_assignable->initializer->get_datatype();
  1627. if (p_assignable->infer_datatype) {
  1628. if (!initializer_type.is_set() || initializer_type.has_no_type() || !initializer_type.is_hard_type()) {
  1629. push_error(vformat(R"(Cannot infer the type of "%s" %s because the value doesn't have a set type.)", p_assignable->identifier->name, p_kind), p_assignable->initializer);
  1630. } else if (initializer_type.kind == GDScriptParser::DataType::BUILTIN && initializer_type.builtin_type == Variant::NIL && !is_constant) {
  1631. push_error(vformat(R"(Cannot infer the type of "%s" %s because the value is "null".)", p_assignable->identifier->name, p_kind), p_assignable->initializer);
  1632. }
  1633. #ifdef DEBUG_ENABLED
  1634. if (initializer_type.is_hard_type() && initializer_type.is_variant()) {
  1635. parser->push_warning(p_assignable, GDScriptWarning::INFERENCE_ON_VARIANT, p_kind);
  1636. }
  1637. #endif
  1638. } else {
  1639. if (!initializer_type.is_set()) {
  1640. push_error(vformat(R"(Could not resolve type for %s "%s".)", p_kind, p_assignable->identifier->name), p_assignable->initializer);
  1641. }
  1642. }
  1643. if (!has_specified_type) {
  1644. type = initializer_type;
  1645. if (!type.is_set() || (type.is_hard_type() && type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL && !is_constant)) {
  1646. type.kind = GDScriptParser::DataType::VARIANT;
  1647. }
  1648. if (p_assignable->infer_datatype || is_constant) {
  1649. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1650. } else {
  1651. type.type_source = GDScriptParser::DataType::INFERRED;
  1652. }
  1653. } else if (!specified_type.is_variant()) {
  1654. if (initializer_type.is_variant() || !initializer_type.is_hard_type()) {
  1655. mark_node_unsafe(p_assignable->initializer);
  1656. p_assignable->use_conversion_assign = true;
  1657. if (!initializer_type.is_variant() && !is_type_compatible(specified_type, initializer_type, true, p_assignable->initializer)) {
  1658. downgrade_node_type_source(p_assignable->initializer);
  1659. }
  1660. } else if (!is_type_compatible(specified_type, initializer_type, true, p_assignable->initializer)) {
  1661. if (!is_constant && is_type_compatible(initializer_type, specified_type)) {
  1662. mark_node_unsafe(p_assignable->initializer);
  1663. p_assignable->use_conversion_assign = true;
  1664. } else {
  1665. push_error(vformat(R"(Cannot assign a value of type %s to %s "%s" with specified type %s.)", initializer_type.to_string(), p_kind, p_assignable->identifier->name, specified_type.to_string()), p_assignable->initializer);
  1666. }
  1667. } else if (specified_type.has_container_element_type() && !initializer_type.has_container_element_type()) {
  1668. mark_node_unsafe(p_assignable->initializer);
  1669. #ifdef DEBUG_ENABLED
  1670. } else if (specified_type.builtin_type == Variant::INT && initializer_type.builtin_type == Variant::FLOAT) {
  1671. parser->push_warning(p_assignable->initializer, GDScriptWarning::NARROWING_CONVERSION);
  1672. #endif
  1673. }
  1674. }
  1675. }
  1676. #ifdef DEBUG_ENABLED
  1677. if (!has_specified_type) {
  1678. const bool is_parameter = p_assignable->type == GDScriptParser::Node::PARAMETER;
  1679. const String declaration_type = is_constant ? "Constant" : (is_parameter ? "Parameter" : "Variable");
  1680. if (p_assignable->infer_datatype || is_constant) {
  1681. parser->push_warning(p_assignable, GDScriptWarning::INFERRED_DECLARATION, declaration_type, p_assignable->identifier->name);
  1682. } else {
  1683. parser->push_warning(p_assignable, GDScriptWarning::UNTYPED_DECLARATION, declaration_type, p_assignable->identifier->name);
  1684. }
  1685. }
  1686. #endif
  1687. type.is_constant = is_constant;
  1688. type.is_read_only = false;
  1689. p_assignable->set_datatype(type);
  1690. }
  1691. void GDScriptAnalyzer::resolve_variable(GDScriptParser::VariableNode *p_variable, bool p_is_local) {
  1692. static constexpr const char *kind = "variable";
  1693. resolve_assignable(p_variable, kind);
  1694. #ifdef DEBUG_ENABLED
  1695. if (p_is_local) {
  1696. if (p_variable->usages == 0 && !String(p_variable->identifier->name).begins_with("_")) {
  1697. parser->push_warning(p_variable, GDScriptWarning::UNUSED_VARIABLE, p_variable->identifier->name);
  1698. } else if (p_variable->assignments == 0) {
  1699. parser->push_warning(p_variable, GDScriptWarning::UNASSIGNED_VARIABLE, p_variable->identifier->name);
  1700. }
  1701. }
  1702. is_shadowing(p_variable->identifier, kind, p_is_local);
  1703. #endif
  1704. }
  1705. void GDScriptAnalyzer::resolve_constant(GDScriptParser::ConstantNode *p_constant, bool p_is_local) {
  1706. static constexpr const char *kind = "constant";
  1707. resolve_assignable(p_constant, kind);
  1708. #ifdef DEBUG_ENABLED
  1709. if (p_is_local) {
  1710. if (p_constant->usages == 0) {
  1711. parser->push_warning(p_constant, GDScriptWarning::UNUSED_LOCAL_CONSTANT, p_constant->identifier->name);
  1712. }
  1713. }
  1714. is_shadowing(p_constant->identifier, kind, p_is_local);
  1715. #endif
  1716. }
  1717. void GDScriptAnalyzer::resolve_parameter(GDScriptParser::ParameterNode *p_parameter) {
  1718. static constexpr const char *kind = "parameter";
  1719. resolve_assignable(p_parameter, kind);
  1720. }
  1721. void GDScriptAnalyzer::resolve_if(GDScriptParser::IfNode *p_if) {
  1722. reduce_expression(p_if->condition);
  1723. resolve_suite(p_if->true_block);
  1724. p_if->set_datatype(p_if->true_block->get_datatype());
  1725. if (p_if->false_block != nullptr) {
  1726. resolve_suite(p_if->false_block);
  1727. decide_suite_type(p_if, p_if->false_block);
  1728. }
  1729. }
  1730. void GDScriptAnalyzer::resolve_for(GDScriptParser::ForNode *p_for) {
  1731. bool list_resolved = false;
  1732. // Optimize constant range() call to not allocate an array.
  1733. // Use int, Vector2i, Vector3i instead, which also can be used as range iterators.
  1734. if (p_for->list && p_for->list->type == GDScriptParser::Node::CALL) {
  1735. GDScriptParser::CallNode *call = static_cast<GDScriptParser::CallNode *>(p_for->list);
  1736. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  1737. if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  1738. GDScriptParser::IdentifierNode *callee = static_cast<GDScriptParser::IdentifierNode *>(call->callee);
  1739. if (callee->name == "range") {
  1740. list_resolved = true;
  1741. if (call->arguments.size() < 1) {
  1742. push_error(R"*(Invalid call for "range()" function. Expected at least 1 argument, none given.)*", call->callee);
  1743. } else if (call->arguments.size() > 3) {
  1744. push_error(vformat(R"*(Invalid call for "range()" function. Expected at most 3 arguments, %d given.)*", call->arguments.size()), call->callee);
  1745. } else {
  1746. // Now we can optimize it.
  1747. bool can_reduce = true;
  1748. Vector<Variant> args;
  1749. args.resize(call->arguments.size());
  1750. for (int i = 0; i < call->arguments.size(); i++) {
  1751. GDScriptParser::ExpressionNode *argument = call->arguments[i];
  1752. reduce_expression(argument);
  1753. if (argument->is_constant) {
  1754. if (argument->reduced_value.get_type() != Variant::INT && argument->reduced_value.get_type() != Variant::FLOAT) {
  1755. can_reduce = false;
  1756. push_error(vformat(R"*(Invalid argument for "range()" call. Argument %d should be int or float but "%s" was given.)*", i + 1, Variant::get_type_name(argument->reduced_value.get_type())), argument);
  1757. }
  1758. if (can_reduce) {
  1759. args.write[i] = argument->reduced_value;
  1760. }
  1761. } else {
  1762. can_reduce = false;
  1763. GDScriptParser::DataType argument_type = argument->get_datatype();
  1764. if (argument_type.is_variant() || !argument_type.is_hard_type()) {
  1765. mark_node_unsafe(argument);
  1766. }
  1767. if (!argument_type.is_variant() && (argument_type.builtin_type != Variant::INT && argument_type.builtin_type != Variant::FLOAT)) {
  1768. if (!argument_type.is_hard_type()) {
  1769. downgrade_node_type_source(argument);
  1770. } else {
  1771. push_error(vformat(R"*(Invalid argument for "range()" call. Argument %d should be int or float but "%s" was given.)*", i + 1, argument_type.to_string()), argument);
  1772. }
  1773. }
  1774. }
  1775. }
  1776. Variant reduced;
  1777. if (can_reduce) {
  1778. switch (args.size()) {
  1779. case 1:
  1780. reduced = (int32_t)args[0];
  1781. break;
  1782. case 2:
  1783. reduced = Vector2i(args[0], args[1]);
  1784. break;
  1785. case 3:
  1786. reduced = Vector3i(args[0], args[1], args[2]);
  1787. break;
  1788. }
  1789. p_for->list->is_constant = true;
  1790. p_for->list->reduced_value = reduced;
  1791. }
  1792. }
  1793. if (p_for->list->is_constant) {
  1794. p_for->list->set_datatype(type_from_variant(p_for->list->reduced_value, p_for->list));
  1795. } else {
  1796. GDScriptParser::DataType list_type;
  1797. list_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1798. list_type.kind = GDScriptParser::DataType::BUILTIN;
  1799. list_type.builtin_type = Variant::ARRAY;
  1800. p_for->list->set_datatype(list_type);
  1801. }
  1802. }
  1803. }
  1804. }
  1805. GDScriptParser::DataType variable_type;
  1806. String list_visible_type = "<unresolved type>";
  1807. if (list_resolved) {
  1808. variable_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1809. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1810. variable_type.builtin_type = Variant::INT;
  1811. list_visible_type = "Array[int]"; // NOTE: `range()` has `Array` return type.
  1812. } else if (p_for->list) {
  1813. resolve_node(p_for->list, false);
  1814. GDScriptParser::DataType list_type = p_for->list->get_datatype();
  1815. list_visible_type = list_type.to_string();
  1816. if (!list_type.is_hard_type()) {
  1817. mark_node_unsafe(p_for->list);
  1818. }
  1819. if (list_type.is_variant()) {
  1820. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1821. mark_node_unsafe(p_for->list);
  1822. } else if (list_type.has_container_element_type()) {
  1823. variable_type = list_type.get_container_element_type();
  1824. variable_type.type_source = list_type.type_source;
  1825. } else if (list_type.is_typed_container_type()) {
  1826. variable_type = list_type.get_typed_container_type();
  1827. variable_type.type_source = list_type.type_source;
  1828. } else if (list_type.builtin_type == Variant::INT || list_type.builtin_type == Variant::FLOAT || list_type.builtin_type == Variant::STRING) {
  1829. variable_type.type_source = list_type.type_source;
  1830. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1831. variable_type.builtin_type = list_type.builtin_type;
  1832. } else if (list_type.builtin_type == Variant::VECTOR2I || list_type.builtin_type == Variant::VECTOR3I) {
  1833. variable_type.type_source = list_type.type_source;
  1834. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1835. variable_type.builtin_type = Variant::INT;
  1836. } else if (list_type.builtin_type == Variant::VECTOR2 || list_type.builtin_type == Variant::VECTOR3) {
  1837. variable_type.type_source = list_type.type_source;
  1838. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1839. variable_type.builtin_type = Variant::FLOAT;
  1840. } else if (list_type.builtin_type == Variant::OBJECT) {
  1841. GDScriptParser::DataType return_type;
  1842. List<GDScriptParser::DataType> par_types;
  1843. int default_arg_count = 0;
  1844. BitField<MethodFlags> method_flags;
  1845. if (get_function_signature(p_for->list, false, list_type, CoreStringNames::get_singleton()->_iter_get, return_type, par_types, default_arg_count, method_flags)) {
  1846. variable_type = return_type;
  1847. variable_type.type_source = list_type.type_source;
  1848. } else if (!list_type.is_hard_type()) {
  1849. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1850. } else {
  1851. push_error(vformat(R"(Unable to iterate on object of type "%s".)", list_type.to_string()), p_for->list);
  1852. }
  1853. } else if (list_type.builtin_type == Variant::ARRAY || list_type.builtin_type == Variant::DICTIONARY || !list_type.is_hard_type()) {
  1854. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1855. } else {
  1856. push_error(vformat(R"(Unable to iterate on value of type "%s".)", list_type.to_string()), p_for->list);
  1857. }
  1858. }
  1859. if (p_for->variable) {
  1860. if (p_for->datatype_specifier) {
  1861. GDScriptParser::DataType specified_type = type_from_metatype(resolve_datatype(p_for->datatype_specifier));
  1862. if (!specified_type.is_variant()) {
  1863. if (variable_type.is_variant() || !variable_type.is_hard_type()) {
  1864. mark_node_unsafe(p_for->variable);
  1865. p_for->use_conversion_assign = true;
  1866. } else if (!is_type_compatible(specified_type, variable_type, true, p_for->variable)) {
  1867. if (is_type_compatible(variable_type, specified_type)) {
  1868. mark_node_unsafe(p_for->variable);
  1869. p_for->use_conversion_assign = true;
  1870. } else {
  1871. push_error(vformat(R"(Unable to iterate on value of type "%s" with variable of type "%s".)", list_visible_type, specified_type.to_string()), p_for->datatype_specifier);
  1872. }
  1873. } else if (!is_type_compatible(specified_type, variable_type)) {
  1874. p_for->use_conversion_assign = true;
  1875. }
  1876. }
  1877. p_for->variable->set_datatype(specified_type);
  1878. } else {
  1879. p_for->variable->set_datatype(variable_type);
  1880. #ifdef DEBUG_ENABLED
  1881. if (variable_type.is_hard_type()) {
  1882. parser->push_warning(p_for->variable, GDScriptWarning::INFERRED_DECLARATION, R"("for" iterator variable)", p_for->variable->name);
  1883. } else {
  1884. parser->push_warning(p_for->variable, GDScriptWarning::UNTYPED_DECLARATION, R"("for" iterator variable)", p_for->variable->name);
  1885. }
  1886. #endif
  1887. }
  1888. }
  1889. resolve_suite(p_for->loop);
  1890. p_for->set_datatype(p_for->loop->get_datatype());
  1891. #ifdef DEBUG_ENABLED
  1892. if (p_for->variable) {
  1893. is_shadowing(p_for->variable, R"("for" iterator variable)", true);
  1894. }
  1895. #endif
  1896. }
  1897. void GDScriptAnalyzer::resolve_while(GDScriptParser::WhileNode *p_while) {
  1898. resolve_node(p_while->condition, false);
  1899. resolve_suite(p_while->loop);
  1900. p_while->set_datatype(p_while->loop->get_datatype());
  1901. }
  1902. void GDScriptAnalyzer::resolve_assert(GDScriptParser::AssertNode *p_assert) {
  1903. reduce_expression(p_assert->condition);
  1904. if (p_assert->message != nullptr) {
  1905. reduce_expression(p_assert->message);
  1906. if (!p_assert->message->get_datatype().has_no_type() && (p_assert->message->get_datatype().kind != GDScriptParser::DataType::BUILTIN || p_assert->message->get_datatype().builtin_type != Variant::STRING)) {
  1907. push_error(R"(Expected string for assert error message.)", p_assert->message);
  1908. }
  1909. }
  1910. p_assert->set_datatype(p_assert->condition->get_datatype());
  1911. #ifdef DEBUG_ENABLED
  1912. if (p_assert->condition->is_constant) {
  1913. if (p_assert->condition->reduced_value.booleanize()) {
  1914. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_TRUE);
  1915. } else if (!(p_assert->condition->type == GDScriptParser::Node::LITERAL && static_cast<GDScriptParser::LiteralNode *>(p_assert->condition)->value.get_type() == Variant::BOOL)) {
  1916. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_FALSE);
  1917. }
  1918. }
  1919. #endif
  1920. }
  1921. void GDScriptAnalyzer::resolve_match(GDScriptParser::MatchNode *p_match) {
  1922. reduce_expression(p_match->test);
  1923. for (int i = 0; i < p_match->branches.size(); i++) {
  1924. resolve_match_branch(p_match->branches[i], p_match->test);
  1925. decide_suite_type(p_match, p_match->branches[i]);
  1926. }
  1927. }
  1928. void GDScriptAnalyzer::resolve_match_branch(GDScriptParser::MatchBranchNode *p_match_branch, GDScriptParser::ExpressionNode *p_match_test) {
  1929. for (int i = 0; i < p_match_branch->patterns.size(); i++) {
  1930. resolve_match_pattern(p_match_branch->patterns[i], p_match_test);
  1931. }
  1932. resolve_suite(p_match_branch->block);
  1933. decide_suite_type(p_match_branch, p_match_branch->block);
  1934. }
  1935. void GDScriptAnalyzer::resolve_match_pattern(GDScriptParser::PatternNode *p_match_pattern, GDScriptParser::ExpressionNode *p_match_test) {
  1936. if (p_match_pattern == nullptr) {
  1937. return;
  1938. }
  1939. GDScriptParser::DataType result;
  1940. switch (p_match_pattern->pattern_type) {
  1941. case GDScriptParser::PatternNode::PT_LITERAL:
  1942. if (p_match_pattern->literal) {
  1943. reduce_literal(p_match_pattern->literal);
  1944. result = p_match_pattern->literal->get_datatype();
  1945. }
  1946. break;
  1947. case GDScriptParser::PatternNode::PT_EXPRESSION:
  1948. if (p_match_pattern->expression) {
  1949. GDScriptParser::ExpressionNode *expr = p_match_pattern->expression;
  1950. reduce_expression(expr);
  1951. result = expr->get_datatype();
  1952. if (!expr->is_constant) {
  1953. while (expr && expr->type == GDScriptParser::Node::SUBSCRIPT) {
  1954. GDScriptParser::SubscriptNode *sub = static_cast<GDScriptParser::SubscriptNode *>(expr);
  1955. if (!sub->is_attribute) {
  1956. expr = nullptr;
  1957. } else {
  1958. expr = sub->base;
  1959. }
  1960. }
  1961. if (!expr || expr->type != GDScriptParser::Node::IDENTIFIER) {
  1962. push_error(R"(Expression in match pattern must be a constant expression, an identifier, or an attribute access ("A.B").)", expr);
  1963. }
  1964. }
  1965. }
  1966. break;
  1967. case GDScriptParser::PatternNode::PT_BIND:
  1968. if (p_match_test != nullptr) {
  1969. result = p_match_test->get_datatype();
  1970. } else {
  1971. result.kind = GDScriptParser::DataType::VARIANT;
  1972. }
  1973. p_match_pattern->bind->set_datatype(result);
  1974. #ifdef DEBUG_ENABLED
  1975. is_shadowing(p_match_pattern->bind, "pattern bind", true);
  1976. if (p_match_pattern->bind->usages == 0 && !String(p_match_pattern->bind->name).begins_with("_")) {
  1977. parser->push_warning(p_match_pattern->bind, GDScriptWarning::UNUSED_VARIABLE, p_match_pattern->bind->name);
  1978. }
  1979. #endif
  1980. break;
  1981. case GDScriptParser::PatternNode::PT_ARRAY:
  1982. for (int i = 0; i < p_match_pattern->array.size(); i++) {
  1983. resolve_match_pattern(p_match_pattern->array[i], nullptr);
  1984. decide_suite_type(p_match_pattern, p_match_pattern->array[i]);
  1985. }
  1986. result = p_match_pattern->get_datatype();
  1987. break;
  1988. case GDScriptParser::PatternNode::PT_DICTIONARY:
  1989. for (int i = 0; i < p_match_pattern->dictionary.size(); i++) {
  1990. if (p_match_pattern->dictionary[i].key) {
  1991. reduce_expression(p_match_pattern->dictionary[i].key);
  1992. if (!p_match_pattern->dictionary[i].key->is_constant) {
  1993. push_error(R"(Expression in dictionary pattern key must be a constant.)", p_match_pattern->dictionary[i].key);
  1994. }
  1995. }
  1996. if (p_match_pattern->dictionary[i].value_pattern) {
  1997. resolve_match_pattern(p_match_pattern->dictionary[i].value_pattern, nullptr);
  1998. decide_suite_type(p_match_pattern, p_match_pattern->dictionary[i].value_pattern);
  1999. }
  2000. }
  2001. result = p_match_pattern->get_datatype();
  2002. break;
  2003. case GDScriptParser::PatternNode::PT_WILDCARD:
  2004. case GDScriptParser::PatternNode::PT_REST:
  2005. result.kind = GDScriptParser::DataType::VARIANT;
  2006. break;
  2007. }
  2008. p_match_pattern->set_datatype(result);
  2009. }
  2010. void GDScriptAnalyzer::resolve_return(GDScriptParser::ReturnNode *p_return) {
  2011. GDScriptParser::DataType result;
  2012. GDScriptParser::DataType expected_type;
  2013. bool has_expected_type = parser->current_function != nullptr;
  2014. if (has_expected_type) {
  2015. expected_type = parser->current_function->get_datatype();
  2016. }
  2017. if (p_return->return_value != nullptr) {
  2018. bool is_void_function = has_expected_type && expected_type.is_hard_type() && expected_type.kind == GDScriptParser::DataType::BUILTIN && expected_type.builtin_type == Variant::NIL;
  2019. bool is_call = p_return->return_value->type == GDScriptParser::Node::CALL;
  2020. if (is_void_function && is_call) {
  2021. // Pretend the call is a root expression to allow those that are "void".
  2022. reduce_call(static_cast<GDScriptParser::CallNode *>(p_return->return_value), false, true);
  2023. } else {
  2024. reduce_expression(p_return->return_value);
  2025. }
  2026. if (is_void_function) {
  2027. p_return->void_return = true;
  2028. const GDScriptParser::DataType &return_type = p_return->return_value->datatype;
  2029. if (is_call && !return_type.is_hard_type()) {
  2030. String function_name = parser->current_function->identifier ? parser->current_function->identifier->name.operator String() : String("<anonymous function>");
  2031. String called_function_name = static_cast<GDScriptParser::CallNode *>(p_return->return_value)->function_name.operator String();
  2032. #ifdef DEBUG_ENABLED
  2033. parser->push_warning(p_return, GDScriptWarning::UNSAFE_VOID_RETURN, function_name, called_function_name);
  2034. #endif
  2035. mark_node_unsafe(p_return);
  2036. } else if (!is_call) {
  2037. push_error("A void function cannot return a value.", p_return);
  2038. }
  2039. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2040. result.kind = GDScriptParser::DataType::BUILTIN;
  2041. result.builtin_type = Variant::NIL;
  2042. result.is_constant = true;
  2043. } else {
  2044. if (p_return->return_value->type == GDScriptParser::Node::ARRAY && has_expected_type && expected_type.has_container_element_type()) {
  2045. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_return->return_value), expected_type.get_container_element_type());
  2046. }
  2047. if (has_expected_type && expected_type.is_hard_type() && p_return->return_value->is_constant) {
  2048. update_const_expression_builtin_type(p_return->return_value, expected_type, "return");
  2049. }
  2050. result = p_return->return_value->get_datatype();
  2051. }
  2052. } else {
  2053. // Return type is null by default.
  2054. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2055. result.kind = GDScriptParser::DataType::BUILTIN;
  2056. result.builtin_type = Variant::NIL;
  2057. result.is_constant = true;
  2058. }
  2059. if (has_expected_type && !expected_type.is_variant()) {
  2060. if (result.is_variant() || !result.is_hard_type()) {
  2061. mark_node_unsafe(p_return);
  2062. if (!is_type_compatible(expected_type, result, true, p_return)) {
  2063. downgrade_node_type_source(p_return);
  2064. }
  2065. } else if (!is_type_compatible(expected_type, result, true, p_return)) {
  2066. mark_node_unsafe(p_return);
  2067. if (!is_type_compatible(result, expected_type)) {
  2068. push_error(vformat(R"(Cannot return value of type "%s" because the function return type is "%s".)", result.to_string(), expected_type.to_string()), p_return);
  2069. }
  2070. #ifdef DEBUG_ENABLED
  2071. } else if (expected_type.builtin_type == Variant::INT && result.builtin_type == Variant::FLOAT) {
  2072. parser->push_warning(p_return, GDScriptWarning::NARROWING_CONVERSION);
  2073. #endif
  2074. }
  2075. }
  2076. p_return->set_datatype(result);
  2077. }
  2078. void GDScriptAnalyzer::reduce_expression(GDScriptParser::ExpressionNode *p_expression, bool p_is_root) {
  2079. // This one makes some magic happen.
  2080. if (p_expression == nullptr) {
  2081. return;
  2082. }
  2083. if (p_expression->reduced) {
  2084. // Don't do this more than once.
  2085. return;
  2086. }
  2087. p_expression->reduced = true;
  2088. switch (p_expression->type) {
  2089. case GDScriptParser::Node::ARRAY:
  2090. reduce_array(static_cast<GDScriptParser::ArrayNode *>(p_expression));
  2091. break;
  2092. case GDScriptParser::Node::ASSIGNMENT:
  2093. reduce_assignment(static_cast<GDScriptParser::AssignmentNode *>(p_expression));
  2094. break;
  2095. case GDScriptParser::Node::AWAIT:
  2096. reduce_await(static_cast<GDScriptParser::AwaitNode *>(p_expression));
  2097. break;
  2098. case GDScriptParser::Node::BINARY_OPERATOR:
  2099. reduce_binary_op(static_cast<GDScriptParser::BinaryOpNode *>(p_expression));
  2100. break;
  2101. case GDScriptParser::Node::CALL:
  2102. reduce_call(static_cast<GDScriptParser::CallNode *>(p_expression), false, p_is_root);
  2103. break;
  2104. case GDScriptParser::Node::CAST:
  2105. reduce_cast(static_cast<GDScriptParser::CastNode *>(p_expression));
  2106. break;
  2107. case GDScriptParser::Node::DICTIONARY:
  2108. reduce_dictionary(static_cast<GDScriptParser::DictionaryNode *>(p_expression));
  2109. break;
  2110. case GDScriptParser::Node::GET_NODE:
  2111. reduce_get_node(static_cast<GDScriptParser::GetNodeNode *>(p_expression));
  2112. break;
  2113. case GDScriptParser::Node::IDENTIFIER:
  2114. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_expression));
  2115. break;
  2116. case GDScriptParser::Node::LAMBDA:
  2117. reduce_lambda(static_cast<GDScriptParser::LambdaNode *>(p_expression));
  2118. break;
  2119. case GDScriptParser::Node::LITERAL:
  2120. reduce_literal(static_cast<GDScriptParser::LiteralNode *>(p_expression));
  2121. break;
  2122. case GDScriptParser::Node::PRELOAD:
  2123. reduce_preload(static_cast<GDScriptParser::PreloadNode *>(p_expression));
  2124. break;
  2125. case GDScriptParser::Node::SELF:
  2126. reduce_self(static_cast<GDScriptParser::SelfNode *>(p_expression));
  2127. break;
  2128. case GDScriptParser::Node::SUBSCRIPT:
  2129. reduce_subscript(static_cast<GDScriptParser::SubscriptNode *>(p_expression));
  2130. break;
  2131. case GDScriptParser::Node::TERNARY_OPERATOR:
  2132. reduce_ternary_op(static_cast<GDScriptParser::TernaryOpNode *>(p_expression), p_is_root);
  2133. break;
  2134. case GDScriptParser::Node::TYPE_TEST:
  2135. reduce_type_test(static_cast<GDScriptParser::TypeTestNode *>(p_expression));
  2136. break;
  2137. case GDScriptParser::Node::UNARY_OPERATOR:
  2138. reduce_unary_op(static_cast<GDScriptParser::UnaryOpNode *>(p_expression));
  2139. break;
  2140. // Non-expressions. Here only to make sure new nodes aren't forgotten.
  2141. case GDScriptParser::Node::NONE:
  2142. case GDScriptParser::Node::ANNOTATION:
  2143. case GDScriptParser::Node::ASSERT:
  2144. case GDScriptParser::Node::BREAK:
  2145. case GDScriptParser::Node::BREAKPOINT:
  2146. case GDScriptParser::Node::CLASS:
  2147. case GDScriptParser::Node::CONSTANT:
  2148. case GDScriptParser::Node::CONTINUE:
  2149. case GDScriptParser::Node::ENUM:
  2150. case GDScriptParser::Node::FOR:
  2151. case GDScriptParser::Node::FUNCTION:
  2152. case GDScriptParser::Node::IF:
  2153. case GDScriptParser::Node::MATCH:
  2154. case GDScriptParser::Node::MATCH_BRANCH:
  2155. case GDScriptParser::Node::PARAMETER:
  2156. case GDScriptParser::Node::PASS:
  2157. case GDScriptParser::Node::PATTERN:
  2158. case GDScriptParser::Node::RETURN:
  2159. case GDScriptParser::Node::SIGNAL:
  2160. case GDScriptParser::Node::SUITE:
  2161. case GDScriptParser::Node::TYPE:
  2162. case GDScriptParser::Node::VARIABLE:
  2163. case GDScriptParser::Node::WHILE:
  2164. ERR_FAIL_MSG("Reaching unreachable case");
  2165. }
  2166. }
  2167. void GDScriptAnalyzer::reduce_array(GDScriptParser::ArrayNode *p_array) {
  2168. for (int i = 0; i < p_array->elements.size(); i++) {
  2169. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  2170. reduce_expression(element);
  2171. }
  2172. // It's array in any case.
  2173. GDScriptParser::DataType arr_type;
  2174. arr_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2175. arr_type.kind = GDScriptParser::DataType::BUILTIN;
  2176. arr_type.builtin_type = Variant::ARRAY;
  2177. arr_type.is_constant = true;
  2178. p_array->set_datatype(arr_type);
  2179. }
  2180. #ifdef DEBUG_ENABLED
  2181. static bool enum_has_value(const GDScriptParser::DataType p_type, int64_t p_value) {
  2182. for (const KeyValue<StringName, int64_t> &E : p_type.enum_values) {
  2183. if (E.value == p_value) {
  2184. return true;
  2185. }
  2186. }
  2187. return false;
  2188. }
  2189. #endif
  2190. void GDScriptAnalyzer::update_const_expression_builtin_type(GDScriptParser::ExpressionNode *p_expression, const GDScriptParser::DataType &p_type, const char *p_usage, bool p_is_cast) {
  2191. if (p_expression->get_datatype() == p_type) {
  2192. return;
  2193. }
  2194. if (p_type.kind != GDScriptParser::DataType::BUILTIN && p_type.kind != GDScriptParser::DataType::ENUM) {
  2195. return;
  2196. }
  2197. GDScriptParser::DataType expression_type = p_expression->get_datatype();
  2198. bool is_enum_cast = p_is_cast && p_type.kind == GDScriptParser::DataType::ENUM && p_type.is_meta_type == false && expression_type.builtin_type == Variant::INT;
  2199. if (!is_enum_cast && !is_type_compatible(p_type, expression_type, true, p_expression)) {
  2200. push_error(vformat(R"(Cannot %s a value of type "%s" as "%s".)", p_usage, expression_type.to_string(), p_type.to_string()), p_expression);
  2201. return;
  2202. }
  2203. GDScriptParser::DataType value_type = type_from_variant(p_expression->reduced_value, p_expression);
  2204. if (expression_type.is_variant() && !is_enum_cast && !is_type_compatible(p_type, value_type, true, p_expression)) {
  2205. push_error(vformat(R"(Cannot %s a value of type "%s" as "%s".)", p_usage, value_type.to_string(), p_type.to_string()), p_expression);
  2206. return;
  2207. }
  2208. #ifdef DEBUG_ENABLED
  2209. if (p_type.kind == GDScriptParser::DataType::ENUM && value_type.builtin_type == Variant::INT && !enum_has_value(p_type, p_expression->reduced_value)) {
  2210. parser->push_warning(p_expression, GDScriptWarning::INT_AS_ENUM_WITHOUT_MATCH, p_usage, p_expression->reduced_value.stringify(), p_type.to_string());
  2211. }
  2212. #endif
  2213. if (value_type.builtin_type == p_type.builtin_type) {
  2214. p_expression->set_datatype(p_type);
  2215. return;
  2216. }
  2217. Variant converted_to;
  2218. const Variant *converted_from = &p_expression->reduced_value;
  2219. Callable::CallError call_error;
  2220. Variant::construct(p_type.builtin_type, converted_to, &converted_from, 1, call_error);
  2221. if (call_error.error) {
  2222. push_error(vformat(R"(Failed to convert a value of type "%s" to "%s".)", value_type.to_string(), p_type.to_string()), p_expression);
  2223. return;
  2224. }
  2225. #ifdef DEBUG_ENABLED
  2226. if (p_type.builtin_type == Variant::INT && value_type.builtin_type == Variant::FLOAT) {
  2227. parser->push_warning(p_expression, GDScriptWarning::NARROWING_CONVERSION);
  2228. }
  2229. #endif
  2230. p_expression->reduced_value = converted_to;
  2231. p_expression->set_datatype(p_type);
  2232. }
  2233. // When an array literal is stored (or passed as function argument) to a typed context, we then assume the array is typed.
  2234. // This function determines which type is that (if any).
  2235. void GDScriptAnalyzer::update_array_literal_element_type(GDScriptParser::ArrayNode *p_array, const GDScriptParser::DataType &p_element_type) {
  2236. for (int i = 0; i < p_array->elements.size(); i++) {
  2237. GDScriptParser::ExpressionNode *element_node = p_array->elements[i];
  2238. if (element_node->is_constant) {
  2239. update_const_expression_builtin_type(element_node, p_element_type, "include");
  2240. }
  2241. const GDScriptParser::DataType &element_type = element_node->get_datatype();
  2242. if (element_type.has_no_type() || element_type.is_variant() || !element_type.is_hard_type()) {
  2243. mark_node_unsafe(element_node);
  2244. continue;
  2245. }
  2246. if (!is_type_compatible(p_element_type, element_type, true, p_array)) {
  2247. if (is_type_compatible(element_type, p_element_type)) {
  2248. mark_node_unsafe(element_node);
  2249. continue;
  2250. }
  2251. push_error(vformat(R"(Cannot have an element of type "%s" in an array of type "Array[%s]".)", element_type.to_string(), p_element_type.to_string()), element_node);
  2252. return;
  2253. }
  2254. }
  2255. GDScriptParser::DataType array_type = p_array->get_datatype();
  2256. array_type.set_container_element_type(p_element_type);
  2257. p_array->set_datatype(array_type);
  2258. }
  2259. void GDScriptAnalyzer::reduce_assignment(GDScriptParser::AssignmentNode *p_assignment) {
  2260. reduce_expression(p_assignment->assignee);
  2261. reduce_expression(p_assignment->assigned_value);
  2262. if (p_assignment->assigned_value == nullptr || p_assignment->assignee == nullptr) {
  2263. return;
  2264. }
  2265. GDScriptParser::DataType assignee_type = p_assignment->assignee->get_datatype();
  2266. if (assignee_type.is_constant) {
  2267. push_error("Cannot assign a new value to a constant.", p_assignment->assignee);
  2268. return;
  2269. } else if (p_assignment->assignee->type == GDScriptParser::Node::SUBSCRIPT && static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee)->base->is_constant) {
  2270. const GDScriptParser::DataType &base_type = static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee)->base->datatype;
  2271. if (base_type.kind != GDScriptParser::DataType::SCRIPT && base_type.kind != GDScriptParser::DataType::CLASS) { // Static variables.
  2272. push_error("Cannot assign a new value to a constant.", p_assignment->assignee);
  2273. return;
  2274. }
  2275. } else if (assignee_type.is_read_only) {
  2276. push_error("Cannot assign a new value to a read-only property.", p_assignment->assignee);
  2277. return;
  2278. } else if (p_assignment->assignee->type == GDScriptParser::Node::SUBSCRIPT) {
  2279. GDScriptParser::SubscriptNode *sub = static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee);
  2280. while (sub) {
  2281. const GDScriptParser::DataType &base_type = sub->base->datatype;
  2282. if (base_type.is_hard_type() && base_type.is_read_only) {
  2283. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !Variant::is_type_shared(base_type.builtin_type)) {
  2284. push_error("Cannot assign a new value to a read-only property.", p_assignment->assignee);
  2285. return;
  2286. }
  2287. } else {
  2288. break;
  2289. }
  2290. if (sub->base->type == GDScriptParser::Node::SUBSCRIPT) {
  2291. sub = static_cast<GDScriptParser::SubscriptNode *>(sub->base);
  2292. } else {
  2293. sub = nullptr;
  2294. }
  2295. }
  2296. }
  2297. // Check if assigned value is an array literal, so we can make it a typed array too if appropriate.
  2298. if (p_assignment->assigned_value->type == GDScriptParser::Node::ARRAY && assignee_type.is_hard_type() && assignee_type.has_container_element_type()) {
  2299. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_assignment->assigned_value), assignee_type.get_container_element_type());
  2300. }
  2301. if (p_assignment->operation == GDScriptParser::AssignmentNode::OP_NONE && assignee_type.is_hard_type() && p_assignment->assigned_value->is_constant) {
  2302. update_const_expression_builtin_type(p_assignment->assigned_value, assignee_type, "assign");
  2303. }
  2304. GDScriptParser::DataType assigned_value_type = p_assignment->assigned_value->get_datatype();
  2305. bool assignee_is_variant = assignee_type.is_variant();
  2306. bool assignee_is_hard = assignee_type.is_hard_type();
  2307. bool assigned_is_variant = assigned_value_type.is_variant();
  2308. bool assigned_is_hard = assigned_value_type.is_hard_type();
  2309. bool compatible = true;
  2310. bool downgrades_assignee = false;
  2311. bool downgrades_assigned = false;
  2312. GDScriptParser::DataType op_type = assigned_value_type;
  2313. if (p_assignment->operation != GDScriptParser::AssignmentNode::OP_NONE && !op_type.is_variant()) {
  2314. op_type = get_operation_type(p_assignment->variant_op, assignee_type, assigned_value_type, compatible, p_assignment->assigned_value);
  2315. if (assignee_is_variant) {
  2316. // variant assignee
  2317. mark_node_unsafe(p_assignment);
  2318. } else if (!compatible) {
  2319. // incompatible hard types and non-variant assignee
  2320. mark_node_unsafe(p_assignment);
  2321. if (assigned_is_variant) {
  2322. // incompatible hard non-variant assignee and hard variant assigned
  2323. p_assignment->use_conversion_assign = true;
  2324. } else {
  2325. // incompatible hard non-variant types
  2326. push_error(vformat(R"(Invalid operands "%s" and "%s" for assignment operator.)", assignee_type.to_string(), assigned_value_type.to_string()), p_assignment);
  2327. }
  2328. } else if (op_type.type_source == GDScriptParser::DataType::UNDETECTED && !assigned_is_variant) {
  2329. // incompatible non-variant types (at least one weak)
  2330. downgrades_assignee = !assignee_is_hard;
  2331. downgrades_assigned = !assigned_is_hard;
  2332. }
  2333. }
  2334. p_assignment->set_datatype(op_type);
  2335. if (assignee_is_variant) {
  2336. if (!assignee_is_hard) {
  2337. // weak variant assignee
  2338. mark_node_unsafe(p_assignment);
  2339. }
  2340. } else {
  2341. if (assignee_is_hard && !assigned_is_hard) {
  2342. // hard non-variant assignee and weak assigned
  2343. mark_node_unsafe(p_assignment);
  2344. p_assignment->use_conversion_assign = true;
  2345. downgrades_assigned = downgrades_assigned || (!assigned_is_variant && !is_type_compatible(assignee_type, op_type, true, p_assignment->assigned_value));
  2346. } else if (compatible) {
  2347. if (op_type.is_variant()) {
  2348. // non-variant assignee and variant result
  2349. mark_node_unsafe(p_assignment);
  2350. if (assignee_is_hard) {
  2351. // hard non-variant assignee and variant result
  2352. p_assignment->use_conversion_assign = true;
  2353. } else {
  2354. // weak non-variant assignee and variant result
  2355. downgrades_assignee = true;
  2356. }
  2357. } else if (!is_type_compatible(assignee_type, op_type, assignee_is_hard, p_assignment->assigned_value)) {
  2358. // non-variant assignee and incompatible result
  2359. mark_node_unsafe(p_assignment);
  2360. if (assignee_is_hard) {
  2361. if (is_type_compatible(op_type, assignee_type)) {
  2362. // hard non-variant assignee and maybe compatible result
  2363. p_assignment->use_conversion_assign = true;
  2364. } else {
  2365. // hard non-variant assignee and incompatible result
  2366. push_error(vformat(R"(Value of type "%s" cannot be assigned to a variable of type "%s".)", assigned_value_type.to_string(), assignee_type.to_string()), p_assignment->assigned_value);
  2367. }
  2368. } else {
  2369. // weak non-variant assignee and incompatible result
  2370. downgrades_assignee = true;
  2371. }
  2372. } else if (assignee_type.has_container_element_type() && !op_type.has_container_element_type()) {
  2373. // typed array assignee and untyped array result
  2374. mark_node_unsafe(p_assignment);
  2375. }
  2376. }
  2377. }
  2378. if (downgrades_assignee) {
  2379. downgrade_node_type_source(p_assignment->assignee);
  2380. }
  2381. if (downgrades_assigned) {
  2382. downgrade_node_type_source(p_assignment->assigned_value);
  2383. }
  2384. #ifdef DEBUG_ENABLED
  2385. if (assignee_type.is_hard_type() && assignee_type.builtin_type == Variant::INT && assigned_value_type.builtin_type == Variant::FLOAT) {
  2386. parser->push_warning(p_assignment->assigned_value, GDScriptWarning::NARROWING_CONVERSION);
  2387. }
  2388. #endif
  2389. }
  2390. void GDScriptAnalyzer::reduce_await(GDScriptParser::AwaitNode *p_await) {
  2391. if (p_await->to_await == nullptr) {
  2392. GDScriptParser::DataType await_type;
  2393. await_type.kind = GDScriptParser::DataType::VARIANT;
  2394. p_await->set_datatype(await_type);
  2395. return;
  2396. }
  2397. if (p_await->to_await->type == GDScriptParser::Node::CALL) {
  2398. reduce_call(static_cast<GDScriptParser::CallNode *>(p_await->to_await), true);
  2399. } else {
  2400. reduce_expression(p_await->to_await);
  2401. }
  2402. GDScriptParser::DataType await_type = p_await->to_await->get_datatype();
  2403. // We cannot infer the type of the result of waiting for a signal.
  2404. if (await_type.is_hard_type() && await_type.kind == GDScriptParser::DataType::BUILTIN && await_type.builtin_type == Variant::SIGNAL) {
  2405. await_type.kind = GDScriptParser::DataType::VARIANT;
  2406. await_type.type_source = GDScriptParser::DataType::UNDETECTED;
  2407. } else if (p_await->to_await->is_constant) {
  2408. p_await->is_constant = p_await->to_await->is_constant;
  2409. p_await->reduced_value = p_await->to_await->reduced_value;
  2410. }
  2411. await_type.is_coroutine = false;
  2412. p_await->set_datatype(await_type);
  2413. #ifdef DEBUG_ENABLED
  2414. GDScriptParser::DataType to_await_type = p_await->to_await->get_datatype();
  2415. if (!to_await_type.is_coroutine && !to_await_type.is_variant() && to_await_type.builtin_type != Variant::SIGNAL) {
  2416. parser->push_warning(p_await, GDScriptWarning::REDUNDANT_AWAIT);
  2417. }
  2418. #endif
  2419. }
  2420. void GDScriptAnalyzer::reduce_binary_op(GDScriptParser::BinaryOpNode *p_binary_op) {
  2421. reduce_expression(p_binary_op->left_operand);
  2422. reduce_expression(p_binary_op->right_operand);
  2423. GDScriptParser::DataType left_type;
  2424. if (p_binary_op->left_operand) {
  2425. left_type = p_binary_op->left_operand->get_datatype();
  2426. }
  2427. GDScriptParser::DataType right_type;
  2428. if (p_binary_op->right_operand) {
  2429. right_type = p_binary_op->right_operand->get_datatype();
  2430. }
  2431. if (!left_type.is_set() || !right_type.is_set()) {
  2432. return;
  2433. }
  2434. #ifdef DEBUG_ENABLED
  2435. if (p_binary_op->variant_op == Variant::OP_DIVIDE && left_type.builtin_type == Variant::INT && right_type.builtin_type == Variant::INT) {
  2436. parser->push_warning(p_binary_op, GDScriptWarning::INTEGER_DIVISION);
  2437. }
  2438. #endif
  2439. if (p_binary_op->left_operand->is_constant && p_binary_op->right_operand->is_constant) {
  2440. p_binary_op->is_constant = true;
  2441. if (p_binary_op->variant_op < Variant::OP_MAX) {
  2442. bool valid = false;
  2443. 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);
  2444. if (!valid) {
  2445. if (p_binary_op->reduced_value.get_type() == Variant::STRING) {
  2446. 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);
  2447. } else {
  2448. push_error(vformat(R"(Invalid operands to operator %s, %s and %s.)",
  2449. Variant::get_operator_name(p_binary_op->variant_op),
  2450. Variant::get_type_name(p_binary_op->left_operand->reduced_value.get_type()),
  2451. Variant::get_type_name(p_binary_op->right_operand->reduced_value.get_type())),
  2452. p_binary_op);
  2453. }
  2454. }
  2455. } else {
  2456. ERR_PRINT("Parser bug: unknown binary operation.");
  2457. }
  2458. p_binary_op->set_datatype(type_from_variant(p_binary_op->reduced_value, p_binary_op));
  2459. return;
  2460. }
  2461. GDScriptParser::DataType result;
  2462. if ((p_binary_op->variant_op == Variant::OP_EQUAL || p_binary_op->variant_op == Variant::OP_NOT_EQUAL) &&
  2463. ((left_type.kind == GDScriptParser::DataType::BUILTIN && left_type.builtin_type == Variant::NIL) || (right_type.kind == GDScriptParser::DataType::BUILTIN && right_type.builtin_type == Variant::NIL))) {
  2464. // "==" and "!=" operators always return a boolean when comparing to null.
  2465. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2466. result.kind = GDScriptParser::DataType::BUILTIN;
  2467. result.builtin_type = Variant::BOOL;
  2468. } else if (left_type.is_variant() || right_type.is_variant()) {
  2469. // Cannot infer type because one operand can be anything.
  2470. result.kind = GDScriptParser::DataType::VARIANT;
  2471. mark_node_unsafe(p_binary_op);
  2472. } else if (p_binary_op->variant_op < Variant::OP_MAX) {
  2473. bool valid = false;
  2474. result = get_operation_type(p_binary_op->variant_op, left_type, right_type, valid, p_binary_op);
  2475. if (!valid) {
  2476. 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);
  2477. } else if (!result.is_hard_type()) {
  2478. mark_node_unsafe(p_binary_op);
  2479. }
  2480. } else {
  2481. ERR_PRINT("Parser bug: unknown binary operation.");
  2482. }
  2483. p_binary_op->set_datatype(result);
  2484. }
  2485. #ifdef SUGGEST_GODOT4_RENAMES
  2486. const char *get_rename_from_map(const char *map[][2], String key) {
  2487. for (int index = 0; map[index][0]; index++) {
  2488. if (map[index][0] == key) {
  2489. return map[index][1];
  2490. }
  2491. }
  2492. return nullptr;
  2493. }
  2494. // Checks if an identifier/function name has been renamed in Godot 4, uses ProjectConverter3To4 for rename map.
  2495. // Returns the new name if found, nullptr otherwise.
  2496. const char *check_for_renamed_identifier(String identifier, GDScriptParser::Node::Type type) {
  2497. switch (type) {
  2498. case GDScriptParser::Node::IDENTIFIER: {
  2499. // Check properties
  2500. const char *result = get_rename_from_map(RenamesMap3To4::gdscript_properties_renames, identifier);
  2501. if (result) {
  2502. return result;
  2503. }
  2504. // Check enum values
  2505. result = get_rename_from_map(RenamesMap3To4::enum_renames, identifier);
  2506. if (result) {
  2507. return result;
  2508. }
  2509. // Check color constants
  2510. result = get_rename_from_map(RenamesMap3To4::color_renames, identifier);
  2511. if (result) {
  2512. return result;
  2513. }
  2514. // Check type names
  2515. result = get_rename_from_map(RenamesMap3To4::class_renames, identifier);
  2516. if (result) {
  2517. return result;
  2518. }
  2519. return get_rename_from_map(RenamesMap3To4::builtin_types_renames, identifier);
  2520. }
  2521. case GDScriptParser::Node::CALL: {
  2522. const char *result = get_rename_from_map(RenamesMap3To4::gdscript_function_renames, identifier);
  2523. if (result) {
  2524. return result;
  2525. }
  2526. // Built-in Types are mistaken for function calls when the built-in type is not found.
  2527. // Check built-in types if function rename not found
  2528. return get_rename_from_map(RenamesMap3To4::builtin_types_renames, identifier);
  2529. }
  2530. // Signal references don't get parsed through the GDScriptAnalyzer. No support for signal rename hints.
  2531. default:
  2532. // No rename found, return null
  2533. return nullptr;
  2534. }
  2535. }
  2536. #endif // SUGGEST_GODOT4_RENAMES
  2537. void GDScriptAnalyzer::reduce_call(GDScriptParser::CallNode *p_call, bool p_is_await, bool p_is_root) {
  2538. bool all_is_constant = true;
  2539. HashMap<int, GDScriptParser::ArrayNode *> arrays; // For array literal to potentially type when passing.
  2540. for (int i = 0; i < p_call->arguments.size(); i++) {
  2541. reduce_expression(p_call->arguments[i]);
  2542. if (p_call->arguments[i]->type == GDScriptParser::Node::ARRAY) {
  2543. arrays[i] = static_cast<GDScriptParser::ArrayNode *>(p_call->arguments[i]);
  2544. }
  2545. all_is_constant = all_is_constant && p_call->arguments[i]->is_constant;
  2546. }
  2547. GDScriptParser::Node::Type callee_type = p_call->get_callee_type();
  2548. GDScriptParser::DataType call_type;
  2549. if (!p_call->is_super && callee_type == GDScriptParser::Node::IDENTIFIER) {
  2550. // Call to name directly.
  2551. StringName function_name = p_call->function_name;
  2552. if (function_name == SNAME("Object")) {
  2553. push_error(R"*(Invalid constructor "Object()", use "Object.new()" instead.)*", p_call);
  2554. p_call->set_datatype(call_type);
  2555. return;
  2556. }
  2557. Variant::Type builtin_type = GDScriptParser::get_builtin_type(function_name);
  2558. if (builtin_type < Variant::VARIANT_MAX) {
  2559. // Is a builtin constructor.
  2560. call_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2561. call_type.kind = GDScriptParser::DataType::BUILTIN;
  2562. call_type.builtin_type = builtin_type;
  2563. bool safe_to_fold = true;
  2564. switch (builtin_type) {
  2565. // Those are stored by reference so not suited for compile-time construction.
  2566. // Because in this case they would be the same reference in all constructed values.
  2567. case Variant::OBJECT:
  2568. case Variant::DICTIONARY:
  2569. case Variant::ARRAY:
  2570. case Variant::PACKED_BYTE_ARRAY:
  2571. case Variant::PACKED_INT32_ARRAY:
  2572. case Variant::PACKED_INT64_ARRAY:
  2573. case Variant::PACKED_FLOAT32_ARRAY:
  2574. case Variant::PACKED_FLOAT64_ARRAY:
  2575. case Variant::PACKED_STRING_ARRAY:
  2576. case Variant::PACKED_VECTOR2_ARRAY:
  2577. case Variant::PACKED_VECTOR3_ARRAY:
  2578. case Variant::PACKED_COLOR_ARRAY:
  2579. safe_to_fold = false;
  2580. break;
  2581. default:
  2582. break;
  2583. }
  2584. if (all_is_constant && safe_to_fold) {
  2585. // Construct here.
  2586. Vector<const Variant *> args;
  2587. for (int i = 0; i < p_call->arguments.size(); i++) {
  2588. args.push_back(&(p_call->arguments[i]->reduced_value));
  2589. }
  2590. Callable::CallError err;
  2591. Variant value;
  2592. Variant::construct(builtin_type, value, (const Variant **)args.ptr(), args.size(), err);
  2593. switch (err.error) {
  2594. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  2595. 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,
  2596. Variant::get_type_name(Variant::Type(err.expected)), p_call->arguments[err.argument]->get_datatype().to_string()),
  2597. p_call->arguments[err.argument]);
  2598. break;
  2599. case Callable::CallError::CALL_ERROR_INVALID_METHOD: {
  2600. String signature = Variant::get_type_name(builtin_type) + "(";
  2601. for (int i = 0; i < p_call->arguments.size(); i++) {
  2602. if (i > 0) {
  2603. signature += ", ";
  2604. }
  2605. signature += p_call->arguments[i]->get_datatype().to_string();
  2606. }
  2607. signature += ")";
  2608. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call->callee);
  2609. } break;
  2610. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  2611. 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);
  2612. break;
  2613. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  2614. 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);
  2615. break;
  2616. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  2617. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  2618. break; // Can't happen in a builtin constructor.
  2619. case Callable::CallError::CALL_OK:
  2620. p_call->is_constant = true;
  2621. p_call->reduced_value = value;
  2622. break;
  2623. }
  2624. } else {
  2625. // If there's one argument, try to use copy constructor (those aren't explicitly defined).
  2626. if (p_call->arguments.size() == 1) {
  2627. GDScriptParser::DataType arg_type = p_call->arguments[0]->get_datatype();
  2628. if (arg_type.is_hard_type() && !arg_type.is_variant()) {
  2629. if (arg_type.kind == GDScriptParser::DataType::BUILTIN && arg_type.builtin_type == builtin_type) {
  2630. // Okay.
  2631. p_call->set_datatype(call_type);
  2632. return;
  2633. }
  2634. } else {
  2635. #ifdef DEBUG_ENABLED
  2636. mark_node_unsafe(p_call);
  2637. // We don't know what type was expected since constructors support overloads.
  2638. // TODO: Improve this by checking for matching candidates?
  2639. parser->push_warning(p_call->arguments[0], GDScriptWarning::UNSAFE_CALL_ARGUMENT, "1", function_name, "<unknown type>", "Variant");
  2640. #endif
  2641. p_call->set_datatype(call_type);
  2642. return;
  2643. }
  2644. }
  2645. List<MethodInfo> constructors;
  2646. Variant::get_constructor_list(builtin_type, &constructors);
  2647. bool match = false;
  2648. for (const MethodInfo &info : constructors) {
  2649. if (p_call->arguments.size() < info.arguments.size() - info.default_arguments.size()) {
  2650. continue;
  2651. }
  2652. if (p_call->arguments.size() > info.arguments.size()) {
  2653. continue;
  2654. }
  2655. bool types_match = true;
  2656. for (int i = 0; i < p_call->arguments.size(); i++) {
  2657. GDScriptParser::DataType par_type = type_from_property(info.arguments[i], true);
  2658. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  2659. if (!is_type_compatible(par_type, arg_type, true)) {
  2660. types_match = false;
  2661. break;
  2662. #ifdef DEBUG_ENABLED
  2663. } else {
  2664. if (par_type.builtin_type == Variant::INT && arg_type.builtin_type == Variant::FLOAT && builtin_type != Variant::INT) {
  2665. parser->push_warning(p_call, GDScriptWarning::NARROWING_CONVERSION, function_name);
  2666. }
  2667. #endif
  2668. }
  2669. }
  2670. if (types_match) {
  2671. for (int i = 0; i < p_call->arguments.size(); i++) {
  2672. GDScriptParser::DataType par_type = type_from_property(info.arguments[i], true);
  2673. if (p_call->arguments[i]->is_constant) {
  2674. update_const_expression_builtin_type(p_call->arguments[i], par_type, "pass");
  2675. }
  2676. #ifdef DEBUG_ENABLED
  2677. if (!(par_type.is_variant() && par_type.is_hard_type())) {
  2678. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  2679. if (arg_type.is_variant() || !arg_type.is_hard_type() || !is_type_compatible(arg_type, par_type, true)) {
  2680. mark_node_unsafe(p_call);
  2681. parser->push_warning(p_call->arguments[i], GDScriptWarning::UNSAFE_CALL_ARGUMENT, itos(i + 1), function_name, par_type.to_string(), arg_type.to_string_strict());
  2682. }
  2683. }
  2684. #endif
  2685. }
  2686. match = true;
  2687. call_type = type_from_property(info.return_val);
  2688. break;
  2689. }
  2690. }
  2691. if (!match) {
  2692. String signature = Variant::get_type_name(builtin_type) + "(";
  2693. for (int i = 0; i < p_call->arguments.size(); i++) {
  2694. if (i > 0) {
  2695. signature += ", ";
  2696. }
  2697. signature += p_call->arguments[i]->get_datatype().to_string();
  2698. }
  2699. signature += ")";
  2700. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call);
  2701. }
  2702. }
  2703. p_call->set_datatype(call_type);
  2704. return;
  2705. } else if (GDScriptUtilityFunctions::function_exists(function_name)) {
  2706. MethodInfo function_info = GDScriptUtilityFunctions::get_function_info(function_name);
  2707. if (!p_is_root && !p_is_await && function_info.return_val.type == Variant::NIL && ((function_info.return_val.usage & PROPERTY_USAGE_NIL_IS_VARIANT) == 0)) {
  2708. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", function_name), p_call);
  2709. }
  2710. if (all_is_constant && GDScriptUtilityFunctions::is_function_constant(function_name)) {
  2711. // Can call on compilation.
  2712. Vector<const Variant *> args;
  2713. for (int i = 0; i < p_call->arguments.size(); i++) {
  2714. args.push_back(&(p_call->arguments[i]->reduced_value));
  2715. }
  2716. Variant value;
  2717. Callable::CallError err;
  2718. GDScriptUtilityFunctions::get_function(function_name)(&value, (const Variant **)args.ptr(), args.size(), err);
  2719. switch (err.error) {
  2720. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  2721. PropertyInfo wrong_arg = function_info.arguments[err.argument];
  2722. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*", function_name, err.argument + 1,
  2723. type_from_property(wrong_arg, true).to_string(), p_call->arguments[err.argument]->get_datatype().to_string()),
  2724. p_call->arguments[err.argument]);
  2725. } break;
  2726. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  2727. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  2728. break;
  2729. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  2730. 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);
  2731. break;
  2732. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  2733. 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);
  2734. break;
  2735. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  2736. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  2737. break; // Can't happen in a builtin constructor.
  2738. case Callable::CallError::CALL_OK:
  2739. p_call->is_constant = true;
  2740. p_call->reduced_value = value;
  2741. break;
  2742. }
  2743. } else {
  2744. validate_call_arg(function_info, p_call);
  2745. }
  2746. p_call->set_datatype(type_from_property(function_info.return_val));
  2747. return;
  2748. } else if (Variant::has_utility_function(function_name)) {
  2749. MethodInfo function_info = info_from_utility_func(function_name);
  2750. if (!p_is_root && !p_is_await && function_info.return_val.type == Variant::NIL && ((function_info.return_val.usage & PROPERTY_USAGE_NIL_IS_VARIANT) == 0)) {
  2751. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", function_name), p_call);
  2752. }
  2753. if (all_is_constant && Variant::get_utility_function_type(function_name) == Variant::UTILITY_FUNC_TYPE_MATH) {
  2754. // Can call on compilation.
  2755. Vector<const Variant *> args;
  2756. for (int i = 0; i < p_call->arguments.size(); i++) {
  2757. args.push_back(&(p_call->arguments[i]->reduced_value));
  2758. }
  2759. Variant value;
  2760. Callable::CallError err;
  2761. Variant::call_utility_function(function_name, &value, (const Variant **)args.ptr(), args.size(), err);
  2762. switch (err.error) {
  2763. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  2764. String expected_type_name;
  2765. if (err.argument < function_info.arguments.size()) {
  2766. expected_type_name = type_from_property(function_info.arguments[err.argument], true).to_string();
  2767. } else {
  2768. expected_type_name = Variant::get_type_name((Variant::Type)err.expected);
  2769. }
  2770. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*", function_name, err.argument + 1,
  2771. expected_type_name, p_call->arguments[err.argument]->get_datatype().to_string()),
  2772. p_call->arguments[err.argument]);
  2773. } break;
  2774. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  2775. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  2776. break;
  2777. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  2778. 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);
  2779. break;
  2780. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  2781. 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);
  2782. break;
  2783. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  2784. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  2785. break; // Can't happen in a builtin constructor.
  2786. case Callable::CallError::CALL_OK:
  2787. p_call->is_constant = true;
  2788. p_call->reduced_value = value;
  2789. break;
  2790. }
  2791. } else {
  2792. validate_call_arg(function_info, p_call);
  2793. }
  2794. p_call->set_datatype(type_from_property(function_info.return_val));
  2795. return;
  2796. }
  2797. }
  2798. GDScriptParser::DataType base_type;
  2799. call_type.kind = GDScriptParser::DataType::VARIANT;
  2800. bool is_self = false;
  2801. if (p_call->is_super) {
  2802. base_type = parser->current_class->base_type;
  2803. base_type.is_meta_type = false;
  2804. is_self = true;
  2805. if (p_call->callee == nullptr && current_lambda != nullptr) {
  2806. push_error("Cannot use `super()` inside a lambda.", p_call);
  2807. }
  2808. } else if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  2809. base_type = parser->current_class->get_datatype();
  2810. base_type.is_meta_type = false;
  2811. is_self = true;
  2812. } else if (callee_type == GDScriptParser::Node::SUBSCRIPT) {
  2813. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee);
  2814. if (subscript->base == nullptr) {
  2815. // Invalid syntax, error already set on parser.
  2816. p_call->set_datatype(call_type);
  2817. mark_node_unsafe(p_call);
  2818. return;
  2819. }
  2820. if (!subscript->is_attribute) {
  2821. // Invalid call. Error already sent in parser.
  2822. // TODO: Could check if Callable here.
  2823. p_call->set_datatype(call_type);
  2824. mark_node_unsafe(p_call);
  2825. return;
  2826. }
  2827. if (subscript->attribute == nullptr) {
  2828. // Invalid call. Error already sent in parser.
  2829. p_call->set_datatype(call_type);
  2830. mark_node_unsafe(p_call);
  2831. return;
  2832. }
  2833. GDScriptParser::IdentifierNode *base_id = nullptr;
  2834. if (subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  2835. base_id = static_cast<GDScriptParser::IdentifierNode *>(subscript->base);
  2836. }
  2837. if (base_id && GDScriptParser::get_builtin_type(base_id->name) < Variant::VARIANT_MAX) {
  2838. base_type = make_builtin_meta_type(GDScriptParser::get_builtin_type(base_id->name));
  2839. } else {
  2840. reduce_expression(subscript->base);
  2841. base_type = subscript->base->get_datatype();
  2842. is_self = subscript->base->type == GDScriptParser::Node::SELF;
  2843. }
  2844. } else {
  2845. // Invalid call. Error already sent in parser.
  2846. // TODO: Could check if Callable here too.
  2847. p_call->set_datatype(call_type);
  2848. mark_node_unsafe(p_call);
  2849. return;
  2850. }
  2851. int default_arg_count = 0;
  2852. BitField<MethodFlags> method_flags;
  2853. GDScriptParser::DataType return_type;
  2854. List<GDScriptParser::DataType> par_types;
  2855. bool is_constructor = (base_type.is_meta_type || (p_call->callee && p_call->callee->type == GDScriptParser::Node::IDENTIFIER)) && p_call->function_name == SNAME("new");
  2856. if (is_constructor && Engine::get_singleton()->has_singleton(base_type.native_type)) {
  2857. push_error(vformat(R"(Cannot construct native class "%s" because it is an engine singleton.)", base_type.native_type), p_call);
  2858. p_call->set_datatype(call_type);
  2859. return;
  2860. }
  2861. if (get_function_signature(p_call, is_constructor, base_type, p_call->function_name, return_type, par_types, default_arg_count, method_flags)) {
  2862. // If the method is implemented in the class hierarchy, the virtual flag will not be set for that MethodInfo and the search stops there.
  2863. // Virtual check only possible for super() calls because class hierarchy is known. Node/Objects may have scripts attached we don't know of at compile-time.
  2864. if (p_call->is_super && method_flags.has_flag(METHOD_FLAG_VIRTUAL)) {
  2865. push_error(vformat(R"*(Cannot call the parent class' virtual function "%s()" because it hasn't been defined.)*", p_call->function_name), p_call);
  2866. }
  2867. // If the function requires typed arrays we must make literals be typed.
  2868. for (const KeyValue<int, GDScriptParser::ArrayNode *> &E : arrays) {
  2869. int index = E.key;
  2870. if (index < par_types.size() && par_types[index].is_hard_type() && par_types[index].has_container_element_type()) {
  2871. update_array_literal_element_type(E.value, par_types[index].get_container_element_type());
  2872. }
  2873. }
  2874. validate_call_arg(par_types, default_arg_count, method_flags.has_flag(METHOD_FLAG_VARARG), p_call);
  2875. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type) {
  2876. // Enum type is treated as a dictionary value for function calls.
  2877. base_type.is_meta_type = false;
  2878. }
  2879. if (is_self && static_context && !method_flags.has_flag(METHOD_FLAG_STATIC)) {
  2880. if (parser->current_function) {
  2881. // Get the parent function above any lambda.
  2882. GDScriptParser::FunctionNode *parent_function = parser->current_function;
  2883. while (parent_function->source_lambda) {
  2884. parent_function = parent_function->source_lambda->parent_function;
  2885. }
  2886. push_error(vformat(R"*(Cannot call non-static function "%s()" from static function "%s()".)*", p_call->function_name, parent_function->identifier->name), p_call);
  2887. } else {
  2888. push_error(vformat(R"*(Cannot call non-static function "%s()" for static variable initializer.)*", p_call->function_name), p_call);
  2889. }
  2890. } else if (!is_self && base_type.is_meta_type && !method_flags.has_flag(METHOD_FLAG_STATIC)) {
  2891. base_type.is_meta_type = false; // For `to_string()`.
  2892. 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);
  2893. } else if (is_self && !method_flags.has_flag(METHOD_FLAG_STATIC)) {
  2894. mark_lambda_use_self();
  2895. }
  2896. if (!p_is_root && !p_is_await && return_type.is_hard_type() && return_type.kind == GDScriptParser::DataType::BUILTIN && return_type.builtin_type == Variant::NIL) {
  2897. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", p_call->function_name), p_call);
  2898. }
  2899. #ifdef DEBUG_ENABLED
  2900. if (p_is_root && return_type.kind != GDScriptParser::DataType::UNRESOLVED && return_type.builtin_type != Variant::NIL &&
  2901. !(p_call->is_super && p_call->function_name == GDScriptLanguage::get_singleton()->strings._init)) {
  2902. parser->push_warning(p_call, GDScriptWarning::RETURN_VALUE_DISCARDED, p_call->function_name);
  2903. }
  2904. if (method_flags.has_flag(METHOD_FLAG_STATIC) && !is_constructor && !base_type.is_meta_type && !(is_self && static_context)) {
  2905. String caller_type = String(base_type.native_type);
  2906. if (caller_type.is_empty()) {
  2907. caller_type = base_type.to_string();
  2908. }
  2909. parser->push_warning(p_call, GDScriptWarning::STATIC_CALLED_ON_INSTANCE, p_call->function_name, caller_type);
  2910. }
  2911. #endif // DEBUG_ENABLED
  2912. call_type = return_type;
  2913. } else {
  2914. bool found = false;
  2915. // Enums do not have functions other than the built-in dictionary ones.
  2916. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type) {
  2917. if (base_type.builtin_type == Variant::DICTIONARY) {
  2918. push_error(vformat(R"*(Enums only have Dictionary built-in methods. Function "%s()" does not exist for enum "%s".)*", p_call->function_name, base_type.enum_type), p_call->callee);
  2919. } else {
  2920. push_error(vformat(R"*(The native enum "%s" does not behave like Dictionary and does not have methods of its own.)*", base_type.enum_type), p_call->callee);
  2921. }
  2922. } else if (!p_call->is_super && callee_type != GDScriptParser::Node::NONE) { // Check if the name exists as something else.
  2923. GDScriptParser::IdentifierNode *callee_id;
  2924. if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  2925. callee_id = static_cast<GDScriptParser::IdentifierNode *>(p_call->callee);
  2926. } else {
  2927. // Can only be attribute.
  2928. callee_id = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee)->attribute;
  2929. }
  2930. if (callee_id) {
  2931. reduce_identifier_from_base(callee_id, &base_type);
  2932. GDScriptParser::DataType callee_datatype = callee_id->get_datatype();
  2933. if (callee_datatype.is_set() && !callee_datatype.is_variant()) {
  2934. found = true;
  2935. if (callee_datatype.builtin_type == Variant::CALLABLE) {
  2936. 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);
  2937. } else {
  2938. 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);
  2939. }
  2940. #ifdef DEBUG_ENABLED
  2941. } else if (!is_self && !(base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN)) {
  2942. parser->push_warning(p_call, GDScriptWarning::UNSAFE_METHOD_ACCESS, p_call->function_name, base_type.to_string());
  2943. mark_node_unsafe(p_call);
  2944. #endif
  2945. }
  2946. }
  2947. }
  2948. if (!found && (is_self || (base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN))) {
  2949. String base_name = is_self && !p_call->is_super ? "self" : base_type.to_string();
  2950. #ifdef SUGGEST_GODOT4_RENAMES
  2951. String rename_hint = String();
  2952. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::Code::RENAMED_IN_GODOT_4_HINT)).booleanize()) {
  2953. const char *renamed_function_name = check_for_renamed_identifier(p_call->function_name, p_call->type);
  2954. if (renamed_function_name) {
  2955. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", String(renamed_function_name) + "()");
  2956. }
  2957. }
  2958. push_error(vformat(R"*(Function "%s()" not found in base %s.%s)*", p_call->function_name, base_name, rename_hint), p_call->is_super ? p_call : p_call->callee);
  2959. #else
  2960. 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);
  2961. #endif // SUGGEST_GODOT4_RENAMES
  2962. } else if (!found && (!p_call->is_super && base_type.is_hard_type() && base_type.is_meta_type)) {
  2963. push_error(vformat(R"*(Static function "%s()" not found in base "%s".)*", p_call->function_name, base_type.to_string()), p_call);
  2964. }
  2965. }
  2966. if (call_type.is_coroutine && !p_is_await && !p_is_root) {
  2967. push_error(vformat(R"*(Function "%s()" is a coroutine, so it must be called with "await".)*", p_call->function_name), p_call);
  2968. }
  2969. p_call->set_datatype(call_type);
  2970. }
  2971. void GDScriptAnalyzer::reduce_cast(GDScriptParser::CastNode *p_cast) {
  2972. reduce_expression(p_cast->operand);
  2973. GDScriptParser::DataType cast_type = type_from_metatype(resolve_datatype(p_cast->cast_type));
  2974. if (!cast_type.is_set()) {
  2975. mark_node_unsafe(p_cast);
  2976. return;
  2977. }
  2978. p_cast->set_datatype(cast_type);
  2979. if (p_cast->operand->is_constant) {
  2980. update_const_expression_builtin_type(p_cast->operand, cast_type, "cast", true);
  2981. if (cast_type.is_variant() || p_cast->operand->get_datatype() == cast_type) {
  2982. p_cast->is_constant = true;
  2983. p_cast->reduced_value = p_cast->operand->reduced_value;
  2984. }
  2985. }
  2986. if (p_cast->operand->type == GDScriptParser::Node::ARRAY && cast_type.has_container_element_type()) {
  2987. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_cast->operand), cast_type.get_container_element_type());
  2988. }
  2989. if (!cast_type.is_variant()) {
  2990. GDScriptParser::DataType op_type = p_cast->operand->get_datatype();
  2991. if (op_type.is_variant() || !op_type.is_hard_type()) {
  2992. mark_node_unsafe(p_cast);
  2993. #ifdef DEBUG_ENABLED
  2994. if (op_type.is_variant() && !op_type.is_hard_type()) {
  2995. parser->push_warning(p_cast, GDScriptWarning::UNSAFE_CAST, cast_type.to_string());
  2996. }
  2997. #endif
  2998. } else {
  2999. bool valid = false;
  3000. if (op_type.builtin_type == Variant::INT && cast_type.kind == GDScriptParser::DataType::ENUM) {
  3001. mark_node_unsafe(p_cast);
  3002. valid = true;
  3003. } else if (op_type.kind == GDScriptParser::DataType::BUILTIN && cast_type.kind == GDScriptParser::DataType::BUILTIN) {
  3004. valid = Variant::can_convert(op_type.builtin_type, cast_type.builtin_type);
  3005. } else if (op_type.kind != GDScriptParser::DataType::BUILTIN && cast_type.kind != GDScriptParser::DataType::BUILTIN) {
  3006. valid = is_type_compatible(cast_type, op_type) || is_type_compatible(op_type, cast_type);
  3007. }
  3008. if (!valid) {
  3009. push_error(vformat(R"(Invalid cast. Cannot convert from "%s" to "%s".)", op_type.to_string(), cast_type.to_string()), p_cast->cast_type);
  3010. }
  3011. }
  3012. }
  3013. }
  3014. void GDScriptAnalyzer::reduce_dictionary(GDScriptParser::DictionaryNode *p_dictionary) {
  3015. HashMap<Variant, GDScriptParser::ExpressionNode *, VariantHasher, StringLikeVariantComparator> elements;
  3016. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  3017. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  3018. if (p_dictionary->style == GDScriptParser::DictionaryNode::PYTHON_DICT) {
  3019. reduce_expression(element.key);
  3020. }
  3021. reduce_expression(element.value);
  3022. if (element.key->is_constant) {
  3023. if (elements.has(element.key->reduced_value)) {
  3024. 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);
  3025. } else {
  3026. elements[element.key->reduced_value] = element.value;
  3027. }
  3028. }
  3029. }
  3030. // It's dictionary in any case.
  3031. GDScriptParser::DataType dict_type;
  3032. dict_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3033. dict_type.kind = GDScriptParser::DataType::BUILTIN;
  3034. dict_type.builtin_type = Variant::DICTIONARY;
  3035. dict_type.is_constant = true;
  3036. p_dictionary->set_datatype(dict_type);
  3037. }
  3038. void GDScriptAnalyzer::reduce_get_node(GDScriptParser::GetNodeNode *p_get_node) {
  3039. GDScriptParser::DataType result;
  3040. result.kind = GDScriptParser::DataType::VARIANT;
  3041. if (!ClassDB::is_parent_class(parser->current_class->base_type.native_type, SNAME("Node"))) {
  3042. push_error(vformat(R"*(Cannot use shorthand "get_node()" notation ("%c") on a class that isn't a node.)*", p_get_node->use_dollar ? '$' : '%'), p_get_node);
  3043. p_get_node->set_datatype(result);
  3044. return;
  3045. }
  3046. if (static_context) {
  3047. push_error(vformat(R"*(Cannot use shorthand "get_node()" notation ("%c") in a static function.)*", p_get_node->use_dollar ? '$' : '%'), p_get_node);
  3048. p_get_node->set_datatype(result);
  3049. return;
  3050. }
  3051. mark_lambda_use_self();
  3052. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3053. result.kind = GDScriptParser::DataType::NATIVE;
  3054. result.builtin_type = Variant::OBJECT;
  3055. result.native_type = SNAME("Node");
  3056. p_get_node->set_datatype(result);
  3057. }
  3058. GDScriptParser::DataType GDScriptAnalyzer::make_global_class_meta_type(const StringName &p_class_name, const GDScriptParser::Node *p_source) {
  3059. GDScriptParser::DataType type;
  3060. String path = ScriptServer::get_global_class_path(p_class_name);
  3061. String ext = path.get_extension();
  3062. if (ext == GDScriptLanguage::get_singleton()->get_extension()) {
  3063. Ref<GDScriptParserRef> ref = get_parser_for(path);
  3064. if (ref.is_null()) {
  3065. push_error(vformat(R"(Could not find script for class "%s".)", p_class_name), p_source);
  3066. type.type_source = GDScriptParser::DataType::UNDETECTED;
  3067. type.kind = GDScriptParser::DataType::VARIANT;
  3068. return type;
  3069. }
  3070. Error err = ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3071. if (err) {
  3072. push_error(vformat(R"(Could not resolve class "%s", because of a parser error.)", p_class_name), p_source);
  3073. type.type_source = GDScriptParser::DataType::UNDETECTED;
  3074. type.kind = GDScriptParser::DataType::VARIANT;
  3075. return type;
  3076. }
  3077. return ref->get_parser()->head->get_datatype();
  3078. } else {
  3079. return make_script_meta_type(ResourceLoader::load(path, "Script"));
  3080. }
  3081. }
  3082. void GDScriptAnalyzer::reduce_identifier_from_base_set_class(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType p_identifier_datatype) {
  3083. ERR_FAIL_NULL(p_identifier);
  3084. p_identifier->set_datatype(p_identifier_datatype);
  3085. Error err = OK;
  3086. Ref<GDScript> scr = GDScriptCache::get_shallow_script(p_identifier_datatype.script_path, err, parser->script_path);
  3087. if (err) {
  3088. push_error(vformat(R"(Error while getting cache for script "%s".)", p_identifier_datatype.script_path), p_identifier);
  3089. return;
  3090. }
  3091. p_identifier->reduced_value = scr->find_class(p_identifier_datatype.class_type->fqcn);
  3092. p_identifier->is_constant = true;
  3093. }
  3094. void GDScriptAnalyzer::reduce_identifier_from_base(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType *p_base) {
  3095. if (!p_identifier->get_datatype().has_no_type()) {
  3096. return;
  3097. }
  3098. GDScriptParser::DataType base;
  3099. if (p_base == nullptr) {
  3100. base = type_from_metatype(parser->current_class->get_datatype());
  3101. } else {
  3102. base = *p_base;
  3103. }
  3104. StringName name = p_identifier->name;
  3105. if (base.kind == GDScriptParser::DataType::ENUM) {
  3106. if (base.is_meta_type) {
  3107. if (base.enum_values.has(name)) {
  3108. p_identifier->set_datatype(type_from_metatype(base));
  3109. p_identifier->is_constant = true;
  3110. p_identifier->reduced_value = base.enum_values[name];
  3111. return;
  3112. }
  3113. // Enum does not have this value, return.
  3114. return;
  3115. } else {
  3116. push_error(R"(Cannot get property from enum value.)", p_identifier);
  3117. return;
  3118. }
  3119. }
  3120. if (base.kind == GDScriptParser::DataType::BUILTIN) {
  3121. if (base.is_meta_type) {
  3122. bool valid = true;
  3123. Variant result = Variant::get_constant_value(base.builtin_type, name, &valid);
  3124. if (valid) {
  3125. p_identifier->is_constant = true;
  3126. p_identifier->reduced_value = result;
  3127. p_identifier->set_datatype(type_from_variant(result, p_identifier));
  3128. } else if (base.is_hard_type()) {
  3129. #ifdef SUGGEST_GODOT4_RENAMES
  3130. String rename_hint = String();
  3131. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::Code::RENAMED_IN_GODOT_4_HINT)).booleanize()) {
  3132. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  3133. if (renamed_identifier_name) {
  3134. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  3135. }
  3136. }
  3137. push_error(vformat(R"(Cannot find constant "%s" on base "%s".%s)", name, base.to_string(), rename_hint), p_identifier);
  3138. #else
  3139. push_error(vformat(R"(Cannot find constant "%s" on base "%s".)", name, base.to_string()), p_identifier);
  3140. #endif // SUGGEST_GODOT4_RENAMES
  3141. }
  3142. } else {
  3143. switch (base.builtin_type) {
  3144. case Variant::NIL: {
  3145. if (base.is_hard_type()) {
  3146. push_error(vformat(R"(Invalid get index "%s" on base Nil)", name), p_identifier);
  3147. }
  3148. return;
  3149. }
  3150. case Variant::DICTIONARY: {
  3151. GDScriptParser::DataType dummy;
  3152. dummy.kind = GDScriptParser::DataType::VARIANT;
  3153. p_identifier->set_datatype(dummy);
  3154. return;
  3155. }
  3156. default: {
  3157. Callable::CallError temp;
  3158. Variant dummy;
  3159. Variant::construct(base.builtin_type, dummy, nullptr, 0, temp);
  3160. List<PropertyInfo> properties;
  3161. dummy.get_property_list(&properties);
  3162. for (const PropertyInfo &prop : properties) {
  3163. if (prop.name == name) {
  3164. p_identifier->set_datatype(type_from_property(prop));
  3165. return;
  3166. }
  3167. }
  3168. if (base.is_hard_type()) {
  3169. #ifdef SUGGEST_GODOT4_RENAMES
  3170. String rename_hint = String();
  3171. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::Code::RENAMED_IN_GODOT_4_HINT)).booleanize()) {
  3172. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  3173. if (renamed_identifier_name) {
  3174. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  3175. }
  3176. }
  3177. push_error(vformat(R"(Cannot find property "%s" on base "%s".%s)", name, base.to_string(), rename_hint), p_identifier);
  3178. #else
  3179. push_error(vformat(R"(Cannot find property "%s" on base "%s".)", name, base.to_string()), p_identifier);
  3180. #endif // SUGGEST_GODOT4_RENAMES
  3181. }
  3182. }
  3183. }
  3184. }
  3185. return;
  3186. }
  3187. GDScriptParser::ClassNode *base_class = base.class_type;
  3188. List<GDScriptParser::ClassNode *> script_classes;
  3189. bool is_base = true;
  3190. if (base_class != nullptr) {
  3191. get_class_node_current_scope_classes(base_class, &script_classes);
  3192. }
  3193. bool is_constructor = base.is_meta_type && p_identifier->name == SNAME("new");
  3194. for (GDScriptParser::ClassNode *script_class : script_classes) {
  3195. if (p_base == nullptr && script_class->identifier && script_class->identifier->name == name) {
  3196. reduce_identifier_from_base_set_class(p_identifier, script_class->get_datatype());
  3197. if (script_class->outer != nullptr) {
  3198. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CLASS;
  3199. }
  3200. return;
  3201. }
  3202. if (is_constructor) {
  3203. name = "_init";
  3204. }
  3205. if (script_class->has_member(name)) {
  3206. resolve_class_member(script_class, name, p_identifier);
  3207. GDScriptParser::ClassNode::Member member = script_class->get_member(name);
  3208. switch (member.type) {
  3209. case GDScriptParser::ClassNode::Member::CONSTANT: {
  3210. p_identifier->set_datatype(member.get_datatype());
  3211. p_identifier->is_constant = true;
  3212. p_identifier->reduced_value = member.constant->initializer->reduced_value;
  3213. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3214. p_identifier->constant_source = member.constant;
  3215. return;
  3216. }
  3217. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  3218. p_identifier->set_datatype(member.get_datatype());
  3219. p_identifier->is_constant = true;
  3220. p_identifier->reduced_value = member.enum_value.value;
  3221. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3222. return;
  3223. }
  3224. case GDScriptParser::ClassNode::Member::ENUM: {
  3225. p_identifier->set_datatype(member.get_datatype());
  3226. p_identifier->is_constant = true;
  3227. p_identifier->reduced_value = member.m_enum->dictionary;
  3228. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3229. return;
  3230. }
  3231. case GDScriptParser::ClassNode::Member::VARIABLE: {
  3232. if (is_base && (!base.is_meta_type || member.variable->is_static)) {
  3233. p_identifier->set_datatype(member.get_datatype());
  3234. p_identifier->source = member.variable->is_static ? GDScriptParser::IdentifierNode::STATIC_VARIABLE : GDScriptParser::IdentifierNode::MEMBER_VARIABLE;
  3235. p_identifier->variable_source = member.variable;
  3236. member.variable->usages += 1;
  3237. return;
  3238. }
  3239. } break;
  3240. case GDScriptParser::ClassNode::Member::SIGNAL: {
  3241. if (is_base && !base.is_meta_type) {
  3242. p_identifier->set_datatype(member.get_datatype());
  3243. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  3244. return;
  3245. }
  3246. } break;
  3247. case GDScriptParser::ClassNode::Member::FUNCTION: {
  3248. if (is_base && (!base.is_meta_type || member.function->is_static)) {
  3249. p_identifier->set_datatype(make_callable_type(member.function->info));
  3250. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_FUNCTION;
  3251. return;
  3252. }
  3253. } break;
  3254. case GDScriptParser::ClassNode::Member::CLASS: {
  3255. reduce_identifier_from_base_set_class(p_identifier, member.get_datatype());
  3256. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CLASS;
  3257. return;
  3258. }
  3259. default: {
  3260. // Do nothing
  3261. }
  3262. }
  3263. }
  3264. if (is_base) {
  3265. is_base = script_class->base_type.class_type != nullptr;
  3266. if (!is_base && p_base != nullptr) {
  3267. break;
  3268. }
  3269. }
  3270. }
  3271. // Check native members. No need for native class recursion because Node exposes all Object's properties.
  3272. const StringName &native = base.native_type;
  3273. if (class_exists(native)) {
  3274. if (is_constructor) {
  3275. name = "_init";
  3276. }
  3277. MethodInfo method_info;
  3278. if (ClassDB::has_property(native, name)) {
  3279. StringName getter_name = ClassDB::get_property_getter(native, name);
  3280. MethodBind *getter = ClassDB::get_method(native, getter_name);
  3281. if (getter != nullptr) {
  3282. bool has_setter = ClassDB::get_property_setter(native, name) != StringName();
  3283. p_identifier->set_datatype(type_from_property(getter->get_return_info(), false, !has_setter));
  3284. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3285. }
  3286. return;
  3287. }
  3288. if (ClassDB::get_method_info(native, name, &method_info)) {
  3289. // Method is callable.
  3290. p_identifier->set_datatype(make_callable_type(method_info));
  3291. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3292. return;
  3293. }
  3294. if (ClassDB::get_signal(native, name, &method_info)) {
  3295. // Signal is a type too.
  3296. p_identifier->set_datatype(make_signal_type(method_info));
  3297. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3298. return;
  3299. }
  3300. if (ClassDB::has_enum(native, name)) {
  3301. p_identifier->set_datatype(make_native_enum_type(name, native));
  3302. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3303. return;
  3304. }
  3305. bool valid = false;
  3306. int64_t int_constant = ClassDB::get_integer_constant(native, name, &valid);
  3307. if (valid) {
  3308. p_identifier->is_constant = true;
  3309. p_identifier->reduced_value = int_constant;
  3310. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3311. // Check whether this constant, which exists, belongs to an enum
  3312. StringName enum_name = ClassDB::get_integer_constant_enum(native, name);
  3313. if (enum_name != StringName()) {
  3314. p_identifier->set_datatype(make_native_enum_type(enum_name, native, false));
  3315. } else {
  3316. p_identifier->set_datatype(type_from_variant(int_constant, p_identifier));
  3317. }
  3318. }
  3319. }
  3320. }
  3321. void GDScriptAnalyzer::reduce_identifier(GDScriptParser::IdentifierNode *p_identifier, bool can_be_builtin) {
  3322. // TODO: This is an opportunity to further infer types.
  3323. // Check if we are inside an enum. This allows enum values to access other elements of the same enum.
  3324. if (current_enum) {
  3325. for (int i = 0; i < current_enum->values.size(); i++) {
  3326. const GDScriptParser::EnumNode::Value &element = current_enum->values[i];
  3327. if (element.identifier->name == p_identifier->name) {
  3328. StringName enum_name = current_enum->identifier ? current_enum->identifier->name : UNNAMED_ENUM;
  3329. GDScriptParser::DataType type = make_enum_type(enum_name, parser->current_class->fqcn, false);
  3330. if (element.parent_enum->identifier) {
  3331. type.enum_type = element.parent_enum->identifier->name;
  3332. }
  3333. p_identifier->set_datatype(type);
  3334. if (element.resolved) {
  3335. p_identifier->is_constant = true;
  3336. p_identifier->reduced_value = element.value;
  3337. } else {
  3338. push_error(R"(Cannot use another enum element before it was declared.)", p_identifier);
  3339. }
  3340. return; // Found anyway.
  3341. }
  3342. }
  3343. }
  3344. bool found_source = false;
  3345. // Check if identifier is local.
  3346. // If that's the case, the declaration already was solved before.
  3347. switch (p_identifier->source) {
  3348. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER:
  3349. p_identifier->set_datatype(p_identifier->parameter_source->get_datatype());
  3350. found_source = true;
  3351. break;
  3352. case GDScriptParser::IdentifierNode::LOCAL_CONSTANT:
  3353. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  3354. p_identifier->set_datatype(p_identifier->constant_source->get_datatype());
  3355. p_identifier->is_constant = true;
  3356. // TODO: Constant should have a value on the node itself.
  3357. p_identifier->reduced_value = p_identifier->constant_source->initializer->reduced_value;
  3358. found_source = true;
  3359. break;
  3360. case GDScriptParser::IdentifierNode::MEMBER_SIGNAL:
  3361. case GDScriptParser::IdentifierNode::INHERITED_VARIABLE:
  3362. mark_lambda_use_self();
  3363. break;
  3364. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  3365. mark_lambda_use_self();
  3366. p_identifier->variable_source->usages++;
  3367. [[fallthrough]];
  3368. case GDScriptParser::IdentifierNode::STATIC_VARIABLE:
  3369. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE:
  3370. p_identifier->set_datatype(p_identifier->variable_source->get_datatype());
  3371. found_source = true;
  3372. break;
  3373. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR:
  3374. p_identifier->set_datatype(p_identifier->bind_source->get_datatype());
  3375. found_source = true;
  3376. break;
  3377. case GDScriptParser::IdentifierNode::LOCAL_BIND: {
  3378. GDScriptParser::DataType result = p_identifier->bind_source->get_datatype();
  3379. result.is_constant = true;
  3380. p_identifier->set_datatype(result);
  3381. found_source = true;
  3382. } break;
  3383. case GDScriptParser::IdentifierNode::UNDEFINED_SOURCE:
  3384. case GDScriptParser::IdentifierNode::MEMBER_FUNCTION:
  3385. case GDScriptParser::IdentifierNode::MEMBER_CLASS:
  3386. break;
  3387. }
  3388. #ifdef DEBUG_ENABLED
  3389. if (!found_source && p_identifier->suite != nullptr && p_identifier->suite->has_local(p_identifier->name)) {
  3390. parser->push_warning(p_identifier, GDScriptWarning::CONFUSABLE_LOCAL_USAGE, p_identifier->name);
  3391. }
  3392. #endif
  3393. // Not a local, so check members.
  3394. if (!found_source) {
  3395. reduce_identifier_from_base(p_identifier);
  3396. if (p_identifier->source != GDScriptParser::IdentifierNode::UNDEFINED_SOURCE || p_identifier->get_datatype().is_set()) {
  3397. // Found.
  3398. found_source = true;
  3399. }
  3400. }
  3401. if (found_source) {
  3402. bool source_is_variable = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_VARIABLE || p_identifier->source == GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3403. bool source_is_signal = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  3404. if ((source_is_variable || source_is_signal) && static_context) {
  3405. if (parser->current_function) {
  3406. // Get the parent function above any lambda.
  3407. GDScriptParser::FunctionNode *parent_function = parser->current_function;
  3408. while (parent_function->source_lambda) {
  3409. parent_function = parent_function->source_lambda->parent_function;
  3410. }
  3411. push_error(vformat(R"*(Cannot access %s "%s" from the static function "%s()".)*", source_is_signal ? "signal" : "instance variable", p_identifier->name, parent_function->identifier->name), p_identifier);
  3412. } else {
  3413. push_error(vformat(R"*(Cannot access %s "%s" for a static variable initializer.)*", source_is_signal ? "signal" : "instance variable", p_identifier->name), p_identifier);
  3414. }
  3415. }
  3416. if (current_lambda != nullptr) {
  3417. // If the identifier is a member variable (including the native class properties) or a signal, we consider the lambda to be using `self`, so we keep a reference to the current instance.
  3418. if (source_is_variable || source_is_signal) {
  3419. mark_lambda_use_self();
  3420. return; // No need to capture.
  3421. }
  3422. // If the identifier is local, check if it's any kind of capture by comparing their source function.
  3423. // Only capture locals and enum values. Constants are still accessible from the lambda using the script reference. If not, this method is done.
  3424. if (p_identifier->source == GDScriptParser::IdentifierNode::UNDEFINED_SOURCE || p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_CONSTANT) {
  3425. return;
  3426. }
  3427. GDScriptParser::FunctionNode *function_test = current_lambda->function;
  3428. // Make sure we aren't capturing variable in the same lambda.
  3429. // This also add captures for nested lambdas.
  3430. 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)) {
  3431. function_test->source_lambda->captures_indices[p_identifier->name] = function_test->source_lambda->captures.size();
  3432. function_test->source_lambda->captures.push_back(p_identifier);
  3433. function_test = function_test->source_lambda->parent_function;
  3434. }
  3435. }
  3436. return;
  3437. }
  3438. StringName name = p_identifier->name;
  3439. p_identifier->source = GDScriptParser::IdentifierNode::UNDEFINED_SOURCE;
  3440. // Not a local or a member, so check globals.
  3441. Variant::Type builtin_type = GDScriptParser::get_builtin_type(name);
  3442. if (builtin_type < Variant::VARIANT_MAX) {
  3443. if (can_be_builtin) {
  3444. p_identifier->set_datatype(make_builtin_meta_type(builtin_type));
  3445. return;
  3446. } else {
  3447. push_error(R"(Builtin type cannot be used as a name on its own.)", p_identifier);
  3448. }
  3449. }
  3450. if (class_exists(name)) {
  3451. p_identifier->set_datatype(make_native_meta_type(name));
  3452. return;
  3453. }
  3454. if (ScriptServer::is_global_class(name)) {
  3455. p_identifier->set_datatype(make_global_class_meta_type(name, p_identifier));
  3456. return;
  3457. }
  3458. // Try singletons.
  3459. // Do this before globals because this might be a singleton loading another one before it's compiled.
  3460. if (ProjectSettings::get_singleton()->has_autoload(name)) {
  3461. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(name);
  3462. if (autoload.is_singleton) {
  3463. // Singleton exists, so it's at least a Node.
  3464. GDScriptParser::DataType result;
  3465. result.kind = GDScriptParser::DataType::NATIVE;
  3466. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3467. if (ResourceLoader::get_resource_type(autoload.path) == "GDScript") {
  3468. Ref<GDScriptParserRef> singl_parser = get_parser_for(autoload.path);
  3469. if (singl_parser.is_valid()) {
  3470. Error err = singl_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3471. if (err == OK) {
  3472. result = type_from_metatype(singl_parser->get_parser()->head->get_datatype());
  3473. }
  3474. }
  3475. } else if (ResourceLoader::get_resource_type(autoload.path) == "PackedScene") {
  3476. if (GDScriptLanguage::get_singleton()->has_any_global_constant(name)) {
  3477. Variant constant = GDScriptLanguage::get_singleton()->get_any_global_constant(name);
  3478. Node *node = Object::cast_to<Node>(constant);
  3479. if (node != nullptr) {
  3480. Ref<GDScript> scr = node->get_script();
  3481. if (scr.is_valid()) {
  3482. Ref<GDScriptParserRef> singl_parser = get_parser_for(scr->get_script_path());
  3483. if (singl_parser.is_valid()) {
  3484. Error err = singl_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3485. if (err == OK) {
  3486. result = type_from_metatype(singl_parser->get_parser()->head->get_datatype());
  3487. }
  3488. }
  3489. }
  3490. }
  3491. }
  3492. }
  3493. result.is_constant = true;
  3494. p_identifier->set_datatype(result);
  3495. return;
  3496. }
  3497. }
  3498. if (CoreConstants::is_global_constant(name)) {
  3499. int index = CoreConstants::get_global_constant_index(name);
  3500. StringName enum_name = CoreConstants::get_global_constant_enum(index);
  3501. int64_t value = CoreConstants::get_global_constant_value(index);
  3502. if (enum_name != StringName()) {
  3503. p_identifier->set_datatype(make_global_enum_type(enum_name, StringName(), false));
  3504. } else {
  3505. p_identifier->set_datatype(type_from_variant(value, p_identifier));
  3506. }
  3507. p_identifier->is_constant = true;
  3508. p_identifier->reduced_value = value;
  3509. return;
  3510. }
  3511. if (GDScriptLanguage::get_singleton()->has_any_global_constant(name)) {
  3512. Variant constant = GDScriptLanguage::get_singleton()->get_any_global_constant(name);
  3513. p_identifier->set_datatype(type_from_variant(constant, p_identifier));
  3514. p_identifier->is_constant = true;
  3515. p_identifier->reduced_value = constant;
  3516. return;
  3517. }
  3518. if (CoreConstants::is_global_enum(name)) {
  3519. p_identifier->set_datatype(make_global_enum_type(name, StringName(), true));
  3520. if (!can_be_builtin) {
  3521. push_error(vformat(R"(Global enum "%s" cannot be used on its own.)", name), p_identifier);
  3522. }
  3523. return;
  3524. }
  3525. // Allow "Variant" here since it might be used for nested enums.
  3526. if (can_be_builtin && name == SNAME("Variant")) {
  3527. GDScriptParser::DataType variant;
  3528. variant.kind = GDScriptParser::DataType::VARIANT;
  3529. variant.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3530. variant.is_meta_type = true;
  3531. variant.is_pseudo_type = true;
  3532. p_identifier->set_datatype(variant);
  3533. return;
  3534. }
  3535. // Not found.
  3536. // Check if it's a builtin function.
  3537. if (GDScriptUtilityFunctions::function_exists(name)) {
  3538. push_error(vformat(R"(Built-in function "%s" cannot be used as an identifier.)", name), p_identifier);
  3539. } else {
  3540. #ifdef SUGGEST_GODOT4_RENAMES
  3541. String rename_hint = String();
  3542. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::Code::RENAMED_IN_GODOT_4_HINT)).booleanize()) {
  3543. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  3544. if (renamed_identifier_name) {
  3545. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  3546. }
  3547. }
  3548. push_error(vformat(R"(Identifier "%s" not declared in the current scope.%s)", name, rename_hint), p_identifier);
  3549. #else
  3550. push_error(vformat(R"(Identifier "%s" not declared in the current scope.)", name), p_identifier);
  3551. #endif // SUGGEST_GODOT4_RENAMES
  3552. }
  3553. GDScriptParser::DataType dummy;
  3554. dummy.kind = GDScriptParser::DataType::VARIANT;
  3555. p_identifier->set_datatype(dummy); // Just so type is set to something.
  3556. }
  3557. void GDScriptAnalyzer::reduce_lambda(GDScriptParser::LambdaNode *p_lambda) {
  3558. // Lambda is always a Callable.
  3559. GDScriptParser::DataType lambda_type;
  3560. lambda_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  3561. lambda_type.kind = GDScriptParser::DataType::BUILTIN;
  3562. lambda_type.builtin_type = Variant::CALLABLE;
  3563. p_lambda->set_datatype(lambda_type);
  3564. if (p_lambda->function == nullptr) {
  3565. return;
  3566. }
  3567. GDScriptParser::LambdaNode *previous_lambda = current_lambda;
  3568. current_lambda = p_lambda;
  3569. resolve_function_signature(p_lambda->function, p_lambda, true);
  3570. current_lambda = previous_lambda;
  3571. pending_body_resolution_lambdas.push_back(p_lambda);
  3572. }
  3573. void GDScriptAnalyzer::reduce_literal(GDScriptParser::LiteralNode *p_literal) {
  3574. p_literal->reduced_value = p_literal->value;
  3575. p_literal->is_constant = true;
  3576. p_literal->set_datatype(type_from_variant(p_literal->reduced_value, p_literal));
  3577. }
  3578. void GDScriptAnalyzer::reduce_preload(GDScriptParser::PreloadNode *p_preload) {
  3579. if (!p_preload->path) {
  3580. return;
  3581. }
  3582. reduce_expression(p_preload->path);
  3583. if (!p_preload->path->is_constant) {
  3584. push_error("Preloaded path must be a constant string.", p_preload->path);
  3585. return;
  3586. }
  3587. if (p_preload->path->reduced_value.get_type() != Variant::STRING) {
  3588. push_error("Preloaded path must be a constant string.", p_preload->path);
  3589. } else {
  3590. p_preload->resolved_path = p_preload->path->reduced_value;
  3591. // TODO: Save this as script dependency.
  3592. if (p_preload->resolved_path.is_relative_path()) {
  3593. p_preload->resolved_path = parser->script_path.get_base_dir().path_join(p_preload->resolved_path);
  3594. }
  3595. p_preload->resolved_path = p_preload->resolved_path.simplify_path();
  3596. if (!ResourceLoader::exists(p_preload->resolved_path)) {
  3597. Ref<FileAccess> file_check = FileAccess::create(FileAccess::ACCESS_RESOURCES);
  3598. if (file_check->file_exists(p_preload->resolved_path)) {
  3599. push_error(vformat(R"(Preload file "%s" has no resource loaders (unrecognized file extension).)", p_preload->resolved_path), p_preload->path);
  3600. } else {
  3601. push_error(vformat(R"(Preload file "%s" does not exist.)", p_preload->resolved_path), p_preload->path);
  3602. }
  3603. } else {
  3604. // TODO: Don't load if validating: use completion cache.
  3605. // Must load GDScript and PackedScenes separately to permit cyclic references
  3606. // as ResourceLoader::load() detect and reject those.
  3607. if (ResourceLoader::get_resource_type(p_preload->resolved_path) == "GDScript") {
  3608. Error err = OK;
  3609. Ref<GDScript> res = GDScriptCache::get_shallow_script(p_preload->resolved_path, err, parser->script_path);
  3610. p_preload->resource = res;
  3611. if (err != OK) {
  3612. push_error(vformat(R"(Could not preload resource script "%s".)", p_preload->resolved_path), p_preload->path);
  3613. }
  3614. } else if (ResourceLoader::get_resource_type(p_preload->resolved_path) == "PackedScene") {
  3615. Error err = OK;
  3616. Ref<PackedScene> res = GDScriptCache::get_packed_scene(p_preload->resolved_path, err, parser->script_path);
  3617. p_preload->resource = res;
  3618. if (err != OK) {
  3619. push_error(vformat(R"(Could not preload resource scene "%s".)", p_preload->resolved_path), p_preload->path);
  3620. }
  3621. } else {
  3622. p_preload->resource = ResourceLoader::load(p_preload->resolved_path);
  3623. if (p_preload->resource.is_null()) {
  3624. push_error(vformat(R"(Could not preload resource file "%s".)", p_preload->resolved_path), p_preload->path);
  3625. }
  3626. }
  3627. }
  3628. }
  3629. p_preload->is_constant = true;
  3630. p_preload->reduced_value = p_preload->resource;
  3631. p_preload->set_datatype(type_from_variant(p_preload->reduced_value, p_preload));
  3632. }
  3633. void GDScriptAnalyzer::reduce_self(GDScriptParser::SelfNode *p_self) {
  3634. p_self->is_constant = false;
  3635. p_self->set_datatype(type_from_metatype(parser->current_class->get_datatype()));
  3636. mark_lambda_use_self();
  3637. }
  3638. void GDScriptAnalyzer::reduce_subscript(GDScriptParser::SubscriptNode *p_subscript, bool p_can_be_pseudo_type) {
  3639. if (p_subscript->base == nullptr) {
  3640. return;
  3641. }
  3642. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  3643. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base), true);
  3644. } else if (p_subscript->base->type == GDScriptParser::Node::SUBSCRIPT) {
  3645. reduce_subscript(static_cast<GDScriptParser::SubscriptNode *>(p_subscript->base), true);
  3646. } else {
  3647. reduce_expression(p_subscript->base);
  3648. }
  3649. GDScriptParser::DataType result_type;
  3650. if (p_subscript->is_attribute) {
  3651. if (p_subscript->attribute == nullptr) {
  3652. return;
  3653. }
  3654. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  3655. bool valid = false;
  3656. // If the base is a metatype, use the analyzer instead.
  3657. if (p_subscript->base->is_constant && !base_type.is_meta_type && base_type.kind != GDScriptParser::DataType::CLASS) {
  3658. // Just try to get it.
  3659. Variant value = p_subscript->base->reduced_value.get_named(p_subscript->attribute->name, valid);
  3660. if (valid) {
  3661. p_subscript->is_constant = true;
  3662. p_subscript->reduced_value = value;
  3663. result_type = type_from_variant(value, p_subscript);
  3664. }
  3665. } else if (base_type.is_variant() || !base_type.is_hard_type()) {
  3666. valid = !base_type.is_pseudo_type || p_can_be_pseudo_type;
  3667. result_type.kind = GDScriptParser::DataType::VARIANT;
  3668. if (base_type.is_variant() && base_type.is_hard_type() && base_type.is_meta_type && base_type.is_pseudo_type) {
  3669. // Special case: it may be a global enum with pseudo base (e.g. Variant.Type).
  3670. String enum_name;
  3671. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  3672. enum_name = String(static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base)->name) + ENUM_SEPARATOR + String(p_subscript->attribute->name);
  3673. }
  3674. if (CoreConstants::is_global_enum(enum_name)) {
  3675. result_type = make_global_enum_type(enum_name, StringName());
  3676. } else {
  3677. valid = false;
  3678. mark_node_unsafe(p_subscript);
  3679. }
  3680. } else {
  3681. mark_node_unsafe(p_subscript);
  3682. }
  3683. } else {
  3684. reduce_identifier_from_base(p_subscript->attribute, &base_type);
  3685. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  3686. if (attr_type.is_set()) {
  3687. valid = !attr_type.is_pseudo_type || p_can_be_pseudo_type;
  3688. result_type = attr_type;
  3689. p_subscript->is_constant = p_subscript->attribute->is_constant;
  3690. p_subscript->reduced_value = p_subscript->attribute->reduced_value;
  3691. } else if (!base_type.is_meta_type || !base_type.is_constant) {
  3692. valid = base_type.kind != GDScriptParser::DataType::BUILTIN;
  3693. #ifdef DEBUG_ENABLED
  3694. if (valid) {
  3695. parser->push_warning(p_subscript, GDScriptWarning::UNSAFE_PROPERTY_ACCESS, p_subscript->attribute->name, base_type.to_string());
  3696. }
  3697. #endif
  3698. result_type.kind = GDScriptParser::DataType::VARIANT;
  3699. mark_node_unsafe(p_subscript);
  3700. }
  3701. }
  3702. if (!valid) {
  3703. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  3704. if (!p_can_be_pseudo_type && (attr_type.is_pseudo_type || result_type.is_pseudo_type)) {
  3705. push_error(vformat(R"(Type "%s" in base "%s" cannot be used on its own.)", p_subscript->attribute->name, type_from_metatype(base_type).to_string()), p_subscript->attribute);
  3706. } else {
  3707. push_error(vformat(R"(Cannot find member "%s" in base "%s".)", p_subscript->attribute->name, type_from_metatype(base_type).to_string()), p_subscript->attribute);
  3708. }
  3709. result_type.kind = GDScriptParser::DataType::VARIANT;
  3710. }
  3711. } else {
  3712. if (p_subscript->index == nullptr) {
  3713. return;
  3714. }
  3715. reduce_expression(p_subscript->index);
  3716. if (p_subscript->base->is_constant && p_subscript->index->is_constant) {
  3717. // Just try to get it.
  3718. bool valid = false;
  3719. Variant value = p_subscript->base->reduced_value.get(p_subscript->index->reduced_value, &valid);
  3720. if (!valid) {
  3721. push_error(vformat(R"(Cannot get index "%s" from "%s".)", p_subscript->index->reduced_value, p_subscript->base->reduced_value), p_subscript->index);
  3722. result_type.kind = GDScriptParser::DataType::VARIANT;
  3723. } else {
  3724. p_subscript->is_constant = true;
  3725. p_subscript->reduced_value = value;
  3726. result_type = type_from_variant(value, p_subscript);
  3727. }
  3728. } else {
  3729. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  3730. GDScriptParser::DataType index_type = p_subscript->index->get_datatype();
  3731. if (base_type.is_variant()) {
  3732. result_type.kind = GDScriptParser::DataType::VARIANT;
  3733. mark_node_unsafe(p_subscript);
  3734. } else {
  3735. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  3736. // Check if indexing is valid.
  3737. bool error = index_type.kind != GDScriptParser::DataType::BUILTIN && base_type.builtin_type != Variant::DICTIONARY;
  3738. if (!error) {
  3739. switch (base_type.builtin_type) {
  3740. // Expect int or real as index.
  3741. case Variant::PACKED_BYTE_ARRAY:
  3742. case Variant::PACKED_COLOR_ARRAY:
  3743. case Variant::PACKED_FLOAT32_ARRAY:
  3744. case Variant::PACKED_FLOAT64_ARRAY:
  3745. case Variant::PACKED_INT32_ARRAY:
  3746. case Variant::PACKED_INT64_ARRAY:
  3747. case Variant::PACKED_STRING_ARRAY:
  3748. case Variant::PACKED_VECTOR2_ARRAY:
  3749. case Variant::PACKED_VECTOR3_ARRAY:
  3750. case Variant::ARRAY:
  3751. case Variant::STRING:
  3752. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT;
  3753. break;
  3754. // Expect String only.
  3755. case Variant::RECT2:
  3756. case Variant::RECT2I:
  3757. case Variant::PLANE:
  3758. case Variant::QUATERNION:
  3759. case Variant::AABB:
  3760. case Variant::OBJECT:
  3761. error = index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  3762. break;
  3763. // Expect String or number.
  3764. case Variant::BASIS:
  3765. case Variant::VECTOR2:
  3766. case Variant::VECTOR2I:
  3767. case Variant::VECTOR3:
  3768. case Variant::VECTOR3I:
  3769. case Variant::VECTOR4:
  3770. case Variant::VECTOR4I:
  3771. case Variant::TRANSFORM2D:
  3772. case Variant::TRANSFORM3D:
  3773. case Variant::PROJECTION:
  3774. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT &&
  3775. index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  3776. break;
  3777. // Expect String or int.
  3778. case Variant::COLOR:
  3779. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  3780. break;
  3781. // Don't support indexing, but we will check it later.
  3782. case Variant::RID:
  3783. case Variant::BOOL:
  3784. case Variant::CALLABLE:
  3785. case Variant::FLOAT:
  3786. case Variant::INT:
  3787. case Variant::NIL:
  3788. case Variant::NODE_PATH:
  3789. case Variant::SIGNAL:
  3790. case Variant::STRING_NAME:
  3791. break;
  3792. // Here for completeness.
  3793. case Variant::DICTIONARY:
  3794. case Variant::VARIANT_MAX:
  3795. break;
  3796. }
  3797. if (error) {
  3798. 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);
  3799. }
  3800. }
  3801. } else if (base_type.kind != GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  3802. if (index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME) {
  3803. 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);
  3804. }
  3805. }
  3806. // Check resulting type if possible.
  3807. result_type.builtin_type = Variant::NIL;
  3808. result_type.kind = GDScriptParser::DataType::BUILTIN;
  3809. result_type.type_source = base_type.is_hard_type() ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  3810. if (base_type.kind != GDScriptParser::DataType::BUILTIN) {
  3811. base_type.builtin_type = Variant::OBJECT;
  3812. }
  3813. switch (base_type.builtin_type) {
  3814. // Can't index at all.
  3815. case Variant::RID:
  3816. case Variant::BOOL:
  3817. case Variant::CALLABLE:
  3818. case Variant::FLOAT:
  3819. case Variant::INT:
  3820. case Variant::NIL:
  3821. case Variant::NODE_PATH:
  3822. case Variant::SIGNAL:
  3823. case Variant::STRING_NAME:
  3824. result_type.kind = GDScriptParser::DataType::VARIANT;
  3825. push_error(vformat(R"(Cannot use subscript operator on a base of type "%s".)", base_type.to_string()), p_subscript->base);
  3826. break;
  3827. // Return int.
  3828. case Variant::PACKED_BYTE_ARRAY:
  3829. case Variant::PACKED_INT32_ARRAY:
  3830. case Variant::PACKED_INT64_ARRAY:
  3831. case Variant::VECTOR2I:
  3832. case Variant::VECTOR3I:
  3833. case Variant::VECTOR4I:
  3834. result_type.builtin_type = Variant::INT;
  3835. break;
  3836. // Return float.
  3837. case Variant::PACKED_FLOAT32_ARRAY:
  3838. case Variant::PACKED_FLOAT64_ARRAY:
  3839. case Variant::VECTOR2:
  3840. case Variant::VECTOR3:
  3841. case Variant::VECTOR4:
  3842. case Variant::QUATERNION:
  3843. result_type.builtin_type = Variant::FLOAT;
  3844. break;
  3845. // Return Color.
  3846. case Variant::PACKED_COLOR_ARRAY:
  3847. result_type.builtin_type = Variant::COLOR;
  3848. break;
  3849. // Return String.
  3850. case Variant::PACKED_STRING_ARRAY:
  3851. case Variant::STRING:
  3852. result_type.builtin_type = Variant::STRING;
  3853. break;
  3854. // Return Vector2.
  3855. case Variant::PACKED_VECTOR2_ARRAY:
  3856. case Variant::TRANSFORM2D:
  3857. case Variant::RECT2:
  3858. result_type.builtin_type = Variant::VECTOR2;
  3859. break;
  3860. // Return Vector2I.
  3861. case Variant::RECT2I:
  3862. result_type.builtin_type = Variant::VECTOR2I;
  3863. break;
  3864. // Return Vector3.
  3865. case Variant::PACKED_VECTOR3_ARRAY:
  3866. case Variant::AABB:
  3867. case Variant::BASIS:
  3868. result_type.builtin_type = Variant::VECTOR3;
  3869. break;
  3870. // Depends on the index.
  3871. case Variant::TRANSFORM3D:
  3872. case Variant::PROJECTION:
  3873. case Variant::PLANE:
  3874. case Variant::COLOR:
  3875. case Variant::DICTIONARY:
  3876. case Variant::OBJECT:
  3877. result_type.kind = GDScriptParser::DataType::VARIANT;
  3878. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  3879. break;
  3880. // Can have an element type.
  3881. case Variant::ARRAY:
  3882. if (base_type.has_container_element_type()) {
  3883. result_type = base_type.get_container_element_type();
  3884. result_type.type_source = base_type.type_source;
  3885. } else {
  3886. result_type.kind = GDScriptParser::DataType::VARIANT;
  3887. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  3888. }
  3889. break;
  3890. // Here for completeness.
  3891. case Variant::VARIANT_MAX:
  3892. break;
  3893. }
  3894. }
  3895. }
  3896. }
  3897. p_subscript->set_datatype(result_type);
  3898. }
  3899. void GDScriptAnalyzer::reduce_ternary_op(GDScriptParser::TernaryOpNode *p_ternary_op, bool p_is_root) {
  3900. reduce_expression(p_ternary_op->condition);
  3901. reduce_expression(p_ternary_op->true_expr, p_is_root);
  3902. reduce_expression(p_ternary_op->false_expr, p_is_root);
  3903. GDScriptParser::DataType result;
  3904. 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) {
  3905. p_ternary_op->is_constant = true;
  3906. if (p_ternary_op->condition->reduced_value.booleanize()) {
  3907. p_ternary_op->reduced_value = p_ternary_op->true_expr->reduced_value;
  3908. } else {
  3909. p_ternary_op->reduced_value = p_ternary_op->false_expr->reduced_value;
  3910. }
  3911. }
  3912. GDScriptParser::DataType true_type;
  3913. if (p_ternary_op->true_expr) {
  3914. true_type = p_ternary_op->true_expr->get_datatype();
  3915. } else {
  3916. true_type.kind = GDScriptParser::DataType::VARIANT;
  3917. }
  3918. GDScriptParser::DataType false_type;
  3919. if (p_ternary_op->false_expr) {
  3920. false_type = p_ternary_op->false_expr->get_datatype();
  3921. } else {
  3922. false_type.kind = GDScriptParser::DataType::VARIANT;
  3923. }
  3924. if (true_type.is_variant() || false_type.is_variant()) {
  3925. result.kind = GDScriptParser::DataType::VARIANT;
  3926. } else {
  3927. result = true_type;
  3928. if (!is_type_compatible(true_type, false_type)) {
  3929. result = false_type;
  3930. if (!is_type_compatible(false_type, true_type)) {
  3931. result.kind = GDScriptParser::DataType::VARIANT;
  3932. #ifdef DEBUG_ENABLED
  3933. parser->push_warning(p_ternary_op, GDScriptWarning::INCOMPATIBLE_TERNARY);
  3934. #endif
  3935. }
  3936. }
  3937. }
  3938. result.type_source = true_type.is_hard_type() && false_type.is_hard_type() ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  3939. p_ternary_op->set_datatype(result);
  3940. }
  3941. void GDScriptAnalyzer::reduce_type_test(GDScriptParser::TypeTestNode *p_type_test) {
  3942. GDScriptParser::DataType result;
  3943. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3944. result.kind = GDScriptParser::DataType::BUILTIN;
  3945. result.builtin_type = Variant::BOOL;
  3946. p_type_test->set_datatype(result);
  3947. if (!p_type_test->operand || !p_type_test->test_type) {
  3948. return;
  3949. }
  3950. reduce_expression(p_type_test->operand);
  3951. GDScriptParser::DataType operand_type = p_type_test->operand->get_datatype();
  3952. GDScriptParser::DataType test_type = type_from_metatype(resolve_datatype(p_type_test->test_type));
  3953. p_type_test->test_datatype = test_type;
  3954. if (!operand_type.is_set() || !test_type.is_set()) {
  3955. return;
  3956. }
  3957. if (p_type_test->operand->is_constant) {
  3958. p_type_test->is_constant = true;
  3959. p_type_test->reduced_value = false;
  3960. if (!is_type_compatible(test_type, operand_type)) {
  3961. push_error(vformat(R"(Expression is of type "%s" so it can't be of type "%s".)", operand_type.to_string(), test_type.to_string()), p_type_test->operand);
  3962. } else if (is_type_compatible(test_type, type_from_variant(p_type_test->operand->reduced_value, p_type_test->operand))) {
  3963. p_type_test->reduced_value = test_type.builtin_type != Variant::OBJECT || !p_type_test->operand->reduced_value.is_null();
  3964. }
  3965. return;
  3966. }
  3967. if (!is_type_compatible(test_type, operand_type) && !is_type_compatible(operand_type, test_type)) {
  3968. if (operand_type.is_hard_type()) {
  3969. push_error(vformat(R"(Expression is of type "%s" so it can't be of type "%s".)", operand_type.to_string(), test_type.to_string()), p_type_test->operand);
  3970. } else {
  3971. downgrade_node_type_source(p_type_test->operand);
  3972. }
  3973. }
  3974. }
  3975. void GDScriptAnalyzer::reduce_unary_op(GDScriptParser::UnaryOpNode *p_unary_op) {
  3976. reduce_expression(p_unary_op->operand);
  3977. GDScriptParser::DataType result;
  3978. if (p_unary_op->operand == nullptr) {
  3979. result.kind = GDScriptParser::DataType::VARIANT;
  3980. p_unary_op->set_datatype(result);
  3981. return;
  3982. }
  3983. GDScriptParser::DataType operand_type = p_unary_op->operand->get_datatype();
  3984. if (p_unary_op->operand->is_constant) {
  3985. p_unary_op->is_constant = true;
  3986. p_unary_op->reduced_value = Variant::evaluate(p_unary_op->variant_op, p_unary_op->operand->reduced_value, Variant());
  3987. result = type_from_variant(p_unary_op->reduced_value, p_unary_op);
  3988. }
  3989. if (operand_type.is_variant()) {
  3990. result.kind = GDScriptParser::DataType::VARIANT;
  3991. mark_node_unsafe(p_unary_op);
  3992. } else {
  3993. bool valid = false;
  3994. result = get_operation_type(p_unary_op->variant_op, operand_type, valid, p_unary_op);
  3995. if (!valid) {
  3996. push_error(vformat(R"(Invalid operand of type "%s" for unary operator "%s".)", operand_type.to_string(), Variant::get_operator_name(p_unary_op->variant_op)), p_unary_op);
  3997. }
  3998. }
  3999. p_unary_op->set_datatype(result);
  4000. }
  4001. Variant GDScriptAnalyzer::make_expression_reduced_value(GDScriptParser::ExpressionNode *p_expression, bool &is_reduced) {
  4002. Variant value;
  4003. if (p_expression == nullptr) {
  4004. return value;
  4005. }
  4006. if (p_expression->is_constant) {
  4007. is_reduced = true;
  4008. value = p_expression->reduced_value;
  4009. } else if (p_expression->type == GDScriptParser::Node::ARRAY) {
  4010. value = make_array_reduced_value(static_cast<GDScriptParser::ArrayNode *>(p_expression), is_reduced);
  4011. } else if (p_expression->type == GDScriptParser::Node::DICTIONARY) {
  4012. value = make_dictionary_reduced_value(static_cast<GDScriptParser::DictionaryNode *>(p_expression), is_reduced);
  4013. } else if (p_expression->type == GDScriptParser::Node::SUBSCRIPT) {
  4014. value = make_subscript_reduced_value(static_cast<GDScriptParser::SubscriptNode *>(p_expression), is_reduced);
  4015. }
  4016. return value;
  4017. }
  4018. Variant GDScriptAnalyzer::make_array_reduced_value(GDScriptParser::ArrayNode *p_array, bool &is_reduced) {
  4019. Array array = p_array->get_datatype().has_container_element_type() ? make_array_from_element_datatype(p_array->get_datatype().get_container_element_type()) : Array();
  4020. array.resize(p_array->elements.size());
  4021. for (int i = 0; i < p_array->elements.size(); i++) {
  4022. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  4023. bool is_element_value_reduced = false;
  4024. Variant element_value = make_expression_reduced_value(element, is_element_value_reduced);
  4025. if (!is_element_value_reduced) {
  4026. return Variant();
  4027. }
  4028. array[i] = element_value;
  4029. }
  4030. array.make_read_only();
  4031. is_reduced = true;
  4032. return array;
  4033. }
  4034. Variant GDScriptAnalyzer::make_dictionary_reduced_value(GDScriptParser::DictionaryNode *p_dictionary, bool &is_reduced) {
  4035. Dictionary dictionary;
  4036. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  4037. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  4038. bool is_element_key_reduced = false;
  4039. Variant element_key = make_expression_reduced_value(element.key, is_element_key_reduced);
  4040. if (!is_element_key_reduced) {
  4041. return Variant();
  4042. }
  4043. bool is_element_value_reduced = false;
  4044. Variant element_value = make_expression_reduced_value(element.value, is_element_value_reduced);
  4045. if (!is_element_value_reduced) {
  4046. return Variant();
  4047. }
  4048. dictionary[element_key] = element_value;
  4049. }
  4050. dictionary.make_read_only();
  4051. is_reduced = true;
  4052. return dictionary;
  4053. }
  4054. Variant GDScriptAnalyzer::make_subscript_reduced_value(GDScriptParser::SubscriptNode *p_subscript, bool &is_reduced) {
  4055. if (p_subscript->base == nullptr || p_subscript->index == nullptr) {
  4056. return Variant();
  4057. }
  4058. bool is_base_value_reduced = false;
  4059. Variant base_value = make_expression_reduced_value(p_subscript->base, is_base_value_reduced);
  4060. if (!is_base_value_reduced) {
  4061. return Variant();
  4062. }
  4063. if (p_subscript->is_attribute) {
  4064. bool is_valid = false;
  4065. Variant value = base_value.get_named(p_subscript->attribute->name, is_valid);
  4066. if (is_valid) {
  4067. is_reduced = true;
  4068. return value;
  4069. } else {
  4070. return Variant();
  4071. }
  4072. } else {
  4073. bool is_index_value_reduced = false;
  4074. Variant index_value = make_expression_reduced_value(p_subscript->index, is_index_value_reduced);
  4075. if (!is_index_value_reduced) {
  4076. return Variant();
  4077. }
  4078. bool is_valid = false;
  4079. Variant value = base_value.get(index_value, &is_valid);
  4080. if (is_valid) {
  4081. is_reduced = true;
  4082. return value;
  4083. } else {
  4084. return Variant();
  4085. }
  4086. }
  4087. }
  4088. Array GDScriptAnalyzer::make_array_from_element_datatype(const GDScriptParser::DataType &p_element_datatype, const GDScriptParser::Node *p_source_node) {
  4089. Array array;
  4090. if (p_element_datatype.builtin_type == Variant::OBJECT) {
  4091. Ref<Script> script_type = p_element_datatype.script_type;
  4092. if (p_element_datatype.kind == GDScriptParser::DataType::CLASS && script_type.is_null()) {
  4093. Error err = OK;
  4094. Ref<GDScript> scr = GDScriptCache::get_shallow_script(p_element_datatype.script_path, err, parser->script_path);
  4095. if (err) {
  4096. push_error(vformat(R"(Error while getting cache for script "%s".)", p_element_datatype.script_path), p_source_node);
  4097. return array;
  4098. }
  4099. script_type.reference_ptr(scr->find_class(p_element_datatype.class_type->fqcn));
  4100. }
  4101. array.set_typed(p_element_datatype.builtin_type, p_element_datatype.native_type, script_type);
  4102. } else {
  4103. array.set_typed(p_element_datatype.builtin_type, StringName(), Variant());
  4104. }
  4105. return array;
  4106. }
  4107. Variant GDScriptAnalyzer::make_variable_default_value(GDScriptParser::VariableNode *p_variable) {
  4108. Variant result = Variant();
  4109. if (p_variable->initializer) {
  4110. bool is_initializer_value_reduced = false;
  4111. Variant initializer_value = make_expression_reduced_value(p_variable->initializer, is_initializer_value_reduced);
  4112. if (is_initializer_value_reduced) {
  4113. result = initializer_value;
  4114. }
  4115. } else {
  4116. GDScriptParser::DataType datatype = p_variable->get_datatype();
  4117. if (datatype.is_hard_type()) {
  4118. if (datatype.kind == GDScriptParser::DataType::BUILTIN && datatype.builtin_type != Variant::OBJECT) {
  4119. if (datatype.builtin_type == Variant::ARRAY && datatype.has_container_element_type()) {
  4120. result = make_array_from_element_datatype(datatype.get_container_element_type());
  4121. } else {
  4122. VariantInternal::initialize(&result, datatype.builtin_type);
  4123. }
  4124. } else if (datatype.kind == GDScriptParser::DataType::ENUM) {
  4125. result = 0;
  4126. }
  4127. }
  4128. }
  4129. return result;
  4130. }
  4131. const HashMap<String, Ref<GDScriptParserRef>> &GDScriptAnalyzer::get_depended_parsers() {
  4132. return depended_parsers;
  4133. }
  4134. GDScriptParser::DataType GDScriptAnalyzer::type_from_variant(const Variant &p_value, const GDScriptParser::Node *p_source) {
  4135. GDScriptParser::DataType result;
  4136. result.is_constant = true;
  4137. result.kind = GDScriptParser::DataType::BUILTIN;
  4138. result.builtin_type = p_value.get_type();
  4139. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT; // Constant has explicit type.
  4140. if (p_value.get_type() == Variant::ARRAY) {
  4141. const Array &array = p_value;
  4142. if (array.get_typed_script()) {
  4143. result.set_container_element_type(type_from_metatype(make_script_meta_type(array.get_typed_script())));
  4144. } else if (array.get_typed_class_name()) {
  4145. result.set_container_element_type(type_from_metatype(make_native_meta_type(array.get_typed_class_name())));
  4146. } else if (array.get_typed_builtin() != Variant::NIL) {
  4147. result.set_container_element_type(type_from_metatype(make_builtin_meta_type((Variant::Type)array.get_typed_builtin())));
  4148. }
  4149. } else if (p_value.get_type() == Variant::OBJECT) {
  4150. // Object is treated as a native type, not a builtin type.
  4151. result.kind = GDScriptParser::DataType::NATIVE;
  4152. Object *obj = p_value;
  4153. if (!obj) {
  4154. return GDScriptParser::DataType();
  4155. }
  4156. result.native_type = obj->get_class_name();
  4157. Ref<Script> scr = p_value; // Check if value is a script itself.
  4158. if (scr.is_valid()) {
  4159. result.is_meta_type = true;
  4160. } else {
  4161. result.is_meta_type = false;
  4162. scr = obj->get_script();
  4163. }
  4164. if (scr.is_valid()) {
  4165. Ref<GDScript> gds = scr;
  4166. if (gds.is_valid()) {
  4167. // This might be an inner class, so we want to get the parser for the root.
  4168. // But still get the inner class from that tree.
  4169. String script_path = gds->get_script_path();
  4170. Ref<GDScriptParserRef> ref = get_parser_for(script_path);
  4171. if (ref.is_null()) {
  4172. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  4173. GDScriptParser::DataType error_type;
  4174. error_type.kind = GDScriptParser::DataType::VARIANT;
  4175. return error_type;
  4176. }
  4177. Error err = ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  4178. GDScriptParser::ClassNode *found = nullptr;
  4179. if (err == OK) {
  4180. found = ref->get_parser()->find_class(gds->fully_qualified_name);
  4181. if (found != nullptr) {
  4182. err = resolve_class_inheritance(found, p_source);
  4183. }
  4184. }
  4185. if (err || found == nullptr) {
  4186. push_error(vformat(R"(Could not resolve script "%s".)", script_path), p_source);
  4187. GDScriptParser::DataType error_type;
  4188. error_type.kind = GDScriptParser::DataType::VARIANT;
  4189. return error_type;
  4190. }
  4191. result.kind = GDScriptParser::DataType::CLASS;
  4192. result.native_type = found->get_datatype().native_type;
  4193. result.class_type = found;
  4194. result.script_path = ref->get_parser()->script_path;
  4195. } else {
  4196. result.kind = GDScriptParser::DataType::SCRIPT;
  4197. result.native_type = scr->get_instance_base_type();
  4198. result.script_path = scr->get_path();
  4199. }
  4200. result.script_type = scr;
  4201. } else {
  4202. result.kind = GDScriptParser::DataType::NATIVE;
  4203. if (result.native_type == GDScriptNativeClass::get_class_static()) {
  4204. result.is_meta_type = true;
  4205. }
  4206. }
  4207. }
  4208. return result;
  4209. }
  4210. GDScriptParser::DataType GDScriptAnalyzer::type_from_metatype(const GDScriptParser::DataType &p_meta_type) {
  4211. GDScriptParser::DataType result = p_meta_type;
  4212. result.is_meta_type = false;
  4213. result.is_pseudo_type = false;
  4214. if (p_meta_type.kind == GDScriptParser::DataType::ENUM) {
  4215. result.builtin_type = Variant::INT;
  4216. } else {
  4217. result.is_constant = false;
  4218. }
  4219. return result;
  4220. }
  4221. GDScriptParser::DataType GDScriptAnalyzer::type_from_property(const PropertyInfo &p_property, bool p_is_arg, bool p_is_readonly) const {
  4222. GDScriptParser::DataType result;
  4223. result.is_read_only = p_is_readonly;
  4224. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4225. if (p_property.type == Variant::NIL && (p_is_arg || (p_property.usage & PROPERTY_USAGE_NIL_IS_VARIANT))) {
  4226. // Variant
  4227. result.kind = GDScriptParser::DataType::VARIANT;
  4228. return result;
  4229. }
  4230. result.builtin_type = p_property.type;
  4231. if (p_property.type == Variant::OBJECT) {
  4232. result.kind = GDScriptParser::DataType::NATIVE;
  4233. result.native_type = p_property.class_name == StringName() ? SNAME("Object") : p_property.class_name;
  4234. } else {
  4235. result.kind = GDScriptParser::DataType::BUILTIN;
  4236. result.builtin_type = p_property.type;
  4237. if (p_property.type == Variant::ARRAY && p_property.hint == PROPERTY_HINT_ARRAY_TYPE) {
  4238. // Check element type.
  4239. StringName elem_type_name = p_property.hint_string;
  4240. GDScriptParser::DataType elem_type;
  4241. elem_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4242. Variant::Type elem_builtin_type = GDScriptParser::get_builtin_type(elem_type_name);
  4243. if (elem_builtin_type < Variant::VARIANT_MAX) {
  4244. // Builtin type.
  4245. elem_type.kind = GDScriptParser::DataType::BUILTIN;
  4246. elem_type.builtin_type = elem_builtin_type;
  4247. } else if (class_exists(elem_type_name)) {
  4248. elem_type.kind = GDScriptParser::DataType::NATIVE;
  4249. elem_type.builtin_type = Variant::OBJECT;
  4250. elem_type.native_type = p_property.hint_string;
  4251. } else if (ScriptServer::is_global_class(elem_type_name)) {
  4252. // Just load this as it shouldn't be a GDScript.
  4253. Ref<Script> script = ResourceLoader::load(ScriptServer::get_global_class_path(elem_type_name));
  4254. elem_type.kind = GDScriptParser::DataType::SCRIPT;
  4255. elem_type.builtin_type = Variant::OBJECT;
  4256. elem_type.native_type = script->get_instance_base_type();
  4257. elem_type.script_type = script;
  4258. } else {
  4259. ERR_FAIL_V_MSG(result, "Could not find element type from property hint of a typed array.");
  4260. }
  4261. elem_type.is_constant = false;
  4262. result.set_container_element_type(elem_type);
  4263. } else if (p_property.type == Variant::INT) {
  4264. // Check if it's enum.
  4265. if ((p_property.usage & PROPERTY_USAGE_CLASS_IS_ENUM) && p_property.class_name != StringName()) {
  4266. if (CoreConstants::is_global_enum(p_property.class_name)) {
  4267. result = make_global_enum_type(p_property.class_name, StringName(), false);
  4268. result.is_constant = false;
  4269. } else {
  4270. Vector<String> names = String(p_property.class_name).split(ENUM_SEPARATOR);
  4271. if (names.size() == 2) {
  4272. result = make_native_enum_type(names[1], names[0], false);
  4273. result.is_constant = false;
  4274. }
  4275. }
  4276. }
  4277. // PROPERTY_USAGE_CLASS_IS_BITFIELD: BitField[T] isn't supported (yet?), use plain int.
  4278. }
  4279. }
  4280. return result;
  4281. }
  4282. bool GDScriptAnalyzer::get_function_signature(GDScriptParser::Node *p_source, bool p_is_constructor, 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, BitField<MethodFlags> &r_method_flags, StringName *r_native_class) {
  4283. r_method_flags = METHOD_FLAGS_DEFAULT;
  4284. r_default_arg_count = 0;
  4285. if (r_native_class) {
  4286. *r_native_class = StringName();
  4287. }
  4288. StringName function_name = p_function;
  4289. bool was_enum = false;
  4290. if (p_base_type.kind == GDScriptParser::DataType::ENUM) {
  4291. was_enum = true;
  4292. if (p_base_type.is_meta_type) {
  4293. // Enum type can be treated as a dictionary value.
  4294. p_base_type.kind = GDScriptParser::DataType::BUILTIN;
  4295. p_base_type.is_meta_type = false;
  4296. } else {
  4297. push_error("Cannot call function on enum value.", p_source);
  4298. return false;
  4299. }
  4300. }
  4301. if (p_base_type.kind == GDScriptParser::DataType::BUILTIN) {
  4302. // Construct a base type to get methods.
  4303. Callable::CallError err;
  4304. Variant dummy;
  4305. Variant::construct(p_base_type.builtin_type, dummy, nullptr, 0, err);
  4306. if (err.error != Callable::CallError::CALL_OK) {
  4307. ERR_FAIL_V_MSG(false, "Could not construct base Variant type.");
  4308. }
  4309. List<MethodInfo> methods;
  4310. dummy.get_method_list(&methods);
  4311. for (const MethodInfo &E : methods) {
  4312. if (E.name == p_function) {
  4313. function_signature_from_info(E, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  4314. // Cannot use non-const methods on enums.
  4315. if (!r_method_flags.has_flag(METHOD_FLAG_STATIC) && was_enum && !(E.flags & METHOD_FLAG_CONST)) {
  4316. push_error(vformat(R"*(Cannot call non-const Dictionary function "%s()" on enum "%s".)*", p_function, p_base_type.enum_type), p_source);
  4317. }
  4318. return true;
  4319. }
  4320. }
  4321. return false;
  4322. }
  4323. StringName base_native = p_base_type.native_type;
  4324. if (base_native != StringName()) {
  4325. // Empty native class might happen in some Script implementations.
  4326. // Just ignore it.
  4327. if (!class_exists(base_native)) {
  4328. push_error(vformat("Native class %s used in script doesn't exist or isn't exposed.", base_native), p_source);
  4329. return false;
  4330. } else if (p_is_constructor && !ClassDB::can_instantiate(base_native)) {
  4331. if (p_base_type.kind == GDScriptParser::DataType::CLASS) {
  4332. push_error(vformat(R"(Class "%s" cannot be constructed as it is based on abstract native class "%s".)", p_base_type.class_type->fqcn.get_file(), base_native), p_source);
  4333. } else if (p_base_type.kind == GDScriptParser::DataType::SCRIPT) {
  4334. push_error(vformat(R"(Script "%s" cannot be constructed as it is based on abstract native class "%s".)", p_base_type.script_path.get_file(), base_native), p_source);
  4335. } else {
  4336. push_error(vformat(R"(Native class "%s" cannot be constructed as it is abstract.)", base_native), p_source);
  4337. }
  4338. return false;
  4339. }
  4340. }
  4341. if (p_is_constructor) {
  4342. function_name = GDScriptLanguage::get_singleton()->strings._init;
  4343. r_method_flags.set_flag(METHOD_FLAG_STATIC);
  4344. }
  4345. GDScriptParser::ClassNode *base_class = p_base_type.class_type;
  4346. GDScriptParser::FunctionNode *found_function = nullptr;
  4347. while (found_function == nullptr && base_class != nullptr) {
  4348. if (base_class->has_member(function_name)) {
  4349. if (base_class->get_member(function_name).type != GDScriptParser::ClassNode::Member::FUNCTION) {
  4350. // TODO: If this is Callable it can have a better error message.
  4351. push_error(vformat(R"(Member "%s" is not a function.)", function_name), p_source);
  4352. return false;
  4353. }
  4354. resolve_class_member(base_class, function_name, p_source);
  4355. found_function = base_class->get_member(function_name).function;
  4356. }
  4357. resolve_class_inheritance(base_class, p_source);
  4358. base_class = base_class->base_type.class_type;
  4359. }
  4360. if (found_function != nullptr) {
  4361. if (p_is_constructor || found_function->is_static) {
  4362. r_method_flags.set_flag(METHOD_FLAG_STATIC);
  4363. }
  4364. for (int i = 0; i < found_function->parameters.size(); i++) {
  4365. r_par_types.push_back(found_function->parameters[i]->get_datatype());
  4366. if (found_function->parameters[i]->initializer != nullptr) {
  4367. r_default_arg_count++;
  4368. }
  4369. }
  4370. r_return_type = p_is_constructor ? p_base_type : found_function->get_datatype();
  4371. r_return_type.is_meta_type = false;
  4372. r_return_type.is_coroutine = found_function->is_coroutine;
  4373. return true;
  4374. }
  4375. Ref<Script> base_script = p_base_type.script_type;
  4376. while (base_script.is_valid() && base_script->has_method(function_name)) {
  4377. MethodInfo info = base_script->get_method_info(function_name);
  4378. if (!(info == MethodInfo())) {
  4379. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  4380. }
  4381. base_script = base_script->get_base_script();
  4382. }
  4383. // If the base is a script, it might be trying to access members of the Script class itself.
  4384. if (p_base_type.is_meta_type && !p_is_constructor && (p_base_type.kind == GDScriptParser::DataType::SCRIPT || p_base_type.kind == GDScriptParser::DataType::CLASS)) {
  4385. MethodInfo info;
  4386. StringName script_class = p_base_type.kind == GDScriptParser::DataType::SCRIPT ? p_base_type.script_type->get_class_name() : StringName(GDScript::get_class_static());
  4387. if (ClassDB::get_method_info(script_class, function_name, &info)) {
  4388. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  4389. }
  4390. }
  4391. if (p_is_constructor) {
  4392. // Native types always have a default constructor.
  4393. r_return_type = p_base_type;
  4394. r_return_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4395. r_return_type.is_meta_type = false;
  4396. return true;
  4397. }
  4398. MethodInfo info;
  4399. if (ClassDB::get_method_info(base_native, function_name, &info)) {
  4400. bool valid = function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  4401. if (valid && Engine::get_singleton()->has_singleton(base_native)) {
  4402. r_method_flags.set_flag(METHOD_FLAG_STATIC);
  4403. }
  4404. #ifdef DEBUG_ENABLED
  4405. MethodBind *native_method = ClassDB::get_method(base_native, function_name);
  4406. if (native_method && r_native_class) {
  4407. *r_native_class = native_method->get_instance_class();
  4408. }
  4409. #endif
  4410. return valid;
  4411. }
  4412. return false;
  4413. }
  4414. 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, BitField<MethodFlags> &r_method_flags) {
  4415. r_return_type = type_from_property(p_info.return_val);
  4416. r_default_arg_count = p_info.default_arguments.size();
  4417. r_method_flags = p_info.flags;
  4418. for (const PropertyInfo &E : p_info.arguments) {
  4419. r_par_types.push_back(type_from_property(E, true));
  4420. }
  4421. return true;
  4422. }
  4423. void GDScriptAnalyzer::validate_call_arg(const MethodInfo &p_method, const GDScriptParser::CallNode *p_call) {
  4424. List<GDScriptParser::DataType> arg_types;
  4425. for (const PropertyInfo &E : p_method.arguments) {
  4426. arg_types.push_back(type_from_property(E, true));
  4427. }
  4428. validate_call_arg(arg_types, p_method.default_arguments.size(), (p_method.flags & METHOD_FLAG_VARARG) != 0, p_call);
  4429. }
  4430. void 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) {
  4431. if (p_call->arguments.size() < p_par_types.size() - p_default_args_count) {
  4432. 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);
  4433. }
  4434. if (!p_is_vararg && p_call->arguments.size() > p_par_types.size()) {
  4435. 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()]);
  4436. }
  4437. for (int i = 0; i < p_call->arguments.size(); i++) {
  4438. if (i >= p_par_types.size()) {
  4439. // Already on vararg place.
  4440. break;
  4441. }
  4442. GDScriptParser::DataType par_type = p_par_types[i];
  4443. if (par_type.is_hard_type() && p_call->arguments[i]->is_constant) {
  4444. update_const_expression_builtin_type(p_call->arguments[i], par_type, "pass");
  4445. }
  4446. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  4447. if (arg_type.is_variant() || !arg_type.is_hard_type()) {
  4448. #ifdef DEBUG_ENABLED
  4449. // Argument can be anything, so this is unsafe (unless the parameter is a hard variant).
  4450. if (!(par_type.is_hard_type() && par_type.is_variant())) {
  4451. mark_node_unsafe(p_call->arguments[i]);
  4452. parser->push_warning(p_call->arguments[i], GDScriptWarning::UNSAFE_CALL_ARGUMENT, itos(i + 1), p_call->function_name, par_type.to_string(), arg_type.to_string_strict());
  4453. }
  4454. #endif
  4455. } else if (par_type.is_hard_type() && !is_type_compatible(par_type, arg_type, true)) {
  4456. if (!is_type_compatible(arg_type, par_type)) {
  4457. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*",
  4458. p_call->function_name, i + 1, par_type.to_string(), arg_type.to_string()),
  4459. p_call->arguments[i]);
  4460. #ifdef DEBUG_ENABLED
  4461. } else {
  4462. // Supertypes are acceptable for dynamic compliance, but it's unsafe.
  4463. mark_node_unsafe(p_call);
  4464. parser->push_warning(p_call->arguments[i], GDScriptWarning::UNSAFE_CALL_ARGUMENT, itos(i + 1), p_call->function_name, par_type.to_string(), arg_type.to_string_strict());
  4465. #endif
  4466. }
  4467. #ifdef DEBUG_ENABLED
  4468. } else 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) {
  4469. parser->push_warning(p_call->arguments[i], GDScriptWarning::NARROWING_CONVERSION, p_call->function_name);
  4470. #endif
  4471. }
  4472. }
  4473. }
  4474. #ifdef DEBUG_ENABLED
  4475. void GDScriptAnalyzer::is_shadowing(GDScriptParser::IdentifierNode *p_identifier, const String &p_context, const bool p_in_local_scope) {
  4476. const StringName &name = p_identifier->name;
  4477. GDScriptParser::DataType base = parser->current_class->get_datatype();
  4478. GDScriptParser::ClassNode *base_class = base.class_type;
  4479. {
  4480. List<MethodInfo> gdscript_funcs;
  4481. GDScriptLanguage::get_singleton()->get_public_functions(&gdscript_funcs);
  4482. for (MethodInfo &info : gdscript_funcs) {
  4483. if (info.name == name) {
  4484. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in function");
  4485. return;
  4486. }
  4487. }
  4488. if (Variant::has_utility_function(name)) {
  4489. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in function");
  4490. return;
  4491. } else if (ClassDB::class_exists(name)) {
  4492. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "native class");
  4493. return;
  4494. } else if (ScriptServer::is_global_class(name)) {
  4495. String class_path = ScriptServer::get_global_class_path(name).get_file();
  4496. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, vformat(R"(global class defined in "%s")", class_path));
  4497. return;
  4498. } else if (GDScriptParser::get_builtin_type(name) < Variant::VARIANT_MAX) {
  4499. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in type");
  4500. return;
  4501. }
  4502. }
  4503. if (p_in_local_scope) {
  4504. while (base_class != nullptr) {
  4505. if (base_class->has_member(name)) {
  4506. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE, p_context, p_identifier->name, base_class->get_member(name).get_type_name(), itos(base_class->get_member(name).get_line()));
  4507. return;
  4508. }
  4509. base_class = base_class->base_type.class_type;
  4510. }
  4511. }
  4512. StringName parent = base.native_type;
  4513. while (parent != StringName()) {
  4514. ERR_FAIL_COND_MSG(!class_exists(parent), "Non-existent native base class.");
  4515. if (ClassDB::has_method(parent, name, true)) {
  4516. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "method", parent);
  4517. return;
  4518. } else if (ClassDB::has_signal(parent, name, true)) {
  4519. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "signal", parent);
  4520. return;
  4521. } else if (ClassDB::has_property(parent, name, true)) {
  4522. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "property", parent);
  4523. return;
  4524. } else if (ClassDB::has_integer_constant(parent, name, true)) {
  4525. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "constant", parent);
  4526. return;
  4527. } else if (ClassDB::has_enum(parent, name, true)) {
  4528. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "enum", parent);
  4529. return;
  4530. }
  4531. parent = ClassDB::get_parent_class(parent);
  4532. }
  4533. }
  4534. #endif
  4535. GDScriptParser::DataType GDScriptAnalyzer::get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, bool &r_valid, const GDScriptParser::Node *p_source) {
  4536. // Unary version.
  4537. GDScriptParser::DataType nil_type;
  4538. nil_type.builtin_type = Variant::NIL;
  4539. nil_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  4540. return get_operation_type(p_operation, p_a, nil_type, r_valid, p_source);
  4541. }
  4542. 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) {
  4543. if (p_operation == Variant::OP_AND || p_operation == Variant::OP_OR) {
  4544. // Those work for any type of argument and always return a boolean.
  4545. // They don't use the Variant operator since they have short-circuit semantics.
  4546. r_valid = true;
  4547. GDScriptParser::DataType result;
  4548. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  4549. result.kind = GDScriptParser::DataType::BUILTIN;
  4550. result.builtin_type = Variant::BOOL;
  4551. return result;
  4552. }
  4553. Variant::Type a_type = p_a.builtin_type;
  4554. Variant::Type b_type = p_b.builtin_type;
  4555. if (p_a.kind == GDScriptParser::DataType::ENUM) {
  4556. if (p_a.is_meta_type) {
  4557. a_type = Variant::DICTIONARY;
  4558. } else {
  4559. a_type = Variant::INT;
  4560. }
  4561. }
  4562. if (p_b.kind == GDScriptParser::DataType::ENUM) {
  4563. if (p_b.is_meta_type) {
  4564. b_type = Variant::DICTIONARY;
  4565. } else {
  4566. b_type = Variant::INT;
  4567. }
  4568. }
  4569. GDScriptParser::DataType result;
  4570. bool hard_operation = p_a.is_hard_type() && p_b.is_hard_type();
  4571. if (p_operation == Variant::OP_ADD && a_type == Variant::ARRAY && b_type == Variant::ARRAY) {
  4572. if (p_a.has_container_element_type() && p_b.has_container_element_type() && p_a.get_container_element_type() == p_b.get_container_element_type()) {
  4573. r_valid = true;
  4574. result = p_a;
  4575. result.type_source = hard_operation ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  4576. return result;
  4577. }
  4578. }
  4579. Variant::ValidatedOperatorEvaluator op_eval = Variant::get_validated_operator_evaluator(p_operation, a_type, b_type);
  4580. bool validated = op_eval != nullptr;
  4581. if (validated) {
  4582. r_valid = true;
  4583. result.type_source = hard_operation ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  4584. result.kind = GDScriptParser::DataType::BUILTIN;
  4585. result.builtin_type = Variant::get_operator_return_type(p_operation, a_type, b_type);
  4586. } else {
  4587. r_valid = !hard_operation;
  4588. result.kind = GDScriptParser::DataType::VARIANT;
  4589. }
  4590. return result;
  4591. }
  4592. // TODO: Add safe/unsafe return variable (for variant cases)
  4593. bool GDScriptAnalyzer::is_type_compatible(const GDScriptParser::DataType &p_target, const GDScriptParser::DataType &p_source, bool p_allow_implicit_conversion, const GDScriptParser::Node *p_source_node) {
  4594. // These return "true" so it doesn't affect users negatively.
  4595. ERR_FAIL_COND_V_MSG(!p_target.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset target type");
  4596. ERR_FAIL_COND_V_MSG(!p_source.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset value type");
  4597. if (p_target.kind == GDScriptParser::DataType::VARIANT) {
  4598. // Variant can receive anything.
  4599. return true;
  4600. }
  4601. if (p_source.kind == GDScriptParser::DataType::VARIANT) {
  4602. // TODO: This is acceptable but unsafe. Make sure unsafe line is set.
  4603. return true;
  4604. }
  4605. if (p_target.kind == GDScriptParser::DataType::BUILTIN) {
  4606. bool valid = p_source.kind == GDScriptParser::DataType::BUILTIN && p_target.builtin_type == p_source.builtin_type;
  4607. if (!valid && p_allow_implicit_conversion) {
  4608. valid = Variant::can_convert_strict(p_source.builtin_type, p_target.builtin_type);
  4609. }
  4610. if (!valid && p_target.builtin_type == Variant::INT && p_source.kind == GDScriptParser::DataType::ENUM && !p_source.is_meta_type) {
  4611. // Enum value is also integer.
  4612. valid = true;
  4613. }
  4614. if (valid && p_target.builtin_type == Variant::ARRAY && p_source.builtin_type == Variant::ARRAY) {
  4615. // Check the element type.
  4616. if (p_target.has_container_element_type() && p_source.has_container_element_type()) {
  4617. valid = p_target.get_container_element_type() == p_source.get_container_element_type();
  4618. }
  4619. }
  4620. return valid;
  4621. }
  4622. if (p_target.kind == GDScriptParser::DataType::ENUM) {
  4623. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::INT) {
  4624. #ifdef DEBUG_ENABLED
  4625. if (p_source_node) {
  4626. parser->push_warning(p_source_node, GDScriptWarning::INT_AS_ENUM_WITHOUT_CAST);
  4627. }
  4628. #endif
  4629. return true;
  4630. }
  4631. if (p_source.kind == GDScriptParser::DataType::ENUM) {
  4632. if (p_source.native_type == p_target.native_type) {
  4633. return true;
  4634. }
  4635. }
  4636. return false;
  4637. }
  4638. // From here on the target type is an object, so we have to test polymorphism.
  4639. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::NIL) {
  4640. // null is acceptable in object.
  4641. return true;
  4642. }
  4643. StringName src_native;
  4644. Ref<Script> src_script;
  4645. const GDScriptParser::ClassNode *src_class = nullptr;
  4646. switch (p_source.kind) {
  4647. case GDScriptParser::DataType::NATIVE:
  4648. if (p_target.kind != GDScriptParser::DataType::NATIVE) {
  4649. // Non-native class cannot be supertype of native.
  4650. return false;
  4651. }
  4652. if (p_source.is_meta_type) {
  4653. src_native = GDScriptNativeClass::get_class_static();
  4654. } else {
  4655. src_native = p_source.native_type;
  4656. }
  4657. break;
  4658. case GDScriptParser::DataType::SCRIPT:
  4659. if (p_target.kind == GDScriptParser::DataType::CLASS) {
  4660. // A script type cannot be a subtype of a GDScript class.
  4661. return false;
  4662. }
  4663. if (p_source.is_meta_type) {
  4664. src_native = p_source.script_type->get_class_name();
  4665. } else {
  4666. src_script = p_source.script_type;
  4667. src_native = src_script->get_instance_base_type();
  4668. }
  4669. break;
  4670. case GDScriptParser::DataType::CLASS:
  4671. if (p_source.is_meta_type) {
  4672. src_native = GDScript::get_class_static();
  4673. } else {
  4674. src_class = p_source.class_type;
  4675. const GDScriptParser::ClassNode *base = src_class;
  4676. while (base->base_type.kind == GDScriptParser::DataType::CLASS) {
  4677. base = base->base_type.class_type;
  4678. }
  4679. src_native = base->base_type.native_type;
  4680. src_script = base->base_type.script_type;
  4681. }
  4682. break;
  4683. case GDScriptParser::DataType::VARIANT:
  4684. case GDScriptParser::DataType::BUILTIN:
  4685. case GDScriptParser::DataType::ENUM:
  4686. case GDScriptParser::DataType::RESOLVING:
  4687. case GDScriptParser::DataType::UNRESOLVED:
  4688. break; // Already solved before.
  4689. }
  4690. switch (p_target.kind) {
  4691. case GDScriptParser::DataType::NATIVE: {
  4692. if (p_target.is_meta_type) {
  4693. return ClassDB::is_parent_class(src_native, GDScriptNativeClass::get_class_static());
  4694. }
  4695. return ClassDB::is_parent_class(src_native, p_target.native_type);
  4696. }
  4697. case GDScriptParser::DataType::SCRIPT:
  4698. if (p_target.is_meta_type) {
  4699. return ClassDB::is_parent_class(src_native, p_target.script_type->get_class_name());
  4700. }
  4701. while (src_script.is_valid()) {
  4702. if (src_script == p_target.script_type) {
  4703. return true;
  4704. }
  4705. src_script = src_script->get_base_script();
  4706. }
  4707. return false;
  4708. case GDScriptParser::DataType::CLASS:
  4709. if (p_target.is_meta_type) {
  4710. return ClassDB::is_parent_class(src_native, GDScript::get_class_static());
  4711. }
  4712. while (src_class != nullptr) {
  4713. if (src_class == p_target.class_type || src_class->fqcn == p_target.class_type->fqcn) {
  4714. return true;
  4715. }
  4716. src_class = src_class->base_type.class_type;
  4717. }
  4718. return false;
  4719. case GDScriptParser::DataType::VARIANT:
  4720. case GDScriptParser::DataType::BUILTIN:
  4721. case GDScriptParser::DataType::ENUM:
  4722. case GDScriptParser::DataType::RESOLVING:
  4723. case GDScriptParser::DataType::UNRESOLVED:
  4724. break; // Already solved before.
  4725. }
  4726. return false;
  4727. }
  4728. void GDScriptAnalyzer::push_error(const String &p_message, const GDScriptParser::Node *p_origin) {
  4729. mark_node_unsafe(p_origin);
  4730. parser->push_error(p_message, p_origin);
  4731. }
  4732. void GDScriptAnalyzer::mark_node_unsafe(const GDScriptParser::Node *p_node) {
  4733. #ifdef DEBUG_ENABLED
  4734. if (p_node == nullptr) {
  4735. return;
  4736. }
  4737. for (int i = p_node->start_line; i <= p_node->end_line; i++) {
  4738. parser->unsafe_lines.insert(i);
  4739. }
  4740. #endif
  4741. }
  4742. void GDScriptAnalyzer::downgrade_node_type_source(GDScriptParser::Node *p_node) {
  4743. GDScriptParser::IdentifierNode *identifier = nullptr;
  4744. if (p_node->type == GDScriptParser::Node::IDENTIFIER) {
  4745. identifier = static_cast<GDScriptParser::IdentifierNode *>(p_node);
  4746. } else if (p_node->type == GDScriptParser::Node::SUBSCRIPT) {
  4747. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_node);
  4748. if (subscript->is_attribute) {
  4749. identifier = subscript->attribute;
  4750. }
  4751. }
  4752. if (identifier == nullptr) {
  4753. return;
  4754. }
  4755. GDScriptParser::Node *source = nullptr;
  4756. switch (identifier->source) {
  4757. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE: {
  4758. source = identifier->variable_source;
  4759. } break;
  4760. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER: {
  4761. source = identifier->parameter_source;
  4762. } break;
  4763. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE: {
  4764. source = identifier->variable_source;
  4765. } break;
  4766. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR: {
  4767. source = identifier->bind_source;
  4768. } break;
  4769. default:
  4770. break;
  4771. }
  4772. if (source == nullptr) {
  4773. return;
  4774. }
  4775. GDScriptParser::DataType datatype;
  4776. datatype.kind = GDScriptParser::DataType::VARIANT;
  4777. source->set_datatype(datatype);
  4778. }
  4779. void GDScriptAnalyzer::mark_lambda_use_self() {
  4780. GDScriptParser::LambdaNode *lambda = current_lambda;
  4781. while (lambda != nullptr) {
  4782. lambda->use_self = true;
  4783. lambda = lambda->parent_lambda;
  4784. }
  4785. }
  4786. void GDScriptAnalyzer::resolve_pending_lambda_bodies() {
  4787. if (pending_body_resolution_lambdas.is_empty()) {
  4788. return;
  4789. }
  4790. GDScriptParser::LambdaNode *previous_lambda = current_lambda;
  4791. List<GDScriptParser::LambdaNode *> lambdas = pending_body_resolution_lambdas;
  4792. pending_body_resolution_lambdas.clear();
  4793. for (GDScriptParser::LambdaNode *lambda : lambdas) {
  4794. current_lambda = lambda;
  4795. resolve_function_body(lambda->function, true);
  4796. int captures_amount = lambda->captures.size();
  4797. if (captures_amount > 0) {
  4798. // Create space for lambda parameters.
  4799. // At the beginning to not mess with optional parameters.
  4800. int param_count = lambda->function->parameters.size();
  4801. lambda->function->parameters.resize(param_count + captures_amount);
  4802. for (int i = param_count - 1; i >= 0; i--) {
  4803. lambda->function->parameters.write[i + captures_amount] = lambda->function->parameters[i];
  4804. lambda->function->parameters_indices[lambda->function->parameters[i]->identifier->name] = i + captures_amount;
  4805. }
  4806. // Add captures as extra parameters at the beginning.
  4807. for (int i = 0; i < lambda->captures.size(); i++) {
  4808. GDScriptParser::IdentifierNode *capture = lambda->captures[i];
  4809. GDScriptParser::ParameterNode *capture_param = parser->alloc_node<GDScriptParser::ParameterNode>();
  4810. capture_param->identifier = capture;
  4811. capture_param->usages = capture->usages;
  4812. capture_param->set_datatype(capture->get_datatype());
  4813. lambda->function->parameters.write[i] = capture_param;
  4814. lambda->function->parameters_indices[capture->name] = i;
  4815. }
  4816. }
  4817. }
  4818. current_lambda = previous_lambda;
  4819. }
  4820. bool GDScriptAnalyzer::class_exists(const StringName &p_class) const {
  4821. return ClassDB::class_exists(p_class) && ClassDB::is_class_exposed(p_class);
  4822. }
  4823. Ref<GDScriptParserRef> GDScriptAnalyzer::get_parser_for(const String &p_path) {
  4824. Ref<GDScriptParserRef> ref;
  4825. if (depended_parsers.has(p_path)) {
  4826. ref = depended_parsers[p_path];
  4827. } else {
  4828. Error err = OK;
  4829. ref = GDScriptCache::get_parser(p_path, GDScriptParserRef::EMPTY, err, parser->script_path);
  4830. if (ref.is_valid()) {
  4831. depended_parsers[p_path] = ref;
  4832. }
  4833. }
  4834. return ref;
  4835. }
  4836. Error GDScriptAnalyzer::resolve_inheritance() {
  4837. return resolve_class_inheritance(parser->head, true);
  4838. }
  4839. Error GDScriptAnalyzer::resolve_interface() {
  4840. resolve_class_interface(parser->head, true);
  4841. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  4842. }
  4843. Error GDScriptAnalyzer::resolve_body() {
  4844. resolve_class_body(parser->head, true);
  4845. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  4846. }
  4847. Error GDScriptAnalyzer::resolve_dependencies() {
  4848. for (KeyValue<String, Ref<GDScriptParserRef>> &K : depended_parsers) {
  4849. if (K.value.is_null()) {
  4850. return ERR_PARSE_ERROR;
  4851. }
  4852. K.value->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  4853. }
  4854. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  4855. }
  4856. Error GDScriptAnalyzer::analyze() {
  4857. parser->errors.clear();
  4858. Error err = OK;
  4859. err = resolve_inheritance();
  4860. if (err) {
  4861. return err;
  4862. }
  4863. // Apply annotations.
  4864. for (GDScriptParser::AnnotationNode *&E : parser->head->annotations) {
  4865. resolve_annotation(E);
  4866. E->apply(parser, parser->head);
  4867. }
  4868. resolve_interface();
  4869. resolve_body();
  4870. if (!parser->errors.is_empty()) {
  4871. return ERR_PARSE_ERROR;
  4872. }
  4873. return resolve_dependencies();
  4874. }
  4875. GDScriptAnalyzer::GDScriptAnalyzer(GDScriptParser *p_parser) {
  4876. parser = p_parser;
  4877. }