gdscript_analyzer.cpp 217 KB

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