gdscript_analyzer.cpp 234 KB

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