gdscript_analyzer.cpp 223 KB

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