gdscript_analyzer.cpp 223 KB

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