gdscript_analyzer.cpp 196 KB

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