gdscript_analyzer.cpp 230 KB

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