gdscript_analyzer.cpp 256 KB

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