gdscript_analyzer.cpp 219 KB

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