gdscript_analyzer.cpp 196 KB

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