gdscript_analyzer.cpp 216 KB

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