gdscript_analyzer.cpp 212 KB

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