gdscript_analyzer.cpp 261 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455
  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_ENABLED
  64. pi.name = Variant::get_utility_function_argument_name(p_function, i);
  65. #else
  66. pi.name = "arg" + itos(i + 1);
  67. #endif // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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 // DEBUG_ENABLED
  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. // Resolve base abstract class/method implementation requirements.
  1326. if (!p_class->is_abstract) {
  1327. HashSet<StringName> implemented_funcs;
  1328. const GDScriptParser::ClassNode *base_class = p_class;
  1329. while (base_class != nullptr) {
  1330. if (!base_class->is_abstract && base_class != p_class) {
  1331. break;
  1332. }
  1333. for (GDScriptParser::ClassNode::Member member : base_class->members) {
  1334. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION) {
  1335. if (member.function->is_abstract) {
  1336. if (base_class == p_class) {
  1337. const String class_name = p_class->identifier == nullptr ? p_class->fqcn.get_file() : String(p_class->identifier->name);
  1338. push_error(vformat(R"*(Class "%s" is not abstract but contains abstract methods. Mark the class as "@abstract" or remove "@abstract" from all methods in this class.)*", class_name), p_class);
  1339. break;
  1340. } else if (!implemented_funcs.has(member.function->identifier->name)) {
  1341. const String class_name = p_class->identifier == nullptr ? p_class->fqcn.get_file() : String(p_class->identifier->name);
  1342. const String base_class_name = base_class->identifier == nullptr ? base_class->fqcn.get_file() : String(base_class->identifier->name);
  1343. push_error(vformat(R"*(Class "%s" must implement "%s.%s()" and other inherited abstract methods or be marked as "@abstract".)*", class_name, base_class_name, member.function->identifier->name), p_class);
  1344. break;
  1345. }
  1346. } else {
  1347. implemented_funcs.insert(member.function->identifier->name);
  1348. }
  1349. }
  1350. }
  1351. if (base_class->base_type.kind == GDScriptParser::DataType::CLASS) {
  1352. base_class = base_class->base_type.class_type;
  1353. } else if (base_class->base_type.kind == GDScriptParser::DataType::SCRIPT) {
  1354. Ref<GDScriptParserRef> base_parser_ref = parser->get_depended_parser_for(base_class->base_type.script_path);
  1355. ERR_BREAK(base_parser_ref.is_null());
  1356. base_class = base_parser_ref->get_parser()->head;
  1357. } else {
  1358. break;
  1359. }
  1360. }
  1361. }
  1362. parser->current_class = previous_class;
  1363. }
  1364. void GDScriptAnalyzer::resolve_class_body(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  1365. resolve_class_body(p_class);
  1366. if (p_recursive) {
  1367. for (int i = 0; i < p_class->members.size(); i++) {
  1368. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1369. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  1370. resolve_class_body(member.m_class, true);
  1371. }
  1372. }
  1373. }
  1374. }
  1375. void GDScriptAnalyzer::resolve_node(GDScriptParser::Node *p_node, bool p_is_root) {
  1376. ERR_FAIL_NULL_MSG(p_node, "Trying to resolve type of a null node.");
  1377. switch (p_node->type) {
  1378. case GDScriptParser::Node::NONE:
  1379. break; // Unreachable.
  1380. case GDScriptParser::Node::CLASS:
  1381. // NOTE: Currently this route is never executed, `resolve_class_*()` is called directly.
  1382. if (OK == resolve_class_inheritance(static_cast<GDScriptParser::ClassNode *>(p_node), true)) {
  1383. resolve_class_interface(static_cast<GDScriptParser::ClassNode *>(p_node), true);
  1384. resolve_class_body(static_cast<GDScriptParser::ClassNode *>(p_node), true);
  1385. }
  1386. break;
  1387. case GDScriptParser::Node::CONSTANT:
  1388. resolve_constant(static_cast<GDScriptParser::ConstantNode *>(p_node), true);
  1389. break;
  1390. case GDScriptParser::Node::FOR:
  1391. resolve_for(static_cast<GDScriptParser::ForNode *>(p_node));
  1392. break;
  1393. case GDScriptParser::Node::IF:
  1394. resolve_if(static_cast<GDScriptParser::IfNode *>(p_node));
  1395. break;
  1396. case GDScriptParser::Node::SUITE:
  1397. resolve_suite(static_cast<GDScriptParser::SuiteNode *>(p_node));
  1398. break;
  1399. case GDScriptParser::Node::VARIABLE:
  1400. resolve_variable(static_cast<GDScriptParser::VariableNode *>(p_node), true);
  1401. break;
  1402. case GDScriptParser::Node::WHILE:
  1403. resolve_while(static_cast<GDScriptParser::WhileNode *>(p_node));
  1404. break;
  1405. case GDScriptParser::Node::ANNOTATION:
  1406. resolve_annotation(static_cast<GDScriptParser::AnnotationNode *>(p_node));
  1407. break;
  1408. case GDScriptParser::Node::ASSERT:
  1409. resolve_assert(static_cast<GDScriptParser::AssertNode *>(p_node));
  1410. break;
  1411. case GDScriptParser::Node::MATCH:
  1412. resolve_match(static_cast<GDScriptParser::MatchNode *>(p_node));
  1413. break;
  1414. case GDScriptParser::Node::MATCH_BRANCH:
  1415. resolve_match_branch(static_cast<GDScriptParser::MatchBranchNode *>(p_node), nullptr);
  1416. break;
  1417. case GDScriptParser::Node::PARAMETER:
  1418. resolve_parameter(static_cast<GDScriptParser::ParameterNode *>(p_node));
  1419. break;
  1420. case GDScriptParser::Node::PATTERN:
  1421. resolve_match_pattern(static_cast<GDScriptParser::PatternNode *>(p_node), nullptr);
  1422. break;
  1423. case GDScriptParser::Node::RETURN:
  1424. resolve_return(static_cast<GDScriptParser::ReturnNode *>(p_node));
  1425. break;
  1426. case GDScriptParser::Node::TYPE:
  1427. resolve_datatype(static_cast<GDScriptParser::TypeNode *>(p_node));
  1428. break;
  1429. // Resolving expression is the same as reducing them.
  1430. case GDScriptParser::Node::ARRAY:
  1431. case GDScriptParser::Node::ASSIGNMENT:
  1432. case GDScriptParser::Node::AWAIT:
  1433. case GDScriptParser::Node::BINARY_OPERATOR:
  1434. case GDScriptParser::Node::CALL:
  1435. case GDScriptParser::Node::CAST:
  1436. case GDScriptParser::Node::DICTIONARY:
  1437. case GDScriptParser::Node::GET_NODE:
  1438. case GDScriptParser::Node::IDENTIFIER:
  1439. case GDScriptParser::Node::LAMBDA:
  1440. case GDScriptParser::Node::LITERAL:
  1441. case GDScriptParser::Node::PRELOAD:
  1442. case GDScriptParser::Node::SELF:
  1443. case GDScriptParser::Node::SUBSCRIPT:
  1444. case GDScriptParser::Node::TERNARY_OPERATOR:
  1445. case GDScriptParser::Node::TYPE_TEST:
  1446. case GDScriptParser::Node::UNARY_OPERATOR:
  1447. reduce_expression(static_cast<GDScriptParser::ExpressionNode *>(p_node), p_is_root);
  1448. break;
  1449. case GDScriptParser::Node::BREAK:
  1450. case GDScriptParser::Node::BREAKPOINT:
  1451. case GDScriptParser::Node::CONTINUE:
  1452. case GDScriptParser::Node::ENUM:
  1453. case GDScriptParser::Node::FUNCTION:
  1454. case GDScriptParser::Node::PASS:
  1455. case GDScriptParser::Node::SIGNAL:
  1456. // Nothing to do.
  1457. break;
  1458. }
  1459. }
  1460. void GDScriptAnalyzer::resolve_annotation(GDScriptParser::AnnotationNode *p_annotation) {
  1461. ERR_FAIL_COND_MSG(!parser->valid_annotations.has(p_annotation->name), vformat(R"(Annotation "%s" not found to validate.)", p_annotation->name));
  1462. if (p_annotation->is_resolved) {
  1463. return;
  1464. }
  1465. p_annotation->is_resolved = true;
  1466. const MethodInfo &annotation_info = parser->valid_annotations[p_annotation->name].info;
  1467. for (int64_t i = 0, j = 0; i < p_annotation->arguments.size(); i++) {
  1468. GDScriptParser::ExpressionNode *argument = p_annotation->arguments[i];
  1469. const PropertyInfo &argument_info = annotation_info.arguments[j];
  1470. if (j + 1 < annotation_info.arguments.size()) {
  1471. ++j;
  1472. }
  1473. reduce_expression(argument);
  1474. if (!argument->is_constant) {
  1475. push_error(vformat(R"(Argument %d of annotation "%s" isn't a constant expression.)", i + 1, p_annotation->name), argument);
  1476. return;
  1477. }
  1478. Variant value = argument->reduced_value;
  1479. if (value.get_type() != argument_info.type) {
  1480. #ifdef DEBUG_ENABLED
  1481. if (argument_info.type == Variant::INT && value.get_type() == Variant::FLOAT) {
  1482. parser->push_warning(argument, GDScriptWarning::NARROWING_CONVERSION);
  1483. }
  1484. #endif // DEBUG_ENABLED
  1485. if (!Variant::can_convert_strict(value.get_type(), argument_info.type)) {
  1486. 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);
  1487. return;
  1488. }
  1489. Variant converted_to;
  1490. const Variant *converted_from = &value;
  1491. Callable::CallError call_error;
  1492. Variant::construct(argument_info.type, converted_to, &converted_from, 1, call_error);
  1493. if (call_error.error != Callable::CallError::CALL_OK) {
  1494. 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);
  1495. return;
  1496. }
  1497. value = converted_to;
  1498. }
  1499. p_annotation->resolved_arguments.push_back(value);
  1500. }
  1501. }
  1502. void GDScriptAnalyzer::resolve_function_signature(GDScriptParser::FunctionNode *p_function, const GDScriptParser::Node *p_source, bool p_is_lambda) {
  1503. if (p_source == nullptr) {
  1504. p_source = p_function;
  1505. }
  1506. StringName function_name = p_function->identifier != nullptr ? p_function->identifier->name : StringName();
  1507. if (p_function->get_datatype().is_resolving()) {
  1508. push_error(vformat(R"(Could not resolve function "%s": Cyclic reference.)", function_name), p_source);
  1509. return;
  1510. }
  1511. if (p_function->resolved_signature) {
  1512. return;
  1513. }
  1514. p_function->resolved_signature = true;
  1515. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  1516. parser->current_function = p_function;
  1517. bool previous_static_context = static_context;
  1518. if (p_is_lambda) {
  1519. // For lambdas this is determined from the context, the `static` keyword is not allowed.
  1520. p_function->is_static = static_context;
  1521. } else {
  1522. // For normal functions, this is determined in the parser by the `static` keyword.
  1523. static_context = p_function->is_static;
  1524. }
  1525. MethodInfo method_info;
  1526. method_info.name = function_name;
  1527. if (p_function->is_static) {
  1528. method_info.flags |= MethodFlags::METHOD_FLAG_STATIC;
  1529. }
  1530. GDScriptParser::DataType prev_datatype = p_function->get_datatype();
  1531. GDScriptParser::DataType resolving_datatype;
  1532. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  1533. p_function->set_datatype(resolving_datatype);
  1534. #ifdef TOOLS_ENABLED
  1535. int default_value_count = 0;
  1536. #endif // TOOLS_ENABLED
  1537. #ifdef DEBUG_ENABLED
  1538. String function_visible_name = function_name;
  1539. if (function_name == StringName()) {
  1540. function_visible_name = p_is_lambda ? "<anonymous lambda>" : "<unknown function>";
  1541. }
  1542. #endif // DEBUG_ENABLED
  1543. for (int i = 0; i < p_function->parameters.size(); i++) {
  1544. resolve_parameter(p_function->parameters[i]);
  1545. method_info.arguments.push_back(p_function->parameters[i]->get_datatype().to_property_info(p_function->parameters[i]->identifier->name));
  1546. #ifdef DEBUG_ENABLED
  1547. if (p_function->parameters[i]->usages == 0 && !String(p_function->parameters[i]->identifier->name).begins_with("_") && !p_function->is_abstract) {
  1548. parser->push_warning(p_function->parameters[i]->identifier, GDScriptWarning::UNUSED_PARAMETER, function_visible_name, p_function->parameters[i]->identifier->name);
  1549. }
  1550. is_shadowing(p_function->parameters[i]->identifier, "function parameter", true);
  1551. #endif // DEBUG_ENABLED
  1552. if (p_function->parameters[i]->initializer) {
  1553. #ifdef TOOLS_ENABLED
  1554. default_value_count++;
  1555. #endif // TOOLS_ENABLED
  1556. if (p_function->parameters[i]->initializer->is_constant) {
  1557. p_function->default_arg_values.push_back(p_function->parameters[i]->initializer->reduced_value);
  1558. } else {
  1559. p_function->default_arg_values.push_back(Variant()); // Prevent shift.
  1560. }
  1561. }
  1562. }
  1563. if (p_function->is_vararg()) {
  1564. resolve_parameter(p_function->rest_parameter);
  1565. if (p_function->rest_parameter->datatype_specifier != nullptr) {
  1566. GDScriptParser::DataType specified_type = p_function->rest_parameter->get_datatype();
  1567. if (specified_type.kind != GDScriptParser::DataType::BUILTIN || specified_type.builtin_type != Variant::ARRAY) {
  1568. push_error(vformat(R"(The rest parameter type must be "Array", but "%s" is specified.)", specified_type.to_string()), p_function->rest_parameter->datatype_specifier);
  1569. } else if ((specified_type.has_container_element_type(0) && !specified_type.get_container_element_type(0).is_variant())) {
  1570. push_error(R"(Typed arrays are currently not supported for the rest parameter.)", p_function->rest_parameter->datatype_specifier);
  1571. }
  1572. } else {
  1573. GDScriptParser::DataType inferred_type;
  1574. inferred_type.type_source = GDScriptParser::DataType::INFERRED;
  1575. inferred_type.kind = GDScriptParser::DataType::BUILTIN;
  1576. inferred_type.builtin_type = Variant::ARRAY;
  1577. p_function->rest_parameter->set_datatype(inferred_type);
  1578. #ifdef DEBUG_ENABLED
  1579. parser->push_warning(p_function->rest_parameter, GDScriptWarning::UNTYPED_DECLARATION, "Parameter", p_function->rest_parameter->identifier->name);
  1580. #endif
  1581. }
  1582. #ifdef DEBUG_ENABLED
  1583. if (p_function->rest_parameter->usages == 0 && !String(p_function->rest_parameter->identifier->name).begins_with("_") && !p_function->is_abstract) {
  1584. parser->push_warning(p_function->rest_parameter->identifier, GDScriptWarning::UNUSED_PARAMETER, function_visible_name, p_function->rest_parameter->identifier->name);
  1585. }
  1586. is_shadowing(p_function->rest_parameter->identifier, "function parameter", true);
  1587. #endif // DEBUG_ENABLED
  1588. }
  1589. if (!p_is_lambda && function_name == GDScriptLanguage::get_singleton()->strings._init) {
  1590. // Constructor.
  1591. GDScriptParser::DataType return_type = parser->current_class->get_datatype();
  1592. return_type.is_meta_type = false;
  1593. p_function->set_datatype(return_type);
  1594. if (p_function->return_type) {
  1595. GDScriptParser::DataType declared_return = resolve_datatype(p_function->return_type);
  1596. if (declared_return.kind != GDScriptParser::DataType::BUILTIN || declared_return.builtin_type != Variant::NIL) {
  1597. push_error("Constructor cannot have an explicit return type.", p_function->return_type);
  1598. }
  1599. }
  1600. } else if (!p_is_lambda && function_name == GDScriptLanguage::get_singleton()->strings._static_init) {
  1601. // Static constructor.
  1602. GDScriptParser::DataType return_type;
  1603. return_type.kind = GDScriptParser::DataType::BUILTIN;
  1604. return_type.builtin_type = Variant::NIL;
  1605. p_function->set_datatype(return_type);
  1606. if (p_function->return_type) {
  1607. GDScriptParser::DataType declared_return = resolve_datatype(p_function->return_type);
  1608. if (declared_return.kind != GDScriptParser::DataType::BUILTIN || declared_return.builtin_type != Variant::NIL) {
  1609. push_error("Static constructor cannot have an explicit return type.", p_function->return_type);
  1610. }
  1611. }
  1612. } else {
  1613. if (p_function->return_type != nullptr) {
  1614. p_function->set_datatype(type_from_metatype(resolve_datatype(p_function->return_type)));
  1615. } else {
  1616. // In case the function is not typed, we can safely assume it's a Variant, so it's okay to mark as "inferred" here.
  1617. // It's not "undetected" to not mix up with unknown functions.
  1618. GDScriptParser::DataType return_type;
  1619. return_type.type_source = GDScriptParser::DataType::INFERRED;
  1620. return_type.kind = GDScriptParser::DataType::VARIANT;
  1621. p_function->set_datatype(return_type);
  1622. }
  1623. #ifdef TOOLS_ENABLED
  1624. // Check if the function signature matches the parent. If not it's an error since it breaks polymorphism.
  1625. // Not for the constructor which can vary in signature.
  1626. GDScriptParser::DataType base_type = parser->current_class->base_type;
  1627. base_type.is_meta_type = false;
  1628. GDScriptParser::DataType parent_return_type;
  1629. List<GDScriptParser::DataType> parameters_types;
  1630. int default_par_count = 0;
  1631. BitField<MethodFlags> method_flags = {};
  1632. StringName native_base;
  1633. 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)) {
  1634. bool valid = p_function->is_static == method_flags.has_flag(METHOD_FLAG_STATIC);
  1635. if (p_function->return_type != nullptr) {
  1636. // Check return type covariance.
  1637. GDScriptParser::DataType return_type = p_function->get_datatype();
  1638. if (return_type.is_variant()) {
  1639. // `is_type_compatible()` returns `true` if one of the types is `Variant`.
  1640. // Don't allow an explicitly specified `Variant` if the parent return type is narrower.
  1641. valid = valid && parent_return_type.is_variant();
  1642. } else if (return_type.kind == GDScriptParser::DataType::BUILTIN && return_type.builtin_type == Variant::NIL) {
  1643. // `is_type_compatible()` returns `true` if target is an `Object` and source is `null`.
  1644. // Don't allow `void` if the parent return type is a hard non-`void` type.
  1645. if (parent_return_type.is_hard_type() && !(parent_return_type.kind == GDScriptParser::DataType::BUILTIN && parent_return_type.builtin_type == Variant::NIL)) {
  1646. valid = false;
  1647. }
  1648. } else {
  1649. valid = valid && is_type_compatible(parent_return_type, return_type);
  1650. }
  1651. }
  1652. int parent_min_argc = parameters_types.size() - default_par_count;
  1653. int parent_max_argc = (method_flags & METHOD_FLAG_VARARG) ? INT_MAX : parameters_types.size();
  1654. int current_min_argc = p_function->parameters.size() - default_value_count;
  1655. int current_max_argc = p_function->is_vararg() ? INT_MAX : p_function->parameters.size();
  1656. // `[current_min_argc..current_max_argc]` must include `[parent_min_argc..parent_max_argc]`.
  1657. valid = valid && current_min_argc <= parent_min_argc && parent_max_argc <= current_max_argc;
  1658. if (valid) {
  1659. int i = 0;
  1660. for (const GDScriptParser::DataType &parent_par_type : parameters_types) {
  1661. if (i >= p_function->parameters.size()) {
  1662. break;
  1663. }
  1664. const GDScriptParser::DataType &current_par_type = p_function->parameters[i]->datatype;
  1665. i++;
  1666. // Check parameter type contravariance.
  1667. if (parent_par_type.is_variant() && parent_par_type.is_hard_type()) {
  1668. // `is_type_compatible()` returns `true` if one of the types is `Variant`.
  1669. // Don't allow narrowing a hard `Variant`.
  1670. valid = valid && current_par_type.is_variant();
  1671. } else {
  1672. valid = valid && is_type_compatible(current_par_type, parent_par_type);
  1673. }
  1674. }
  1675. }
  1676. if (!valid) {
  1677. // Compute parent signature as a string to show in the error message.
  1678. String parent_signature = String(function_name) + "(";
  1679. int j = 0;
  1680. for (const GDScriptParser::DataType &par_type : parameters_types) {
  1681. if (j > 0) {
  1682. parent_signature += ", ";
  1683. }
  1684. String parameter = par_type.to_string();
  1685. if (parameter == "null") {
  1686. parameter = "Variant";
  1687. }
  1688. parent_signature += parameter;
  1689. if (j >= parameters_types.size() - default_par_count) {
  1690. parent_signature += " = <default>";
  1691. }
  1692. j++;
  1693. }
  1694. if (method_flags & METHOD_FLAG_VARARG) {
  1695. if (!parameters_types.is_empty()) {
  1696. parent_signature += ", ";
  1697. }
  1698. parent_signature += "...";
  1699. }
  1700. parent_signature += ") -> ";
  1701. const String return_type = parent_return_type.to_string_strict();
  1702. if (return_type == "null") {
  1703. parent_signature += "void";
  1704. } else {
  1705. parent_signature += return_type;
  1706. }
  1707. push_error(vformat(R"(The function signature doesn't match the parent. Parent signature is "%s".)", parent_signature), p_function);
  1708. }
  1709. #ifdef DEBUG_ENABLED
  1710. if (native_base != StringName()) {
  1711. parser->push_warning(p_function, GDScriptWarning::NATIVE_METHOD_OVERRIDE, function_name, native_base);
  1712. }
  1713. #endif // DEBUG_ENABLED
  1714. }
  1715. #endif // TOOLS_ENABLED
  1716. }
  1717. #ifdef DEBUG_ENABLED
  1718. if (p_function->return_type == nullptr) {
  1719. parser->push_warning(p_function, GDScriptWarning::UNTYPED_DECLARATION, "Function", function_visible_name);
  1720. }
  1721. #endif // DEBUG_ENABLED
  1722. method_info.default_arguments.append_array(p_function->default_arg_values);
  1723. method_info.return_val = p_function->get_datatype().to_property_info("");
  1724. p_function->info = method_info;
  1725. if (p_function->get_datatype().is_resolving()) {
  1726. p_function->set_datatype(prev_datatype);
  1727. }
  1728. parser->current_function = previous_function;
  1729. static_context = previous_static_context;
  1730. }
  1731. void GDScriptAnalyzer::resolve_function_body(GDScriptParser::FunctionNode *p_function, bool p_is_lambda) {
  1732. if (p_function->resolved_body) {
  1733. return;
  1734. }
  1735. p_function->resolved_body = true;
  1736. if (p_function->is_abstract) {
  1737. // Abstract functions don't have a body.
  1738. if (!p_function->body->statements.is_empty()) {
  1739. push_error(R"(Abstract function cannot have a body.)", p_function->body);
  1740. }
  1741. return;
  1742. } else {
  1743. // Non-abstract functions must have a body.
  1744. if (p_function->body->statements.is_empty()) {
  1745. push_error(R"(A function must either have a ":" followed by a body, or be marked as "@abstract".)", p_function);
  1746. return;
  1747. }
  1748. }
  1749. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  1750. parser->current_function = p_function;
  1751. bool previous_static_context = static_context;
  1752. static_context = p_function->is_static;
  1753. resolve_suite(p_function->body);
  1754. if (!p_function->get_datatype().is_hard_type() && p_function->body->get_datatype().is_set()) {
  1755. // Use the suite inferred type if return isn't explicitly set.
  1756. p_function->set_datatype(p_function->body->get_datatype());
  1757. } 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)) {
  1758. if (!p_function->body->has_return && (p_is_lambda || p_function->identifier->name != GDScriptLanguage::get_singleton()->strings._init)) {
  1759. push_error(R"(Not all code paths return a value.)", p_function);
  1760. }
  1761. }
  1762. parser->current_function = previous_function;
  1763. static_context = previous_static_context;
  1764. }
  1765. void GDScriptAnalyzer::decide_suite_type(GDScriptParser::Node *p_suite, GDScriptParser::Node *p_statement) {
  1766. if (p_statement == nullptr) {
  1767. return;
  1768. }
  1769. switch (p_statement->type) {
  1770. case GDScriptParser::Node::IF:
  1771. case GDScriptParser::Node::FOR:
  1772. case GDScriptParser::Node::MATCH:
  1773. case GDScriptParser::Node::PATTERN:
  1774. case GDScriptParser::Node::RETURN:
  1775. case GDScriptParser::Node::WHILE:
  1776. // Use return or nested suite type as this suite type.
  1777. if (p_suite->get_datatype().is_set() && (p_suite->get_datatype() != p_statement->get_datatype())) {
  1778. // Mixed types.
  1779. // TODO: This could use the common supertype instead.
  1780. p_suite->datatype.kind = GDScriptParser::DataType::VARIANT;
  1781. p_suite->datatype.type_source = GDScriptParser::DataType::UNDETECTED;
  1782. } else {
  1783. p_suite->set_datatype(p_statement->get_datatype());
  1784. p_suite->datatype.type_source = GDScriptParser::DataType::INFERRED;
  1785. }
  1786. break;
  1787. default:
  1788. break;
  1789. }
  1790. }
  1791. void GDScriptAnalyzer::resolve_suite(GDScriptParser::SuiteNode *p_suite) {
  1792. for (int i = 0; i < p_suite->statements.size(); i++) {
  1793. GDScriptParser::Node *stmt = p_suite->statements[i];
  1794. // Apply annotations.
  1795. for (GDScriptParser::AnnotationNode *&E : stmt->annotations) {
  1796. resolve_annotation(E);
  1797. E->apply(parser, stmt, nullptr); // TODO: Provide `p_class`.
  1798. }
  1799. resolve_node(stmt);
  1800. resolve_pending_lambda_bodies();
  1801. decide_suite_type(p_suite, stmt);
  1802. }
  1803. }
  1804. void GDScriptAnalyzer::resolve_assignable(GDScriptParser::AssignableNode *p_assignable, const char *p_kind) {
  1805. GDScriptParser::DataType type;
  1806. type.kind = GDScriptParser::DataType::VARIANT;
  1807. bool is_constant = p_assignable->type == GDScriptParser::Node::CONSTANT;
  1808. #ifdef DEBUG_ENABLED
  1809. if (p_assignable->identifier != nullptr && p_assignable->identifier->suite != nullptr && p_assignable->identifier->suite->parent_block != nullptr) {
  1810. if (p_assignable->identifier->suite->parent_block->has_local(p_assignable->identifier->name)) {
  1811. const GDScriptParser::SuiteNode::Local &local = p_assignable->identifier->suite->parent_block->get_local(p_assignable->identifier->name);
  1812. parser->push_warning(p_assignable->identifier, GDScriptWarning::CONFUSABLE_LOCAL_DECLARATION, local.get_name(), p_assignable->identifier->name);
  1813. }
  1814. }
  1815. #endif // DEBUG_ENABLED
  1816. GDScriptParser::DataType specified_type;
  1817. bool has_specified_type = p_assignable->datatype_specifier != nullptr;
  1818. if (has_specified_type) {
  1819. specified_type = type_from_metatype(resolve_datatype(p_assignable->datatype_specifier));
  1820. type = specified_type;
  1821. }
  1822. if (p_assignable->initializer != nullptr) {
  1823. reduce_expression(p_assignable->initializer);
  1824. if (p_assignable->initializer->type == GDScriptParser::Node::ARRAY) {
  1825. GDScriptParser::ArrayNode *array = static_cast<GDScriptParser::ArrayNode *>(p_assignable->initializer);
  1826. if (has_specified_type && specified_type.has_container_element_type(0)) {
  1827. update_array_literal_element_type(array, specified_type.get_container_element_type(0));
  1828. }
  1829. } else if (p_assignable->initializer->type == GDScriptParser::Node::DICTIONARY) {
  1830. GDScriptParser::DictionaryNode *dictionary = static_cast<GDScriptParser::DictionaryNode *>(p_assignable->initializer);
  1831. if (has_specified_type && specified_type.has_container_element_types()) {
  1832. update_dictionary_literal_element_type(dictionary, specified_type.get_container_element_type_or_variant(0), specified_type.get_container_element_type_or_variant(1));
  1833. }
  1834. }
  1835. if (is_constant && !p_assignable->initializer->is_constant) {
  1836. bool is_initializer_value_reduced = false;
  1837. Variant initializer_value = make_expression_reduced_value(p_assignable->initializer, is_initializer_value_reduced);
  1838. if (is_initializer_value_reduced) {
  1839. p_assignable->initializer->is_constant = true;
  1840. p_assignable->initializer->reduced_value = initializer_value;
  1841. } else {
  1842. push_error(vformat(R"(Assigned value for %s "%s" isn't a constant expression.)", p_kind, p_assignable->identifier->name), p_assignable->initializer);
  1843. }
  1844. }
  1845. if (has_specified_type && p_assignable->initializer->is_constant) {
  1846. update_const_expression_builtin_type(p_assignable->initializer, specified_type, "assign");
  1847. }
  1848. GDScriptParser::DataType initializer_type = p_assignable->initializer->get_datatype();
  1849. if (p_assignable->infer_datatype) {
  1850. if (!initializer_type.is_set() || initializer_type.has_no_type() || !initializer_type.is_hard_type()) {
  1851. 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);
  1852. } else if (initializer_type.kind == GDScriptParser::DataType::BUILTIN && initializer_type.builtin_type == Variant::NIL && !is_constant) {
  1853. 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);
  1854. }
  1855. #ifdef DEBUG_ENABLED
  1856. if (initializer_type.is_hard_type() && initializer_type.is_variant()) {
  1857. parser->push_warning(p_assignable, GDScriptWarning::INFERENCE_ON_VARIANT, p_kind);
  1858. }
  1859. #endif // DEBUG_ENABLED
  1860. } else {
  1861. if (!initializer_type.is_set()) {
  1862. push_error(vformat(R"(Could not resolve type for %s "%s".)", p_kind, p_assignable->identifier->name), p_assignable->initializer);
  1863. }
  1864. }
  1865. if (!has_specified_type) {
  1866. type = initializer_type;
  1867. if (!type.is_set() || (type.is_hard_type() && type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL && !is_constant)) {
  1868. type.kind = GDScriptParser::DataType::VARIANT;
  1869. }
  1870. if (p_assignable->infer_datatype || is_constant) {
  1871. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1872. } else {
  1873. type.type_source = GDScriptParser::DataType::INFERRED;
  1874. }
  1875. } else if (!specified_type.is_variant()) {
  1876. if (initializer_type.is_variant() || !initializer_type.is_hard_type()) {
  1877. mark_node_unsafe(p_assignable->initializer);
  1878. p_assignable->use_conversion_assign = true;
  1879. if (!initializer_type.is_variant() && !is_type_compatible(specified_type, initializer_type, true, p_assignable->initializer)) {
  1880. downgrade_node_type_source(p_assignable->initializer);
  1881. }
  1882. } else if (!is_type_compatible(specified_type, initializer_type, true, p_assignable->initializer)) {
  1883. if (!is_constant && is_type_compatible(initializer_type, specified_type)) {
  1884. mark_node_unsafe(p_assignable->initializer);
  1885. p_assignable->use_conversion_assign = true;
  1886. } else {
  1887. 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);
  1888. }
  1889. } 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))) {
  1890. mark_node_unsafe(p_assignable->initializer);
  1891. #ifdef DEBUG_ENABLED
  1892. } else if (specified_type.builtin_type == Variant::INT && initializer_type.builtin_type == Variant::FLOAT) {
  1893. parser->push_warning(p_assignable->initializer, GDScriptWarning::NARROWING_CONVERSION);
  1894. #endif // DEBUG_ENABLED
  1895. }
  1896. }
  1897. }
  1898. #ifdef DEBUG_ENABLED
  1899. const bool is_parameter = p_assignable->type == GDScriptParser::Node::PARAMETER;
  1900. if (!has_specified_type) {
  1901. const String declaration_type = is_constant ? "Constant" : (is_parameter ? "Parameter" : "Variable");
  1902. if (p_assignable->infer_datatype || is_constant) {
  1903. // Do not produce the `INFERRED_DECLARATION` warning on type import because there is no way to specify the true type.
  1904. // And removing the metatype makes it impossible to use the constant as a type hint (especially for enums).
  1905. const bool is_type_import = is_constant && p_assignable->initializer != nullptr && p_assignable->initializer->datatype.is_meta_type;
  1906. if (!is_type_import) {
  1907. parser->push_warning(p_assignable, GDScriptWarning::INFERRED_DECLARATION, declaration_type, p_assignable->identifier->name);
  1908. }
  1909. } else {
  1910. parser->push_warning(p_assignable, GDScriptWarning::UNTYPED_DECLARATION, declaration_type, p_assignable->identifier->name);
  1911. }
  1912. } else if (!is_parameter && specified_type.kind == GDScriptParser::DataType::ENUM && p_assignable->initializer == nullptr) {
  1913. // Warn about enum variables without default value. Unless the enum defines the "0" value, then it's fine.
  1914. bool has_zero_value = false;
  1915. for (const KeyValue<StringName, int64_t> &kv : specified_type.enum_values) {
  1916. if (kv.value == 0) {
  1917. has_zero_value = true;
  1918. break;
  1919. }
  1920. }
  1921. if (!has_zero_value) {
  1922. parser->push_warning(p_assignable, GDScriptWarning::ENUM_VARIABLE_WITHOUT_DEFAULT, p_assignable->identifier->name);
  1923. }
  1924. }
  1925. #endif // DEBUG_ENABLED
  1926. type.is_constant = is_constant;
  1927. type.is_read_only = false;
  1928. p_assignable->set_datatype(type);
  1929. }
  1930. void GDScriptAnalyzer::resolve_variable(GDScriptParser::VariableNode *p_variable, bool p_is_local) {
  1931. static constexpr const char *kind = "variable";
  1932. resolve_assignable(p_variable, kind);
  1933. #ifdef DEBUG_ENABLED
  1934. if (p_is_local) {
  1935. if (p_variable->usages == 0 && !String(p_variable->identifier->name).begins_with("_")) {
  1936. parser->push_warning(p_variable, GDScriptWarning::UNUSED_VARIABLE, p_variable->identifier->name);
  1937. }
  1938. }
  1939. is_shadowing(p_variable->identifier, kind, p_is_local);
  1940. #endif // DEBUG_ENABLED
  1941. }
  1942. void GDScriptAnalyzer::resolve_constant(GDScriptParser::ConstantNode *p_constant, bool p_is_local) {
  1943. static constexpr const char *kind = "constant";
  1944. resolve_assignable(p_constant, kind);
  1945. #ifdef DEBUG_ENABLED
  1946. if (p_is_local) {
  1947. if (p_constant->usages == 0 && !String(p_constant->identifier->name).begins_with("_")) {
  1948. parser->push_warning(p_constant, GDScriptWarning::UNUSED_LOCAL_CONSTANT, p_constant->identifier->name);
  1949. }
  1950. }
  1951. is_shadowing(p_constant->identifier, kind, p_is_local);
  1952. #endif // DEBUG_ENABLED
  1953. }
  1954. void GDScriptAnalyzer::resolve_parameter(GDScriptParser::ParameterNode *p_parameter) {
  1955. static constexpr const char *kind = "parameter";
  1956. resolve_assignable(p_parameter, kind);
  1957. }
  1958. void GDScriptAnalyzer::resolve_if(GDScriptParser::IfNode *p_if) {
  1959. reduce_expression(p_if->condition);
  1960. resolve_suite(p_if->true_block);
  1961. p_if->set_datatype(p_if->true_block->get_datatype());
  1962. if (p_if->false_block != nullptr) {
  1963. resolve_suite(p_if->false_block);
  1964. decide_suite_type(p_if, p_if->false_block);
  1965. }
  1966. }
  1967. void GDScriptAnalyzer::resolve_for(GDScriptParser::ForNode *p_for) {
  1968. GDScriptParser::DataType variable_type;
  1969. GDScriptParser::DataType list_type;
  1970. if (p_for->list) {
  1971. resolve_node(p_for->list, false);
  1972. bool is_range = false;
  1973. if (p_for->list->type == GDScriptParser::Node::CALL) {
  1974. GDScriptParser::CallNode *call = static_cast<GDScriptParser::CallNode *>(p_for->list);
  1975. if (call->get_callee_type() == GDScriptParser::Node::IDENTIFIER) {
  1976. if (static_cast<GDScriptParser::IdentifierNode *>(call->callee)->name == "range") {
  1977. if (call->arguments.is_empty()) {
  1978. push_error(R"*(Invalid call for "range()" function. Expected at least 1 argument, none given.)*", call);
  1979. } else if (call->arguments.size() > 3) {
  1980. push_error(vformat(R"*(Invalid call for "range()" function. Expected at most 3 arguments, %d given.)*", call->arguments.size()), call);
  1981. }
  1982. is_range = true;
  1983. variable_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1984. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1985. variable_type.builtin_type = Variant::INT;
  1986. }
  1987. }
  1988. }
  1989. list_type = p_for->list->get_datatype();
  1990. if (!list_type.is_hard_type()) {
  1991. mark_node_unsafe(p_for->list);
  1992. }
  1993. if (is_range) {
  1994. // Already solved.
  1995. } else if (list_type.is_variant()) {
  1996. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1997. mark_node_unsafe(p_for->list);
  1998. } else if (list_type.has_container_element_type(0)) {
  1999. variable_type = list_type.get_container_element_type(0);
  2000. variable_type.type_source = list_type.type_source;
  2001. } else if (list_type.is_typed_container_type()) {
  2002. variable_type = list_type.get_typed_container_type();
  2003. variable_type.type_source = list_type.type_source;
  2004. } else if (list_type.builtin_type == Variant::INT || list_type.builtin_type == Variant::FLOAT || list_type.builtin_type == Variant::STRING) {
  2005. variable_type.type_source = list_type.type_source;
  2006. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  2007. variable_type.builtin_type = list_type.builtin_type;
  2008. } else if (list_type.builtin_type == Variant::VECTOR2I || list_type.builtin_type == Variant::VECTOR3I) {
  2009. variable_type.type_source = list_type.type_source;
  2010. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  2011. variable_type.builtin_type = Variant::INT;
  2012. } else if (list_type.builtin_type == Variant::VECTOR2 || list_type.builtin_type == Variant::VECTOR3) {
  2013. variable_type.type_source = list_type.type_source;
  2014. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  2015. variable_type.builtin_type = Variant::FLOAT;
  2016. } else if (list_type.builtin_type == Variant::OBJECT) {
  2017. GDScriptParser::DataType return_type;
  2018. List<GDScriptParser::DataType> par_types;
  2019. int default_arg_count = 0;
  2020. BitField<MethodFlags> method_flags = {};
  2021. if (get_function_signature(p_for->list, false, list_type, CoreStringName(_iter_get), return_type, par_types, default_arg_count, method_flags)) {
  2022. variable_type = return_type;
  2023. variable_type.type_source = list_type.type_source;
  2024. } else if (!list_type.is_hard_type()) {
  2025. variable_type.kind = GDScriptParser::DataType::VARIANT;
  2026. } else {
  2027. push_error(vformat(R"(Unable to iterate on object of type "%s".)", list_type.to_string()), p_for->list);
  2028. }
  2029. } else if (list_type.builtin_type == Variant::ARRAY || list_type.builtin_type == Variant::DICTIONARY || !list_type.is_hard_type()) {
  2030. variable_type.kind = GDScriptParser::DataType::VARIANT;
  2031. } else {
  2032. push_error(vformat(R"(Unable to iterate on value of type "%s".)", list_type.to_string()), p_for->list);
  2033. }
  2034. }
  2035. if (p_for->variable) {
  2036. if (p_for->datatype_specifier) {
  2037. GDScriptParser::DataType specified_type = type_from_metatype(resolve_datatype(p_for->datatype_specifier));
  2038. if (!specified_type.is_variant()) {
  2039. if (variable_type.is_variant() || !variable_type.is_hard_type()) {
  2040. mark_node_unsafe(p_for->variable);
  2041. p_for->use_conversion_assign = true;
  2042. } else if (!is_type_compatible(specified_type, variable_type, true, p_for->variable)) {
  2043. if (is_type_compatible(variable_type, specified_type)) {
  2044. mark_node_unsafe(p_for->variable);
  2045. p_for->use_conversion_assign = true;
  2046. } else {
  2047. push_error(vformat(R"(Unable to iterate on value of type "%s" with variable of type "%s".)", list_type.to_string(), specified_type.to_string()), p_for->datatype_specifier);
  2048. }
  2049. } else if (!is_type_compatible(specified_type, variable_type)) {
  2050. p_for->use_conversion_assign = true;
  2051. }
  2052. if (p_for->list) {
  2053. if (p_for->list->type == GDScriptParser::Node::ARRAY) {
  2054. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_for->list), specified_type);
  2055. } else if (p_for->list->type == GDScriptParser::Node::DICTIONARY) {
  2056. update_dictionary_literal_element_type(static_cast<GDScriptParser::DictionaryNode *>(p_for->list), specified_type, GDScriptParser::DataType::get_variant_type());
  2057. }
  2058. }
  2059. }
  2060. p_for->variable->set_datatype(specified_type);
  2061. } else {
  2062. p_for->variable->set_datatype(variable_type);
  2063. #ifdef DEBUG_ENABLED
  2064. if (variable_type.is_hard_type()) {
  2065. parser->push_warning(p_for->variable, GDScriptWarning::INFERRED_DECLARATION, R"("for" iterator variable)", p_for->variable->name);
  2066. } else {
  2067. parser->push_warning(p_for->variable, GDScriptWarning::UNTYPED_DECLARATION, R"("for" iterator variable)", p_for->variable->name);
  2068. }
  2069. #endif // DEBUG_ENABLED
  2070. }
  2071. }
  2072. resolve_suite(p_for->loop);
  2073. p_for->set_datatype(p_for->loop->get_datatype());
  2074. #ifdef DEBUG_ENABLED
  2075. if (p_for->variable) {
  2076. is_shadowing(p_for->variable, R"("for" iterator variable)", true);
  2077. }
  2078. #endif // DEBUG_ENABLED
  2079. }
  2080. void GDScriptAnalyzer::resolve_while(GDScriptParser::WhileNode *p_while) {
  2081. resolve_node(p_while->condition, false);
  2082. resolve_suite(p_while->loop);
  2083. p_while->set_datatype(p_while->loop->get_datatype());
  2084. }
  2085. void GDScriptAnalyzer::resolve_assert(GDScriptParser::AssertNode *p_assert) {
  2086. reduce_expression(p_assert->condition);
  2087. if (p_assert->message != nullptr) {
  2088. reduce_expression(p_assert->message);
  2089. 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)) {
  2090. push_error(R"(Expected string for assert error message.)", p_assert->message);
  2091. }
  2092. }
  2093. p_assert->set_datatype(p_assert->condition->get_datatype());
  2094. #ifdef DEBUG_ENABLED
  2095. if (p_assert->condition->is_constant) {
  2096. if (p_assert->condition->reduced_value.booleanize()) {
  2097. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_TRUE);
  2098. } else if (!(p_assert->condition->type == GDScriptParser::Node::LITERAL && static_cast<GDScriptParser::LiteralNode *>(p_assert->condition)->value.get_type() == Variant::BOOL)) {
  2099. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_FALSE);
  2100. }
  2101. }
  2102. #endif // DEBUG_ENABLED
  2103. }
  2104. void GDScriptAnalyzer::resolve_match(GDScriptParser::MatchNode *p_match) {
  2105. reduce_expression(p_match->test);
  2106. for (int i = 0; i < p_match->branches.size(); i++) {
  2107. resolve_match_branch(p_match->branches[i], p_match->test);
  2108. decide_suite_type(p_match, p_match->branches[i]);
  2109. }
  2110. }
  2111. void GDScriptAnalyzer::resolve_match_branch(GDScriptParser::MatchBranchNode *p_match_branch, GDScriptParser::ExpressionNode *p_match_test) {
  2112. // Apply annotations.
  2113. for (GDScriptParser::AnnotationNode *&E : p_match_branch->annotations) {
  2114. resolve_annotation(E);
  2115. E->apply(parser, p_match_branch, nullptr); // TODO: Provide `p_class`.
  2116. }
  2117. for (int i = 0; i < p_match_branch->patterns.size(); i++) {
  2118. resolve_match_pattern(p_match_branch->patterns[i], p_match_test);
  2119. }
  2120. if (p_match_branch->guard_body) {
  2121. resolve_suite(p_match_branch->guard_body);
  2122. }
  2123. resolve_suite(p_match_branch->block);
  2124. decide_suite_type(p_match_branch, p_match_branch->block);
  2125. }
  2126. void GDScriptAnalyzer::resolve_match_pattern(GDScriptParser::PatternNode *p_match_pattern, GDScriptParser::ExpressionNode *p_match_test) {
  2127. if (p_match_pattern == nullptr) {
  2128. return;
  2129. }
  2130. GDScriptParser::DataType result;
  2131. switch (p_match_pattern->pattern_type) {
  2132. case GDScriptParser::PatternNode::PT_LITERAL:
  2133. if (p_match_pattern->literal) {
  2134. reduce_literal(p_match_pattern->literal);
  2135. result = p_match_pattern->literal->get_datatype();
  2136. }
  2137. break;
  2138. case GDScriptParser::PatternNode::PT_EXPRESSION:
  2139. if (p_match_pattern->expression) {
  2140. GDScriptParser::ExpressionNode *expr = p_match_pattern->expression;
  2141. reduce_expression(expr);
  2142. result = expr->get_datatype();
  2143. if (!expr->is_constant) {
  2144. while (expr && expr->type == GDScriptParser::Node::SUBSCRIPT) {
  2145. GDScriptParser::SubscriptNode *sub = static_cast<GDScriptParser::SubscriptNode *>(expr);
  2146. if (!sub->is_attribute) {
  2147. expr = nullptr;
  2148. } else {
  2149. expr = sub->base;
  2150. }
  2151. }
  2152. if (!expr || expr->type != GDScriptParser::Node::IDENTIFIER) {
  2153. push_error(R"(Expression in match pattern must be a constant expression, an identifier, or an attribute access ("A.B").)", expr);
  2154. }
  2155. }
  2156. }
  2157. break;
  2158. case GDScriptParser::PatternNode::PT_BIND:
  2159. if (p_match_test != nullptr) {
  2160. result = p_match_test->get_datatype();
  2161. } else {
  2162. result.kind = GDScriptParser::DataType::VARIANT;
  2163. }
  2164. p_match_pattern->bind->set_datatype(result);
  2165. #ifdef DEBUG_ENABLED
  2166. is_shadowing(p_match_pattern->bind, "pattern bind", true);
  2167. if (p_match_pattern->bind->usages == 0 && !String(p_match_pattern->bind->name).begins_with("_")) {
  2168. parser->push_warning(p_match_pattern->bind, GDScriptWarning::UNUSED_VARIABLE, p_match_pattern->bind->name);
  2169. }
  2170. #endif // DEBUG_ENABLED
  2171. break;
  2172. case GDScriptParser::PatternNode::PT_ARRAY:
  2173. for (int i = 0; i < p_match_pattern->array.size(); i++) {
  2174. resolve_match_pattern(p_match_pattern->array[i], nullptr);
  2175. decide_suite_type(p_match_pattern, p_match_pattern->array[i]);
  2176. }
  2177. result = p_match_pattern->get_datatype();
  2178. break;
  2179. case GDScriptParser::PatternNode::PT_DICTIONARY:
  2180. for (int i = 0; i < p_match_pattern->dictionary.size(); i++) {
  2181. if (p_match_pattern->dictionary[i].key) {
  2182. reduce_expression(p_match_pattern->dictionary[i].key);
  2183. if (!p_match_pattern->dictionary[i].key->is_constant) {
  2184. push_error(R"(Expression in dictionary pattern key must be a constant.)", p_match_pattern->dictionary[i].key);
  2185. }
  2186. }
  2187. if (p_match_pattern->dictionary[i].value_pattern) {
  2188. resolve_match_pattern(p_match_pattern->dictionary[i].value_pattern, nullptr);
  2189. decide_suite_type(p_match_pattern, p_match_pattern->dictionary[i].value_pattern);
  2190. }
  2191. }
  2192. result = p_match_pattern->get_datatype();
  2193. break;
  2194. case GDScriptParser::PatternNode::PT_WILDCARD:
  2195. case GDScriptParser::PatternNode::PT_REST:
  2196. result.kind = GDScriptParser::DataType::VARIANT;
  2197. break;
  2198. }
  2199. p_match_pattern->set_datatype(result);
  2200. }
  2201. void GDScriptAnalyzer::resolve_return(GDScriptParser::ReturnNode *p_return) {
  2202. GDScriptParser::DataType result;
  2203. GDScriptParser::DataType expected_type;
  2204. bool has_expected_type = parser->current_function != nullptr;
  2205. if (has_expected_type) {
  2206. expected_type = parser->current_function->get_datatype();
  2207. }
  2208. if (p_return->return_value != nullptr) {
  2209. bool is_void_function = has_expected_type && expected_type.is_hard_type() && expected_type.kind == GDScriptParser::DataType::BUILTIN && expected_type.builtin_type == Variant::NIL;
  2210. bool is_call = p_return->return_value->type == GDScriptParser::Node::CALL;
  2211. if (is_void_function && is_call) {
  2212. // Pretend the call is a root expression to allow those that are "void".
  2213. reduce_call(static_cast<GDScriptParser::CallNode *>(p_return->return_value), false, true);
  2214. } else {
  2215. reduce_expression(p_return->return_value);
  2216. }
  2217. if (is_void_function) {
  2218. p_return->void_return = true;
  2219. const GDScriptParser::DataType &return_type = p_return->return_value->datatype;
  2220. if (is_call && !return_type.is_hard_type()) {
  2221. String function_name = parser->current_function->identifier ? parser->current_function->identifier->name.operator String() : String("<anonymous function>");
  2222. String called_function_name = static_cast<GDScriptParser::CallNode *>(p_return->return_value)->function_name.operator String();
  2223. #ifdef DEBUG_ENABLED
  2224. parser->push_warning(p_return, GDScriptWarning::UNSAFE_VOID_RETURN, function_name, called_function_name);
  2225. #endif // DEBUG_ENABLED
  2226. mark_node_unsafe(p_return);
  2227. } else if (!is_call) {
  2228. push_error("A void function cannot return a value.", p_return);
  2229. }
  2230. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2231. result.kind = GDScriptParser::DataType::BUILTIN;
  2232. result.builtin_type = Variant::NIL;
  2233. result.is_constant = true;
  2234. } else {
  2235. if (p_return->return_value->type == GDScriptParser::Node::ARRAY && has_expected_type && expected_type.has_container_element_type(0)) {
  2236. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_return->return_value), expected_type.get_container_element_type(0));
  2237. } else if (p_return->return_value->type == GDScriptParser::Node::DICTIONARY && has_expected_type && expected_type.has_container_element_types()) {
  2238. update_dictionary_literal_element_type(static_cast<GDScriptParser::DictionaryNode *>(p_return->return_value),
  2239. expected_type.get_container_element_type_or_variant(0), expected_type.get_container_element_type_or_variant(1));
  2240. }
  2241. if (has_expected_type && expected_type.is_hard_type() && p_return->return_value->is_constant) {
  2242. update_const_expression_builtin_type(p_return->return_value, expected_type, "return");
  2243. }
  2244. result = p_return->return_value->get_datatype();
  2245. }
  2246. } else {
  2247. // Return type is null by default.
  2248. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2249. result.kind = GDScriptParser::DataType::BUILTIN;
  2250. result.builtin_type = Variant::NIL;
  2251. result.is_constant = true;
  2252. }
  2253. if (has_expected_type && !expected_type.is_variant()) {
  2254. if (result.is_variant() || !result.is_hard_type()) {
  2255. mark_node_unsafe(p_return);
  2256. if (!is_type_compatible(expected_type, result, true, p_return)) {
  2257. downgrade_node_type_source(p_return);
  2258. }
  2259. } else if (!is_type_compatible(expected_type, result, true, p_return)) {
  2260. mark_node_unsafe(p_return);
  2261. if (!is_type_compatible(result, expected_type)) {
  2262. 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);
  2263. }
  2264. #ifdef DEBUG_ENABLED
  2265. } else if (expected_type.builtin_type == Variant::INT && result.builtin_type == Variant::FLOAT) {
  2266. parser->push_warning(p_return, GDScriptWarning::NARROWING_CONVERSION);
  2267. #endif // DEBUG_ENABLED
  2268. }
  2269. }
  2270. p_return->set_datatype(result);
  2271. }
  2272. void GDScriptAnalyzer::reduce_expression(GDScriptParser::ExpressionNode *p_expression, bool p_is_root) {
  2273. // This one makes some magic happen.
  2274. if (p_expression == nullptr) {
  2275. return;
  2276. }
  2277. if (p_expression->reduced) {
  2278. // Don't do this more than once.
  2279. return;
  2280. }
  2281. p_expression->reduced = true;
  2282. switch (p_expression->type) {
  2283. case GDScriptParser::Node::ARRAY:
  2284. reduce_array(static_cast<GDScriptParser::ArrayNode *>(p_expression));
  2285. break;
  2286. case GDScriptParser::Node::ASSIGNMENT:
  2287. reduce_assignment(static_cast<GDScriptParser::AssignmentNode *>(p_expression));
  2288. break;
  2289. case GDScriptParser::Node::AWAIT:
  2290. reduce_await(static_cast<GDScriptParser::AwaitNode *>(p_expression));
  2291. break;
  2292. case GDScriptParser::Node::BINARY_OPERATOR:
  2293. reduce_binary_op(static_cast<GDScriptParser::BinaryOpNode *>(p_expression));
  2294. break;
  2295. case GDScriptParser::Node::CALL:
  2296. reduce_call(static_cast<GDScriptParser::CallNode *>(p_expression), false, p_is_root);
  2297. break;
  2298. case GDScriptParser::Node::CAST:
  2299. reduce_cast(static_cast<GDScriptParser::CastNode *>(p_expression));
  2300. break;
  2301. case GDScriptParser::Node::DICTIONARY:
  2302. reduce_dictionary(static_cast<GDScriptParser::DictionaryNode *>(p_expression));
  2303. break;
  2304. case GDScriptParser::Node::GET_NODE:
  2305. reduce_get_node(static_cast<GDScriptParser::GetNodeNode *>(p_expression));
  2306. break;
  2307. case GDScriptParser::Node::IDENTIFIER:
  2308. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_expression));
  2309. break;
  2310. case GDScriptParser::Node::LAMBDA:
  2311. reduce_lambda(static_cast<GDScriptParser::LambdaNode *>(p_expression));
  2312. break;
  2313. case GDScriptParser::Node::LITERAL:
  2314. reduce_literal(static_cast<GDScriptParser::LiteralNode *>(p_expression));
  2315. break;
  2316. case GDScriptParser::Node::PRELOAD:
  2317. reduce_preload(static_cast<GDScriptParser::PreloadNode *>(p_expression));
  2318. break;
  2319. case GDScriptParser::Node::SELF:
  2320. reduce_self(static_cast<GDScriptParser::SelfNode *>(p_expression));
  2321. break;
  2322. case GDScriptParser::Node::SUBSCRIPT:
  2323. reduce_subscript(static_cast<GDScriptParser::SubscriptNode *>(p_expression));
  2324. break;
  2325. case GDScriptParser::Node::TERNARY_OPERATOR:
  2326. reduce_ternary_op(static_cast<GDScriptParser::TernaryOpNode *>(p_expression), p_is_root);
  2327. break;
  2328. case GDScriptParser::Node::TYPE_TEST:
  2329. reduce_type_test(static_cast<GDScriptParser::TypeTestNode *>(p_expression));
  2330. break;
  2331. case GDScriptParser::Node::UNARY_OPERATOR:
  2332. reduce_unary_op(static_cast<GDScriptParser::UnaryOpNode *>(p_expression));
  2333. break;
  2334. // Non-expressions. Here only to make sure new nodes aren't forgotten.
  2335. case GDScriptParser::Node::NONE:
  2336. case GDScriptParser::Node::ANNOTATION:
  2337. case GDScriptParser::Node::ASSERT:
  2338. case GDScriptParser::Node::BREAK:
  2339. case GDScriptParser::Node::BREAKPOINT:
  2340. case GDScriptParser::Node::CLASS:
  2341. case GDScriptParser::Node::CONSTANT:
  2342. case GDScriptParser::Node::CONTINUE:
  2343. case GDScriptParser::Node::ENUM:
  2344. case GDScriptParser::Node::FOR:
  2345. case GDScriptParser::Node::FUNCTION:
  2346. case GDScriptParser::Node::IF:
  2347. case GDScriptParser::Node::MATCH:
  2348. case GDScriptParser::Node::MATCH_BRANCH:
  2349. case GDScriptParser::Node::PARAMETER:
  2350. case GDScriptParser::Node::PASS:
  2351. case GDScriptParser::Node::PATTERN:
  2352. case GDScriptParser::Node::RETURN:
  2353. case GDScriptParser::Node::SIGNAL:
  2354. case GDScriptParser::Node::SUITE:
  2355. case GDScriptParser::Node::TYPE:
  2356. case GDScriptParser::Node::VARIABLE:
  2357. case GDScriptParser::Node::WHILE:
  2358. ERR_FAIL_MSG("Reaching unreachable case");
  2359. }
  2360. if (p_expression->get_datatype().kind == GDScriptParser::DataType::UNRESOLVED) {
  2361. // Prevent `is_type_compatible()` errors for incomplete expressions.
  2362. // The error can still occur if `reduce_*()` is called directly.
  2363. GDScriptParser::DataType dummy;
  2364. dummy.kind = GDScriptParser::DataType::VARIANT;
  2365. p_expression->set_datatype(dummy);
  2366. }
  2367. }
  2368. void GDScriptAnalyzer::reduce_array(GDScriptParser::ArrayNode *p_array) {
  2369. for (int i = 0; i < p_array->elements.size(); i++) {
  2370. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  2371. reduce_expression(element);
  2372. }
  2373. // It's array in any case.
  2374. GDScriptParser::DataType arr_type;
  2375. arr_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2376. arr_type.kind = GDScriptParser::DataType::BUILTIN;
  2377. arr_type.builtin_type = Variant::ARRAY;
  2378. arr_type.is_constant = true;
  2379. p_array->set_datatype(arr_type);
  2380. }
  2381. #ifdef DEBUG_ENABLED
  2382. static bool enum_has_value(const GDScriptParser::DataType p_type, int64_t p_value) {
  2383. for (const KeyValue<StringName, int64_t> &E : p_type.enum_values) {
  2384. if (E.value == p_value) {
  2385. return true;
  2386. }
  2387. }
  2388. return false;
  2389. }
  2390. #endif // DEBUG_ENABLED
  2391. void GDScriptAnalyzer::update_const_expression_builtin_type(GDScriptParser::ExpressionNode *p_expression, const GDScriptParser::DataType &p_type, const char *p_usage, bool p_is_cast) {
  2392. if (p_expression->get_datatype() == p_type) {
  2393. return;
  2394. }
  2395. if (p_type.kind != GDScriptParser::DataType::BUILTIN && p_type.kind != GDScriptParser::DataType::ENUM) {
  2396. return;
  2397. }
  2398. GDScriptParser::DataType expression_type = p_expression->get_datatype();
  2399. 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;
  2400. if (!is_enum_cast && !is_type_compatible(p_type, expression_type, true, p_expression)) {
  2401. 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);
  2402. return;
  2403. }
  2404. GDScriptParser::DataType value_type = type_from_variant(p_expression->reduced_value, p_expression);
  2405. if (expression_type.is_variant() && !is_enum_cast && !is_type_compatible(p_type, value_type, true, p_expression)) {
  2406. 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);
  2407. return;
  2408. }
  2409. #ifdef DEBUG_ENABLED
  2410. if (p_type.kind == GDScriptParser::DataType::ENUM && value_type.builtin_type == Variant::INT && !enum_has_value(p_type, p_expression->reduced_value)) {
  2411. parser->push_warning(p_expression, GDScriptWarning::INT_AS_ENUM_WITHOUT_MATCH, p_usage, p_expression->reduced_value.stringify(), p_type.to_string());
  2412. }
  2413. #endif // DEBUG_ENABLED
  2414. if (value_type.builtin_type == p_type.builtin_type) {
  2415. p_expression->set_datatype(p_type);
  2416. return;
  2417. }
  2418. Variant converted_to;
  2419. const Variant *converted_from = &p_expression->reduced_value;
  2420. Callable::CallError call_error;
  2421. Variant::construct(p_type.builtin_type, converted_to, &converted_from, 1, call_error);
  2422. if (call_error.error) {
  2423. push_error(vformat(R"(Failed to convert a value of type "%s" to "%s".)", value_type.to_string(), p_type.to_string()), p_expression);
  2424. return;
  2425. }
  2426. #ifdef DEBUG_ENABLED
  2427. if (p_type.builtin_type == Variant::INT && value_type.builtin_type == Variant::FLOAT) {
  2428. parser->push_warning(p_expression, GDScriptWarning::NARROWING_CONVERSION);
  2429. }
  2430. #endif // DEBUG_ENABLED
  2431. p_expression->reduced_value = converted_to;
  2432. p_expression->set_datatype(p_type);
  2433. }
  2434. // When an array literal is stored (or passed as function argument) to a typed context, we then assume the array is typed.
  2435. // This function determines which type is that (if any).
  2436. void GDScriptAnalyzer::update_array_literal_element_type(GDScriptParser::ArrayNode *p_array, const GDScriptParser::DataType &p_element_type) {
  2437. GDScriptParser::DataType expected_type = p_element_type;
  2438. expected_type.container_element_types.clear(); // Nested types (like `Array[Array[int]]`) are not currently supported.
  2439. for (int i = 0; i < p_array->elements.size(); i++) {
  2440. GDScriptParser::ExpressionNode *element_node = p_array->elements[i];
  2441. if (element_node->is_constant) {
  2442. update_const_expression_builtin_type(element_node, expected_type, "include");
  2443. }
  2444. const GDScriptParser::DataType &actual_type = element_node->get_datatype();
  2445. if (actual_type.has_no_type() || actual_type.is_variant() || !actual_type.is_hard_type()) {
  2446. mark_node_unsafe(element_node);
  2447. continue;
  2448. }
  2449. if (!is_type_compatible(expected_type, actual_type, true, p_array)) {
  2450. if (is_type_compatible(actual_type, expected_type)) {
  2451. mark_node_unsafe(element_node);
  2452. continue;
  2453. }
  2454. 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);
  2455. return;
  2456. }
  2457. }
  2458. GDScriptParser::DataType array_type = p_array->get_datatype();
  2459. array_type.set_container_element_type(0, expected_type);
  2460. p_array->set_datatype(array_type);
  2461. }
  2462. // When a dictionary literal is stored (or passed as function argument) to a typed context, we then assume the dictionary is typed.
  2463. // This function determines which type is that (if any).
  2464. 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) {
  2465. GDScriptParser::DataType expected_key_type = p_key_element_type;
  2466. GDScriptParser::DataType expected_value_type = p_value_element_type;
  2467. expected_key_type.container_element_types.clear(); // Nested types (like `Dictionary[String, Array[int]]`) are not currently supported.
  2468. expected_value_type.container_element_types.clear();
  2469. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  2470. GDScriptParser::ExpressionNode *key_element_node = p_dictionary->elements[i].key;
  2471. if (key_element_node->is_constant) {
  2472. update_const_expression_builtin_type(key_element_node, expected_key_type, "include");
  2473. }
  2474. const GDScriptParser::DataType &actual_key_type = key_element_node->get_datatype();
  2475. if (actual_key_type.has_no_type() || actual_key_type.is_variant() || !actual_key_type.is_hard_type()) {
  2476. mark_node_unsafe(key_element_node);
  2477. } else if (!is_type_compatible(expected_key_type, actual_key_type, true, p_dictionary)) {
  2478. if (is_type_compatible(actual_key_type, expected_key_type)) {
  2479. mark_node_unsafe(key_element_node);
  2480. } else {
  2481. 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);
  2482. return;
  2483. }
  2484. }
  2485. GDScriptParser::ExpressionNode *value_element_node = p_dictionary->elements[i].value;
  2486. if (value_element_node->is_constant) {
  2487. update_const_expression_builtin_type(value_element_node, expected_value_type, "include");
  2488. }
  2489. const GDScriptParser::DataType &actual_value_type = value_element_node->get_datatype();
  2490. if (actual_value_type.has_no_type() || actual_value_type.is_variant() || !actual_value_type.is_hard_type()) {
  2491. mark_node_unsafe(value_element_node);
  2492. } else if (!is_type_compatible(expected_value_type, actual_value_type, true, p_dictionary)) {
  2493. if (is_type_compatible(actual_value_type, expected_value_type)) {
  2494. mark_node_unsafe(value_element_node);
  2495. } else {
  2496. 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);
  2497. return;
  2498. }
  2499. }
  2500. }
  2501. GDScriptParser::DataType dictionary_type = p_dictionary->get_datatype();
  2502. dictionary_type.set_container_element_type(0, expected_key_type);
  2503. dictionary_type.set_container_element_type(1, expected_value_type);
  2504. p_dictionary->set_datatype(dictionary_type);
  2505. }
  2506. void GDScriptAnalyzer::reduce_assignment(GDScriptParser::AssignmentNode *p_assignment) {
  2507. reduce_expression(p_assignment->assigned_value);
  2508. #ifdef DEBUG_ENABLED
  2509. // Increment assignment count for local variables.
  2510. // Before we reduce the assignee because we don't want to warn about not being assigned when performing the assignment.
  2511. if (p_assignment->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  2512. GDScriptParser::IdentifierNode *id = static_cast<GDScriptParser::IdentifierNode *>(p_assignment->assignee);
  2513. if (id->source == GDScriptParser::IdentifierNode::LOCAL_VARIABLE && id->variable_source) {
  2514. id->variable_source->assignments++;
  2515. }
  2516. }
  2517. #endif // DEBUG_ENABLED
  2518. reduce_expression(p_assignment->assignee);
  2519. #ifdef DEBUG_ENABLED
  2520. {
  2521. bool is_subscript = false;
  2522. GDScriptParser::ExpressionNode *base = p_assignment->assignee;
  2523. while (base && base->type == GDScriptParser::Node::SUBSCRIPT) {
  2524. is_subscript = true;
  2525. base = static_cast<GDScriptParser::SubscriptNode *>(base)->base;
  2526. }
  2527. if (base && base->type == GDScriptParser::Node::IDENTIFIER) {
  2528. GDScriptParser::IdentifierNode *id = static_cast<GDScriptParser::IdentifierNode *>(base);
  2529. if (current_lambda && current_lambda->captures_indices.has(id->name)) {
  2530. bool need_warn = false;
  2531. if (is_subscript) {
  2532. const GDScriptParser::DataType &id_type = id->datatype;
  2533. if (id_type.is_hard_type()) {
  2534. switch (id_type.kind) {
  2535. case GDScriptParser::DataType::BUILTIN:
  2536. // TODO: Change `Variant::is_type_shared()` to include packed arrays?
  2537. need_warn = !Variant::is_type_shared(id_type.builtin_type) && id_type.builtin_type < Variant::PACKED_BYTE_ARRAY;
  2538. break;
  2539. case GDScriptParser::DataType::ENUM:
  2540. need_warn = true;
  2541. break;
  2542. default:
  2543. break;
  2544. }
  2545. }
  2546. } else {
  2547. need_warn = true;
  2548. }
  2549. if (need_warn) {
  2550. parser->push_warning(p_assignment, GDScriptWarning::CONFUSABLE_CAPTURE_REASSIGNMENT, id->name);
  2551. }
  2552. }
  2553. }
  2554. }
  2555. #endif // DEBUG_ENABLED
  2556. if (p_assignment->assigned_value == nullptr || p_assignment->assignee == nullptr) {
  2557. return;
  2558. }
  2559. GDScriptParser::DataType assignee_type = p_assignment->assignee->get_datatype();
  2560. if (assignee_type.is_constant) {
  2561. push_error("Cannot assign a new value to a constant.", p_assignment->assignee);
  2562. return;
  2563. } else if (p_assignment->assignee->type == GDScriptParser::Node::SUBSCRIPT && static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee)->base->is_constant) {
  2564. const GDScriptParser::DataType &base_type = static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee)->base->datatype;
  2565. if (base_type.kind != GDScriptParser::DataType::SCRIPT && base_type.kind != GDScriptParser::DataType::CLASS) { // Static variables.
  2566. push_error("Cannot assign a new value to a constant.", p_assignment->assignee);
  2567. return;
  2568. }
  2569. } else if (assignee_type.is_read_only) {
  2570. push_error("Cannot assign a new value to a read-only property.", p_assignment->assignee);
  2571. return;
  2572. } else if (p_assignment->assignee->type == GDScriptParser::Node::SUBSCRIPT) {
  2573. GDScriptParser::SubscriptNode *sub = static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee);
  2574. while (sub) {
  2575. const GDScriptParser::DataType &base_type = sub->base->datatype;
  2576. if (base_type.is_hard_type() && base_type.is_read_only) {
  2577. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !Variant::is_type_shared(base_type.builtin_type)) {
  2578. push_error("Cannot assign a new value to a read-only property.", p_assignment->assignee);
  2579. return;
  2580. }
  2581. } else {
  2582. break;
  2583. }
  2584. if (sub->base->type == GDScriptParser::Node::SUBSCRIPT) {
  2585. sub = static_cast<GDScriptParser::SubscriptNode *>(sub->base);
  2586. } else {
  2587. sub = nullptr;
  2588. }
  2589. }
  2590. }
  2591. // Check if assigned value is an array/dictionary literal, so we can make it a typed container too if appropriate.
  2592. if (p_assignment->assigned_value->type == GDScriptParser::Node::ARRAY && assignee_type.is_hard_type() && assignee_type.has_container_element_type(0)) {
  2593. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_assignment->assigned_value), assignee_type.get_container_element_type(0));
  2594. } else if (p_assignment->assigned_value->type == GDScriptParser::Node::DICTIONARY && assignee_type.is_hard_type() && assignee_type.has_container_element_types()) {
  2595. update_dictionary_literal_element_type(static_cast<GDScriptParser::DictionaryNode *>(p_assignment->assigned_value),
  2596. assignee_type.get_container_element_type_or_variant(0), assignee_type.get_container_element_type_or_variant(1));
  2597. }
  2598. if (p_assignment->operation == GDScriptParser::AssignmentNode::OP_NONE && assignee_type.is_hard_type() && p_assignment->assigned_value->is_constant) {
  2599. update_const_expression_builtin_type(p_assignment->assigned_value, assignee_type, "assign");
  2600. }
  2601. GDScriptParser::DataType assigned_value_type = p_assignment->assigned_value->get_datatype();
  2602. bool assignee_is_variant = assignee_type.is_variant();
  2603. bool assignee_is_hard = assignee_type.is_hard_type();
  2604. bool assigned_is_variant = assigned_value_type.is_variant();
  2605. bool assigned_is_hard = assigned_value_type.is_hard_type();
  2606. bool compatible = true;
  2607. bool downgrades_assignee = false;
  2608. bool downgrades_assigned = false;
  2609. GDScriptParser::DataType op_type = assigned_value_type;
  2610. if (p_assignment->operation != GDScriptParser::AssignmentNode::OP_NONE && !op_type.is_variant()) {
  2611. op_type = get_operation_type(p_assignment->variant_op, assignee_type, assigned_value_type, compatible, p_assignment->assigned_value);
  2612. if (assignee_is_variant) {
  2613. // variant assignee
  2614. mark_node_unsafe(p_assignment);
  2615. } else if (!compatible) {
  2616. // incompatible hard types and non-variant assignee
  2617. mark_node_unsafe(p_assignment);
  2618. if (assigned_is_variant) {
  2619. // incompatible hard non-variant assignee and hard variant assigned
  2620. p_assignment->use_conversion_assign = true;
  2621. } else {
  2622. // incompatible hard non-variant types
  2623. push_error(vformat(R"(Invalid operands "%s" and "%s" for assignment operator.)", assignee_type.to_string(), assigned_value_type.to_string()), p_assignment);
  2624. }
  2625. } else if (op_type.type_source == GDScriptParser::DataType::UNDETECTED && !assigned_is_variant) {
  2626. // incompatible non-variant types (at least one weak)
  2627. downgrades_assignee = !assignee_is_hard;
  2628. downgrades_assigned = !assigned_is_hard;
  2629. }
  2630. }
  2631. p_assignment->set_datatype(op_type);
  2632. if (assignee_is_variant) {
  2633. if (!assignee_is_hard) {
  2634. // weak variant assignee
  2635. mark_node_unsafe(p_assignment);
  2636. }
  2637. } else {
  2638. if (assignee_is_hard && !assigned_is_hard) {
  2639. // hard non-variant assignee and weak assigned
  2640. mark_node_unsafe(p_assignment);
  2641. p_assignment->use_conversion_assign = true;
  2642. downgrades_assigned = downgrades_assigned || (!assigned_is_variant && !is_type_compatible(assignee_type, op_type, true, p_assignment->assigned_value));
  2643. } else if (compatible) {
  2644. if (op_type.is_variant()) {
  2645. // non-variant assignee and variant result
  2646. mark_node_unsafe(p_assignment);
  2647. if (assignee_is_hard) {
  2648. // hard non-variant assignee and variant result
  2649. p_assignment->use_conversion_assign = true;
  2650. } else {
  2651. // weak non-variant assignee and variant result
  2652. downgrades_assignee = true;
  2653. }
  2654. } else if (!is_type_compatible(assignee_type, op_type, assignee_is_hard, p_assignment->assigned_value)) {
  2655. // non-variant assignee and incompatible result
  2656. mark_node_unsafe(p_assignment);
  2657. if (assignee_is_hard) {
  2658. if (is_type_compatible(op_type, assignee_type)) {
  2659. // hard non-variant assignee and maybe compatible result
  2660. p_assignment->use_conversion_assign = true;
  2661. } else {
  2662. // hard non-variant assignee and incompatible result
  2663. 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);
  2664. }
  2665. } else {
  2666. // weak non-variant assignee and incompatible result
  2667. downgrades_assignee = true;
  2668. }
  2669. } 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))) {
  2670. // Typed assignee and untyped result.
  2671. mark_node_unsafe(p_assignment);
  2672. }
  2673. }
  2674. }
  2675. if (downgrades_assignee) {
  2676. downgrade_node_type_source(p_assignment->assignee);
  2677. }
  2678. if (downgrades_assigned) {
  2679. downgrade_node_type_source(p_assignment->assigned_value);
  2680. }
  2681. #ifdef DEBUG_ENABLED
  2682. if (assignee_type.is_hard_type() && assignee_type.builtin_type == Variant::INT && assigned_value_type.builtin_type == Variant::FLOAT) {
  2683. parser->push_warning(p_assignment->assigned_value, GDScriptWarning::NARROWING_CONVERSION);
  2684. }
  2685. // Check for assignment with operation before assignment.
  2686. if (p_assignment->operation != GDScriptParser::AssignmentNode::OP_NONE && p_assignment->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  2687. GDScriptParser::IdentifierNode *id = static_cast<GDScriptParser::IdentifierNode *>(p_assignment->assignee);
  2688. // Use == 1 here because this assignment was already counted in the beginning of the function.
  2689. if (id->source == GDScriptParser::IdentifierNode::LOCAL_VARIABLE && id->variable_source && id->variable_source->assignments == 1) {
  2690. parser->push_warning(p_assignment, GDScriptWarning::UNASSIGNED_VARIABLE_OP_ASSIGN, id->name, Variant::get_operator_name(p_assignment->variant_op));
  2691. }
  2692. }
  2693. #endif // DEBUG_ENABLED
  2694. }
  2695. void GDScriptAnalyzer::reduce_await(GDScriptParser::AwaitNode *p_await) {
  2696. if (p_await->to_await == nullptr) {
  2697. GDScriptParser::DataType await_type;
  2698. await_type.kind = GDScriptParser::DataType::VARIANT;
  2699. p_await->set_datatype(await_type);
  2700. return;
  2701. }
  2702. if (p_await->to_await->type == GDScriptParser::Node::CALL) {
  2703. reduce_call(static_cast<GDScriptParser::CallNode *>(p_await->to_await), true);
  2704. } else {
  2705. reduce_expression(p_await->to_await);
  2706. }
  2707. GDScriptParser::DataType await_type = p_await->to_await->get_datatype();
  2708. // We cannot infer the type of the result of waiting for a signal.
  2709. if (await_type.is_hard_type() && await_type.kind == GDScriptParser::DataType::BUILTIN && await_type.builtin_type == Variant::SIGNAL) {
  2710. await_type.kind = GDScriptParser::DataType::VARIANT;
  2711. await_type.type_source = GDScriptParser::DataType::UNDETECTED;
  2712. } else if (p_await->to_await->is_constant) {
  2713. p_await->is_constant = p_await->to_await->is_constant;
  2714. p_await->reduced_value = p_await->to_await->reduced_value;
  2715. }
  2716. await_type.is_coroutine = false;
  2717. p_await->set_datatype(await_type);
  2718. #ifdef DEBUG_ENABLED
  2719. GDScriptParser::DataType to_await_type = p_await->to_await->get_datatype();
  2720. if (!to_await_type.is_coroutine && !to_await_type.is_variant() && to_await_type.builtin_type != Variant::SIGNAL) {
  2721. parser->push_warning(p_await, GDScriptWarning::REDUNDANT_AWAIT);
  2722. }
  2723. #endif // DEBUG_ENABLED
  2724. }
  2725. void GDScriptAnalyzer::reduce_binary_op(GDScriptParser::BinaryOpNode *p_binary_op) {
  2726. reduce_expression(p_binary_op->left_operand);
  2727. reduce_expression(p_binary_op->right_operand);
  2728. GDScriptParser::DataType left_type;
  2729. if (p_binary_op->left_operand) {
  2730. left_type = p_binary_op->left_operand->get_datatype();
  2731. }
  2732. GDScriptParser::DataType right_type;
  2733. if (p_binary_op->right_operand) {
  2734. right_type = p_binary_op->right_operand->get_datatype();
  2735. }
  2736. if (!left_type.is_set() || !right_type.is_set()) {
  2737. return;
  2738. }
  2739. #ifdef DEBUG_ENABLED
  2740. if (p_binary_op->variant_op == Variant::OP_DIVIDE && left_type.builtin_type == Variant::INT && right_type.builtin_type == Variant::INT) {
  2741. parser->push_warning(p_binary_op, GDScriptWarning::INTEGER_DIVISION);
  2742. }
  2743. #endif // DEBUG_ENABLED
  2744. if (p_binary_op->left_operand->is_constant && p_binary_op->right_operand->is_constant) {
  2745. p_binary_op->is_constant = true;
  2746. if (p_binary_op->variant_op < Variant::OP_MAX) {
  2747. bool valid = false;
  2748. 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);
  2749. if (!valid) {
  2750. if (p_binary_op->reduced_value.get_type() == Variant::STRING) {
  2751. 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);
  2752. } else {
  2753. push_error(vformat(R"(Invalid operands to operator %s, %s and %s.)",
  2754. Variant::get_operator_name(p_binary_op->variant_op),
  2755. Variant::get_type_name(p_binary_op->left_operand->reduced_value.get_type()),
  2756. Variant::get_type_name(p_binary_op->right_operand->reduced_value.get_type())),
  2757. p_binary_op);
  2758. }
  2759. }
  2760. } else {
  2761. ERR_PRINT("Parser bug: unknown binary operation.");
  2762. }
  2763. p_binary_op->set_datatype(type_from_variant(p_binary_op->reduced_value, p_binary_op));
  2764. return;
  2765. }
  2766. GDScriptParser::DataType result;
  2767. if ((p_binary_op->variant_op == Variant::OP_EQUAL || p_binary_op->variant_op == Variant::OP_NOT_EQUAL) &&
  2768. ((left_type.kind == GDScriptParser::DataType::BUILTIN && left_type.builtin_type == Variant::NIL) || (right_type.kind == GDScriptParser::DataType::BUILTIN && right_type.builtin_type == Variant::NIL))) {
  2769. // "==" and "!=" operators always return a boolean when comparing to null.
  2770. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2771. result.kind = GDScriptParser::DataType::BUILTIN;
  2772. result.builtin_type = Variant::BOOL;
  2773. } else if (p_binary_op->variant_op == Variant::OP_MODULE && left_type.builtin_type == Variant::STRING) {
  2774. // The modulo operator (%) on string acts as formatting and will always return a string.
  2775. result.type_source = left_type.type_source;
  2776. result.kind = GDScriptParser::DataType::BUILTIN;
  2777. result.builtin_type = Variant::STRING;
  2778. } else if (left_type.is_variant() || right_type.is_variant()) {
  2779. // Cannot infer type because one operand can be anything.
  2780. result.kind = GDScriptParser::DataType::VARIANT;
  2781. mark_node_unsafe(p_binary_op);
  2782. } else if (p_binary_op->variant_op < Variant::OP_MAX) {
  2783. bool valid = false;
  2784. result = get_operation_type(p_binary_op->variant_op, left_type, right_type, valid, p_binary_op);
  2785. if (!valid) {
  2786. 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);
  2787. } else if (!result.is_hard_type()) {
  2788. mark_node_unsafe(p_binary_op);
  2789. }
  2790. } else {
  2791. ERR_PRINT("Parser bug: unknown binary operation.");
  2792. }
  2793. p_binary_op->set_datatype(result);
  2794. }
  2795. #ifdef SUGGEST_GODOT4_RENAMES
  2796. const char *get_rename_from_map(const char *map[][2], String key) {
  2797. for (int index = 0; map[index][0]; index++) {
  2798. if (map[index][0] == key) {
  2799. return map[index][1];
  2800. }
  2801. }
  2802. return nullptr;
  2803. }
  2804. // Checks if an identifier/function name has been renamed in Godot 4, uses ProjectConverter3To4 for rename map.
  2805. // Returns the new name if found, nullptr otherwise.
  2806. const char *check_for_renamed_identifier(String identifier, GDScriptParser::Node::Type type) {
  2807. switch (type) {
  2808. case GDScriptParser::Node::IDENTIFIER: {
  2809. // Check properties
  2810. const char *result = get_rename_from_map(RenamesMap3To4::gdscript_properties_renames, identifier);
  2811. if (result) {
  2812. return result;
  2813. }
  2814. // Check enum values
  2815. result = get_rename_from_map(RenamesMap3To4::enum_renames, identifier);
  2816. if (result) {
  2817. return result;
  2818. }
  2819. // Check color constants
  2820. result = get_rename_from_map(RenamesMap3To4::color_renames, identifier);
  2821. if (result) {
  2822. return result;
  2823. }
  2824. // Check type names
  2825. result = get_rename_from_map(RenamesMap3To4::class_renames, identifier);
  2826. if (result) {
  2827. return result;
  2828. }
  2829. return get_rename_from_map(RenamesMap3To4::builtin_types_renames, identifier);
  2830. }
  2831. case GDScriptParser::Node::CALL: {
  2832. const char *result = get_rename_from_map(RenamesMap3To4::gdscript_function_renames, identifier);
  2833. if (result) {
  2834. return result;
  2835. }
  2836. // Built-in Types are mistaken for function calls when the built-in type is not found.
  2837. // Check built-in types if function rename not found
  2838. return get_rename_from_map(RenamesMap3To4::builtin_types_renames, identifier);
  2839. }
  2840. // Signal references don't get parsed through the GDScriptAnalyzer. No support for signal rename hints.
  2841. default:
  2842. // No rename found, return null
  2843. return nullptr;
  2844. }
  2845. }
  2846. #endif // SUGGEST_GODOT4_RENAMES
  2847. void GDScriptAnalyzer::reduce_call(GDScriptParser::CallNode *p_call, bool p_is_await, bool p_is_root) {
  2848. bool all_is_constant = true;
  2849. HashMap<int, GDScriptParser::ArrayNode *> arrays; // For array literal to potentially type when passing.
  2850. HashMap<int, GDScriptParser::DictionaryNode *> dictionaries; // Same, but for dictionaries.
  2851. for (int i = 0; i < p_call->arguments.size(); i++) {
  2852. reduce_expression(p_call->arguments[i]);
  2853. if (p_call->arguments[i]->type == GDScriptParser::Node::ARRAY) {
  2854. arrays[i] = static_cast<GDScriptParser::ArrayNode *>(p_call->arguments[i]);
  2855. } else if (p_call->arguments[i]->type == GDScriptParser::Node::DICTIONARY) {
  2856. dictionaries[i] = static_cast<GDScriptParser::DictionaryNode *>(p_call->arguments[i]);
  2857. }
  2858. all_is_constant = all_is_constant && p_call->arguments[i]->is_constant;
  2859. }
  2860. GDScriptParser::Node::Type callee_type = p_call->get_callee_type();
  2861. GDScriptParser::DataType call_type;
  2862. if (!p_call->is_super && callee_type == GDScriptParser::Node::IDENTIFIER) {
  2863. // Call to name directly.
  2864. StringName function_name = p_call->function_name;
  2865. if (function_name == SNAME("Object")) {
  2866. push_error(R"*(Invalid constructor "Object()", use "Object.new()" instead.)*", p_call);
  2867. p_call->set_datatype(call_type);
  2868. return;
  2869. }
  2870. Variant::Type builtin_type = GDScriptParser::get_builtin_type(function_name);
  2871. if (builtin_type < Variant::VARIANT_MAX) {
  2872. // Is a builtin constructor.
  2873. call_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2874. call_type.kind = GDScriptParser::DataType::BUILTIN;
  2875. call_type.builtin_type = builtin_type;
  2876. bool safe_to_fold = true;
  2877. switch (builtin_type) {
  2878. // Those are stored by reference so not suited for compile-time construction.
  2879. // Because in this case they would be the same reference in all constructed values.
  2880. case Variant::OBJECT:
  2881. case Variant::DICTIONARY:
  2882. case Variant::ARRAY:
  2883. case Variant::PACKED_BYTE_ARRAY:
  2884. case Variant::PACKED_INT32_ARRAY:
  2885. case Variant::PACKED_INT64_ARRAY:
  2886. case Variant::PACKED_FLOAT32_ARRAY:
  2887. case Variant::PACKED_FLOAT64_ARRAY:
  2888. case Variant::PACKED_STRING_ARRAY:
  2889. case Variant::PACKED_VECTOR2_ARRAY:
  2890. case Variant::PACKED_VECTOR3_ARRAY:
  2891. case Variant::PACKED_COLOR_ARRAY:
  2892. case Variant::PACKED_VECTOR4_ARRAY:
  2893. safe_to_fold = false;
  2894. break;
  2895. default:
  2896. break;
  2897. }
  2898. if (all_is_constant && safe_to_fold) {
  2899. // Construct here.
  2900. Vector<const Variant *> args;
  2901. for (int i = 0; i < p_call->arguments.size(); i++) {
  2902. args.push_back(&(p_call->arguments[i]->reduced_value));
  2903. }
  2904. Callable::CallError err;
  2905. Variant value;
  2906. Variant::construct(builtin_type, value, (const Variant **)args.ptr(), args.size(), err);
  2907. switch (err.error) {
  2908. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  2909. 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,
  2910. Variant::get_type_name(Variant::Type(err.expected)), p_call->arguments[err.argument]->get_datatype().to_string()),
  2911. p_call->arguments[err.argument]);
  2912. break;
  2913. case Callable::CallError::CALL_ERROR_INVALID_METHOD: {
  2914. String signature = Variant::get_type_name(builtin_type) + "(";
  2915. for (int i = 0; i < p_call->arguments.size(); i++) {
  2916. if (i > 0) {
  2917. signature += ", ";
  2918. }
  2919. signature += p_call->arguments[i]->get_datatype().to_string();
  2920. }
  2921. signature += ")";
  2922. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call->callee);
  2923. } break;
  2924. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  2925. 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);
  2926. break;
  2927. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  2928. 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);
  2929. break;
  2930. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  2931. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  2932. break; // Can't happen in a builtin constructor.
  2933. case Callable::CallError::CALL_OK:
  2934. p_call->is_constant = true;
  2935. p_call->reduced_value = value;
  2936. break;
  2937. }
  2938. } else {
  2939. // If there's one argument, try to use copy constructor (those aren't explicitly defined).
  2940. if (p_call->arguments.size() == 1) {
  2941. GDScriptParser::DataType arg_type = p_call->arguments[0]->get_datatype();
  2942. if (arg_type.is_hard_type() && !arg_type.is_variant()) {
  2943. if (arg_type.kind == GDScriptParser::DataType::BUILTIN && arg_type.builtin_type == builtin_type) {
  2944. // Okay.
  2945. p_call->set_datatype(call_type);
  2946. return;
  2947. }
  2948. } else {
  2949. #ifdef DEBUG_ENABLED
  2950. mark_node_unsafe(p_call);
  2951. // Constructors support overloads.
  2952. Vector<String> types;
  2953. for (int i = 0; i < Variant::VARIANT_MAX; i++) {
  2954. if (i != builtin_type && Variant::can_convert_strict((Variant::Type)i, builtin_type)) {
  2955. types.push_back(Variant::get_type_name((Variant::Type)i));
  2956. }
  2957. }
  2958. String expected_types = function_name;
  2959. if (types.size() == 1) {
  2960. expected_types += "\" or \"" + types[0];
  2961. } else if (types.size() >= 2) {
  2962. for (int i = 0; i < types.size() - 1; i++) {
  2963. expected_types += "\", \"" + types[i];
  2964. }
  2965. expected_types += "\", or \"" + types[types.size() - 1];
  2966. }
  2967. parser->push_warning(p_call->arguments[0], GDScriptWarning::UNSAFE_CALL_ARGUMENT, "1", "constructor", function_name, expected_types, "Variant");
  2968. #endif // DEBUG_ENABLED
  2969. p_call->set_datatype(call_type);
  2970. return;
  2971. }
  2972. }
  2973. List<MethodInfo> constructors;
  2974. Variant::get_constructor_list(builtin_type, &constructors);
  2975. bool match = false;
  2976. for (const MethodInfo &info : constructors) {
  2977. if (p_call->arguments.size() < info.arguments.size() - info.default_arguments.size()) {
  2978. continue;
  2979. }
  2980. if (p_call->arguments.size() > info.arguments.size()) {
  2981. continue;
  2982. }
  2983. bool types_match = true;
  2984. for (int64_t i = 0; i < p_call->arguments.size(); ++i) {
  2985. GDScriptParser::DataType par_type = type_from_property(info.arguments[i], true);
  2986. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  2987. if (!is_type_compatible(par_type, arg_type, true)) {
  2988. types_match = false;
  2989. break;
  2990. #ifdef DEBUG_ENABLED
  2991. } else {
  2992. if (par_type.builtin_type == Variant::INT && arg_type.builtin_type == Variant::FLOAT && builtin_type != Variant::INT) {
  2993. parser->push_warning(p_call, GDScriptWarning::NARROWING_CONVERSION, function_name);
  2994. }
  2995. #endif // DEBUG_ENABLED
  2996. }
  2997. }
  2998. if (types_match) {
  2999. for (int64_t i = 0; i < p_call->arguments.size(); ++i) {
  3000. GDScriptParser::DataType par_type = type_from_property(info.arguments[i], true);
  3001. if (p_call->arguments[i]->is_constant) {
  3002. update_const_expression_builtin_type(p_call->arguments[i], par_type, "pass");
  3003. }
  3004. #ifdef DEBUG_ENABLED
  3005. if (!(par_type.is_variant() && par_type.is_hard_type())) {
  3006. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  3007. if (arg_type.is_variant() || !arg_type.is_hard_type()) {
  3008. mark_node_unsafe(p_call);
  3009. 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());
  3010. }
  3011. }
  3012. #endif // DEBUG_ENABLED
  3013. }
  3014. match = true;
  3015. call_type = type_from_property(info.return_val);
  3016. break;
  3017. }
  3018. }
  3019. if (!match) {
  3020. String signature = Variant::get_type_name(builtin_type) + "(";
  3021. for (int i = 0; i < p_call->arguments.size(); i++) {
  3022. if (i > 0) {
  3023. signature += ", ";
  3024. }
  3025. signature += p_call->arguments[i]->get_datatype().to_string();
  3026. }
  3027. signature += ")";
  3028. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call);
  3029. }
  3030. }
  3031. #ifdef DEBUG_ENABLED
  3032. // Consider `Signal(self, "my_signal")` as an implicit use of the signal.
  3033. if (builtin_type == Variant::SIGNAL && p_call->arguments.size() >= 2) {
  3034. const GDScriptParser::ExpressionNode *object_arg = p_call->arguments[0];
  3035. if (object_arg && object_arg->type == GDScriptParser::Node::SELF) {
  3036. const GDScriptParser::ExpressionNode *signal_arg = p_call->arguments[1];
  3037. if (signal_arg && signal_arg->is_constant) {
  3038. const StringName &signal_name = signal_arg->reduced_value;
  3039. if (parser->current_class->has_member(signal_name)) {
  3040. const GDScriptParser::ClassNode::Member &member = parser->current_class->get_member(signal_name);
  3041. if (member.type == GDScriptParser::ClassNode::Member::SIGNAL) {
  3042. member.signal->usages++;
  3043. }
  3044. }
  3045. }
  3046. }
  3047. }
  3048. #endif // DEBUG_ENABLED
  3049. p_call->set_datatype(call_type);
  3050. return;
  3051. } else if (GDScriptUtilityFunctions::function_exists(function_name)) {
  3052. MethodInfo function_info = GDScriptUtilityFunctions::get_function_info(function_name);
  3053. 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)) {
  3054. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", function_name), p_call);
  3055. }
  3056. if (all_is_constant && GDScriptUtilityFunctions::is_function_constant(function_name)) {
  3057. // Can call on compilation.
  3058. Vector<const Variant *> args;
  3059. for (int i = 0; i < p_call->arguments.size(); i++) {
  3060. args.push_back(&(p_call->arguments[i]->reduced_value));
  3061. }
  3062. Variant value;
  3063. Callable::CallError err;
  3064. GDScriptUtilityFunctions::get_function(function_name)(&value, (const Variant **)args.ptr(), args.size(), err);
  3065. switch (err.error) {
  3066. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  3067. if (value.get_type() == Variant::STRING && !value.operator String().is_empty()) {
  3068. push_error(vformat(R"*(Invalid argument for "%s()" function: %s)*", function_name, value), p_call->arguments[err.argument]);
  3069. } else {
  3070. // Do not use `type_from_property()` for expected type, since utility functions use their own checks.
  3071. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*", function_name, err.argument + 1,
  3072. Variant::get_type_name((Variant::Type)err.expected), p_call->arguments[err.argument]->get_datatype().to_string()),
  3073. p_call->arguments[err.argument]);
  3074. }
  3075. break;
  3076. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  3077. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  3078. break;
  3079. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  3080. 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);
  3081. break;
  3082. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  3083. 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);
  3084. break;
  3085. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  3086. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  3087. break; // Can't happen in a builtin constructor.
  3088. case Callable::CallError::CALL_OK:
  3089. p_call->is_constant = true;
  3090. p_call->reduced_value = value;
  3091. break;
  3092. }
  3093. } else {
  3094. validate_call_arg(function_info, p_call);
  3095. }
  3096. p_call->set_datatype(type_from_property(function_info.return_val));
  3097. return;
  3098. } else if (Variant::has_utility_function(function_name)) {
  3099. MethodInfo function_info = info_from_utility_func(function_name);
  3100. 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)) {
  3101. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", function_name), p_call);
  3102. }
  3103. if (all_is_constant && Variant::get_utility_function_type(function_name) == Variant::UTILITY_FUNC_TYPE_MATH) {
  3104. // Can call on compilation.
  3105. Vector<const Variant *> args;
  3106. for (int i = 0; i < p_call->arguments.size(); i++) {
  3107. args.push_back(&(p_call->arguments[i]->reduced_value));
  3108. }
  3109. Variant value;
  3110. Callable::CallError err;
  3111. Variant::call_utility_function(function_name, &value, (const Variant **)args.ptr(), args.size(), err);
  3112. switch (err.error) {
  3113. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  3114. if (value.get_type() == Variant::STRING && !value.operator String().is_empty()) {
  3115. push_error(vformat(R"*(Invalid argument for "%s()" function: %s)*", function_name, value), p_call->arguments[err.argument]);
  3116. } else {
  3117. // Do not use `type_from_property()` for expected type, since utility functions use their own checks.
  3118. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*", function_name, err.argument + 1,
  3119. Variant::get_type_name((Variant::Type)err.expected), p_call->arguments[err.argument]->get_datatype().to_string()),
  3120. p_call->arguments[err.argument]);
  3121. }
  3122. break;
  3123. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  3124. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  3125. break;
  3126. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  3127. 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);
  3128. break;
  3129. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  3130. 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);
  3131. break;
  3132. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  3133. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  3134. break; // Can't happen in a builtin constructor.
  3135. case Callable::CallError::CALL_OK:
  3136. p_call->is_constant = true;
  3137. p_call->reduced_value = value;
  3138. break;
  3139. }
  3140. } else {
  3141. validate_call_arg(function_info, p_call);
  3142. }
  3143. p_call->set_datatype(type_from_property(function_info.return_val));
  3144. return;
  3145. }
  3146. }
  3147. GDScriptParser::DataType base_type;
  3148. call_type.kind = GDScriptParser::DataType::VARIANT;
  3149. bool is_self = false;
  3150. if (p_call->is_super) {
  3151. base_type = parser->current_class->base_type;
  3152. base_type.is_meta_type = false;
  3153. is_self = true;
  3154. if (p_call->callee == nullptr && current_lambda != nullptr) {
  3155. push_error("Cannot use `super()` inside a lambda.", p_call);
  3156. }
  3157. } else if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  3158. base_type = parser->current_class->get_datatype();
  3159. base_type.is_meta_type = false;
  3160. is_self = true;
  3161. } else if (callee_type == GDScriptParser::Node::SUBSCRIPT) {
  3162. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee);
  3163. if (subscript->base == nullptr) {
  3164. // Invalid syntax, error already set on parser.
  3165. p_call->set_datatype(call_type);
  3166. mark_node_unsafe(p_call);
  3167. return;
  3168. }
  3169. if (!subscript->is_attribute) {
  3170. // Invalid call. Error already sent in parser.
  3171. // TODO: Could check if Callable here.
  3172. p_call->set_datatype(call_type);
  3173. mark_node_unsafe(p_call);
  3174. return;
  3175. }
  3176. if (subscript->attribute == nullptr) {
  3177. // Invalid call. Error already sent in parser.
  3178. p_call->set_datatype(call_type);
  3179. mark_node_unsafe(p_call);
  3180. return;
  3181. }
  3182. GDScriptParser::IdentifierNode *base_id = nullptr;
  3183. if (subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  3184. base_id = static_cast<GDScriptParser::IdentifierNode *>(subscript->base);
  3185. }
  3186. if (base_id && GDScriptParser::get_builtin_type(base_id->name) < Variant::VARIANT_MAX) {
  3187. base_type = make_builtin_meta_type(GDScriptParser::get_builtin_type(base_id->name));
  3188. } else {
  3189. reduce_expression(subscript->base);
  3190. base_type = subscript->base->get_datatype();
  3191. is_self = subscript->base->type == GDScriptParser::Node::SELF;
  3192. }
  3193. } else {
  3194. // Invalid call. Error already sent in parser.
  3195. // TODO: Could check if Callable here too.
  3196. p_call->set_datatype(call_type);
  3197. mark_node_unsafe(p_call);
  3198. return;
  3199. }
  3200. int default_arg_count = 0;
  3201. BitField<MethodFlags> method_flags = {};
  3202. GDScriptParser::DataType return_type;
  3203. List<GDScriptParser::DataType> par_types;
  3204. bool is_constructor = (base_type.is_meta_type || (p_call->callee && p_call->callee->type == GDScriptParser::Node::IDENTIFIER)) && p_call->function_name == SNAME("new");
  3205. if (is_constructor) {
  3206. if (Engine::get_singleton()->has_singleton(base_type.native_type)) {
  3207. push_error(vformat(R"(Cannot construct native class "%s" because it is an engine singleton.)", base_type.native_type), p_call);
  3208. p_call->set_datatype(call_type);
  3209. return;
  3210. }
  3211. if ((base_type.kind == GDScriptParser::DataType::CLASS && base_type.class_type->is_abstract) || (base_type.kind == GDScriptParser::DataType::SCRIPT && base_type.script_type.is_valid() && base_type.script_type->is_abstract())) {
  3212. push_error(vformat(R"(Cannot construct abstract class "%s".)", base_type.to_string()), p_call);
  3213. }
  3214. }
  3215. if (get_function_signature(p_call, is_constructor, base_type, p_call->function_name, return_type, par_types, default_arg_count, method_flags)) {
  3216. p_call->is_static = method_flags.has_flag(METHOD_FLAG_STATIC);
  3217. // If the method is implemented in the class hierarchy, the virtual/abstract flag will not be set for that `MethodInfo` and the search stops there.
  3218. // Virtual/abstract check only possible for super calls because class hierarchy is known. Objects may have scripts attached we don't know of at compile-time.
  3219. if (p_call->is_super) {
  3220. if (method_flags.has_flag(METHOD_FLAG_VIRTUAL)) {
  3221. push_error(vformat(R"*(Cannot call the parent class' virtual function "%s()" because it hasn't been defined.)*", p_call->function_name), p_call);
  3222. } else if (method_flags.has_flag(METHOD_FLAG_VIRTUAL_REQUIRED)) {
  3223. push_error(vformat(R"*(Cannot call the parent class' abstract function "%s()" because it hasn't been defined.)*", p_call->function_name), p_call);
  3224. }
  3225. }
  3226. // If the function requires typed arrays we must make literals be typed.
  3227. for (const KeyValue<int, GDScriptParser::ArrayNode *> &E : arrays) {
  3228. int index = E.key;
  3229. if (index < par_types.size() && par_types.get(index).is_hard_type() && par_types.get(index).has_container_element_type(0)) {
  3230. update_array_literal_element_type(E.value, par_types.get(index).get_container_element_type(0));
  3231. }
  3232. }
  3233. for (const KeyValue<int, GDScriptParser::DictionaryNode *> &E : dictionaries) {
  3234. int index = E.key;
  3235. if (index < par_types.size() && par_types.get(index).is_hard_type() && par_types.get(index).has_container_element_types()) {
  3236. GDScriptParser::DataType key = par_types.get(index).get_container_element_type_or_variant(0);
  3237. GDScriptParser::DataType value = par_types.get(index).get_container_element_type_or_variant(1);
  3238. update_dictionary_literal_element_type(E.value, key, value);
  3239. }
  3240. }
  3241. validate_call_arg(par_types, default_arg_count, method_flags.has_flag(METHOD_FLAG_VARARG), p_call);
  3242. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type) {
  3243. // Enum type is treated as a dictionary value for function calls.
  3244. base_type.is_meta_type = false;
  3245. }
  3246. if (is_self && static_context && !p_call->is_static) {
  3247. // Get the parent function above any lambda.
  3248. GDScriptParser::FunctionNode *parent_function = parser->current_function;
  3249. while (parent_function && parent_function->source_lambda) {
  3250. parent_function = parent_function->source_lambda->parent_function;
  3251. }
  3252. if (parent_function) {
  3253. 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);
  3254. } else {
  3255. push_error(vformat(R"*(Cannot call non-static function "%s()" from a static variable initializer.)*", p_call->function_name), p_call);
  3256. }
  3257. } else if (!is_self && base_type.is_meta_type && !p_call->is_static) {
  3258. base_type.is_meta_type = false; // For `to_string()`.
  3259. 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);
  3260. } else if (is_self && !p_call->is_static) {
  3261. mark_lambda_use_self();
  3262. }
  3263. if (!p_is_root && !p_is_await && return_type.is_hard_type() && return_type.kind == GDScriptParser::DataType::BUILTIN && return_type.builtin_type == Variant::NIL) {
  3264. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", p_call->function_name), p_call);
  3265. }
  3266. #ifdef DEBUG_ENABLED
  3267. // FIXME: No warning for built-in constructors and utilities due to early return.
  3268. if (p_is_root && return_type.kind != GDScriptParser::DataType::UNRESOLVED && return_type.builtin_type != Variant::NIL &&
  3269. !(p_call->is_super && p_call->function_name == GDScriptLanguage::get_singleton()->strings._init)) {
  3270. parser->push_warning(p_call, GDScriptWarning::RETURN_VALUE_DISCARDED, p_call->function_name);
  3271. }
  3272. if (method_flags.has_flag(METHOD_FLAG_STATIC) && !is_constructor && !base_type.is_meta_type && !is_self) {
  3273. String caller_type = base_type.to_string();
  3274. parser->push_warning(p_call, GDScriptWarning::STATIC_CALLED_ON_INSTANCE, p_call->function_name, caller_type);
  3275. }
  3276. // Consider `emit_signal()`, `connect()`, and `disconnect()` as implicit uses of the signal.
  3277. 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()) {
  3278. const GDScriptParser::ExpressionNode *signal_arg = p_call->arguments[0];
  3279. if (signal_arg && signal_arg->is_constant) {
  3280. const StringName &signal_name = signal_arg->reduced_value;
  3281. if (parser->current_class->has_member(signal_name)) {
  3282. const GDScriptParser::ClassNode::Member &member = parser->current_class->get_member(signal_name);
  3283. if (member.type == GDScriptParser::ClassNode::Member::SIGNAL) {
  3284. member.signal->usages++;
  3285. }
  3286. }
  3287. }
  3288. }
  3289. #endif // DEBUG_ENABLED
  3290. call_type = return_type;
  3291. } else {
  3292. bool found = false;
  3293. // Enums do not have functions other than the built-in dictionary ones.
  3294. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type) {
  3295. if (base_type.builtin_type == Variant::DICTIONARY) {
  3296. 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);
  3297. } else {
  3298. 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);
  3299. }
  3300. } else if (!p_call->is_super && callee_type != GDScriptParser::Node::NONE) { // Check if the name exists as something else.
  3301. GDScriptParser::IdentifierNode *callee_id;
  3302. if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  3303. callee_id = static_cast<GDScriptParser::IdentifierNode *>(p_call->callee);
  3304. } else {
  3305. // Can only be attribute.
  3306. callee_id = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee)->attribute;
  3307. }
  3308. if (callee_id) {
  3309. reduce_identifier_from_base(callee_id, &base_type);
  3310. GDScriptParser::DataType callee_datatype = callee_id->get_datatype();
  3311. if (callee_datatype.is_set() && !callee_datatype.is_variant()) {
  3312. found = true;
  3313. if (callee_datatype.builtin_type == Variant::CALLABLE) {
  3314. 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);
  3315. } else {
  3316. 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);
  3317. }
  3318. #ifdef DEBUG_ENABLED
  3319. } else if (!is_self && !(base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN)) {
  3320. parser->push_warning(p_call, GDScriptWarning::UNSAFE_METHOD_ACCESS, p_call->function_name, base_type.to_string());
  3321. mark_node_unsafe(p_call);
  3322. #endif // DEBUG_ENABLED
  3323. }
  3324. }
  3325. }
  3326. if (!found && (is_self || (base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN))) {
  3327. String base_name = is_self && !p_call->is_super ? "self" : base_type.to_string();
  3328. #ifdef SUGGEST_GODOT4_RENAMES
  3329. String rename_hint;
  3330. if (GLOBAL_GET_CACHED(bool, "debug/gdscript/warnings/renamed_in_godot_4_hint")) {
  3331. const char *renamed_function_name = check_for_renamed_identifier(p_call->function_name, p_call->type);
  3332. if (renamed_function_name) {
  3333. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", String(renamed_function_name) + "()");
  3334. }
  3335. }
  3336. 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);
  3337. #else
  3338. 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);
  3339. #endif // SUGGEST_GODOT4_RENAMES
  3340. } else if (!found && (!p_call->is_super && base_type.is_hard_type() && base_type.is_meta_type)) {
  3341. push_error(vformat(R"*(Static function "%s()" not found in base "%s".)*", p_call->function_name, base_type.to_string()), p_call);
  3342. }
  3343. }
  3344. if (call_type.is_coroutine && !p_is_await && !p_is_root) {
  3345. push_error(vformat(R"*(Function "%s()" is a coroutine, so it must be called with "await".)*", p_call->function_name), p_call);
  3346. }
  3347. p_call->set_datatype(call_type);
  3348. }
  3349. void GDScriptAnalyzer::reduce_cast(GDScriptParser::CastNode *p_cast) {
  3350. reduce_expression(p_cast->operand);
  3351. GDScriptParser::DataType cast_type = type_from_metatype(resolve_datatype(p_cast->cast_type));
  3352. if (!cast_type.is_set()) {
  3353. mark_node_unsafe(p_cast);
  3354. return;
  3355. }
  3356. p_cast->set_datatype(cast_type);
  3357. if (p_cast->operand->is_constant) {
  3358. update_const_expression_builtin_type(p_cast->operand, cast_type, "cast", true);
  3359. if (cast_type.is_variant() || p_cast->operand->get_datatype() == cast_type) {
  3360. p_cast->is_constant = true;
  3361. p_cast->reduced_value = p_cast->operand->reduced_value;
  3362. }
  3363. }
  3364. if (p_cast->operand->type == GDScriptParser::Node::ARRAY && cast_type.has_container_element_type(0)) {
  3365. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_cast->operand), cast_type.get_container_element_type(0));
  3366. }
  3367. if (p_cast->operand->type == GDScriptParser::Node::DICTIONARY && cast_type.has_container_element_types()) {
  3368. update_dictionary_literal_element_type(static_cast<GDScriptParser::DictionaryNode *>(p_cast->operand),
  3369. cast_type.get_container_element_type_or_variant(0), cast_type.get_container_element_type_or_variant(1));
  3370. }
  3371. if (!cast_type.is_variant()) {
  3372. GDScriptParser::DataType op_type = p_cast->operand->get_datatype();
  3373. if (op_type.is_variant() || !op_type.is_hard_type()) {
  3374. mark_node_unsafe(p_cast);
  3375. #ifdef DEBUG_ENABLED
  3376. parser->push_warning(p_cast, GDScriptWarning::UNSAFE_CAST, cast_type.to_string());
  3377. #endif // DEBUG_ENABLED
  3378. } else {
  3379. bool valid = false;
  3380. if (op_type.builtin_type == Variant::INT && cast_type.kind == GDScriptParser::DataType::ENUM) {
  3381. mark_node_unsafe(p_cast);
  3382. valid = true;
  3383. } else if (op_type.kind == GDScriptParser::DataType::ENUM && cast_type.builtin_type == Variant::INT) {
  3384. valid = true;
  3385. } else if (op_type.kind == GDScriptParser::DataType::BUILTIN && cast_type.kind == GDScriptParser::DataType::BUILTIN) {
  3386. valid = Variant::can_convert(op_type.builtin_type, cast_type.builtin_type);
  3387. } else if (op_type.kind != GDScriptParser::DataType::BUILTIN && cast_type.kind != GDScriptParser::DataType::BUILTIN) {
  3388. valid = is_type_compatible(cast_type, op_type) || is_type_compatible(op_type, cast_type);
  3389. }
  3390. if (!valid) {
  3391. push_error(vformat(R"(Invalid cast. Cannot convert from "%s" to "%s".)", op_type.to_string(), cast_type.to_string()), p_cast->cast_type);
  3392. }
  3393. }
  3394. }
  3395. }
  3396. void GDScriptAnalyzer::reduce_dictionary(GDScriptParser::DictionaryNode *p_dictionary) {
  3397. HashMap<Variant, GDScriptParser::ExpressionNode *, VariantHasher, StringLikeVariantComparator> elements;
  3398. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  3399. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  3400. if (p_dictionary->style == GDScriptParser::DictionaryNode::PYTHON_DICT) {
  3401. reduce_expression(element.key);
  3402. }
  3403. reduce_expression(element.value);
  3404. if (element.key->is_constant) {
  3405. if (elements.has(element.key->reduced_value)) {
  3406. 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);
  3407. } else {
  3408. elements[element.key->reduced_value] = element.value;
  3409. }
  3410. }
  3411. }
  3412. // It's dictionary in any case.
  3413. GDScriptParser::DataType dict_type;
  3414. dict_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3415. dict_type.kind = GDScriptParser::DataType::BUILTIN;
  3416. dict_type.builtin_type = Variant::DICTIONARY;
  3417. dict_type.is_constant = true;
  3418. p_dictionary->set_datatype(dict_type);
  3419. }
  3420. void GDScriptAnalyzer::reduce_get_node(GDScriptParser::GetNodeNode *p_get_node) {
  3421. GDScriptParser::DataType result;
  3422. result.kind = GDScriptParser::DataType::VARIANT;
  3423. if (!ClassDB::is_parent_class(parser->current_class->base_type.native_type, SNAME("Node"))) {
  3424. 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);
  3425. p_get_node->set_datatype(result);
  3426. return;
  3427. }
  3428. if (static_context) {
  3429. push_error(vformat(R"*(Cannot use shorthand "get_node()" notation ("%c") in a static function.)*", p_get_node->use_dollar ? '$' : '%'), p_get_node);
  3430. p_get_node->set_datatype(result);
  3431. return;
  3432. }
  3433. mark_lambda_use_self();
  3434. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3435. result.kind = GDScriptParser::DataType::NATIVE;
  3436. result.builtin_type = Variant::OBJECT;
  3437. result.native_type = SNAME("Node");
  3438. p_get_node->set_datatype(result);
  3439. }
  3440. GDScriptParser::DataType GDScriptAnalyzer::make_global_class_meta_type(const StringName &p_class_name, const GDScriptParser::Node *p_source) {
  3441. GDScriptParser::DataType type;
  3442. String path = ScriptServer::get_global_class_path(p_class_name);
  3443. String ext = path.get_extension();
  3444. if (ext == GDScriptLanguage::get_singleton()->get_extension()) {
  3445. Ref<GDScriptParserRef> ref = parser->get_depended_parser_for(path);
  3446. if (ref.is_null()) {
  3447. push_error(vformat(R"(Could not find script for class "%s".)", p_class_name), p_source);
  3448. type.type_source = GDScriptParser::DataType::UNDETECTED;
  3449. type.kind = GDScriptParser::DataType::VARIANT;
  3450. return type;
  3451. }
  3452. Error err = ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3453. if (err) {
  3454. push_error(vformat(R"(Could not resolve class "%s", because of a parser error.)", p_class_name), p_source);
  3455. type.type_source = GDScriptParser::DataType::UNDETECTED;
  3456. type.kind = GDScriptParser::DataType::VARIANT;
  3457. return type;
  3458. }
  3459. return ref->get_parser()->head->get_datatype();
  3460. } else {
  3461. return make_script_meta_type(ResourceLoader::load(path, "Script"));
  3462. }
  3463. }
  3464. 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) {
  3465. // Delicate piece of code that intentionally doesn't use the GDScript cache or `get_depended_parser_for`.
  3466. // Search dependencies for the parser that owns `p_class` and make a cache entry for it.
  3467. // 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.
  3468. // Since https://github.com/godotengine/godot/pull/94871 there can technically be multiple parsers for the same script in the same parser tree.
  3469. // Even if unlikely, getting the wrong parser could lead to strange undefined behavior without errors.
  3470. if (p_class == nullptr) {
  3471. return nullptr;
  3472. }
  3473. if (HashMap<const GDScriptParser::ClassNode *, Ref<GDScriptParserRef>>::Iterator E = external_class_parser_cache.find(p_class)) {
  3474. return E->value;
  3475. }
  3476. if (parser->has_class(p_class)) {
  3477. return nullptr;
  3478. }
  3479. if (p_from_class == nullptr) {
  3480. p_from_class = parser->head;
  3481. }
  3482. Ref<GDScriptParserRef> parser_ref;
  3483. for (const GDScriptParser::ClassNode *look_class = p_from_class; look_class != nullptr; look_class = look_class->base_type.class_type) {
  3484. if (parser->has_class(look_class)) {
  3485. parser_ref = find_cached_external_parser_for_class(p_class, parser);
  3486. if (parser_ref.is_valid()) {
  3487. break;
  3488. }
  3489. }
  3490. if (HashMap<const GDScriptParser::ClassNode *, Ref<GDScriptParserRef>>::Iterator E = external_class_parser_cache.find(look_class)) {
  3491. parser_ref = find_cached_external_parser_for_class(p_class, E->value);
  3492. if (parser_ref.is_valid()) {
  3493. break;
  3494. }
  3495. }
  3496. String look_class_script_path = look_class->get_datatype().script_path;
  3497. if (HashMap<String, Ref<GDScriptParserRef>>::Iterator E = parser->depended_parsers.find(look_class_script_path)) {
  3498. parser_ref = find_cached_external_parser_for_class(p_class, E->value);
  3499. if (parser_ref.is_valid()) {
  3500. break;
  3501. }
  3502. }
  3503. }
  3504. if (parser_ref.is_null()) {
  3505. push_error(vformat(R"(Parser bug (please report): Could not find external parser for class "%s". (%s))", p_class->fqcn, p_context), p_source);
  3506. // A null parser will be inserted into the cache, so this error won't spam for the same class.
  3507. // This is ok, the values of external_class_parser_cache are not assumed to be valid references.
  3508. }
  3509. external_class_parser_cache.insert(p_class, parser_ref);
  3510. return parser_ref;
  3511. }
  3512. Ref<GDScriptParserRef> GDScriptAnalyzer::find_cached_external_parser_for_class(const GDScriptParser::ClassNode *p_class, const Ref<GDScriptParserRef> &p_dependant_parser) {
  3513. if (p_dependant_parser.is_null()) {
  3514. return nullptr;
  3515. }
  3516. if (HashMap<const GDScriptParser::ClassNode *, Ref<GDScriptParserRef>>::Iterator E = p_dependant_parser->get_analyzer()->external_class_parser_cache.find(p_class)) {
  3517. if (E->value.is_valid()) {
  3518. // Silently ensure it's parsed.
  3519. E->value->raise_status(GDScriptParserRef::PARSED);
  3520. if (E->value->get_parser()->has_class(p_class)) {
  3521. return E->value;
  3522. }
  3523. }
  3524. }
  3525. if (p_dependant_parser->get_parser()->has_class(p_class)) {
  3526. return p_dependant_parser;
  3527. }
  3528. // Silently ensure it's parsed.
  3529. p_dependant_parser->raise_status(GDScriptParserRef::PARSED);
  3530. return find_cached_external_parser_for_class(p_class, p_dependant_parser->get_parser());
  3531. }
  3532. Ref<GDScriptParserRef> GDScriptAnalyzer::find_cached_external_parser_for_class(const GDScriptParser::ClassNode *p_class, GDScriptParser *p_dependant_parser) {
  3533. if (p_dependant_parser == nullptr) {
  3534. return nullptr;
  3535. }
  3536. String script_path = p_class->get_datatype().script_path;
  3537. if (HashMap<String, Ref<GDScriptParserRef>>::Iterator E = p_dependant_parser->depended_parsers.find(script_path)) {
  3538. if (E->value.is_valid()) {
  3539. // Silently ensure it's parsed.
  3540. E->value->raise_status(GDScriptParserRef::PARSED);
  3541. if (E->value->get_parser()->has_class(p_class)) {
  3542. return E->value;
  3543. }
  3544. }
  3545. }
  3546. return nullptr;
  3547. }
  3548. Ref<GDScript> GDScriptAnalyzer::get_depended_shallow_script(const String &p_path, Error &r_error) {
  3549. // To keep a local cache of the parser for resolving external nodes later.
  3550. const String path = ResourceUID::ensure_path(p_path);
  3551. parser->get_depended_parser_for(path);
  3552. Ref<GDScript> scr = GDScriptCache::get_shallow_script(path, r_error, parser->script_path);
  3553. return scr;
  3554. }
  3555. void GDScriptAnalyzer::reduce_identifier_from_base_set_class(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType p_identifier_datatype) {
  3556. ERR_FAIL_NULL(p_identifier);
  3557. p_identifier->set_datatype(p_identifier_datatype);
  3558. Error err = OK;
  3559. Ref<GDScript> scr = get_depended_shallow_script(p_identifier_datatype.script_path, err);
  3560. if (err) {
  3561. push_error(vformat(R"(Error while getting cache for script "%s".)", p_identifier_datatype.script_path), p_identifier);
  3562. return;
  3563. }
  3564. p_identifier->reduced_value = scr->find_class(p_identifier_datatype.class_type->fqcn);
  3565. p_identifier->is_constant = true;
  3566. }
  3567. void GDScriptAnalyzer::reduce_identifier_from_base(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType *p_base) {
  3568. if (!p_identifier->get_datatype().has_no_type()) {
  3569. return;
  3570. }
  3571. GDScriptParser::DataType base;
  3572. if (p_base == nullptr) {
  3573. base = type_from_metatype(parser->current_class->get_datatype());
  3574. } else {
  3575. base = *p_base;
  3576. }
  3577. StringName name = p_identifier->name;
  3578. if (base.kind == GDScriptParser::DataType::ENUM) {
  3579. if (base.is_meta_type) {
  3580. if (base.enum_values.has(name)) {
  3581. p_identifier->set_datatype(type_from_metatype(base));
  3582. p_identifier->is_constant = true;
  3583. p_identifier->reduced_value = base.enum_values[name];
  3584. return;
  3585. }
  3586. // Enum does not have this value, return.
  3587. return;
  3588. } else {
  3589. push_error(R"(Cannot get property from enum value.)", p_identifier);
  3590. return;
  3591. }
  3592. }
  3593. if (base.kind == GDScriptParser::DataType::BUILTIN) {
  3594. if (base.is_meta_type) {
  3595. bool valid = false;
  3596. if (Variant::has_constant(base.builtin_type, name)) {
  3597. valid = true;
  3598. const Variant constant_value = Variant::get_constant_value(base.builtin_type, name);
  3599. p_identifier->is_constant = true;
  3600. p_identifier->reduced_value = constant_value;
  3601. p_identifier->set_datatype(type_from_variant(constant_value, p_identifier));
  3602. }
  3603. if (!valid) {
  3604. const StringName enum_name = Variant::get_enum_for_enumeration(base.builtin_type, name);
  3605. if (enum_name != StringName()) {
  3606. valid = true;
  3607. p_identifier->is_constant = true;
  3608. p_identifier->reduced_value = Variant::get_enum_value(base.builtin_type, enum_name, name);
  3609. p_identifier->set_datatype(make_builtin_enum_type(enum_name, base.builtin_type, false));
  3610. }
  3611. }
  3612. if (!valid && Variant::has_enum(base.builtin_type, name)) {
  3613. valid = true;
  3614. p_identifier->set_datatype(make_builtin_enum_type(name, base.builtin_type, true));
  3615. }
  3616. if (!valid && base.is_hard_type()) {
  3617. #ifdef SUGGEST_GODOT4_RENAMES
  3618. String rename_hint;
  3619. if (GLOBAL_GET_CACHED(bool, "debug/gdscript/warnings/renamed_in_godot_4_hint")) {
  3620. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  3621. if (renamed_identifier_name) {
  3622. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  3623. }
  3624. }
  3625. push_error(vformat(R"(Cannot find member "%s" in base "%s".%s)", name, base.to_string(), rename_hint), p_identifier);
  3626. #else
  3627. push_error(vformat(R"(Cannot find member "%s" in base "%s".)", name, base.to_string()), p_identifier);
  3628. #endif // SUGGEST_GODOT4_RENAMES
  3629. }
  3630. } else {
  3631. switch (base.builtin_type) {
  3632. case Variant::NIL: {
  3633. if (base.is_hard_type()) {
  3634. push_error(vformat(R"(Cannot get property "%s" on a null object.)", name), p_identifier);
  3635. }
  3636. return;
  3637. }
  3638. case Variant::DICTIONARY: {
  3639. GDScriptParser::DataType dummy;
  3640. dummy.kind = GDScriptParser::DataType::VARIANT;
  3641. p_identifier->set_datatype(dummy);
  3642. return;
  3643. }
  3644. default: {
  3645. Callable::CallError temp;
  3646. Variant dummy;
  3647. Variant::construct(base.builtin_type, dummy, nullptr, 0, temp);
  3648. List<PropertyInfo> properties;
  3649. dummy.get_property_list(&properties);
  3650. for (const PropertyInfo &prop : properties) {
  3651. if (prop.name == name) {
  3652. p_identifier->set_datatype(type_from_property(prop));
  3653. return;
  3654. }
  3655. }
  3656. if (Variant::has_builtin_method(base.builtin_type, name)) {
  3657. p_identifier->set_datatype(make_callable_type(Variant::get_builtin_method_info(base.builtin_type, name)));
  3658. return;
  3659. }
  3660. if (base.is_hard_type()) {
  3661. #ifdef SUGGEST_GODOT4_RENAMES
  3662. String rename_hint;
  3663. if (GLOBAL_GET_CACHED(bool, "debug/gdscript/warnings/renamed_in_godot_4_hint")) {
  3664. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  3665. if (renamed_identifier_name) {
  3666. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  3667. }
  3668. }
  3669. push_error(vformat(R"(Cannot find member "%s" in base "%s".%s)", name, base.to_string(), rename_hint), p_identifier);
  3670. #else
  3671. push_error(vformat(R"(Cannot find member "%s" in base "%s".)", name, base.to_string()), p_identifier);
  3672. #endif // SUGGEST_GODOT4_RENAMES
  3673. }
  3674. }
  3675. }
  3676. }
  3677. return;
  3678. }
  3679. GDScriptParser::ClassNode *base_class = base.class_type;
  3680. List<GDScriptParser::ClassNode *> script_classes;
  3681. bool is_base = true;
  3682. if (base_class != nullptr) {
  3683. get_class_node_current_scope_classes(base_class, &script_classes, p_identifier);
  3684. }
  3685. bool is_constructor = base.is_meta_type && p_identifier->name == SNAME("new");
  3686. for (GDScriptParser::ClassNode *script_class : script_classes) {
  3687. if (p_base == nullptr && script_class->identifier && script_class->identifier->name == name) {
  3688. reduce_identifier_from_base_set_class(p_identifier, script_class->get_datatype());
  3689. if (script_class->outer != nullptr) {
  3690. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CLASS;
  3691. }
  3692. return;
  3693. }
  3694. if (is_constructor) {
  3695. name = "_init";
  3696. }
  3697. if (script_class->has_member(name)) {
  3698. resolve_class_member(script_class, name, p_identifier);
  3699. GDScriptParser::ClassNode::Member member = script_class->get_member(name);
  3700. switch (member.type) {
  3701. case GDScriptParser::ClassNode::Member::CONSTANT: {
  3702. p_identifier->set_datatype(member.get_datatype());
  3703. p_identifier->is_constant = true;
  3704. p_identifier->reduced_value = member.constant->initializer->reduced_value;
  3705. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3706. p_identifier->constant_source = member.constant;
  3707. return;
  3708. }
  3709. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  3710. p_identifier->set_datatype(member.get_datatype());
  3711. p_identifier->is_constant = true;
  3712. p_identifier->reduced_value = member.enum_value.value;
  3713. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3714. return;
  3715. }
  3716. case GDScriptParser::ClassNode::Member::ENUM: {
  3717. p_identifier->set_datatype(member.get_datatype());
  3718. p_identifier->is_constant = true;
  3719. p_identifier->reduced_value = member.m_enum->dictionary;
  3720. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3721. return;
  3722. }
  3723. case GDScriptParser::ClassNode::Member::VARIABLE: {
  3724. if (is_base && (!base.is_meta_type || member.variable->is_static)) {
  3725. p_identifier->set_datatype(member.get_datatype());
  3726. p_identifier->source = member.variable->is_static ? GDScriptParser::IdentifierNode::STATIC_VARIABLE : GDScriptParser::IdentifierNode::MEMBER_VARIABLE;
  3727. p_identifier->variable_source = member.variable;
  3728. member.variable->usages += 1;
  3729. return;
  3730. }
  3731. } break;
  3732. case GDScriptParser::ClassNode::Member::SIGNAL: {
  3733. if (is_base && !base.is_meta_type) {
  3734. p_identifier->set_datatype(member.get_datatype());
  3735. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  3736. p_identifier->signal_source = member.signal;
  3737. member.signal->usages += 1;
  3738. return;
  3739. }
  3740. } break;
  3741. case GDScriptParser::ClassNode::Member::FUNCTION: {
  3742. if (is_base && (!base.is_meta_type || member.function->is_static || is_constructor)) {
  3743. p_identifier->set_datatype(make_callable_type(member.function->info));
  3744. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_FUNCTION;
  3745. p_identifier->function_source = member.function;
  3746. p_identifier->function_source_is_static = member.function->is_static;
  3747. return;
  3748. }
  3749. } break;
  3750. case GDScriptParser::ClassNode::Member::CLASS: {
  3751. reduce_identifier_from_base_set_class(p_identifier, member.get_datatype());
  3752. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CLASS;
  3753. return;
  3754. }
  3755. default: {
  3756. // Do nothing
  3757. }
  3758. }
  3759. }
  3760. if (is_base) {
  3761. is_base = script_class->base_type.class_type != nullptr;
  3762. if (!is_base && p_base != nullptr) {
  3763. break;
  3764. }
  3765. }
  3766. }
  3767. // Check non-GDScript scripts.
  3768. Ref<Script> script_type = base.script_type;
  3769. if (base_class == nullptr && script_type.is_valid()) {
  3770. List<PropertyInfo> property_list;
  3771. script_type->get_script_property_list(&property_list);
  3772. for (const PropertyInfo &property_info : property_list) {
  3773. if (property_info.name != p_identifier->name) {
  3774. continue;
  3775. }
  3776. const GDScriptParser::DataType property_type = GDScriptAnalyzer::type_from_property(property_info, false, false);
  3777. p_identifier->set_datatype(property_type);
  3778. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_VARIABLE;
  3779. return;
  3780. }
  3781. MethodInfo method_info = script_type->get_method_info(p_identifier->name);
  3782. if (method_info.name == p_identifier->name) {
  3783. p_identifier->set_datatype(make_callable_type(method_info));
  3784. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_FUNCTION;
  3785. p_identifier->function_source_is_static = method_info.flags & METHOD_FLAG_STATIC;
  3786. return;
  3787. }
  3788. List<MethodInfo> signal_list;
  3789. script_type->get_script_signal_list(&signal_list);
  3790. for (const MethodInfo &signal_info : signal_list) {
  3791. if (signal_info.name != p_identifier->name) {
  3792. continue;
  3793. }
  3794. const GDScriptParser::DataType signal_type = make_signal_type(signal_info);
  3795. p_identifier->set_datatype(signal_type);
  3796. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  3797. return;
  3798. }
  3799. HashMap<StringName, Variant> constant_map;
  3800. script_type->get_constants(&constant_map);
  3801. if (constant_map.has(p_identifier->name)) {
  3802. Variant constant = constant_map.get(p_identifier->name);
  3803. p_identifier->set_datatype(make_builtin_meta_type(constant.get_type()));
  3804. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3805. return;
  3806. }
  3807. }
  3808. // Check native members. No need for native class recursion because Node exposes all Object's properties.
  3809. const StringName &native = base.native_type;
  3810. if (class_exists(native)) {
  3811. if (is_constructor) {
  3812. name = "_init";
  3813. }
  3814. MethodInfo method_info;
  3815. if (ClassDB::has_property(native, name)) {
  3816. StringName getter_name = ClassDB::get_property_getter(native, name);
  3817. MethodBind *getter = ClassDB::get_method(native, getter_name);
  3818. if (getter != nullptr) {
  3819. bool has_setter = ClassDB::get_property_setter(native, name) != StringName();
  3820. p_identifier->set_datatype(type_from_property(getter->get_return_info(), false, !has_setter));
  3821. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3822. }
  3823. return;
  3824. }
  3825. if (ClassDB::get_method_info(native, name, &method_info)) {
  3826. // Method is callable.
  3827. p_identifier->set_datatype(make_callable_type(method_info));
  3828. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3829. return;
  3830. }
  3831. if (ClassDB::get_signal(native, name, &method_info)) {
  3832. // Signal is a type too.
  3833. p_identifier->set_datatype(make_signal_type(method_info));
  3834. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3835. return;
  3836. }
  3837. if (ClassDB::has_enum(native, name)) {
  3838. p_identifier->set_datatype(make_native_enum_type(name, native));
  3839. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3840. return;
  3841. }
  3842. bool valid = false;
  3843. int64_t int_constant = ClassDB::get_integer_constant(native, name, &valid);
  3844. if (valid) {
  3845. p_identifier->is_constant = true;
  3846. p_identifier->reduced_value = int_constant;
  3847. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3848. // Check whether this constant, which exists, belongs to an enum
  3849. StringName enum_name = ClassDB::get_integer_constant_enum(native, name);
  3850. if (enum_name != StringName()) {
  3851. p_identifier->set_datatype(make_native_enum_type(enum_name, native, false));
  3852. } else {
  3853. p_identifier->set_datatype(type_from_variant(int_constant, p_identifier));
  3854. }
  3855. }
  3856. }
  3857. }
  3858. void GDScriptAnalyzer::reduce_identifier(GDScriptParser::IdentifierNode *p_identifier, bool can_be_builtin) {
  3859. // TODO: This is an opportunity to further infer types.
  3860. // Check if we are inside an enum. This allows enum values to access other elements of the same enum.
  3861. if (current_enum) {
  3862. for (int i = 0; i < current_enum->values.size(); i++) {
  3863. const GDScriptParser::EnumNode::Value &element = current_enum->values[i];
  3864. if (element.identifier->name == p_identifier->name) {
  3865. StringName enum_name = current_enum->identifier ? current_enum->identifier->name : UNNAMED_ENUM;
  3866. GDScriptParser::DataType type = make_class_enum_type(enum_name, parser->current_class, parser->script_path, false);
  3867. if (element.parent_enum->identifier) {
  3868. type.enum_type = element.parent_enum->identifier->name;
  3869. }
  3870. p_identifier->set_datatype(type);
  3871. if (element.resolved) {
  3872. p_identifier->is_constant = true;
  3873. p_identifier->reduced_value = element.value;
  3874. } else {
  3875. push_error(R"(Cannot use another enum element before it was declared.)", p_identifier);
  3876. }
  3877. return; // Found anyway.
  3878. }
  3879. }
  3880. }
  3881. bool found_source = false;
  3882. // Check if identifier is local.
  3883. // If that's the case, the declaration already was solved before.
  3884. switch (p_identifier->source) {
  3885. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER:
  3886. p_identifier->set_datatype(p_identifier->parameter_source->get_datatype());
  3887. found_source = true;
  3888. break;
  3889. case GDScriptParser::IdentifierNode::LOCAL_CONSTANT:
  3890. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  3891. p_identifier->set_datatype(p_identifier->constant_source->get_datatype());
  3892. p_identifier->is_constant = true;
  3893. // TODO: Constant should have a value on the node itself.
  3894. p_identifier->reduced_value = p_identifier->constant_source->initializer->reduced_value;
  3895. found_source = true;
  3896. break;
  3897. case GDScriptParser::IdentifierNode::MEMBER_SIGNAL:
  3898. p_identifier->signal_source->usages++;
  3899. [[fallthrough]];
  3900. case GDScriptParser::IdentifierNode::INHERITED_VARIABLE:
  3901. mark_lambda_use_self();
  3902. break;
  3903. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  3904. mark_lambda_use_self();
  3905. p_identifier->variable_source->usages++;
  3906. [[fallthrough]];
  3907. case GDScriptParser::IdentifierNode::STATIC_VARIABLE:
  3908. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE:
  3909. p_identifier->set_datatype(p_identifier->variable_source->get_datatype());
  3910. found_source = true;
  3911. #ifdef DEBUG_ENABLED
  3912. 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)) {
  3913. parser->push_warning(p_identifier, GDScriptWarning::UNASSIGNED_VARIABLE, p_identifier->name);
  3914. }
  3915. #endif // DEBUG_ENABLED
  3916. break;
  3917. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR:
  3918. p_identifier->set_datatype(p_identifier->bind_source->get_datatype());
  3919. found_source = true;
  3920. break;
  3921. case GDScriptParser::IdentifierNode::LOCAL_BIND: {
  3922. GDScriptParser::DataType result = p_identifier->bind_source->get_datatype();
  3923. result.is_constant = true;
  3924. p_identifier->set_datatype(result);
  3925. found_source = true;
  3926. } break;
  3927. case GDScriptParser::IdentifierNode::UNDEFINED_SOURCE:
  3928. case GDScriptParser::IdentifierNode::MEMBER_FUNCTION:
  3929. case GDScriptParser::IdentifierNode::MEMBER_CLASS:
  3930. break;
  3931. }
  3932. #ifdef DEBUG_ENABLED
  3933. if (!found_source && p_identifier->suite != nullptr && p_identifier->suite->has_local(p_identifier->name)) {
  3934. parser->push_warning(p_identifier, GDScriptWarning::CONFUSABLE_LOCAL_USAGE, p_identifier->name);
  3935. }
  3936. #endif // DEBUG_ENABLED
  3937. // Not a local, so check members.
  3938. if (!found_source) {
  3939. reduce_identifier_from_base(p_identifier);
  3940. if (p_identifier->source != GDScriptParser::IdentifierNode::UNDEFINED_SOURCE || p_identifier->get_datatype().is_set()) {
  3941. // Found.
  3942. found_source = true;
  3943. }
  3944. }
  3945. if (found_source) {
  3946. const bool source_is_instance_variable = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_VARIABLE || p_identifier->source == GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3947. const bool source_is_instance_function = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_FUNCTION && !p_identifier->function_source_is_static;
  3948. const bool source_is_signal = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  3949. if (static_context && (source_is_instance_variable || source_is_instance_function || source_is_signal)) {
  3950. // Get the parent function above any lambda.
  3951. GDScriptParser::FunctionNode *parent_function = parser->current_function;
  3952. while (parent_function && parent_function->source_lambda) {
  3953. parent_function = parent_function->source_lambda->parent_function;
  3954. }
  3955. String source_type;
  3956. if (source_is_instance_variable) {
  3957. source_type = "non-static variable";
  3958. } else if (source_is_instance_function) {
  3959. source_type = "non-static function";
  3960. } else { // source_is_signal
  3961. source_type = "signal";
  3962. }
  3963. if (parent_function) {
  3964. push_error(vformat(R"*(Cannot access %s "%s" from the static function "%s()".)*", source_type, p_identifier->name, parent_function->identifier->name), p_identifier);
  3965. } else {
  3966. push_error(vformat(R"*(Cannot access %s "%s" from a static variable initializer.)*", source_type, p_identifier->name), p_identifier);
  3967. }
  3968. }
  3969. if (current_lambda != nullptr) {
  3970. // If the identifier is a member variable (including the native class properties), member function, or a signal,
  3971. // we consider the lambda to be using `self`, so we keep a reference to the current instance.
  3972. if (source_is_instance_variable || source_is_instance_function || source_is_signal) {
  3973. mark_lambda_use_self();
  3974. return; // No need to capture.
  3975. }
  3976. switch (p_identifier->source) {
  3977. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER:
  3978. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE:
  3979. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR:
  3980. case GDScriptParser::IdentifierNode::LOCAL_BIND:
  3981. break; // Need to capture.
  3982. case GDScriptParser::IdentifierNode::UNDEFINED_SOURCE: // A global.
  3983. case GDScriptParser::IdentifierNode::LOCAL_CONSTANT:
  3984. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  3985. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  3986. case GDScriptParser::IdentifierNode::MEMBER_FUNCTION:
  3987. case GDScriptParser::IdentifierNode::MEMBER_SIGNAL:
  3988. case GDScriptParser::IdentifierNode::MEMBER_CLASS:
  3989. case GDScriptParser::IdentifierNode::INHERITED_VARIABLE:
  3990. case GDScriptParser::IdentifierNode::STATIC_VARIABLE:
  3991. return; // No need to capture.
  3992. }
  3993. GDScriptParser::FunctionNode *function_test = current_lambda->function;
  3994. // Make sure we aren't capturing variable in the same lambda.
  3995. // This also add captures for nested lambdas.
  3996. 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)) {
  3997. function_test->source_lambda->captures_indices[p_identifier->name] = function_test->source_lambda->captures.size();
  3998. function_test->source_lambda->captures.push_back(p_identifier);
  3999. function_test = function_test->source_lambda->parent_function;
  4000. }
  4001. }
  4002. return;
  4003. }
  4004. StringName name = p_identifier->name;
  4005. p_identifier->source = GDScriptParser::IdentifierNode::UNDEFINED_SOURCE;
  4006. // Not a local or a member, so check globals.
  4007. Variant::Type builtin_type = GDScriptParser::get_builtin_type(name);
  4008. if (builtin_type < Variant::VARIANT_MAX) {
  4009. if (can_be_builtin) {
  4010. p_identifier->set_datatype(make_builtin_meta_type(builtin_type));
  4011. return;
  4012. } else {
  4013. push_error(R"(Builtin type cannot be used as a name on its own.)", p_identifier);
  4014. }
  4015. }
  4016. if (class_exists(name)) {
  4017. p_identifier->set_datatype(make_native_meta_type(name));
  4018. return;
  4019. }
  4020. if (ScriptServer::is_global_class(name)) {
  4021. p_identifier->set_datatype(make_global_class_meta_type(name, p_identifier));
  4022. return;
  4023. }
  4024. // Try singletons.
  4025. // Do this before globals because this might be a singleton loading another one before it's compiled.
  4026. if (ProjectSettings::get_singleton()->has_autoload(name)) {
  4027. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(name);
  4028. if (autoload.is_singleton) {
  4029. // Singleton exists, so it's at least a Node.
  4030. GDScriptParser::DataType result;
  4031. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4032. result.kind = GDScriptParser::DataType::NATIVE;
  4033. result.builtin_type = Variant::OBJECT;
  4034. result.native_type = SNAME("Node");
  4035. if (ResourceLoader::get_resource_type(autoload.path) == "GDScript") {
  4036. Ref<GDScriptParserRef> single_parser = parser->get_depended_parser_for(autoload.path);
  4037. if (single_parser.is_valid()) {
  4038. Error err = single_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  4039. if (err == OK) {
  4040. result = type_from_metatype(single_parser->get_parser()->head->get_datatype());
  4041. }
  4042. }
  4043. } else if (ResourceLoader::get_resource_type(autoload.path) == "PackedScene") {
  4044. if (GDScriptLanguage::get_singleton()->has_any_global_constant(name)) {
  4045. Variant constant = GDScriptLanguage::get_singleton()->get_any_global_constant(name);
  4046. Node *node = Object::cast_to<Node>(constant);
  4047. if (node != nullptr) {
  4048. Ref<GDScript> scr = node->get_script();
  4049. if (scr.is_valid()) {
  4050. Ref<GDScriptParserRef> single_parser = parser->get_depended_parser_for(scr->get_script_path());
  4051. if (single_parser.is_valid()) {
  4052. Error err = single_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  4053. if (err == OK) {
  4054. result = type_from_metatype(single_parser->get_parser()->head->get_datatype());
  4055. }
  4056. }
  4057. }
  4058. }
  4059. }
  4060. }
  4061. result.is_constant = true;
  4062. p_identifier->set_datatype(result);
  4063. return;
  4064. }
  4065. }
  4066. if (CoreConstants::is_global_constant(name)) {
  4067. int index = CoreConstants::get_global_constant_index(name);
  4068. StringName enum_name = CoreConstants::get_global_constant_enum(index);
  4069. int64_t value = CoreConstants::get_global_constant_value(index);
  4070. if (enum_name != StringName()) {
  4071. p_identifier->set_datatype(make_global_enum_type(enum_name, StringName(), false));
  4072. } else {
  4073. p_identifier->set_datatype(type_from_variant(value, p_identifier));
  4074. }
  4075. p_identifier->is_constant = true;
  4076. p_identifier->reduced_value = value;
  4077. return;
  4078. }
  4079. if (GDScriptLanguage::get_singleton()->has_any_global_constant(name)) {
  4080. Variant constant = GDScriptLanguage::get_singleton()->get_any_global_constant(name);
  4081. p_identifier->set_datatype(type_from_variant(constant, p_identifier));
  4082. p_identifier->is_constant = true;
  4083. p_identifier->reduced_value = constant;
  4084. return;
  4085. }
  4086. if (CoreConstants::is_global_enum(name)) {
  4087. p_identifier->set_datatype(make_global_enum_type(name, StringName(), true));
  4088. if (!can_be_builtin) {
  4089. push_error(vformat(R"(Global enum "%s" cannot be used on its own.)", name), p_identifier);
  4090. }
  4091. return;
  4092. }
  4093. if (Variant::has_utility_function(name) || GDScriptUtilityFunctions::function_exists(name)) {
  4094. p_identifier->is_constant = true;
  4095. p_identifier->reduced_value = Callable(memnew(GDScriptUtilityCallable(name)));
  4096. MethodInfo method_info;
  4097. if (GDScriptUtilityFunctions::function_exists(name)) {
  4098. method_info = GDScriptUtilityFunctions::get_function_info(name);
  4099. } else {
  4100. method_info = Variant::get_utility_function_info(name);
  4101. }
  4102. p_identifier->set_datatype(make_callable_type(method_info));
  4103. return;
  4104. }
  4105. // Allow "Variant" here since it might be used for nested enums.
  4106. if (can_be_builtin && name == SNAME("Variant")) {
  4107. GDScriptParser::DataType variant;
  4108. variant.kind = GDScriptParser::DataType::VARIANT;
  4109. variant.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4110. variant.is_meta_type = true;
  4111. variant.is_pseudo_type = true;
  4112. p_identifier->set_datatype(variant);
  4113. return;
  4114. }
  4115. // Not found.
  4116. #ifdef SUGGEST_GODOT4_RENAMES
  4117. String rename_hint;
  4118. if (GLOBAL_GET_CACHED(bool, "debug/gdscript/warnings/renamed_in_godot_4_hint")) {
  4119. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  4120. if (renamed_identifier_name) {
  4121. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  4122. }
  4123. }
  4124. push_error(vformat(R"(Identifier "%s" not declared in the current scope.%s)", name, rename_hint), p_identifier);
  4125. #else
  4126. push_error(vformat(R"(Identifier "%s" not declared in the current scope.)", name), p_identifier);
  4127. #endif // SUGGEST_GODOT4_RENAMES
  4128. GDScriptParser::DataType dummy;
  4129. dummy.kind = GDScriptParser::DataType::VARIANT;
  4130. p_identifier->set_datatype(dummy); // Just so type is set to something.
  4131. }
  4132. void GDScriptAnalyzer::reduce_lambda(GDScriptParser::LambdaNode *p_lambda) {
  4133. // Lambda is always a Callable.
  4134. GDScriptParser::DataType lambda_type;
  4135. lambda_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  4136. lambda_type.kind = GDScriptParser::DataType::BUILTIN;
  4137. lambda_type.builtin_type = Variant::CALLABLE;
  4138. p_lambda->set_datatype(lambda_type);
  4139. if (p_lambda->function == nullptr) {
  4140. return;
  4141. }
  4142. GDScriptParser::LambdaNode *previous_lambda = current_lambda;
  4143. current_lambda = p_lambda;
  4144. resolve_function_signature(p_lambda->function, p_lambda, true);
  4145. current_lambda = previous_lambda;
  4146. pending_body_resolution_lambdas.push_back(p_lambda);
  4147. }
  4148. void GDScriptAnalyzer::reduce_literal(GDScriptParser::LiteralNode *p_literal) {
  4149. p_literal->reduced_value = p_literal->value;
  4150. p_literal->is_constant = true;
  4151. p_literal->set_datatype(type_from_variant(p_literal->reduced_value, p_literal));
  4152. }
  4153. void GDScriptAnalyzer::reduce_preload(GDScriptParser::PreloadNode *p_preload) {
  4154. if (!p_preload->path) {
  4155. return;
  4156. }
  4157. reduce_expression(p_preload->path);
  4158. if (!p_preload->path->is_constant) {
  4159. push_error("Preloaded path must be a constant string.", p_preload->path);
  4160. return;
  4161. }
  4162. if (p_preload->path->reduced_value.get_type() != Variant::STRING) {
  4163. push_error("Preloaded path must be a constant string.", p_preload->path);
  4164. } else {
  4165. p_preload->resolved_path = p_preload->path->reduced_value;
  4166. // TODO: Save this as script dependency.
  4167. if (p_preload->resolved_path.is_relative_path()) {
  4168. p_preload->resolved_path = parser->script_path.get_base_dir().path_join(p_preload->resolved_path);
  4169. }
  4170. p_preload->resolved_path = p_preload->resolved_path.simplify_path();
  4171. if (!ResourceLoader::exists(p_preload->resolved_path)) {
  4172. Ref<FileAccess> file_check = FileAccess::create(FileAccess::ACCESS_RESOURCES);
  4173. if (file_check->file_exists(p_preload->resolved_path)) {
  4174. push_error(vformat(R"(Preload file "%s" has no resource loaders (unrecognized file extension).)", p_preload->resolved_path), p_preload->path);
  4175. } else {
  4176. push_error(vformat(R"(Preload file "%s" does not exist.)", p_preload->resolved_path), p_preload->path);
  4177. }
  4178. } else {
  4179. // TODO: Don't load if validating: use completion cache.
  4180. // Must load GDScript separately to permit cyclic references
  4181. // as ResourceLoader::load() detects and rejects those.
  4182. const String &res_type = ResourceLoader::get_resource_type(p_preload->resolved_path);
  4183. if (res_type == "GDScript") {
  4184. Error err = OK;
  4185. Ref<GDScript> res = get_depended_shallow_script(p_preload->resolved_path, err);
  4186. p_preload->resource = res;
  4187. if (err != OK) {
  4188. push_error(vformat(R"(Could not preload resource script "%s".)", p_preload->resolved_path), p_preload->path);
  4189. }
  4190. } else {
  4191. Error err = OK;
  4192. p_preload->resource = ResourceLoader::load(p_preload->resolved_path, res_type, ResourceFormatLoader::CACHE_MODE_REUSE, &err);
  4193. if (err == ERR_BUSY) {
  4194. p_preload->resource = ResourceLoader::ensure_resource_ref_override_for_outer_load(p_preload->resolved_path, res_type);
  4195. }
  4196. if (p_preload->resource.is_null()) {
  4197. push_error(vformat(R"(Could not preload resource file "%s".)", p_preload->resolved_path), p_preload->path);
  4198. }
  4199. }
  4200. }
  4201. }
  4202. p_preload->is_constant = true;
  4203. p_preload->reduced_value = p_preload->resource;
  4204. p_preload->set_datatype(type_from_variant(p_preload->reduced_value, p_preload));
  4205. // TODO: Not sure if this is necessary anymore.
  4206. // 'type_from_variant()' should call 'resolve_class_inheritance()' which would call 'ensure_cached_external_parser_for_class()'
  4207. // Better safe than sorry.
  4208. ensure_cached_external_parser_for_class(p_preload->get_datatype().class_type, nullptr, "Trying to resolve preload", p_preload);
  4209. }
  4210. void GDScriptAnalyzer::reduce_self(GDScriptParser::SelfNode *p_self) {
  4211. p_self->is_constant = false;
  4212. p_self->set_datatype(type_from_metatype(parser->current_class->get_datatype()));
  4213. mark_lambda_use_self();
  4214. }
  4215. void GDScriptAnalyzer::reduce_subscript(GDScriptParser::SubscriptNode *p_subscript, bool p_can_be_pseudo_type) {
  4216. if (p_subscript->base == nullptr) {
  4217. return;
  4218. }
  4219. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  4220. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base), true);
  4221. } else if (p_subscript->base->type == GDScriptParser::Node::SUBSCRIPT) {
  4222. reduce_subscript(static_cast<GDScriptParser::SubscriptNode *>(p_subscript->base), true);
  4223. } else {
  4224. reduce_expression(p_subscript->base);
  4225. }
  4226. GDScriptParser::DataType result_type;
  4227. if (p_subscript->is_attribute) {
  4228. if (p_subscript->attribute == nullptr) {
  4229. return;
  4230. }
  4231. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  4232. bool valid = false;
  4233. // If the base is a metatype, use the analyzer instead.
  4234. if (p_subscript->base->is_constant && !base_type.is_meta_type) {
  4235. // GH-92534. If the base is a GDScript, use the analyzer instead.
  4236. bool base_is_gdscript = false;
  4237. if (p_subscript->base->reduced_value.get_type() == Variant::OBJECT) {
  4238. Ref<GDScript> gdscript = Object::cast_to<GDScript>(p_subscript->base->reduced_value.get_validated_object());
  4239. if (gdscript.is_valid()) {
  4240. base_is_gdscript = true;
  4241. // Makes a metatype from a constant GDScript, since `base_type` is not a metatype.
  4242. GDScriptParser::DataType base_type_meta = type_from_variant(gdscript, p_subscript);
  4243. // First try to reduce the attribute from the metatype.
  4244. reduce_identifier_from_base(p_subscript->attribute, &base_type_meta);
  4245. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  4246. if (attr_type.is_set()) {
  4247. valid = !attr_type.is_pseudo_type || p_can_be_pseudo_type;
  4248. result_type = attr_type;
  4249. p_subscript->is_constant = p_subscript->attribute->is_constant;
  4250. p_subscript->reduced_value = p_subscript->attribute->reduced_value;
  4251. }
  4252. if (!valid) {
  4253. // If unsuccessful, reset and return to the normal route.
  4254. p_subscript->attribute->set_datatype(GDScriptParser::DataType());
  4255. }
  4256. }
  4257. }
  4258. if (!base_is_gdscript) {
  4259. // Just try to get it.
  4260. Variant value = p_subscript->base->reduced_value.get_named(p_subscript->attribute->name, valid);
  4261. if (valid) {
  4262. p_subscript->is_constant = true;
  4263. p_subscript->reduced_value = value;
  4264. result_type = type_from_variant(value, p_subscript);
  4265. }
  4266. }
  4267. }
  4268. if (valid) {
  4269. // Do nothing.
  4270. } else if (base_type.is_variant() || !base_type.is_hard_type()) {
  4271. valid = !base_type.is_pseudo_type || p_can_be_pseudo_type;
  4272. result_type.kind = GDScriptParser::DataType::VARIANT;
  4273. if (base_type.is_variant() && base_type.is_hard_type() && base_type.is_meta_type && base_type.is_pseudo_type) {
  4274. // Special case: it may be a global enum with pseudo base (e.g. Variant.Type).
  4275. String enum_name;
  4276. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  4277. enum_name = String(static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base)->name) + ENUM_SEPARATOR + String(p_subscript->attribute->name);
  4278. }
  4279. if (CoreConstants::is_global_enum(enum_name)) {
  4280. result_type = make_global_enum_type(enum_name, StringName());
  4281. } else {
  4282. valid = false;
  4283. mark_node_unsafe(p_subscript);
  4284. }
  4285. } else {
  4286. mark_node_unsafe(p_subscript);
  4287. }
  4288. } else {
  4289. reduce_identifier_from_base(p_subscript->attribute, &base_type);
  4290. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  4291. if (attr_type.is_set()) {
  4292. if (base_type.builtin_type == Variant::DICTIONARY && base_type.has_container_element_types()) {
  4293. Variant::Type key_type = base_type.get_container_element_type_or_variant(0).builtin_type;
  4294. valid = key_type == Variant::NIL || key_type == Variant::STRING || key_type == Variant::STRING_NAME;
  4295. if (base_type.has_container_element_type(1)) {
  4296. result_type = base_type.get_container_element_type(1);
  4297. result_type.type_source = base_type.type_source;
  4298. } else {
  4299. result_type.builtin_type = Variant::NIL;
  4300. result_type.kind = GDScriptParser::DataType::VARIANT;
  4301. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  4302. }
  4303. } else {
  4304. valid = !attr_type.is_pseudo_type || p_can_be_pseudo_type;
  4305. result_type = attr_type;
  4306. p_subscript->is_constant = p_subscript->attribute->is_constant;
  4307. p_subscript->reduced_value = p_subscript->attribute->reduced_value;
  4308. }
  4309. } else if (!base_type.is_meta_type || !base_type.is_constant) {
  4310. valid = base_type.kind != GDScriptParser::DataType::BUILTIN;
  4311. #ifdef DEBUG_ENABLED
  4312. if (valid) {
  4313. parser->push_warning(p_subscript, GDScriptWarning::UNSAFE_PROPERTY_ACCESS, p_subscript->attribute->name, base_type.to_string());
  4314. }
  4315. #endif // DEBUG_ENABLED
  4316. result_type.kind = GDScriptParser::DataType::VARIANT;
  4317. mark_node_unsafe(p_subscript);
  4318. }
  4319. }
  4320. if (!valid) {
  4321. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  4322. if (!p_can_be_pseudo_type && (attr_type.is_pseudo_type || result_type.is_pseudo_type)) {
  4323. 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);
  4324. } else {
  4325. 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);
  4326. }
  4327. result_type.kind = GDScriptParser::DataType::VARIANT;
  4328. }
  4329. } else {
  4330. if (p_subscript->index == nullptr) {
  4331. return;
  4332. }
  4333. reduce_expression(p_subscript->index);
  4334. if (p_subscript->base->is_constant && p_subscript->index->is_constant) {
  4335. // Just try to get it.
  4336. bool valid = false;
  4337. // TODO: Check if `p_subscript->base->reduced_value` is GDScript.
  4338. Variant value = p_subscript->base->reduced_value.get(p_subscript->index->reduced_value, &valid);
  4339. if (!valid) {
  4340. push_error(vformat(R"(Cannot get index "%s" from "%s".)", p_subscript->index->reduced_value, p_subscript->base->reduced_value), p_subscript->index);
  4341. result_type.kind = GDScriptParser::DataType::VARIANT;
  4342. } else {
  4343. p_subscript->is_constant = true;
  4344. p_subscript->reduced_value = value;
  4345. result_type = type_from_variant(value, p_subscript);
  4346. }
  4347. } else {
  4348. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  4349. GDScriptParser::DataType index_type = p_subscript->index->get_datatype();
  4350. if (base_type.is_variant()) {
  4351. result_type.kind = GDScriptParser::DataType::VARIANT;
  4352. mark_node_unsafe(p_subscript);
  4353. } else {
  4354. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  4355. // Check if indexing is valid.
  4356. bool error = index_type.kind != GDScriptParser::DataType::BUILTIN && base_type.builtin_type != Variant::DICTIONARY;
  4357. if (!error) {
  4358. switch (base_type.builtin_type) {
  4359. // Expect int or real as index.
  4360. case Variant::PACKED_BYTE_ARRAY:
  4361. case Variant::PACKED_FLOAT32_ARRAY:
  4362. case Variant::PACKED_FLOAT64_ARRAY:
  4363. case Variant::PACKED_INT32_ARRAY:
  4364. case Variant::PACKED_INT64_ARRAY:
  4365. case Variant::PACKED_STRING_ARRAY:
  4366. case Variant::PACKED_VECTOR2_ARRAY:
  4367. case Variant::PACKED_VECTOR3_ARRAY:
  4368. case Variant::PACKED_COLOR_ARRAY:
  4369. case Variant::PACKED_VECTOR4_ARRAY:
  4370. case Variant::ARRAY:
  4371. case Variant::STRING:
  4372. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT;
  4373. break;
  4374. // Expect String only.
  4375. case Variant::RECT2:
  4376. case Variant::RECT2I:
  4377. case Variant::PLANE:
  4378. case Variant::QUATERNION:
  4379. case Variant::AABB:
  4380. case Variant::OBJECT:
  4381. error = index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  4382. break;
  4383. // Expect String or number.
  4384. case Variant::BASIS:
  4385. case Variant::VECTOR2:
  4386. case Variant::VECTOR2I:
  4387. case Variant::VECTOR3:
  4388. case Variant::VECTOR3I:
  4389. case Variant::VECTOR4:
  4390. case Variant::VECTOR4I:
  4391. case Variant::TRANSFORM2D:
  4392. case Variant::TRANSFORM3D:
  4393. case Variant::PROJECTION:
  4394. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT &&
  4395. index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  4396. break;
  4397. // Expect String or int.
  4398. case Variant::COLOR:
  4399. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  4400. break;
  4401. // Don't support indexing, but we will check it later.
  4402. case Variant::RID:
  4403. case Variant::BOOL:
  4404. case Variant::CALLABLE:
  4405. case Variant::FLOAT:
  4406. case Variant::INT:
  4407. case Variant::NIL:
  4408. case Variant::NODE_PATH:
  4409. case Variant::SIGNAL:
  4410. case Variant::STRING_NAME:
  4411. break;
  4412. // Support depends on if the dictionary has a typed key, otherwise anything is valid.
  4413. case Variant::DICTIONARY:
  4414. if (base_type.has_container_element_type(0)) {
  4415. GDScriptParser::DataType key_type = base_type.get_container_element_type(0);
  4416. switch (index_type.builtin_type) {
  4417. // Null value will be treated as an empty object, allow.
  4418. case Variant::NIL:
  4419. error = key_type.builtin_type != Variant::OBJECT;
  4420. break;
  4421. // Objects are parsed for validity in a similar manner to container types.
  4422. case Variant::OBJECT:
  4423. if (key_type.builtin_type == Variant::OBJECT) {
  4424. error = !key_type.can_reference(index_type);
  4425. } else {
  4426. error = key_type.builtin_type != Variant::NIL;
  4427. }
  4428. break;
  4429. // String and StringName interchangeable in this context.
  4430. case Variant::STRING:
  4431. case Variant::STRING_NAME:
  4432. error = key_type.builtin_type != Variant::STRING_NAME && key_type.builtin_type != Variant::STRING;
  4433. break;
  4434. // Ints are valid indices for floats, but not the other way around.
  4435. case Variant::INT:
  4436. error = key_type.builtin_type != Variant::INT && key_type.builtin_type != Variant::FLOAT;
  4437. break;
  4438. // All other cases require the types to match exactly.
  4439. default:
  4440. error = key_type.builtin_type != index_type.builtin_type;
  4441. break;
  4442. }
  4443. }
  4444. break;
  4445. // Here for completeness.
  4446. case Variant::VARIANT_MAX:
  4447. break;
  4448. }
  4449. if (error) {
  4450. 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);
  4451. }
  4452. }
  4453. } else if (base_type.kind != GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  4454. if (index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME) {
  4455. 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);
  4456. }
  4457. }
  4458. // Check resulting type if possible.
  4459. result_type.builtin_type = Variant::NIL;
  4460. result_type.kind = GDScriptParser::DataType::BUILTIN;
  4461. result_type.type_source = base_type.is_hard_type() ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  4462. if (base_type.kind != GDScriptParser::DataType::BUILTIN) {
  4463. base_type.builtin_type = Variant::OBJECT;
  4464. }
  4465. switch (base_type.builtin_type) {
  4466. // Can't index at all.
  4467. case Variant::RID:
  4468. case Variant::BOOL:
  4469. case Variant::CALLABLE:
  4470. case Variant::FLOAT:
  4471. case Variant::INT:
  4472. case Variant::NIL:
  4473. case Variant::NODE_PATH:
  4474. case Variant::SIGNAL:
  4475. case Variant::STRING_NAME:
  4476. result_type.kind = GDScriptParser::DataType::VARIANT;
  4477. push_error(vformat(R"(Cannot use subscript operator on a base of type "%s".)", base_type.to_string()), p_subscript->base);
  4478. break;
  4479. // Return int.
  4480. case Variant::PACKED_BYTE_ARRAY:
  4481. case Variant::PACKED_INT32_ARRAY:
  4482. case Variant::PACKED_INT64_ARRAY:
  4483. case Variant::VECTOR2I:
  4484. case Variant::VECTOR3I:
  4485. case Variant::VECTOR4I:
  4486. result_type.builtin_type = Variant::INT;
  4487. break;
  4488. // Return float.
  4489. case Variant::PACKED_FLOAT32_ARRAY:
  4490. case Variant::PACKED_FLOAT64_ARRAY:
  4491. case Variant::VECTOR2:
  4492. case Variant::VECTOR3:
  4493. case Variant::VECTOR4:
  4494. case Variant::QUATERNION:
  4495. result_type.builtin_type = Variant::FLOAT;
  4496. break;
  4497. // Return String.
  4498. case Variant::PACKED_STRING_ARRAY:
  4499. case Variant::STRING:
  4500. result_type.builtin_type = Variant::STRING;
  4501. break;
  4502. // Return Vector2.
  4503. case Variant::PACKED_VECTOR2_ARRAY:
  4504. case Variant::TRANSFORM2D:
  4505. case Variant::RECT2:
  4506. result_type.builtin_type = Variant::VECTOR2;
  4507. break;
  4508. // Return Vector2I.
  4509. case Variant::RECT2I:
  4510. result_type.builtin_type = Variant::VECTOR2I;
  4511. break;
  4512. // Return Vector3.
  4513. case Variant::PACKED_VECTOR3_ARRAY:
  4514. case Variant::AABB:
  4515. case Variant::BASIS:
  4516. result_type.builtin_type = Variant::VECTOR3;
  4517. break;
  4518. // Return Color.
  4519. case Variant::PACKED_COLOR_ARRAY:
  4520. result_type.builtin_type = Variant::COLOR;
  4521. break;
  4522. // Return Vector4.
  4523. case Variant::PACKED_VECTOR4_ARRAY:
  4524. result_type.builtin_type = Variant::VECTOR4;
  4525. break;
  4526. // Depends on the index.
  4527. case Variant::TRANSFORM3D:
  4528. case Variant::PROJECTION:
  4529. case Variant::PLANE:
  4530. case Variant::COLOR:
  4531. case Variant::OBJECT:
  4532. result_type.kind = GDScriptParser::DataType::VARIANT;
  4533. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  4534. break;
  4535. // Can have an element type.
  4536. case Variant::ARRAY:
  4537. if (base_type.has_container_element_type(0)) {
  4538. result_type = base_type.get_container_element_type(0);
  4539. result_type.type_source = base_type.type_source;
  4540. } else {
  4541. result_type.kind = GDScriptParser::DataType::VARIANT;
  4542. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  4543. }
  4544. break;
  4545. // Can have two element types, but we only care about the value.
  4546. case Variant::DICTIONARY:
  4547. if (base_type.has_container_element_type(1)) {
  4548. result_type = base_type.get_container_element_type(1);
  4549. result_type.type_source = base_type.type_source;
  4550. } else {
  4551. result_type.kind = GDScriptParser::DataType::VARIANT;
  4552. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  4553. }
  4554. break;
  4555. // Here for completeness.
  4556. case Variant::VARIANT_MAX:
  4557. break;
  4558. }
  4559. }
  4560. }
  4561. }
  4562. p_subscript->set_datatype(result_type);
  4563. }
  4564. void GDScriptAnalyzer::reduce_ternary_op(GDScriptParser::TernaryOpNode *p_ternary_op, bool p_is_root) {
  4565. reduce_expression(p_ternary_op->condition);
  4566. reduce_expression(p_ternary_op->true_expr, p_is_root);
  4567. reduce_expression(p_ternary_op->false_expr, p_is_root);
  4568. GDScriptParser::DataType result;
  4569. 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) {
  4570. p_ternary_op->is_constant = true;
  4571. if (p_ternary_op->condition->reduced_value.booleanize()) {
  4572. p_ternary_op->reduced_value = p_ternary_op->true_expr->reduced_value;
  4573. } else {
  4574. p_ternary_op->reduced_value = p_ternary_op->false_expr->reduced_value;
  4575. }
  4576. }
  4577. GDScriptParser::DataType true_type;
  4578. if (p_ternary_op->true_expr) {
  4579. true_type = p_ternary_op->true_expr->get_datatype();
  4580. } else {
  4581. true_type.kind = GDScriptParser::DataType::VARIANT;
  4582. }
  4583. GDScriptParser::DataType false_type;
  4584. if (p_ternary_op->false_expr) {
  4585. false_type = p_ternary_op->false_expr->get_datatype();
  4586. } else {
  4587. false_type.kind = GDScriptParser::DataType::VARIANT;
  4588. }
  4589. if (true_type.is_variant() || false_type.is_variant()) {
  4590. result.kind = GDScriptParser::DataType::VARIANT;
  4591. } else {
  4592. result = true_type;
  4593. if (!is_type_compatible(true_type, false_type)) {
  4594. result = false_type;
  4595. if (!is_type_compatible(false_type, true_type)) {
  4596. result.kind = GDScriptParser::DataType::VARIANT;
  4597. #ifdef DEBUG_ENABLED
  4598. parser->push_warning(p_ternary_op, GDScriptWarning::INCOMPATIBLE_TERNARY);
  4599. #endif // DEBUG_ENABLED
  4600. }
  4601. }
  4602. }
  4603. result.type_source = true_type.is_hard_type() && false_type.is_hard_type() ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  4604. p_ternary_op->set_datatype(result);
  4605. }
  4606. void GDScriptAnalyzer::reduce_type_test(GDScriptParser::TypeTestNode *p_type_test) {
  4607. GDScriptParser::DataType result;
  4608. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4609. result.kind = GDScriptParser::DataType::BUILTIN;
  4610. result.builtin_type = Variant::BOOL;
  4611. p_type_test->set_datatype(result);
  4612. if (!p_type_test->operand || !p_type_test->test_type) {
  4613. return;
  4614. }
  4615. reduce_expression(p_type_test->operand);
  4616. GDScriptParser::DataType operand_type = p_type_test->operand->get_datatype();
  4617. GDScriptParser::DataType test_type = type_from_metatype(resolve_datatype(p_type_test->test_type));
  4618. p_type_test->test_datatype = test_type;
  4619. if (!operand_type.is_set() || !test_type.is_set()) {
  4620. return;
  4621. }
  4622. if (p_type_test->operand->is_constant) {
  4623. p_type_test->is_constant = true;
  4624. p_type_test->reduced_value = false;
  4625. if (!is_type_compatible(test_type, operand_type)) {
  4626. 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);
  4627. } else if (is_type_compatible(test_type, type_from_variant(p_type_test->operand->reduced_value, p_type_test->operand))) {
  4628. p_type_test->reduced_value = test_type.builtin_type != Variant::OBJECT || !p_type_test->operand->reduced_value.is_null();
  4629. }
  4630. return;
  4631. }
  4632. if (!is_type_compatible(test_type, operand_type) && !is_type_compatible(operand_type, test_type)) {
  4633. if (operand_type.is_hard_type()) {
  4634. 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);
  4635. } else {
  4636. downgrade_node_type_source(p_type_test->operand);
  4637. }
  4638. }
  4639. }
  4640. void GDScriptAnalyzer::reduce_unary_op(GDScriptParser::UnaryOpNode *p_unary_op) {
  4641. reduce_expression(p_unary_op->operand);
  4642. GDScriptParser::DataType result;
  4643. if (p_unary_op->operand == nullptr) {
  4644. result.kind = GDScriptParser::DataType::VARIANT;
  4645. p_unary_op->set_datatype(result);
  4646. return;
  4647. }
  4648. GDScriptParser::DataType operand_type = p_unary_op->operand->get_datatype();
  4649. if (p_unary_op->operand->is_constant) {
  4650. p_unary_op->is_constant = true;
  4651. p_unary_op->reduced_value = Variant::evaluate(p_unary_op->variant_op, p_unary_op->operand->reduced_value, Variant());
  4652. result = type_from_variant(p_unary_op->reduced_value, p_unary_op);
  4653. }
  4654. if (operand_type.is_variant()) {
  4655. result.kind = GDScriptParser::DataType::VARIANT;
  4656. mark_node_unsafe(p_unary_op);
  4657. } else {
  4658. bool valid = false;
  4659. result = get_operation_type(p_unary_op->variant_op, operand_type, valid, p_unary_op);
  4660. if (!valid) {
  4661. 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);
  4662. }
  4663. }
  4664. p_unary_op->set_datatype(result);
  4665. }
  4666. Variant GDScriptAnalyzer::make_expression_reduced_value(GDScriptParser::ExpressionNode *p_expression, bool &is_reduced) {
  4667. if (p_expression == nullptr) {
  4668. return Variant();
  4669. }
  4670. if (p_expression->is_constant) {
  4671. is_reduced = true;
  4672. return p_expression->reduced_value;
  4673. }
  4674. switch (p_expression->type) {
  4675. case GDScriptParser::Node::ARRAY:
  4676. return make_array_reduced_value(static_cast<GDScriptParser::ArrayNode *>(p_expression), is_reduced);
  4677. case GDScriptParser::Node::DICTIONARY:
  4678. return make_dictionary_reduced_value(static_cast<GDScriptParser::DictionaryNode *>(p_expression), is_reduced);
  4679. case GDScriptParser::Node::SUBSCRIPT:
  4680. return make_subscript_reduced_value(static_cast<GDScriptParser::SubscriptNode *>(p_expression), is_reduced);
  4681. case GDScriptParser::Node::CALL:
  4682. return make_call_reduced_value(static_cast<GDScriptParser::CallNode *>(p_expression), is_reduced);
  4683. default:
  4684. break;
  4685. }
  4686. return Variant();
  4687. }
  4688. Variant GDScriptAnalyzer::make_array_reduced_value(GDScriptParser::ArrayNode *p_array, bool &is_reduced) {
  4689. 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();
  4690. array.resize(p_array->elements.size());
  4691. for (int i = 0; i < p_array->elements.size(); i++) {
  4692. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  4693. bool is_element_value_reduced = false;
  4694. Variant element_value = make_expression_reduced_value(element, is_element_value_reduced);
  4695. if (!is_element_value_reduced) {
  4696. return Variant();
  4697. }
  4698. array[i] = element_value;
  4699. }
  4700. array.make_read_only();
  4701. is_reduced = true;
  4702. return array;
  4703. }
  4704. Variant GDScriptAnalyzer::make_dictionary_reduced_value(GDScriptParser::DictionaryNode *p_dictionary, bool &is_reduced) {
  4705. Dictionary dictionary = p_dictionary->get_datatype().has_container_element_types()
  4706. ? 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))
  4707. : Dictionary();
  4708. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  4709. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  4710. bool is_element_key_reduced = false;
  4711. Variant element_key = make_expression_reduced_value(element.key, is_element_key_reduced);
  4712. if (!is_element_key_reduced) {
  4713. return Variant();
  4714. }
  4715. bool is_element_value_reduced = false;
  4716. Variant element_value = make_expression_reduced_value(element.value, is_element_value_reduced);
  4717. if (!is_element_value_reduced) {
  4718. return Variant();
  4719. }
  4720. dictionary[element_key] = element_value;
  4721. }
  4722. dictionary.make_read_only();
  4723. is_reduced = true;
  4724. return dictionary;
  4725. }
  4726. Variant GDScriptAnalyzer::make_subscript_reduced_value(GDScriptParser::SubscriptNode *p_subscript, bool &is_reduced) {
  4727. if (p_subscript->base == nullptr || p_subscript->index == nullptr) {
  4728. return Variant();
  4729. }
  4730. bool is_base_value_reduced = false;
  4731. Variant base_value = make_expression_reduced_value(p_subscript->base, is_base_value_reduced);
  4732. if (!is_base_value_reduced) {
  4733. return Variant();
  4734. }
  4735. if (p_subscript->is_attribute) {
  4736. bool is_valid = false;
  4737. Variant value = base_value.get_named(p_subscript->attribute->name, is_valid);
  4738. if (is_valid) {
  4739. is_reduced = true;
  4740. return value;
  4741. } else {
  4742. return Variant();
  4743. }
  4744. } else {
  4745. bool is_index_value_reduced = false;
  4746. Variant index_value = make_expression_reduced_value(p_subscript->index, is_index_value_reduced);
  4747. if (!is_index_value_reduced) {
  4748. return Variant();
  4749. }
  4750. bool is_valid = false;
  4751. Variant value = base_value.get(index_value, &is_valid);
  4752. if (is_valid) {
  4753. is_reduced = true;
  4754. return value;
  4755. } else {
  4756. return Variant();
  4757. }
  4758. }
  4759. }
  4760. Variant GDScriptAnalyzer::make_call_reduced_value(GDScriptParser::CallNode *p_call, bool &is_reduced) {
  4761. if (p_call->get_callee_type() == GDScriptParser::Node::IDENTIFIER) {
  4762. Variant::Type type = Variant::NIL;
  4763. if (p_call->function_name == SNAME("Array")) {
  4764. type = Variant::ARRAY;
  4765. } else if (p_call->function_name == SNAME("Dictionary")) {
  4766. type = Variant::DICTIONARY;
  4767. } else {
  4768. return Variant();
  4769. }
  4770. Vector<Variant> args;
  4771. args.resize(p_call->arguments.size());
  4772. const Variant **argptrs = (const Variant **)alloca(sizeof(const Variant *) * args.size());
  4773. for (int i = 0; i < p_call->arguments.size(); i++) {
  4774. bool is_arg_value_reduced = false;
  4775. Variant arg_value = make_expression_reduced_value(p_call->arguments[i], is_arg_value_reduced);
  4776. if (!is_arg_value_reduced) {
  4777. return Variant();
  4778. }
  4779. args.write[i] = arg_value;
  4780. argptrs[i] = &args[i];
  4781. }
  4782. Variant result;
  4783. Callable::CallError ce;
  4784. Variant::construct(type, result, argptrs, args.size(), ce);
  4785. if (ce.error) {
  4786. push_error(vformat(R"(Failed to construct "%s".)", Variant::get_type_name(type)), p_call);
  4787. return Variant();
  4788. }
  4789. if (type == Variant::ARRAY) {
  4790. Array array = result;
  4791. array.make_read_only();
  4792. } else if (type == Variant::DICTIONARY) {
  4793. Dictionary dictionary = result;
  4794. dictionary.make_read_only();
  4795. }
  4796. is_reduced = true;
  4797. return result;
  4798. }
  4799. return Variant();
  4800. }
  4801. Array GDScriptAnalyzer::make_array_from_element_datatype(const GDScriptParser::DataType &p_element_datatype, const GDScriptParser::Node *p_source_node) {
  4802. Array array;
  4803. if (p_element_datatype.builtin_type == Variant::OBJECT) {
  4804. Ref<Script> script_type = p_element_datatype.script_type;
  4805. if (p_element_datatype.kind == GDScriptParser::DataType::CLASS && script_type.is_null()) {
  4806. Error err = OK;
  4807. Ref<GDScript> scr = get_depended_shallow_script(p_element_datatype.script_path, err);
  4808. if (err) {
  4809. push_error(vformat(R"(Error while getting cache for script "%s".)", p_element_datatype.script_path), p_source_node);
  4810. return array;
  4811. }
  4812. script_type.reference_ptr(scr->find_class(p_element_datatype.class_type->fqcn));
  4813. }
  4814. array.set_typed(p_element_datatype.builtin_type, p_element_datatype.native_type, script_type);
  4815. } else {
  4816. array.set_typed(p_element_datatype.builtin_type, StringName(), Variant());
  4817. }
  4818. return array;
  4819. }
  4820. 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) {
  4821. Dictionary dictionary;
  4822. StringName key_name;
  4823. Variant key_script;
  4824. StringName value_name;
  4825. Variant value_script;
  4826. if (p_key_element_datatype.builtin_type == Variant::OBJECT) {
  4827. Ref<Script> script_type = p_key_element_datatype.script_type;
  4828. if (p_key_element_datatype.kind == GDScriptParser::DataType::CLASS && script_type.is_null()) {
  4829. Error err = OK;
  4830. Ref<GDScript> scr = get_depended_shallow_script(p_key_element_datatype.script_path, err);
  4831. if (err) {
  4832. push_error(vformat(R"(Error while getting cache for script "%s".)", p_key_element_datatype.script_path), p_source_node);
  4833. return dictionary;
  4834. }
  4835. script_type.reference_ptr(scr->find_class(p_key_element_datatype.class_type->fqcn));
  4836. }
  4837. key_name = p_key_element_datatype.native_type;
  4838. key_script = script_type;
  4839. }
  4840. if (p_value_element_datatype.builtin_type == Variant::OBJECT) {
  4841. Ref<Script> script_type = p_value_element_datatype.script_type;
  4842. if (p_value_element_datatype.kind == GDScriptParser::DataType::CLASS && script_type.is_null()) {
  4843. Error err = OK;
  4844. Ref<GDScript> scr = get_depended_shallow_script(p_value_element_datatype.script_path, err);
  4845. if (err) {
  4846. push_error(vformat(R"(Error while getting cache for script "%s".)", p_value_element_datatype.script_path), p_source_node);
  4847. return dictionary;
  4848. }
  4849. script_type.reference_ptr(scr->find_class(p_value_element_datatype.class_type->fqcn));
  4850. }
  4851. value_name = p_value_element_datatype.native_type;
  4852. value_script = script_type;
  4853. }
  4854. dictionary.set_typed(p_key_element_datatype.builtin_type, key_name, key_script, p_value_element_datatype.builtin_type, value_name, value_script);
  4855. return dictionary;
  4856. }
  4857. Variant GDScriptAnalyzer::make_variable_default_value(GDScriptParser::VariableNode *p_variable) {
  4858. Variant result = Variant();
  4859. if (p_variable->initializer) {
  4860. bool is_initializer_value_reduced = false;
  4861. Variant initializer_value = make_expression_reduced_value(p_variable->initializer, is_initializer_value_reduced);
  4862. if (is_initializer_value_reduced) {
  4863. result = initializer_value;
  4864. }
  4865. } else {
  4866. GDScriptParser::DataType datatype = p_variable->get_datatype();
  4867. if (datatype.is_hard_type()) {
  4868. if (datatype.kind == GDScriptParser::DataType::BUILTIN && datatype.builtin_type != Variant::OBJECT) {
  4869. if (datatype.builtin_type == Variant::ARRAY && datatype.has_container_element_type(0)) {
  4870. result = make_array_from_element_datatype(datatype.get_container_element_type(0));
  4871. } else if (datatype.builtin_type == Variant::DICTIONARY && datatype.has_container_element_types()) {
  4872. GDScriptParser::DataType key = datatype.get_container_element_type_or_variant(0);
  4873. GDScriptParser::DataType value = datatype.get_container_element_type_or_variant(1);
  4874. result = make_dictionary_from_element_datatype(key, value);
  4875. } else {
  4876. VariantInternal::initialize(&result, datatype.builtin_type);
  4877. }
  4878. } else if (datatype.kind == GDScriptParser::DataType::ENUM) {
  4879. result = 0;
  4880. }
  4881. }
  4882. }
  4883. return result;
  4884. }
  4885. GDScriptParser::DataType GDScriptAnalyzer::type_from_variant(const Variant &p_value, const GDScriptParser::Node *p_source) {
  4886. GDScriptParser::DataType result;
  4887. result.is_constant = true;
  4888. result.kind = GDScriptParser::DataType::BUILTIN;
  4889. result.builtin_type = p_value.get_type();
  4890. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT; // Constant has explicit type.
  4891. if (p_value.get_type() == Variant::ARRAY) {
  4892. const Array &array = p_value;
  4893. if (array.get_typed_script()) {
  4894. result.set_container_element_type(0, type_from_metatype(make_script_meta_type(array.get_typed_script())));
  4895. } else if (array.get_typed_class_name()) {
  4896. result.set_container_element_type(0, type_from_metatype(make_native_meta_type(array.get_typed_class_name())));
  4897. } else if (array.get_typed_builtin() != Variant::NIL) {
  4898. result.set_container_element_type(0, type_from_metatype(make_builtin_meta_type((Variant::Type)array.get_typed_builtin())));
  4899. }
  4900. } else if (p_value.get_type() == Variant::DICTIONARY) {
  4901. const Dictionary &dict = p_value;
  4902. if (dict.get_typed_key_script()) {
  4903. result.set_container_element_type(0, type_from_metatype(make_script_meta_type(dict.get_typed_key_script())));
  4904. } else if (dict.get_typed_key_class_name()) {
  4905. result.set_container_element_type(0, type_from_metatype(make_native_meta_type(dict.get_typed_key_class_name())));
  4906. } else if (dict.get_typed_key_builtin() != Variant::NIL) {
  4907. result.set_container_element_type(0, type_from_metatype(make_builtin_meta_type((Variant::Type)dict.get_typed_key_builtin())));
  4908. }
  4909. if (dict.get_typed_value_script()) {
  4910. result.set_container_element_type(1, type_from_metatype(make_script_meta_type(dict.get_typed_value_script())));
  4911. } else if (dict.get_typed_value_class_name()) {
  4912. result.set_container_element_type(1, type_from_metatype(make_native_meta_type(dict.get_typed_value_class_name())));
  4913. } else if (dict.get_typed_value_builtin() != Variant::NIL) {
  4914. result.set_container_element_type(1, type_from_metatype(make_builtin_meta_type((Variant::Type)dict.get_typed_value_builtin())));
  4915. }
  4916. } else if (p_value.get_type() == Variant::OBJECT) {
  4917. // Object is treated as a native type, not a builtin type.
  4918. result.kind = GDScriptParser::DataType::NATIVE;
  4919. Object *obj = p_value;
  4920. if (!obj) {
  4921. return GDScriptParser::DataType();
  4922. }
  4923. result.native_type = obj->get_class_name();
  4924. Ref<Script> scr = p_value; // Check if value is a script itself.
  4925. if (scr.is_valid()) {
  4926. result.is_meta_type = true;
  4927. } else {
  4928. result.is_meta_type = false;
  4929. scr = obj->get_script();
  4930. }
  4931. if (scr.is_valid()) {
  4932. Ref<GDScript> gds = scr;
  4933. if (gds.is_valid()) {
  4934. // This might be an inner class, so we want to get the parser for the root.
  4935. // But still get the inner class from that tree.
  4936. String script_path = gds->get_script_path();
  4937. Ref<GDScriptParserRef> ref = parser->get_depended_parser_for(script_path);
  4938. if (ref.is_null()) {
  4939. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  4940. GDScriptParser::DataType error_type;
  4941. error_type.kind = GDScriptParser::DataType::VARIANT;
  4942. return error_type;
  4943. }
  4944. Error err = ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  4945. GDScriptParser::ClassNode *found = nullptr;
  4946. if (err == OK) {
  4947. found = ref->get_parser()->find_class(gds->fully_qualified_name);
  4948. if (found != nullptr) {
  4949. err = resolve_class_inheritance(found, p_source);
  4950. }
  4951. }
  4952. if (err || found == nullptr) {
  4953. push_error(vformat(R"(Could not resolve script "%s".)", script_path), p_source);
  4954. GDScriptParser::DataType error_type;
  4955. error_type.kind = GDScriptParser::DataType::VARIANT;
  4956. return error_type;
  4957. }
  4958. result.kind = GDScriptParser::DataType::CLASS;
  4959. result.native_type = found->get_datatype().native_type;
  4960. result.class_type = found;
  4961. result.script_path = ref->get_parser()->script_path;
  4962. } else {
  4963. result.kind = GDScriptParser::DataType::SCRIPT;
  4964. result.native_type = scr->get_instance_base_type();
  4965. result.script_path = scr->get_path();
  4966. }
  4967. result.script_type = scr;
  4968. } else {
  4969. result.kind = GDScriptParser::DataType::NATIVE;
  4970. if (result.native_type == GDScriptNativeClass::get_class_static()) {
  4971. result.is_meta_type = true;
  4972. }
  4973. }
  4974. }
  4975. return result;
  4976. }
  4977. GDScriptParser::DataType GDScriptAnalyzer::type_from_metatype(const GDScriptParser::DataType &p_meta_type) {
  4978. GDScriptParser::DataType result = p_meta_type;
  4979. result.is_meta_type = false;
  4980. result.is_pseudo_type = false;
  4981. if (p_meta_type.kind == GDScriptParser::DataType::ENUM) {
  4982. result.builtin_type = Variant::INT;
  4983. } else {
  4984. result.is_constant = false;
  4985. }
  4986. return result;
  4987. }
  4988. GDScriptParser::DataType GDScriptAnalyzer::type_from_property(const PropertyInfo &p_property, bool p_is_arg, bool p_is_readonly) const {
  4989. GDScriptParser::DataType result;
  4990. result.is_read_only = p_is_readonly;
  4991. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4992. if (p_property.type == Variant::NIL && (p_is_arg || (p_property.usage & PROPERTY_USAGE_NIL_IS_VARIANT))) {
  4993. // Variant
  4994. result.kind = GDScriptParser::DataType::VARIANT;
  4995. return result;
  4996. }
  4997. result.builtin_type = p_property.type;
  4998. if (p_property.type == Variant::OBJECT) {
  4999. if (ScriptServer::is_global_class(p_property.class_name)) {
  5000. result.kind = GDScriptParser::DataType::SCRIPT;
  5001. result.script_path = ScriptServer::get_global_class_path(p_property.class_name);
  5002. result.native_type = ScriptServer::get_global_class_native_base(p_property.class_name);
  5003. Ref<Script> scr = ResourceLoader::load(ScriptServer::get_global_class_path(p_property.class_name));
  5004. if (scr.is_valid()) {
  5005. result.script_type = scr;
  5006. }
  5007. } else {
  5008. result.kind = GDScriptParser::DataType::NATIVE;
  5009. result.native_type = p_property.class_name == StringName() ? "Object" : p_property.class_name;
  5010. }
  5011. } else {
  5012. result.kind = GDScriptParser::DataType::BUILTIN;
  5013. result.builtin_type = p_property.type;
  5014. if (p_property.type == Variant::ARRAY && p_property.hint == PROPERTY_HINT_ARRAY_TYPE) {
  5015. // Check element type.
  5016. StringName elem_type_name = p_property.hint_string;
  5017. GDScriptParser::DataType elem_type;
  5018. elem_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  5019. Variant::Type elem_builtin_type = GDScriptParser::get_builtin_type(elem_type_name);
  5020. if (elem_builtin_type < Variant::VARIANT_MAX) {
  5021. // Builtin type.
  5022. elem_type.kind = GDScriptParser::DataType::BUILTIN;
  5023. elem_type.builtin_type = elem_builtin_type;
  5024. } else if (class_exists(elem_type_name)) {
  5025. elem_type.kind = GDScriptParser::DataType::NATIVE;
  5026. elem_type.builtin_type = Variant::OBJECT;
  5027. elem_type.native_type = elem_type_name;
  5028. } else if (ScriptServer::is_global_class(elem_type_name)) {
  5029. // Just load this as it shouldn't be a GDScript.
  5030. Ref<Script> script = ResourceLoader::load(ScriptServer::get_global_class_path(elem_type_name));
  5031. elem_type.kind = GDScriptParser::DataType::SCRIPT;
  5032. elem_type.builtin_type = Variant::OBJECT;
  5033. elem_type.native_type = script->get_instance_base_type();
  5034. elem_type.script_type = script;
  5035. } else {
  5036. ERR_FAIL_V_MSG(result, "Could not find element type from property hint of a typed array.");
  5037. }
  5038. elem_type.is_constant = false;
  5039. result.set_container_element_type(0, elem_type);
  5040. } else if (p_property.type == Variant::DICTIONARY && p_property.hint == PROPERTY_HINT_DICTIONARY_TYPE) {
  5041. // Check element type.
  5042. StringName key_elem_type_name = p_property.hint_string.get_slicec(';', 0);
  5043. GDScriptParser::DataType key_elem_type;
  5044. key_elem_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  5045. Variant::Type key_elem_builtin_type = GDScriptParser::get_builtin_type(key_elem_type_name);
  5046. if (key_elem_builtin_type < Variant::VARIANT_MAX) {
  5047. // Builtin type.
  5048. key_elem_type.kind = GDScriptParser::DataType::BUILTIN;
  5049. key_elem_type.builtin_type = key_elem_builtin_type;
  5050. } else if (class_exists(key_elem_type_name)) {
  5051. key_elem_type.kind = GDScriptParser::DataType::NATIVE;
  5052. key_elem_type.builtin_type = Variant::OBJECT;
  5053. key_elem_type.native_type = key_elem_type_name;
  5054. } else if (ScriptServer::is_global_class(key_elem_type_name)) {
  5055. // Just load this as it shouldn't be a GDScript.
  5056. Ref<Script> script = ResourceLoader::load(ScriptServer::get_global_class_path(key_elem_type_name));
  5057. key_elem_type.kind = GDScriptParser::DataType::SCRIPT;
  5058. key_elem_type.builtin_type = Variant::OBJECT;
  5059. key_elem_type.native_type = script->get_instance_base_type();
  5060. key_elem_type.script_type = script;
  5061. } else {
  5062. ERR_FAIL_V_MSG(result, "Could not find element type from property hint of a typed dictionary.");
  5063. }
  5064. key_elem_type.is_constant = false;
  5065. StringName value_elem_type_name = p_property.hint_string.get_slicec(';', 1);
  5066. GDScriptParser::DataType value_elem_type;
  5067. value_elem_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  5068. Variant::Type value_elem_builtin_type = GDScriptParser::get_builtin_type(value_elem_type_name);
  5069. if (value_elem_builtin_type < Variant::VARIANT_MAX) {
  5070. // Builtin type.
  5071. value_elem_type.kind = GDScriptParser::DataType::BUILTIN;
  5072. value_elem_type.builtin_type = value_elem_builtin_type;
  5073. } else if (class_exists(value_elem_type_name)) {
  5074. value_elem_type.kind = GDScriptParser::DataType::NATIVE;
  5075. value_elem_type.builtin_type = Variant::OBJECT;
  5076. value_elem_type.native_type = value_elem_type_name;
  5077. } else if (ScriptServer::is_global_class(value_elem_type_name)) {
  5078. // Just load this as it shouldn't be a GDScript.
  5079. Ref<Script> script = ResourceLoader::load(ScriptServer::get_global_class_path(value_elem_type_name));
  5080. value_elem_type.kind = GDScriptParser::DataType::SCRIPT;
  5081. value_elem_type.builtin_type = Variant::OBJECT;
  5082. value_elem_type.native_type = script->get_instance_base_type();
  5083. value_elem_type.script_type = script;
  5084. } else {
  5085. ERR_FAIL_V_MSG(result, "Could not find element type from property hint of a typed dictionary.");
  5086. }
  5087. value_elem_type.is_constant = false;
  5088. result.set_container_element_type(0, key_elem_type);
  5089. result.set_container_element_type(1, value_elem_type);
  5090. } else if (p_property.type == Variant::INT) {
  5091. // Check if it's enum.
  5092. if ((p_property.usage & PROPERTY_USAGE_CLASS_IS_ENUM) && p_property.class_name != StringName()) {
  5093. if (CoreConstants::is_global_enum(p_property.class_name)) {
  5094. result = make_global_enum_type(p_property.class_name, StringName(), false);
  5095. result.is_constant = false;
  5096. } else {
  5097. Vector<String> names = String(p_property.class_name).split(ENUM_SEPARATOR);
  5098. if (names.size() == 2) {
  5099. result = make_enum_type(names[1], names[0], false);
  5100. result.is_constant = false;
  5101. }
  5102. }
  5103. }
  5104. // PROPERTY_USAGE_CLASS_IS_BITFIELD: BitField[T] isn't supported (yet?), use plain int.
  5105. }
  5106. }
  5107. return result;
  5108. }
  5109. 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) {
  5110. r_method_flags = METHOD_FLAGS_DEFAULT;
  5111. r_default_arg_count = 0;
  5112. if (r_native_class) {
  5113. *r_native_class = StringName();
  5114. }
  5115. StringName function_name = p_function;
  5116. bool was_enum = false;
  5117. if (p_base_type.kind == GDScriptParser::DataType::ENUM) {
  5118. was_enum = true;
  5119. if (p_base_type.is_meta_type) {
  5120. // Enum type can be treated as a dictionary value.
  5121. p_base_type.kind = GDScriptParser::DataType::BUILTIN;
  5122. p_base_type.is_meta_type = false;
  5123. } else {
  5124. push_error("Cannot call function on enum value.", p_source);
  5125. return false;
  5126. }
  5127. }
  5128. if (p_base_type.kind == GDScriptParser::DataType::BUILTIN) {
  5129. // Construct a base type to get methods.
  5130. Callable::CallError err;
  5131. Variant dummy;
  5132. Variant::construct(p_base_type.builtin_type, dummy, nullptr, 0, err);
  5133. if (err.error != Callable::CallError::CALL_OK) {
  5134. ERR_FAIL_V_MSG(false, "Could not construct base Variant type.");
  5135. }
  5136. List<MethodInfo> methods;
  5137. dummy.get_method_list(&methods);
  5138. for (const MethodInfo &E : methods) {
  5139. if (E.name == p_function) {
  5140. function_signature_from_info(E, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  5141. // Cannot use non-const methods on enums.
  5142. if (!r_method_flags.has_flag(METHOD_FLAG_STATIC) && was_enum && !(E.flags & METHOD_FLAG_CONST)) {
  5143. push_error(vformat(R"*(Cannot call non-const Dictionary function "%s()" on enum "%s".)*", p_function, p_base_type.enum_type), p_source);
  5144. }
  5145. return true;
  5146. }
  5147. }
  5148. return false;
  5149. }
  5150. StringName base_native = p_base_type.native_type;
  5151. if (base_native != StringName()) {
  5152. // Empty native class might happen in some Script implementations.
  5153. // Just ignore it.
  5154. if (!class_exists(base_native)) {
  5155. push_error(vformat("Native class %s used in script doesn't exist or isn't exposed.", base_native), p_source);
  5156. return false;
  5157. } else if (p_is_constructor && ClassDB::is_abstract(base_native)) {
  5158. if (p_base_type.kind == GDScriptParser::DataType::CLASS) {
  5159. 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);
  5160. } else if (p_base_type.kind == GDScriptParser::DataType::SCRIPT) {
  5161. 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);
  5162. } else {
  5163. push_error(vformat(R"(Native class "%s" cannot be constructed as it is abstract.)", base_native), p_source);
  5164. }
  5165. return false;
  5166. }
  5167. }
  5168. if (p_is_constructor) {
  5169. function_name = GDScriptLanguage::get_singleton()->strings._init;
  5170. r_method_flags.set_flag(METHOD_FLAG_STATIC);
  5171. }
  5172. GDScriptParser::ClassNode *base_class = p_base_type.class_type;
  5173. GDScriptParser::FunctionNode *found_function = nullptr;
  5174. while (found_function == nullptr && base_class != nullptr) {
  5175. if (base_class->has_member(function_name)) {
  5176. if (base_class->get_member(function_name).type != GDScriptParser::ClassNode::Member::FUNCTION) {
  5177. // TODO: If this is Callable it can have a better error message.
  5178. push_error(vformat(R"(Member "%s" is not a function.)", function_name), p_source);
  5179. return false;
  5180. }
  5181. resolve_class_member(base_class, function_name, p_source);
  5182. found_function = base_class->get_member(function_name).function;
  5183. }
  5184. resolve_class_inheritance(base_class, p_source);
  5185. base_class = base_class->base_type.class_type;
  5186. }
  5187. if (found_function != nullptr) {
  5188. if (found_function->is_abstract) {
  5189. r_method_flags.set_flag(METHOD_FLAG_VIRTUAL_REQUIRED);
  5190. }
  5191. if (p_is_constructor || found_function->is_static) {
  5192. r_method_flags.set_flag(METHOD_FLAG_STATIC);
  5193. }
  5194. for (int i = 0; i < found_function->parameters.size(); i++) {
  5195. r_par_types.push_back(found_function->parameters[i]->get_datatype());
  5196. if (found_function->parameters[i]->initializer != nullptr) {
  5197. r_default_arg_count++;
  5198. }
  5199. }
  5200. if (found_function->is_vararg()) {
  5201. r_method_flags.set_flag(METHOD_FLAG_VARARG);
  5202. }
  5203. r_return_type = p_is_constructor ? p_base_type : found_function->get_datatype();
  5204. r_return_type.is_meta_type = false;
  5205. r_return_type.is_coroutine = found_function->is_coroutine;
  5206. return true;
  5207. }
  5208. Ref<Script> base_script = p_base_type.script_type;
  5209. while (base_script.is_valid() && base_script->has_method(function_name)) {
  5210. MethodInfo info = base_script->get_method_info(function_name);
  5211. if (!(info == MethodInfo())) {
  5212. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  5213. }
  5214. base_script = base_script->get_base_script();
  5215. }
  5216. // If the base is a script, it might be trying to access members of the Script class itself.
  5217. if (p_base_type.is_meta_type && !p_is_constructor && (p_base_type.kind == GDScriptParser::DataType::SCRIPT || p_base_type.kind == GDScriptParser::DataType::CLASS)) {
  5218. MethodInfo info;
  5219. StringName script_class = p_base_type.kind == GDScriptParser::DataType::SCRIPT ? p_base_type.script_type->get_class_name() : StringName(GDScript::get_class_static());
  5220. if (ClassDB::get_method_info(script_class, function_name, &info)) {
  5221. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  5222. }
  5223. }
  5224. if (p_is_constructor) {
  5225. // Native types always have a default constructor.
  5226. r_return_type = p_base_type;
  5227. r_return_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  5228. r_return_type.is_meta_type = false;
  5229. return true;
  5230. }
  5231. MethodInfo info;
  5232. if (ClassDB::get_method_info(base_native, function_name, &info)) {
  5233. bool valid = function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  5234. if (valid && Engine::get_singleton()->has_singleton(base_native)) {
  5235. r_method_flags.set_flag(METHOD_FLAG_STATIC);
  5236. }
  5237. #ifdef DEBUG_ENABLED
  5238. MethodBind *native_method = ClassDB::get_method(base_native, function_name);
  5239. if (native_method && r_native_class) {
  5240. *r_native_class = native_method->get_instance_class();
  5241. }
  5242. #endif // DEBUG_ENABLED
  5243. return valid;
  5244. }
  5245. return false;
  5246. }
  5247. 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) {
  5248. r_return_type = type_from_property(p_info.return_val);
  5249. r_default_arg_count = p_info.default_arguments.size();
  5250. r_method_flags = p_info.flags;
  5251. for (const PropertyInfo &E : p_info.arguments) {
  5252. r_par_types.push_back(type_from_property(E, true));
  5253. }
  5254. return true;
  5255. }
  5256. void GDScriptAnalyzer::validate_call_arg(const MethodInfo &p_method, const GDScriptParser::CallNode *p_call) {
  5257. List<GDScriptParser::DataType> arg_types;
  5258. for (const PropertyInfo &E : p_method.arguments) {
  5259. arg_types.push_back(type_from_property(E, true));
  5260. }
  5261. validate_call_arg(arg_types, p_method.default_arguments.size(), (p_method.flags & METHOD_FLAG_VARARG) != 0, p_call);
  5262. }
  5263. 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) {
  5264. if (p_call->arguments.size() < p_par_types.size() - p_default_args_count) {
  5265. 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);
  5266. }
  5267. if (!p_is_vararg && p_call->arguments.size() > p_par_types.size()) {
  5268. 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()]);
  5269. }
  5270. List<GDScriptParser::DataType>::ConstIterator par_itr = p_par_types.begin();
  5271. for (int i = 0; i < p_call->arguments.size(); ++par_itr, ++i) {
  5272. if (i >= p_par_types.size()) {
  5273. // Already on vararg place.
  5274. break;
  5275. }
  5276. GDScriptParser::DataType par_type = *par_itr;
  5277. if (par_type.is_hard_type() && p_call->arguments[i]->is_constant) {
  5278. update_const_expression_builtin_type(p_call->arguments[i], par_type, "pass");
  5279. }
  5280. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  5281. if (arg_type.is_variant() || !arg_type.is_hard_type()) {
  5282. #ifdef DEBUG_ENABLED
  5283. // Argument can be anything, so this is unsafe (unless the parameter is a hard variant).
  5284. if (!(par_type.is_hard_type() && par_type.is_variant())) {
  5285. mark_node_unsafe(p_call->arguments[i]);
  5286. 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());
  5287. }
  5288. #endif // DEBUG_ENABLED
  5289. } else if (par_type.is_hard_type() && !is_type_compatible(par_type, arg_type, true)) {
  5290. if (!is_type_compatible(arg_type, par_type)) {
  5291. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*",
  5292. p_call->function_name, i + 1, par_type.to_string(), arg_type.to_string()),
  5293. p_call->arguments[i]);
  5294. #ifdef DEBUG_ENABLED
  5295. } else {
  5296. // Supertypes are acceptable for dynamic compliance, but it's unsafe.
  5297. mark_node_unsafe(p_call);
  5298. 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());
  5299. #endif // DEBUG_ENABLED
  5300. }
  5301. #ifdef DEBUG_ENABLED
  5302. } 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) {
  5303. parser->push_warning(p_call->arguments[i], GDScriptWarning::NARROWING_CONVERSION, p_call->function_name);
  5304. #endif // DEBUG_ENABLED
  5305. }
  5306. }
  5307. }
  5308. #ifdef DEBUG_ENABLED
  5309. void GDScriptAnalyzer::is_shadowing(GDScriptParser::IdentifierNode *p_identifier, const String &p_context, const bool p_in_local_scope) {
  5310. const StringName &name = p_identifier->name;
  5311. {
  5312. List<MethodInfo> gdscript_funcs;
  5313. GDScriptLanguage::get_singleton()->get_public_functions(&gdscript_funcs);
  5314. for (MethodInfo &info : gdscript_funcs) {
  5315. if (info.name == name) {
  5316. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in function");
  5317. return;
  5318. }
  5319. }
  5320. if (Variant::has_utility_function(name)) {
  5321. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in function");
  5322. return;
  5323. } else if (ClassDB::class_exists(name)) {
  5324. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "native class");
  5325. return;
  5326. } else if (ScriptServer::is_global_class(name)) {
  5327. String class_path = ScriptServer::get_global_class_path(name).get_file();
  5328. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, vformat(R"(global class defined in "%s")", class_path));
  5329. return;
  5330. } else if (GDScriptParser::get_builtin_type(name) < Variant::VARIANT_MAX) {
  5331. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in type");
  5332. return;
  5333. }
  5334. }
  5335. const GDScriptParser::DataType current_class_type = parser->current_class->get_datatype();
  5336. if (p_in_local_scope) {
  5337. GDScriptParser::ClassNode *base_class = current_class_type.class_type;
  5338. if (base_class != nullptr) {
  5339. if (base_class->has_member(name)) {
  5340. 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()));
  5341. return;
  5342. }
  5343. base_class = base_class->base_type.class_type;
  5344. }
  5345. while (base_class != nullptr) {
  5346. if (base_class->has_member(name)) {
  5347. String base_class_name = base_class->get_global_name();
  5348. if (base_class_name.is_empty()) {
  5349. base_class_name = base_class->fqcn;
  5350. }
  5351. 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);
  5352. return;
  5353. }
  5354. base_class = base_class->base_type.class_type;
  5355. }
  5356. }
  5357. StringName native_base_class = current_class_type.native_type;
  5358. while (native_base_class != StringName()) {
  5359. ERR_FAIL_COND_MSG(!class_exists(native_base_class), "Non-existent native base class.");
  5360. if (ClassDB::has_method(native_base_class, name, true)) {
  5361. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "method", native_base_class);
  5362. return;
  5363. } else if (ClassDB::has_signal(native_base_class, name, true)) {
  5364. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "signal", native_base_class);
  5365. return;
  5366. } else if (ClassDB::has_property(native_base_class, name, true)) {
  5367. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "property", native_base_class);
  5368. return;
  5369. } else if (ClassDB::has_integer_constant(native_base_class, name, true)) {
  5370. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "constant", native_base_class);
  5371. return;
  5372. } else if (ClassDB::has_enum(native_base_class, name, true)) {
  5373. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "enum", native_base_class);
  5374. return;
  5375. }
  5376. native_base_class = ClassDB::get_parent_class(native_base_class);
  5377. }
  5378. }
  5379. #endif // DEBUG_ENABLED
  5380. GDScriptParser::DataType GDScriptAnalyzer::get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, bool &r_valid, const GDScriptParser::Node *p_source) {
  5381. // Unary version.
  5382. GDScriptParser::DataType nil_type;
  5383. nil_type.builtin_type = Variant::NIL;
  5384. nil_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  5385. return get_operation_type(p_operation, p_a, nil_type, r_valid, p_source);
  5386. }
  5387. 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) {
  5388. if (p_operation == Variant::OP_AND || p_operation == Variant::OP_OR) {
  5389. // Those work for any type of argument and always return a boolean.
  5390. // They don't use the Variant operator since they have short-circuit semantics.
  5391. r_valid = true;
  5392. GDScriptParser::DataType result;
  5393. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  5394. result.kind = GDScriptParser::DataType::BUILTIN;
  5395. result.builtin_type = Variant::BOOL;
  5396. return result;
  5397. }
  5398. Variant::Type a_type = p_a.builtin_type;
  5399. Variant::Type b_type = p_b.builtin_type;
  5400. if (p_a.kind == GDScriptParser::DataType::ENUM) {
  5401. if (p_a.is_meta_type) {
  5402. a_type = Variant::DICTIONARY;
  5403. } else {
  5404. a_type = Variant::INT;
  5405. }
  5406. }
  5407. if (p_b.kind == GDScriptParser::DataType::ENUM) {
  5408. if (p_b.is_meta_type) {
  5409. b_type = Variant::DICTIONARY;
  5410. } else {
  5411. b_type = Variant::INT;
  5412. }
  5413. }
  5414. GDScriptParser::DataType result;
  5415. bool hard_operation = p_a.is_hard_type() && p_b.is_hard_type();
  5416. if (p_operation == Variant::OP_ADD && a_type == Variant::ARRAY && b_type == Variant::ARRAY) {
  5417. 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)) {
  5418. r_valid = true;
  5419. result = p_a;
  5420. result.type_source = hard_operation ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  5421. return result;
  5422. }
  5423. }
  5424. Variant::ValidatedOperatorEvaluator op_eval = Variant::get_validated_operator_evaluator(p_operation, a_type, b_type);
  5425. bool validated = op_eval != nullptr;
  5426. if (validated) {
  5427. r_valid = true;
  5428. result.type_source = hard_operation ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  5429. result.kind = GDScriptParser::DataType::BUILTIN;
  5430. result.builtin_type = Variant::get_operator_return_type(p_operation, a_type, b_type);
  5431. } else {
  5432. r_valid = !hard_operation;
  5433. result.kind = GDScriptParser::DataType::VARIANT;
  5434. }
  5435. return result;
  5436. }
  5437. 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) {
  5438. #ifdef DEBUG_ENABLED
  5439. if (p_source_node) {
  5440. if (p_target.kind == GDScriptParser::DataType::ENUM) {
  5441. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::INT) {
  5442. parser->push_warning(p_source_node, GDScriptWarning::INT_AS_ENUM_WITHOUT_CAST);
  5443. }
  5444. }
  5445. }
  5446. #endif // DEBUG_ENABLED
  5447. return check_type_compatibility(p_target, p_source, p_allow_implicit_conversion, p_source_node);
  5448. }
  5449. // TODO: Add safe/unsafe return variable (for variant cases)
  5450. 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) {
  5451. // These return "true" so it doesn't affect users negatively.
  5452. ERR_FAIL_COND_V_MSG(!p_target.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset target type");
  5453. ERR_FAIL_COND_V_MSG(!p_source.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset value type");
  5454. if (p_target.kind == GDScriptParser::DataType::VARIANT) {
  5455. // Variant can receive anything.
  5456. return true;
  5457. }
  5458. if (p_source.kind == GDScriptParser::DataType::VARIANT) {
  5459. // TODO: This is acceptable but unsafe. Make sure unsafe line is set.
  5460. return true;
  5461. }
  5462. if (p_target.kind == GDScriptParser::DataType::BUILTIN) {
  5463. bool valid = p_source.kind == GDScriptParser::DataType::BUILTIN && p_target.builtin_type == p_source.builtin_type;
  5464. if (!valid && p_allow_implicit_conversion) {
  5465. valid = Variant::can_convert_strict(p_source.builtin_type, p_target.builtin_type);
  5466. }
  5467. if (!valid && p_target.builtin_type == Variant::INT && p_source.kind == GDScriptParser::DataType::ENUM && !p_source.is_meta_type) {
  5468. // Enum value is also integer.
  5469. valid = true;
  5470. }
  5471. if (valid && p_target.builtin_type == Variant::ARRAY && p_source.builtin_type == Variant::ARRAY) {
  5472. // Check the element type.
  5473. if (p_target.has_container_element_type(0) && p_source.has_container_element_type(0)) {
  5474. valid = p_target.get_container_element_type(0) == p_source.get_container_element_type(0);
  5475. }
  5476. }
  5477. if (valid && p_target.builtin_type == Variant::DICTIONARY && p_source.builtin_type == Variant::DICTIONARY) {
  5478. // Check the element types.
  5479. if (p_target.has_container_element_type(0) && p_source.has_container_element_type(0)) {
  5480. valid = p_target.get_container_element_type(0) == p_source.get_container_element_type(0);
  5481. }
  5482. if (valid && p_target.has_container_element_type(1) && p_source.has_container_element_type(1)) {
  5483. valid = p_target.get_container_element_type(1) == p_source.get_container_element_type(1);
  5484. }
  5485. }
  5486. return valid;
  5487. }
  5488. if (p_target.kind == GDScriptParser::DataType::ENUM) {
  5489. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::INT) {
  5490. return true;
  5491. }
  5492. if (p_source.kind == GDScriptParser::DataType::ENUM) {
  5493. if (p_source.native_type == p_target.native_type) {
  5494. return true;
  5495. }
  5496. }
  5497. return false;
  5498. }
  5499. // From here on the target type is an object, so we have to test polymorphism.
  5500. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::NIL) {
  5501. // null is acceptable in object.
  5502. return true;
  5503. }
  5504. StringName src_native;
  5505. Ref<Script> src_script;
  5506. const GDScriptParser::ClassNode *src_class = nullptr;
  5507. switch (p_source.kind) {
  5508. case GDScriptParser::DataType::NATIVE:
  5509. if (p_target.kind != GDScriptParser::DataType::NATIVE) {
  5510. // Non-native class cannot be supertype of native.
  5511. return false;
  5512. }
  5513. if (p_source.is_meta_type) {
  5514. src_native = GDScriptNativeClass::get_class_static();
  5515. } else {
  5516. src_native = p_source.native_type;
  5517. }
  5518. break;
  5519. case GDScriptParser::DataType::SCRIPT:
  5520. if (p_target.kind == GDScriptParser::DataType::CLASS) {
  5521. // A script type cannot be a subtype of a GDScript class.
  5522. return false;
  5523. }
  5524. if (p_source.script_type.is_null()) {
  5525. return false;
  5526. }
  5527. if (p_source.is_meta_type) {
  5528. src_native = p_source.script_type->get_class_name();
  5529. } else {
  5530. src_script = p_source.script_type;
  5531. src_native = src_script->get_instance_base_type();
  5532. }
  5533. break;
  5534. case GDScriptParser::DataType::CLASS:
  5535. if (p_source.is_meta_type) {
  5536. src_native = GDScript::get_class_static();
  5537. } else {
  5538. src_class = p_source.class_type;
  5539. const GDScriptParser::ClassNode *base = src_class;
  5540. while (base->base_type.kind == GDScriptParser::DataType::CLASS) {
  5541. base = base->base_type.class_type;
  5542. }
  5543. src_native = base->base_type.native_type;
  5544. src_script = base->base_type.script_type;
  5545. }
  5546. break;
  5547. case GDScriptParser::DataType::VARIANT:
  5548. case GDScriptParser::DataType::BUILTIN:
  5549. case GDScriptParser::DataType::ENUM:
  5550. case GDScriptParser::DataType::RESOLVING:
  5551. case GDScriptParser::DataType::UNRESOLVED:
  5552. break; // Already solved before.
  5553. }
  5554. switch (p_target.kind) {
  5555. case GDScriptParser::DataType::NATIVE: {
  5556. if (p_target.is_meta_type) {
  5557. return ClassDB::is_parent_class(src_native, GDScriptNativeClass::get_class_static());
  5558. }
  5559. return ClassDB::is_parent_class(src_native, p_target.native_type);
  5560. }
  5561. case GDScriptParser::DataType::SCRIPT:
  5562. if (p_target.is_meta_type) {
  5563. return ClassDB::is_parent_class(src_native, p_target.script_type->get_class_name());
  5564. }
  5565. while (src_script.is_valid()) {
  5566. if (src_script == p_target.script_type) {
  5567. return true;
  5568. }
  5569. src_script = src_script->get_base_script();
  5570. }
  5571. return false;
  5572. case GDScriptParser::DataType::CLASS:
  5573. if (p_target.is_meta_type) {
  5574. return ClassDB::is_parent_class(src_native, GDScript::get_class_static());
  5575. }
  5576. while (src_class != nullptr) {
  5577. if (src_class == p_target.class_type || src_class->fqcn == p_target.class_type->fqcn) {
  5578. return true;
  5579. }
  5580. src_class = src_class->base_type.class_type;
  5581. }
  5582. return false;
  5583. case GDScriptParser::DataType::VARIANT:
  5584. case GDScriptParser::DataType::BUILTIN:
  5585. case GDScriptParser::DataType::ENUM:
  5586. case GDScriptParser::DataType::RESOLVING:
  5587. case GDScriptParser::DataType::UNRESOLVED:
  5588. break; // Already solved before.
  5589. }
  5590. return false;
  5591. }
  5592. void GDScriptAnalyzer::push_error(const String &p_message, const GDScriptParser::Node *p_origin) {
  5593. mark_node_unsafe(p_origin);
  5594. parser->push_error(p_message, p_origin);
  5595. }
  5596. void GDScriptAnalyzer::mark_node_unsafe(const GDScriptParser::Node *p_node) {
  5597. #ifdef DEBUG_ENABLED
  5598. if (p_node == nullptr) {
  5599. return;
  5600. }
  5601. for (int i = p_node->start_line; i <= p_node->end_line; i++) {
  5602. parser->unsafe_lines.insert(i);
  5603. }
  5604. #endif // DEBUG_ENABLED
  5605. }
  5606. void GDScriptAnalyzer::downgrade_node_type_source(GDScriptParser::Node *p_node) {
  5607. GDScriptParser::IdentifierNode *identifier = nullptr;
  5608. if (p_node->type == GDScriptParser::Node::IDENTIFIER) {
  5609. identifier = static_cast<GDScriptParser::IdentifierNode *>(p_node);
  5610. } else if (p_node->type == GDScriptParser::Node::SUBSCRIPT) {
  5611. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_node);
  5612. if (subscript->is_attribute) {
  5613. identifier = subscript->attribute;
  5614. }
  5615. }
  5616. if (identifier == nullptr) {
  5617. return;
  5618. }
  5619. GDScriptParser::Node *source = nullptr;
  5620. switch (identifier->source) {
  5621. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE: {
  5622. source = identifier->variable_source;
  5623. } break;
  5624. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER: {
  5625. source = identifier->parameter_source;
  5626. } break;
  5627. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE: {
  5628. source = identifier->variable_source;
  5629. } break;
  5630. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR: {
  5631. source = identifier->bind_source;
  5632. } break;
  5633. default:
  5634. break;
  5635. }
  5636. if (source == nullptr) {
  5637. return;
  5638. }
  5639. GDScriptParser::DataType datatype;
  5640. datatype.kind = GDScriptParser::DataType::VARIANT;
  5641. source->set_datatype(datatype);
  5642. }
  5643. void GDScriptAnalyzer::mark_lambda_use_self() {
  5644. GDScriptParser::LambdaNode *lambda = current_lambda;
  5645. while (lambda != nullptr) {
  5646. lambda->use_self = true;
  5647. lambda = lambda->parent_lambda;
  5648. }
  5649. }
  5650. void GDScriptAnalyzer::resolve_pending_lambda_bodies() {
  5651. if (pending_body_resolution_lambdas.is_empty()) {
  5652. return;
  5653. }
  5654. GDScriptParser::LambdaNode *previous_lambda = current_lambda;
  5655. bool previous_static_context = static_context;
  5656. List<GDScriptParser::LambdaNode *> lambdas = pending_body_resolution_lambdas;
  5657. pending_body_resolution_lambdas.clear();
  5658. for (GDScriptParser::LambdaNode *lambda : lambdas) {
  5659. current_lambda = lambda;
  5660. static_context = lambda->function->is_static;
  5661. resolve_function_body(lambda->function, true);
  5662. int captures_amount = lambda->captures.size();
  5663. if (captures_amount > 0) {
  5664. // Create space for lambda parameters.
  5665. // At the beginning to not mess with optional parameters.
  5666. int param_count = lambda->function->parameters.size();
  5667. lambda->function->parameters.resize(param_count + captures_amount);
  5668. for (int i = param_count - 1; i >= 0; i--) {
  5669. lambda->function->parameters.write[i + captures_amount] = lambda->function->parameters[i];
  5670. lambda->function->parameters_indices[lambda->function->parameters[i]->identifier->name] = i + captures_amount;
  5671. }
  5672. // Add captures as extra parameters at the beginning.
  5673. for (int i = 0; i < lambda->captures.size(); i++) {
  5674. GDScriptParser::IdentifierNode *capture = lambda->captures[i];
  5675. GDScriptParser::ParameterNode *capture_param = parser->alloc_node<GDScriptParser::ParameterNode>();
  5676. capture_param->identifier = capture;
  5677. capture_param->usages = capture->usages;
  5678. capture_param->set_datatype(capture->get_datatype());
  5679. lambda->function->parameters.write[i] = capture_param;
  5680. lambda->function->parameters_indices[capture->name] = i;
  5681. }
  5682. }
  5683. }
  5684. current_lambda = previous_lambda;
  5685. static_context = previous_static_context;
  5686. }
  5687. bool GDScriptAnalyzer::class_exists(const StringName &p_class) const {
  5688. return ClassDB::class_exists(p_class) && ClassDB::is_class_exposed(p_class);
  5689. }
  5690. Error GDScriptAnalyzer::resolve_inheritance() {
  5691. return resolve_class_inheritance(parser->head, true);
  5692. }
  5693. Error GDScriptAnalyzer::resolve_interface() {
  5694. resolve_class_interface(parser->head, true);
  5695. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  5696. }
  5697. Error GDScriptAnalyzer::resolve_body() {
  5698. resolve_class_body(parser->head, true);
  5699. #ifdef DEBUG_ENABLED
  5700. // Apply here, after all `@warning_ignore`s have been resolved and applied.
  5701. parser->apply_pending_warnings();
  5702. #endif // DEBUG_ENABLED
  5703. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  5704. }
  5705. Error GDScriptAnalyzer::resolve_dependencies() {
  5706. for (KeyValue<String, Ref<GDScriptParserRef>> &K : parser->depended_parsers) {
  5707. if (K.value.is_null()) {
  5708. return ERR_PARSE_ERROR;
  5709. }
  5710. K.value->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  5711. }
  5712. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  5713. }
  5714. Error GDScriptAnalyzer::analyze() {
  5715. parser->errors.clear();
  5716. Error err = resolve_inheritance();
  5717. if (err) {
  5718. return err;
  5719. }
  5720. resolve_interface();
  5721. err = resolve_body();
  5722. if (err) {
  5723. return err;
  5724. }
  5725. return resolve_dependencies();
  5726. }
  5727. GDScriptAnalyzer::GDScriptAnalyzer(GDScriptParser *p_parser) {
  5728. parser = p_parser;
  5729. }