gdscript_analyzer.cpp 219 KB

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