gdscript_analyzer.cpp 201 KB

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