gdscript_parser.cpp 175 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157
  1. /**************************************************************************/
  2. /* gdscript_parser.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_parser.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/io/file_access.h"
  33. #include "core/io/resource_loader.h"
  34. #include "core/math/math_defs.h"
  35. #include "gdscript.h"
  36. #include "scene/main/multiplayer_api.h"
  37. #ifdef DEBUG_ENABLED
  38. #include "core/os/os.h"
  39. #include "core/string/string_builder.h"
  40. #include "gdscript_warning.h"
  41. #include "servers/text_server.h"
  42. #endif // DEBUG_ENABLED
  43. #ifdef TOOLS_ENABLED
  44. #include "editor/editor_settings.h"
  45. #endif // TOOLS_ENABLED
  46. static HashMap<StringName, Variant::Type> builtin_types;
  47. Variant::Type GDScriptParser::get_builtin_type(const StringName &p_type) {
  48. if (builtin_types.is_empty()) {
  49. for (int i = 1; i < Variant::VARIANT_MAX; i++) {
  50. builtin_types[Variant::get_type_name((Variant::Type)i)] = (Variant::Type)i;
  51. }
  52. }
  53. if (builtin_types.has(p_type)) {
  54. return builtin_types[p_type];
  55. }
  56. return Variant::VARIANT_MAX;
  57. }
  58. void GDScriptParser::cleanup() {
  59. builtin_types.clear();
  60. }
  61. void GDScriptParser::get_annotation_list(List<MethodInfo> *r_annotations) const {
  62. for (const KeyValue<StringName, AnnotationInfo> &E : valid_annotations) {
  63. r_annotations->push_back(E.value.info);
  64. }
  65. }
  66. bool GDScriptParser::annotation_exists(const String &p_annotation_name) const {
  67. return valid_annotations.has(p_annotation_name);
  68. }
  69. GDScriptParser::GDScriptParser() {
  70. // Register valid annotations.
  71. // TODO: Should this be static?
  72. register_annotation(MethodInfo("@tool"), AnnotationInfo::SCRIPT, &GDScriptParser::tool_annotation);
  73. register_annotation(MethodInfo("@icon", PropertyInfo(Variant::STRING, "icon_path")), AnnotationInfo::SCRIPT, &GDScriptParser::icon_annotation);
  74. register_annotation(MethodInfo("@static_unload"), AnnotationInfo::SCRIPT, &GDScriptParser::static_unload_annotation);
  75. register_annotation(MethodInfo("@onready"), AnnotationInfo::VARIABLE, &GDScriptParser::onready_annotation);
  76. // Export annotations.
  77. register_annotation(MethodInfo("@export"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_NONE, Variant::NIL>);
  78. register_annotation(MethodInfo("@export_enum", PropertyInfo(Variant::STRING, "names")), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_ENUM, Variant::NIL>, varray(), true);
  79. register_annotation(MethodInfo("@export_file", PropertyInfo(Variant::STRING, "filter")), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_FILE, Variant::STRING>, varray(""), true);
  80. register_annotation(MethodInfo("@export_dir"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_DIR, Variant::STRING>);
  81. register_annotation(MethodInfo("@export_global_file", PropertyInfo(Variant::STRING, "filter")), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_GLOBAL_FILE, Variant::STRING>, varray(""), true);
  82. register_annotation(MethodInfo("@export_global_dir"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_GLOBAL_DIR, Variant::STRING>);
  83. register_annotation(MethodInfo("@export_multiline"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_MULTILINE_TEXT, Variant::STRING>);
  84. register_annotation(MethodInfo("@export_placeholder", PropertyInfo(Variant::STRING, "placeholder")), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_PLACEHOLDER_TEXT, Variant::STRING>);
  85. register_annotation(MethodInfo("@export_range", PropertyInfo(Variant::FLOAT, "min"), PropertyInfo(Variant::FLOAT, "max"), PropertyInfo(Variant::FLOAT, "step"), PropertyInfo(Variant::STRING, "extra_hints")), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_RANGE, Variant::FLOAT>, varray(1.0, ""), true);
  86. register_annotation(MethodInfo("@export_exp_easing", PropertyInfo(Variant::STRING, "hints")), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_EXP_EASING, Variant::FLOAT>, varray(""), true);
  87. register_annotation(MethodInfo("@export_color_no_alpha"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_COLOR_NO_ALPHA, Variant::COLOR>);
  88. register_annotation(MethodInfo("@export_node_path", PropertyInfo(Variant::STRING, "type")), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_NODE_PATH_VALID_TYPES, Variant::NODE_PATH>, varray(""), true);
  89. register_annotation(MethodInfo("@export_flags", PropertyInfo(Variant::STRING, "names")), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_FLAGS, Variant::INT>, varray(), true);
  90. register_annotation(MethodInfo("@export_flags_2d_render"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_2D_RENDER, Variant::INT>);
  91. register_annotation(MethodInfo("@export_flags_2d_physics"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_2D_PHYSICS, Variant::INT>);
  92. register_annotation(MethodInfo("@export_flags_2d_navigation"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_2D_NAVIGATION, Variant::INT>);
  93. register_annotation(MethodInfo("@export_flags_3d_render"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_3D_RENDER, Variant::INT>);
  94. register_annotation(MethodInfo("@export_flags_3d_physics"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_3D_PHYSICS, Variant::INT>);
  95. register_annotation(MethodInfo("@export_flags_3d_navigation"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_3D_NAVIGATION, Variant::INT>);
  96. // Export grouping annotations.
  97. register_annotation(MethodInfo("@export_category", PropertyInfo(Variant::STRING, "name")), AnnotationInfo::STANDALONE, &GDScriptParser::export_group_annotations<PROPERTY_USAGE_CATEGORY>);
  98. register_annotation(MethodInfo("@export_group", PropertyInfo(Variant::STRING, "name"), PropertyInfo(Variant::STRING, "prefix")), AnnotationInfo::STANDALONE, &GDScriptParser::export_group_annotations<PROPERTY_USAGE_GROUP>, varray(""));
  99. register_annotation(MethodInfo("@export_subgroup", PropertyInfo(Variant::STRING, "name"), PropertyInfo(Variant::STRING, "prefix")), AnnotationInfo::STANDALONE, &GDScriptParser::export_group_annotations<PROPERTY_USAGE_SUBGROUP>, varray(""));
  100. // Warning annotations.
  101. register_annotation(MethodInfo("@warning_ignore", PropertyInfo(Variant::STRING, "warning")), AnnotationInfo::CLASS | AnnotationInfo::VARIABLE | AnnotationInfo::SIGNAL | AnnotationInfo::CONSTANT | AnnotationInfo::FUNCTION | AnnotationInfo::STATEMENT, &GDScriptParser::warning_annotations, varray(), true);
  102. // Networking.
  103. register_annotation(MethodInfo("@rpc", PropertyInfo(Variant::STRING, "mode"), PropertyInfo(Variant::STRING, "sync"), PropertyInfo(Variant::STRING, "transfer_mode"), PropertyInfo(Variant::INT, "transfer_channel")), AnnotationInfo::FUNCTION, &GDScriptParser::rpc_annotation, varray("authority", "call_remote", "unreliable", 0), true);
  104. #ifdef DEBUG_ENABLED
  105. is_ignoring_warnings = !(bool)GLOBAL_GET("debug/gdscript/warnings/enable");
  106. #endif
  107. }
  108. GDScriptParser::~GDScriptParser() {
  109. clear();
  110. }
  111. void GDScriptParser::clear() {
  112. while (list != nullptr) {
  113. Node *element = list;
  114. list = list->next;
  115. memdelete(element);
  116. }
  117. head = nullptr;
  118. list = nullptr;
  119. _is_tool = false;
  120. for_completion = false;
  121. errors.clear();
  122. multiline_stack.clear();
  123. nodes_in_progress.clear();
  124. }
  125. void GDScriptParser::push_error(const String &p_message, const Node *p_origin) {
  126. // TODO: Improve error reporting by pointing at source code.
  127. // TODO: Errors might point at more than one place at once (e.g. show previous declaration).
  128. panic_mode = true;
  129. // TODO: Improve positional information.
  130. if (p_origin == nullptr) {
  131. errors.push_back({ p_message, current.start_line, current.start_column });
  132. } else {
  133. errors.push_back({ p_message, p_origin->start_line, p_origin->leftmost_column });
  134. }
  135. }
  136. #ifdef DEBUG_ENABLED
  137. void GDScriptParser::push_warning(const Node *p_source, GDScriptWarning::Code p_code, const Vector<String> &p_symbols) {
  138. ERR_FAIL_COND(p_source == nullptr);
  139. if (is_ignoring_warnings) {
  140. return;
  141. }
  142. if (GLOBAL_GET("debug/gdscript/warnings/exclude_addons").booleanize() && script_path.begins_with("res://addons/")) {
  143. return;
  144. }
  145. if (ignored_warnings.has(p_code)) {
  146. return;
  147. }
  148. int warn_level = (int)GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(p_code));
  149. if (!warn_level) {
  150. return;
  151. }
  152. GDScriptWarning warning;
  153. warning.code = p_code;
  154. warning.symbols = p_symbols;
  155. warning.start_line = p_source->start_line;
  156. warning.end_line = p_source->end_line;
  157. warning.leftmost_column = p_source->leftmost_column;
  158. warning.rightmost_column = p_source->rightmost_column;
  159. if (warn_level == GDScriptWarning::WarnLevel::ERROR) {
  160. push_error(warning.get_message() + String(" (Warning treated as error.)"), p_source);
  161. return;
  162. }
  163. List<GDScriptWarning>::Element *before = nullptr;
  164. for (List<GDScriptWarning>::Element *E = warnings.front(); E; E = E->next()) {
  165. if (E->get().start_line > warning.start_line) {
  166. break;
  167. }
  168. before = E;
  169. }
  170. if (before) {
  171. warnings.insert_after(before, warning);
  172. } else {
  173. warnings.push_front(warning);
  174. }
  175. }
  176. #endif
  177. void GDScriptParser::make_completion_context(CompletionType p_type, Node *p_node, int p_argument, bool p_force) {
  178. if (!for_completion || (!p_force && completion_context.type != COMPLETION_NONE)) {
  179. return;
  180. }
  181. if (previous.cursor_place != GDScriptTokenizer::CURSOR_MIDDLE && previous.cursor_place != GDScriptTokenizer::CURSOR_END && current.cursor_place == GDScriptTokenizer::CURSOR_NONE) {
  182. return;
  183. }
  184. CompletionContext context;
  185. context.type = p_type;
  186. context.current_class = current_class;
  187. context.current_function = current_function;
  188. context.current_suite = current_suite;
  189. context.current_line = tokenizer.get_cursor_line();
  190. context.current_argument = p_argument;
  191. context.node = p_node;
  192. completion_context = context;
  193. }
  194. void GDScriptParser::make_completion_context(CompletionType p_type, Variant::Type p_builtin_type, bool p_force) {
  195. if (!for_completion || (!p_force && completion_context.type != COMPLETION_NONE)) {
  196. return;
  197. }
  198. if (previous.cursor_place != GDScriptTokenizer::CURSOR_MIDDLE && previous.cursor_place != GDScriptTokenizer::CURSOR_END && current.cursor_place == GDScriptTokenizer::CURSOR_NONE) {
  199. return;
  200. }
  201. CompletionContext context;
  202. context.type = p_type;
  203. context.current_class = current_class;
  204. context.current_function = current_function;
  205. context.current_suite = current_suite;
  206. context.current_line = tokenizer.get_cursor_line();
  207. context.builtin_type = p_builtin_type;
  208. completion_context = context;
  209. }
  210. void GDScriptParser::push_completion_call(Node *p_call) {
  211. if (!for_completion) {
  212. return;
  213. }
  214. CompletionCall call;
  215. call.call = p_call;
  216. call.argument = 0;
  217. completion_call_stack.push_back(call);
  218. if (previous.cursor_place == GDScriptTokenizer::CURSOR_MIDDLE || previous.cursor_place == GDScriptTokenizer::CURSOR_END || current.cursor_place == GDScriptTokenizer::CURSOR_BEGINNING) {
  219. completion_call = call;
  220. }
  221. }
  222. void GDScriptParser::pop_completion_call() {
  223. if (!for_completion) {
  224. return;
  225. }
  226. ERR_FAIL_COND_MSG(completion_call_stack.is_empty(), "Trying to pop empty completion call stack");
  227. completion_call_stack.pop_back();
  228. }
  229. void GDScriptParser::set_last_completion_call_arg(int p_argument) {
  230. if (!for_completion || passed_cursor) {
  231. return;
  232. }
  233. ERR_FAIL_COND_MSG(completion_call_stack.is_empty(), "Trying to set argument on empty completion call stack");
  234. completion_call_stack.back()->get().argument = p_argument;
  235. }
  236. Error GDScriptParser::parse(const String &p_source_code, const String &p_script_path, bool p_for_completion) {
  237. clear();
  238. String source = p_source_code;
  239. int cursor_line = -1;
  240. int cursor_column = -1;
  241. for_completion = p_for_completion;
  242. int tab_size = 4;
  243. #ifdef TOOLS_ENABLED
  244. if (EditorSettings::get_singleton()) {
  245. tab_size = EditorSettings::get_singleton()->get_setting("text_editor/behavior/indent/size");
  246. }
  247. #endif // TOOLS_ENABLED
  248. if (p_for_completion) {
  249. // Remove cursor sentinel char.
  250. const Vector<String> lines = p_source_code.split("\n");
  251. cursor_line = 1;
  252. cursor_column = 1;
  253. for (int i = 0; i < lines.size(); i++) {
  254. bool found = false;
  255. const String &line = lines[i];
  256. for (int j = 0; j < line.size(); j++) {
  257. if (line[j] == char32_t(0xFFFF)) {
  258. found = true;
  259. break;
  260. } else if (line[j] == '\t') {
  261. cursor_column += tab_size - 1;
  262. }
  263. cursor_column++;
  264. }
  265. if (found) {
  266. break;
  267. }
  268. cursor_line++;
  269. cursor_column = 1;
  270. }
  271. source = source.replace_first(String::chr(0xFFFF), String());
  272. }
  273. tokenizer.set_source_code(source);
  274. tokenizer.set_cursor_position(cursor_line, cursor_column);
  275. script_path = p_script_path;
  276. current = tokenizer.scan();
  277. // Avoid error or newline as the first token.
  278. // The latter can mess with the parser when opening files filled exclusively with comments and newlines.
  279. while (current.type == GDScriptTokenizer::Token::ERROR || current.type == GDScriptTokenizer::Token::NEWLINE) {
  280. if (current.type == GDScriptTokenizer::Token::ERROR) {
  281. push_error(current.literal);
  282. }
  283. current = tokenizer.scan();
  284. }
  285. #ifdef DEBUG_ENABLED
  286. // Warn about parsing an empty script file:
  287. if (current.type == GDScriptTokenizer::Token::TK_EOF) {
  288. // Create a dummy Node for the warning, pointing to the very beginning of the file
  289. Node *nd = alloc_node<PassNode>();
  290. nd->start_line = 1;
  291. nd->start_column = 0;
  292. nd->end_line = 1;
  293. nd->leftmost_column = 0;
  294. nd->rightmost_column = 0;
  295. push_warning(nd, GDScriptWarning::EMPTY_FILE);
  296. }
  297. #endif
  298. push_multiline(false); // Keep one for the whole parsing.
  299. parse_program();
  300. pop_multiline();
  301. #ifdef DEBUG_ENABLED
  302. if (multiline_stack.size() > 0) {
  303. ERR_PRINT("Parser bug: Imbalanced multiline stack.");
  304. }
  305. #endif
  306. if (errors.is_empty()) {
  307. return OK;
  308. } else {
  309. return ERR_PARSE_ERROR;
  310. }
  311. }
  312. GDScriptTokenizer::Token GDScriptParser::advance() {
  313. lambda_ended = false; // Empty marker since we're past the end in any case.
  314. if (current.type == GDScriptTokenizer::Token::TK_EOF) {
  315. ERR_FAIL_COND_V_MSG(current.type == GDScriptTokenizer::Token::TK_EOF, current, "GDScript parser bug: Trying to advance past the end of stream.");
  316. }
  317. if (for_completion && !completion_call_stack.is_empty()) {
  318. if (completion_call.call == nullptr && tokenizer.is_past_cursor()) {
  319. completion_call = completion_call_stack.back()->get();
  320. passed_cursor = true;
  321. }
  322. }
  323. previous = current;
  324. current = tokenizer.scan();
  325. while (current.type == GDScriptTokenizer::Token::ERROR) {
  326. push_error(current.literal);
  327. current = tokenizer.scan();
  328. }
  329. for (Node *n : nodes_in_progress) {
  330. update_extents(n);
  331. }
  332. return previous;
  333. }
  334. bool GDScriptParser::match(GDScriptTokenizer::Token::Type p_token_type) {
  335. if (!check(p_token_type)) {
  336. return false;
  337. }
  338. advance();
  339. return true;
  340. }
  341. bool GDScriptParser::check(GDScriptTokenizer::Token::Type p_token_type) const {
  342. if (p_token_type == GDScriptTokenizer::Token::IDENTIFIER) {
  343. return current.is_identifier();
  344. }
  345. return current.type == p_token_type;
  346. }
  347. bool GDScriptParser::consume(GDScriptTokenizer::Token::Type p_token_type, const String &p_error_message) {
  348. if (match(p_token_type)) {
  349. return true;
  350. }
  351. push_error(p_error_message);
  352. return false;
  353. }
  354. bool GDScriptParser::is_at_end() const {
  355. return check(GDScriptTokenizer::Token::TK_EOF);
  356. }
  357. void GDScriptParser::synchronize() {
  358. panic_mode = false;
  359. while (!is_at_end()) {
  360. if (previous.type == GDScriptTokenizer::Token::NEWLINE || previous.type == GDScriptTokenizer::Token::SEMICOLON) {
  361. return;
  362. }
  363. switch (current.type) {
  364. case GDScriptTokenizer::Token::CLASS:
  365. case GDScriptTokenizer::Token::FUNC:
  366. case GDScriptTokenizer::Token::STATIC:
  367. case GDScriptTokenizer::Token::VAR:
  368. case GDScriptTokenizer::Token::CONST:
  369. case GDScriptTokenizer::Token::SIGNAL:
  370. //case GDScriptTokenizer::Token::IF: // Can also be inside expressions.
  371. case GDScriptTokenizer::Token::FOR:
  372. case GDScriptTokenizer::Token::WHILE:
  373. case GDScriptTokenizer::Token::MATCH:
  374. case GDScriptTokenizer::Token::RETURN:
  375. case GDScriptTokenizer::Token::ANNOTATION:
  376. return;
  377. default:
  378. // Do nothing.
  379. break;
  380. }
  381. advance();
  382. }
  383. }
  384. void GDScriptParser::push_multiline(bool p_state) {
  385. multiline_stack.push_back(p_state);
  386. tokenizer.set_multiline_mode(p_state);
  387. if (p_state) {
  388. // Consume potential whitespace tokens already waiting in line.
  389. while (current.type == GDScriptTokenizer::Token::NEWLINE || current.type == GDScriptTokenizer::Token::INDENT || current.type == GDScriptTokenizer::Token::DEDENT) {
  390. current = tokenizer.scan(); // Don't call advance() here, as we don't want to change the previous token.
  391. }
  392. }
  393. }
  394. void GDScriptParser::pop_multiline() {
  395. ERR_FAIL_COND_MSG(multiline_stack.size() == 0, "Parser bug: trying to pop from multiline stack without available value.");
  396. multiline_stack.pop_back();
  397. tokenizer.set_multiline_mode(multiline_stack.size() > 0 ? multiline_stack.back()->get() : false);
  398. }
  399. bool GDScriptParser::is_statement_end_token() const {
  400. return check(GDScriptTokenizer::Token::NEWLINE) || check(GDScriptTokenizer::Token::SEMICOLON) || check(GDScriptTokenizer::Token::TK_EOF);
  401. }
  402. bool GDScriptParser::is_statement_end() const {
  403. return lambda_ended || in_lambda || is_statement_end_token();
  404. }
  405. void GDScriptParser::end_statement(const String &p_context) {
  406. bool found = false;
  407. while (is_statement_end() && !is_at_end()) {
  408. // Remove sequential newlines/semicolons.
  409. if (is_statement_end_token()) {
  410. // Only consume if this is an actual token.
  411. advance();
  412. } else if (lambda_ended) {
  413. lambda_ended = false; // Consume this "token".
  414. found = true;
  415. break;
  416. } else {
  417. if (!found) {
  418. lambda_ended = true; // Mark the lambda as done since we found something else to end the statement.
  419. found = true;
  420. }
  421. break;
  422. }
  423. found = true;
  424. }
  425. if (!found && !is_at_end()) {
  426. push_error(vformat(R"(Expected end of statement after %s, found "%s" instead.)", p_context, current.get_name()));
  427. }
  428. }
  429. void GDScriptParser::parse_program() {
  430. head = alloc_node<ClassNode>();
  431. head->fqcn = script_path;
  432. current_class = head;
  433. bool can_have_class_or_extends = true;
  434. while (!check(GDScriptTokenizer::Token::TK_EOF)) {
  435. if (match(GDScriptTokenizer::Token::ANNOTATION)) {
  436. AnnotationNode *annotation = parse_annotation(AnnotationInfo::SCRIPT | AnnotationInfo::STANDALONE | AnnotationInfo::CLASS_LEVEL);
  437. if (annotation != nullptr) {
  438. if (annotation->applies_to(AnnotationInfo::SCRIPT)) {
  439. // `@icon` needs to be applied in the parser. See GH-72444.
  440. if (annotation->name == SNAME("@icon")) {
  441. annotation->apply(this, head);
  442. } else {
  443. head->annotations.push_back(annotation);
  444. }
  445. } else {
  446. annotation_stack.push_back(annotation);
  447. // This annotation must appear after script-level annotations
  448. // and class_name/extends (ex: could be @onready or @export),
  449. // so we stop looking for script-level stuff.
  450. can_have_class_or_extends = false;
  451. break;
  452. }
  453. }
  454. } else if (check(GDScriptTokenizer::Token::LITERAL) && current.literal.get_type() == Variant::STRING) {
  455. // Allow strings in class body as multiline comments.
  456. advance();
  457. if (!match(GDScriptTokenizer::Token::NEWLINE)) {
  458. push_error("Expected newline after comment string.");
  459. }
  460. } else {
  461. break;
  462. }
  463. }
  464. while (can_have_class_or_extends) {
  465. // Order here doesn't matter, but there should be only one of each at most.
  466. switch (current.type) {
  467. case GDScriptTokenizer::Token::CLASS_NAME:
  468. advance();
  469. if (head->identifier != nullptr) {
  470. push_error(R"("class_name" can only be used once.)");
  471. } else {
  472. parse_class_name();
  473. }
  474. break;
  475. case GDScriptTokenizer::Token::EXTENDS:
  476. advance();
  477. if (head->extends_used) {
  478. push_error(R"("extends" can only be used once.)");
  479. } else {
  480. parse_extends();
  481. end_statement("superclass");
  482. }
  483. break;
  484. case GDScriptTokenizer::Token::LITERAL:
  485. if (current.literal.get_type() == Variant::STRING) {
  486. // Allow strings in class body as multiline comments.
  487. advance();
  488. if (!match(GDScriptTokenizer::Token::NEWLINE)) {
  489. push_error("Expected newline after comment string.");
  490. }
  491. break;
  492. }
  493. [[fallthrough]];
  494. default:
  495. // No tokens are allowed between script annotations and class/extends.
  496. can_have_class_or_extends = false;
  497. break;
  498. }
  499. if (panic_mode) {
  500. synchronize();
  501. }
  502. }
  503. parse_class_body(true);
  504. complete_extents(head);
  505. #ifdef TOOLS_ENABLED
  506. for (const KeyValue<int, GDScriptTokenizer::CommentData> &E : tokenizer.get_comments()) {
  507. if (E.value.new_line && E.value.comment.begins_with("##")) {
  508. class_doc_line = MIN(class_doc_line, E.key);
  509. }
  510. }
  511. if (has_comment(class_doc_line)) {
  512. get_class_doc_comment(class_doc_line, head->doc_brief_description, head->doc_description, head->doc_tutorials, false);
  513. }
  514. #endif // TOOLS_ENABLED
  515. if (!check(GDScriptTokenizer::Token::TK_EOF)) {
  516. push_error("Expected end of file.");
  517. }
  518. clear_unused_annotations();
  519. }
  520. GDScriptParser::ClassNode *GDScriptParser::find_class(const String &p_qualified_name) const {
  521. String first = p_qualified_name.get_slice("::", 0);
  522. Vector<String> class_names;
  523. GDScriptParser::ClassNode *result = nullptr;
  524. // Empty initial name means start at the head.
  525. if (first.is_empty() || (head->identifier && first == head->identifier->name)) {
  526. class_names = p_qualified_name.split("::");
  527. result = head;
  528. } else if (p_qualified_name.begins_with(script_path)) {
  529. // Script path could have a class path separator("::") in it.
  530. class_names = p_qualified_name.trim_prefix(script_path).split("::");
  531. result = head;
  532. } else if (head->has_member(first)) {
  533. class_names = p_qualified_name.split("::");
  534. GDScriptParser::ClassNode::Member member = head->get_member(first);
  535. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  536. result = member.m_class;
  537. }
  538. }
  539. // Starts at index 1 because index 0 was handled above.
  540. for (int i = 1; result != nullptr && i < class_names.size(); i++) {
  541. String current_name = class_names[i];
  542. GDScriptParser::ClassNode *next = nullptr;
  543. if (result->has_member(current_name)) {
  544. GDScriptParser::ClassNode::Member member = result->get_member(current_name);
  545. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  546. next = member.m_class;
  547. }
  548. }
  549. result = next;
  550. }
  551. return result;
  552. }
  553. bool GDScriptParser::has_class(const GDScriptParser::ClassNode *p_class) const {
  554. if (head->fqcn.is_empty() && p_class->fqcn.get_slice("::", 0).is_empty()) {
  555. return p_class == head;
  556. } else if (p_class->fqcn.begins_with(head->fqcn)) {
  557. return find_class(p_class->fqcn.trim_prefix(head->fqcn)) == p_class;
  558. }
  559. return false;
  560. }
  561. GDScriptParser::ClassNode *GDScriptParser::parse_class(bool p_is_static) {
  562. ClassNode *n_class = alloc_node<ClassNode>();
  563. ClassNode *previous_class = current_class;
  564. current_class = n_class;
  565. n_class->outer = previous_class;
  566. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected identifier for the class name after "class".)")) {
  567. n_class->identifier = parse_identifier();
  568. if (n_class->outer) {
  569. String fqcn = n_class->outer->fqcn;
  570. if (fqcn.is_empty()) {
  571. fqcn = script_path;
  572. }
  573. n_class->fqcn = fqcn + "::" + n_class->identifier->name;
  574. } else {
  575. n_class->fqcn = n_class->identifier->name;
  576. }
  577. }
  578. if (match(GDScriptTokenizer::Token::EXTENDS)) {
  579. parse_extends();
  580. }
  581. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after class declaration.)");
  582. bool multiline = match(GDScriptTokenizer::Token::NEWLINE);
  583. if (multiline && !consume(GDScriptTokenizer::Token::INDENT, R"(Expected indented block after class declaration.)")) {
  584. current_class = previous_class;
  585. complete_extents(n_class);
  586. return n_class;
  587. }
  588. if (match(GDScriptTokenizer::Token::EXTENDS)) {
  589. if (n_class->extends_used) {
  590. push_error(R"(Cannot use "extends" more than once in the same class.)");
  591. }
  592. parse_extends();
  593. end_statement("superclass");
  594. }
  595. parse_class_body(multiline);
  596. complete_extents(n_class);
  597. if (multiline) {
  598. consume(GDScriptTokenizer::Token::DEDENT, R"(Missing unindent at the end of the class body.)");
  599. }
  600. current_class = previous_class;
  601. return n_class;
  602. }
  603. void GDScriptParser::parse_class_name() {
  604. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected identifier for the global class name after "class_name".)")) {
  605. current_class->identifier = parse_identifier();
  606. current_class->fqcn = String(current_class->identifier->name);
  607. }
  608. if (match(GDScriptTokenizer::Token::EXTENDS)) {
  609. // Allow extends on the same line.
  610. parse_extends();
  611. end_statement("superclass");
  612. } else {
  613. end_statement("class_name statement");
  614. }
  615. }
  616. void GDScriptParser::parse_extends() {
  617. current_class->extends_used = true;
  618. int chain_index = 0;
  619. if (match(GDScriptTokenizer::Token::LITERAL)) {
  620. if (previous.literal.get_type() != Variant::STRING) {
  621. push_error(vformat(R"(Only strings or identifiers can be used after "extends", found "%s" instead.)", Variant::get_type_name(previous.literal.get_type())));
  622. }
  623. current_class->extends_path = previous.literal;
  624. if (!match(GDScriptTokenizer::Token::PERIOD)) {
  625. return;
  626. }
  627. }
  628. make_completion_context(COMPLETION_INHERIT_TYPE, current_class, chain_index++);
  629. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected superclass name after "extends".)")) {
  630. return;
  631. }
  632. current_class->extends.push_back(parse_identifier());
  633. while (match(GDScriptTokenizer::Token::PERIOD)) {
  634. make_completion_context(COMPLETION_INHERIT_TYPE, current_class, chain_index++);
  635. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected superclass name after ".".)")) {
  636. return;
  637. }
  638. current_class->extends.push_back(parse_identifier());
  639. }
  640. }
  641. template <class T>
  642. void GDScriptParser::parse_class_member(T *(GDScriptParser::*p_parse_function)(bool), AnnotationInfo::TargetKind p_target, const String &p_member_kind, bool p_is_static) {
  643. advance();
  644. #ifdef TOOLS_ENABLED
  645. int doc_comment_line = previous.start_line - 1;
  646. #endif // TOOLS_ENABLED
  647. // Consume annotations.
  648. List<AnnotationNode *> annotations;
  649. while (!annotation_stack.is_empty()) {
  650. AnnotationNode *last_annotation = annotation_stack.back()->get();
  651. if (last_annotation->applies_to(p_target)) {
  652. annotations.push_front(last_annotation);
  653. annotation_stack.pop_back();
  654. } else {
  655. push_error(vformat(R"(Annotation "%s" cannot be applied to a %s.)", last_annotation->name, p_member_kind));
  656. clear_unused_annotations();
  657. }
  658. #ifdef TOOLS_ENABLED
  659. if (last_annotation->start_line == doc_comment_line) {
  660. doc_comment_line--;
  661. }
  662. #endif // TOOLS_ENABLED
  663. }
  664. T *member = (this->*p_parse_function)(p_is_static);
  665. if (member == nullptr) {
  666. return;
  667. }
  668. for (AnnotationNode *&annotation : annotations) {
  669. member->annotations.push_back(annotation);
  670. }
  671. #ifdef TOOLS_ENABLED
  672. // Consume doc comments.
  673. class_doc_line = MIN(class_doc_line, doc_comment_line - 1);
  674. // Check whether current line has a doc comment
  675. if (has_comment(previous.start_line, true)) {
  676. member->doc_description = get_doc_comment(previous.start_line, true);
  677. } else if (has_comment(doc_comment_line, true)) {
  678. if constexpr (std::is_same_v<T, ClassNode>) {
  679. get_class_doc_comment(doc_comment_line, member->doc_brief_description, member->doc_description, member->doc_tutorials, true);
  680. } else {
  681. member->doc_description = get_doc_comment(doc_comment_line);
  682. }
  683. }
  684. #endif // TOOLS_ENABLED
  685. if (member->identifier != nullptr) {
  686. if (!((String)member->identifier->name).is_empty()) { // Enums may be unnamed.
  687. #ifdef DEBUG_ENABLED
  688. List<MethodInfo> gdscript_funcs;
  689. GDScriptLanguage::get_singleton()->get_public_functions(&gdscript_funcs);
  690. for (MethodInfo &info : gdscript_funcs) {
  691. if (info.name == member->identifier->name) {
  692. push_warning(member->identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_member_kind, member->identifier->name, "built-in function");
  693. }
  694. }
  695. if (Variant::has_utility_function(member->identifier->name)) {
  696. push_warning(member->identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_member_kind, member->identifier->name, "built-in function");
  697. }
  698. #endif
  699. if (current_class->members_indices.has(member->identifier->name)) {
  700. push_error(vformat(R"(%s "%s" has the same name as a previously declared %s.)", p_member_kind.capitalize(), member->identifier->name, current_class->get_member(member->identifier->name).get_type_name()), member->identifier);
  701. } else {
  702. current_class->add_member(member);
  703. }
  704. } else {
  705. current_class->add_member(member);
  706. }
  707. }
  708. }
  709. void GDScriptParser::parse_class_body(bool p_is_multiline) {
  710. bool class_end = false;
  711. bool next_is_static = false;
  712. while (!class_end && !is_at_end()) {
  713. GDScriptTokenizer::Token token = current;
  714. switch (token.type) {
  715. case GDScriptTokenizer::Token::VAR:
  716. parse_class_member(&GDScriptParser::parse_variable, AnnotationInfo::VARIABLE, "variable", next_is_static);
  717. if (next_is_static) {
  718. current_class->has_static_data = true;
  719. }
  720. break;
  721. case GDScriptTokenizer::Token::CONST:
  722. parse_class_member(&GDScriptParser::parse_constant, AnnotationInfo::CONSTANT, "constant");
  723. break;
  724. case GDScriptTokenizer::Token::SIGNAL:
  725. parse_class_member(&GDScriptParser::parse_signal, AnnotationInfo::SIGNAL, "signal");
  726. break;
  727. case GDScriptTokenizer::Token::FUNC:
  728. parse_class_member(&GDScriptParser::parse_function, AnnotationInfo::FUNCTION, "function", next_is_static);
  729. break;
  730. case GDScriptTokenizer::Token::CLASS:
  731. parse_class_member(&GDScriptParser::parse_class, AnnotationInfo::CLASS, "class");
  732. break;
  733. case GDScriptTokenizer::Token::ENUM:
  734. parse_class_member(&GDScriptParser::parse_enum, AnnotationInfo::NONE, "enum");
  735. break;
  736. case GDScriptTokenizer::Token::STATIC: {
  737. advance();
  738. next_is_static = true;
  739. if (!check(GDScriptTokenizer::Token::FUNC) && !check(GDScriptTokenizer::Token::VAR)) {
  740. push_error(R"(Expected "func" or "var" after "static".)");
  741. }
  742. } break;
  743. case GDScriptTokenizer::Token::ANNOTATION: {
  744. advance();
  745. // Check for standalone and class-level annotations.
  746. AnnotationNode *annotation = parse_annotation(AnnotationInfo::STANDALONE | AnnotationInfo::CLASS_LEVEL);
  747. if (annotation != nullptr) {
  748. if (annotation->applies_to(AnnotationInfo::STANDALONE)) {
  749. if (previous.type != GDScriptTokenizer::Token::NEWLINE) {
  750. push_error(R"(Expected newline after a standalone annotation.)");
  751. }
  752. if (annotation->name == SNAME("@export_category") || annotation->name == SNAME("@export_group") || annotation->name == SNAME("@export_subgroup")) {
  753. current_class->add_member_group(annotation);
  754. } else {
  755. // For potential non-group standalone annotations.
  756. push_error(R"(Unexpected standalone annotation in class body.)");
  757. }
  758. } else {
  759. annotation_stack.push_back(annotation);
  760. }
  761. }
  762. break;
  763. }
  764. case GDScriptTokenizer::Token::PASS:
  765. advance();
  766. end_statement(R"("pass")");
  767. break;
  768. case GDScriptTokenizer::Token::DEDENT:
  769. class_end = true;
  770. break;
  771. case GDScriptTokenizer::Token::LITERAL:
  772. if (current.literal.get_type() == Variant::STRING) {
  773. // Allow strings in class body as multiline comments.
  774. advance();
  775. if (!match(GDScriptTokenizer::Token::NEWLINE)) {
  776. push_error("Expected newline after comment string.");
  777. }
  778. break;
  779. }
  780. [[fallthrough]];
  781. default:
  782. // Display a completion with identifiers.
  783. make_completion_context(COMPLETION_IDENTIFIER, nullptr);
  784. push_error(vformat(R"(Unexpected "%s" in class body.)", current.get_name()));
  785. advance();
  786. break;
  787. }
  788. if (token.type != GDScriptTokenizer::Token::STATIC) {
  789. next_is_static = false;
  790. }
  791. if (panic_mode) {
  792. synchronize();
  793. }
  794. if (!p_is_multiline) {
  795. class_end = true;
  796. }
  797. }
  798. }
  799. GDScriptParser::VariableNode *GDScriptParser::parse_variable(bool p_is_static) {
  800. return parse_variable(p_is_static, true);
  801. }
  802. GDScriptParser::VariableNode *GDScriptParser::parse_variable(bool p_is_static, bool p_allow_property) {
  803. VariableNode *variable = alloc_node<VariableNode>();
  804. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected variable name after "var".)")) {
  805. complete_extents(variable);
  806. return nullptr;
  807. }
  808. variable->identifier = parse_identifier();
  809. variable->export_info.name = variable->identifier->name;
  810. variable->is_static = p_is_static;
  811. if (match(GDScriptTokenizer::Token::COLON)) {
  812. if (check(GDScriptTokenizer::Token::NEWLINE)) {
  813. if (p_allow_property) {
  814. advance();
  815. return parse_property(variable, true);
  816. } else {
  817. push_error(R"(Expected type after ":")");
  818. complete_extents(variable);
  819. return nullptr;
  820. }
  821. } else if (check((GDScriptTokenizer::Token::EQUAL))) {
  822. // Infer type.
  823. variable->infer_datatype = true;
  824. } else {
  825. if (p_allow_property) {
  826. make_completion_context(COMPLETION_PROPERTY_DECLARATION_OR_TYPE, variable);
  827. if (check(GDScriptTokenizer::Token::IDENTIFIER)) {
  828. // Check if get or set.
  829. if (current.get_identifier() == "get" || current.get_identifier() == "set") {
  830. return parse_property(variable, false);
  831. }
  832. }
  833. }
  834. // Parse type.
  835. variable->datatype_specifier = parse_type();
  836. }
  837. }
  838. if (match(GDScriptTokenizer::Token::EQUAL)) {
  839. // Initializer.
  840. variable->initializer = parse_expression(false);
  841. if (variable->initializer == nullptr) {
  842. push_error(R"(Expected expression for variable initial value after "=".)");
  843. }
  844. variable->assignments++;
  845. }
  846. if (p_allow_property && match(GDScriptTokenizer::Token::COLON)) {
  847. if (match(GDScriptTokenizer::Token::NEWLINE)) {
  848. return parse_property(variable, true);
  849. } else {
  850. return parse_property(variable, false);
  851. }
  852. }
  853. complete_extents(variable);
  854. end_statement("variable declaration");
  855. return variable;
  856. }
  857. GDScriptParser::VariableNode *GDScriptParser::parse_property(VariableNode *p_variable, bool p_need_indent) {
  858. if (p_need_indent) {
  859. if (!consume(GDScriptTokenizer::Token::INDENT, R"(Expected indented block for property after ":".)")) {
  860. complete_extents(p_variable);
  861. return nullptr;
  862. }
  863. }
  864. VariableNode *property = p_variable;
  865. make_completion_context(COMPLETION_PROPERTY_DECLARATION, property);
  866. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected "get" or "set" for property declaration.)")) {
  867. complete_extents(p_variable);
  868. return nullptr;
  869. }
  870. IdentifierNode *function = parse_identifier();
  871. if (check(GDScriptTokenizer::Token::EQUAL)) {
  872. p_variable->property = VariableNode::PROP_SETGET;
  873. } else {
  874. p_variable->property = VariableNode::PROP_INLINE;
  875. if (!p_need_indent) {
  876. push_error("Property with inline code must go to an indented block.");
  877. }
  878. }
  879. bool getter_used = false;
  880. bool setter_used = false;
  881. // Run with a loop because order doesn't matter.
  882. for (int i = 0; i < 2; i++) {
  883. if (function->name == SNAME("set")) {
  884. if (setter_used) {
  885. push_error(R"(Properties can only have one setter.)");
  886. } else {
  887. parse_property_setter(property);
  888. setter_used = true;
  889. }
  890. } else if (function->name == SNAME("get")) {
  891. if (getter_used) {
  892. push_error(R"(Properties can only have one getter.)");
  893. } else {
  894. parse_property_getter(property);
  895. getter_used = true;
  896. }
  897. } else {
  898. // TODO: Update message to only have the missing one if it's the case.
  899. push_error(R"(Expected "get" or "set" for property declaration.)");
  900. }
  901. if (i == 0 && p_variable->property == VariableNode::PROP_SETGET) {
  902. if (match(GDScriptTokenizer::Token::COMMA)) {
  903. // Consume potential newline.
  904. if (match(GDScriptTokenizer::Token::NEWLINE)) {
  905. if (!p_need_indent) {
  906. push_error(R"(Inline setter/getter setting cannot span across multiple lines (use "\\"" if needed).)");
  907. }
  908. }
  909. } else {
  910. break;
  911. }
  912. }
  913. if (!match(GDScriptTokenizer::Token::IDENTIFIER)) {
  914. break;
  915. }
  916. function = parse_identifier();
  917. }
  918. complete_extents(p_variable);
  919. if (p_variable->property == VariableNode::PROP_SETGET) {
  920. end_statement("property declaration");
  921. }
  922. if (p_need_indent) {
  923. consume(GDScriptTokenizer::Token::DEDENT, R"(Expected end of indented block for property.)");
  924. }
  925. return property;
  926. }
  927. void GDScriptParser::parse_property_setter(VariableNode *p_variable) {
  928. switch (p_variable->property) {
  929. case VariableNode::PROP_INLINE: {
  930. FunctionNode *function = alloc_node<FunctionNode>();
  931. IdentifierNode *identifier = alloc_node<IdentifierNode>();
  932. complete_extents(identifier);
  933. identifier->name = "@" + p_variable->identifier->name + "_setter";
  934. function->identifier = identifier;
  935. function->is_static = p_variable->is_static;
  936. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected "(" after "set".)");
  937. ParameterNode *parameter = alloc_node<ParameterNode>();
  938. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected parameter name after "(".)")) {
  939. reset_extents(parameter, previous);
  940. p_variable->setter_parameter = parse_identifier();
  941. parameter->identifier = p_variable->setter_parameter;
  942. function->parameters_indices[parameter->identifier->name] = 0;
  943. function->parameters.push_back(parameter);
  944. }
  945. complete_extents(parameter);
  946. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected ")" after parameter name.)*");
  947. consume(GDScriptTokenizer::Token::COLON, R"*(Expected ":" after ")".)*");
  948. FunctionNode *previous_function = current_function;
  949. current_function = function;
  950. if (p_variable->setter_parameter != nullptr) {
  951. SuiteNode *body = alloc_node<SuiteNode>();
  952. body->add_local(parameter, function);
  953. function->body = parse_suite("setter declaration", body);
  954. p_variable->setter = function;
  955. }
  956. current_function = previous_function;
  957. complete_extents(function);
  958. break;
  959. }
  960. case VariableNode::PROP_SETGET:
  961. consume(GDScriptTokenizer::Token::EQUAL, R"(Expected "=" after "set")");
  962. make_completion_context(COMPLETION_PROPERTY_METHOD, p_variable);
  963. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected setter function name after "=".)")) {
  964. p_variable->setter_pointer = parse_identifier();
  965. }
  966. break;
  967. case VariableNode::PROP_NONE:
  968. break; // Unreachable.
  969. }
  970. }
  971. void GDScriptParser::parse_property_getter(VariableNode *p_variable) {
  972. switch (p_variable->property) {
  973. case VariableNode::PROP_INLINE: {
  974. FunctionNode *function = alloc_node<FunctionNode>();
  975. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "get".)");
  976. IdentifierNode *identifier = alloc_node<IdentifierNode>();
  977. complete_extents(identifier);
  978. identifier->name = "@" + p_variable->identifier->name + "_getter";
  979. function->identifier = identifier;
  980. function->is_static = p_variable->is_static;
  981. FunctionNode *previous_function = current_function;
  982. current_function = function;
  983. SuiteNode *body = alloc_node<SuiteNode>();
  984. function->body = parse_suite("getter declaration", body);
  985. p_variable->getter = function;
  986. current_function = previous_function;
  987. complete_extents(function);
  988. break;
  989. }
  990. case VariableNode::PROP_SETGET:
  991. consume(GDScriptTokenizer::Token::EQUAL, R"(Expected "=" after "get")");
  992. make_completion_context(COMPLETION_PROPERTY_METHOD, p_variable);
  993. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected getter function name after "=".)")) {
  994. p_variable->getter_pointer = parse_identifier();
  995. }
  996. break;
  997. case VariableNode::PROP_NONE:
  998. break; // Unreachable.
  999. }
  1000. }
  1001. GDScriptParser::ConstantNode *GDScriptParser::parse_constant(bool p_is_static) {
  1002. ConstantNode *constant = alloc_node<ConstantNode>();
  1003. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected constant name after "const".)")) {
  1004. return nullptr;
  1005. }
  1006. constant->identifier = parse_identifier();
  1007. if (match(GDScriptTokenizer::Token::COLON)) {
  1008. if (check((GDScriptTokenizer::Token::EQUAL))) {
  1009. // Infer type.
  1010. constant->infer_datatype = true;
  1011. } else {
  1012. // Parse type.
  1013. constant->datatype_specifier = parse_type();
  1014. }
  1015. }
  1016. if (consume(GDScriptTokenizer::Token::EQUAL, R"(Expected initializer after constant name.)")) {
  1017. // Initializer.
  1018. constant->initializer = parse_expression(false);
  1019. if (constant->initializer == nullptr) {
  1020. push_error(R"(Expected initializer expression for constant.)");
  1021. complete_extents(constant);
  1022. return nullptr;
  1023. }
  1024. } else {
  1025. complete_extents(constant);
  1026. return nullptr;
  1027. }
  1028. complete_extents(constant);
  1029. end_statement("constant declaration");
  1030. return constant;
  1031. }
  1032. GDScriptParser::ParameterNode *GDScriptParser::parse_parameter() {
  1033. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected parameter name.)")) {
  1034. return nullptr;
  1035. }
  1036. ParameterNode *parameter = alloc_node<ParameterNode>();
  1037. parameter->identifier = parse_identifier();
  1038. if (match(GDScriptTokenizer::Token::COLON)) {
  1039. if (check((GDScriptTokenizer::Token::EQUAL))) {
  1040. // Infer type.
  1041. parameter->infer_datatype = true;
  1042. } else {
  1043. // Parse type.
  1044. make_completion_context(COMPLETION_TYPE_NAME, parameter);
  1045. parameter->datatype_specifier = parse_type();
  1046. }
  1047. }
  1048. if (match(GDScriptTokenizer::Token::EQUAL)) {
  1049. // Default value.
  1050. parameter->initializer = parse_expression(false);
  1051. }
  1052. complete_extents(parameter);
  1053. return parameter;
  1054. }
  1055. GDScriptParser::SignalNode *GDScriptParser::parse_signal(bool p_is_static) {
  1056. SignalNode *signal = alloc_node<SignalNode>();
  1057. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected signal name after "signal".)")) {
  1058. complete_extents(signal);
  1059. return nullptr;
  1060. }
  1061. signal->identifier = parse_identifier();
  1062. if (check(GDScriptTokenizer::Token::PARENTHESIS_OPEN)) {
  1063. push_multiline(true);
  1064. advance();
  1065. do {
  1066. if (check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE)) {
  1067. // Allow for trailing comma.
  1068. break;
  1069. }
  1070. ParameterNode *parameter = parse_parameter();
  1071. if (parameter == nullptr) {
  1072. push_error("Expected signal parameter name.");
  1073. break;
  1074. }
  1075. if (parameter->initializer != nullptr) {
  1076. push_error(R"(Signal parameters cannot have a default value.)");
  1077. }
  1078. if (signal->parameters_indices.has(parameter->identifier->name)) {
  1079. push_error(vformat(R"(Parameter with name "%s" was already declared for this signal.)", parameter->identifier->name));
  1080. } else {
  1081. signal->parameters_indices[parameter->identifier->name] = signal->parameters.size();
  1082. signal->parameters.push_back(parameter);
  1083. }
  1084. } while (match(GDScriptTokenizer::Token::COMMA) && !is_at_end());
  1085. pop_multiline();
  1086. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected closing ")" after signal parameters.)*");
  1087. }
  1088. complete_extents(signal);
  1089. end_statement("signal declaration");
  1090. return signal;
  1091. }
  1092. GDScriptParser::EnumNode *GDScriptParser::parse_enum(bool p_is_static) {
  1093. EnumNode *enum_node = alloc_node<EnumNode>();
  1094. bool named = false;
  1095. if (check(GDScriptTokenizer::Token::IDENTIFIER)) {
  1096. advance();
  1097. enum_node->identifier = parse_identifier();
  1098. named = true;
  1099. }
  1100. push_multiline(true);
  1101. consume(GDScriptTokenizer::Token::BRACE_OPEN, vformat(R"(Expected "{" after %s.)", named ? "enum name" : R"("enum")"));
  1102. HashMap<StringName, int> elements;
  1103. #ifdef DEBUG_ENABLED
  1104. List<MethodInfo> gdscript_funcs;
  1105. GDScriptLanguage::get_singleton()->get_public_functions(&gdscript_funcs);
  1106. #endif
  1107. do {
  1108. if (check(GDScriptTokenizer::Token::BRACE_CLOSE)) {
  1109. break; // Allow trailing comma.
  1110. }
  1111. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected identifier for enum key.)")) {
  1112. EnumNode::Value item;
  1113. GDScriptParser::IdentifierNode *identifier = parse_identifier();
  1114. #ifdef DEBUG_ENABLED
  1115. if (!named) { // Named enum identifiers do not shadow anything since you can only access them with NamedEnum.ENUM_VALUE
  1116. for (MethodInfo &info : gdscript_funcs) {
  1117. if (info.name == identifier->name) {
  1118. push_warning(identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, "enum member", identifier->name, "built-in function");
  1119. }
  1120. }
  1121. if (Variant::has_utility_function(identifier->name)) {
  1122. push_warning(identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, "enum member", identifier->name, "built-in function");
  1123. } else if (ClassDB::class_exists(identifier->name)) {
  1124. push_warning(identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, "enum member", identifier->name, "global class");
  1125. }
  1126. }
  1127. #endif
  1128. item.identifier = identifier;
  1129. item.parent_enum = enum_node;
  1130. item.line = previous.start_line;
  1131. item.leftmost_column = previous.leftmost_column;
  1132. item.rightmost_column = previous.rightmost_column;
  1133. if (elements.has(item.identifier->name)) {
  1134. push_error(vformat(R"(Name "%s" was already in this enum (at line %d).)", item.identifier->name, elements[item.identifier->name]), item.identifier);
  1135. } else if (!named) {
  1136. if (current_class->members_indices.has(item.identifier->name)) {
  1137. push_error(vformat(R"(Name "%s" is already used as a class %s.)", item.identifier->name, current_class->get_member(item.identifier->name).get_type_name()));
  1138. }
  1139. }
  1140. elements[item.identifier->name] = item.line;
  1141. if (match(GDScriptTokenizer::Token::EQUAL)) {
  1142. ExpressionNode *value = parse_expression(false);
  1143. if (value == nullptr) {
  1144. push_error(R"(Expected expression value after "=".)");
  1145. }
  1146. item.custom_value = value;
  1147. }
  1148. item.index = enum_node->values.size();
  1149. enum_node->values.push_back(item);
  1150. if (!named) {
  1151. // Add as member of current class.
  1152. current_class->add_member(item);
  1153. }
  1154. }
  1155. } while (match(GDScriptTokenizer::Token::COMMA));
  1156. pop_multiline();
  1157. consume(GDScriptTokenizer::Token::BRACE_CLOSE, R"(Expected closing "}" for enum.)");
  1158. #ifdef TOOLS_ENABLED
  1159. // Enum values documentation.
  1160. for (int i = 0; i < enum_node->values.size(); i++) {
  1161. if (i == enum_node->values.size() - 1) {
  1162. // If close bracket is same line as last value.
  1163. if (enum_node->values[i].line != previous.start_line && has_comment(enum_node->values[i].line)) {
  1164. if (named) {
  1165. enum_node->values.write[i].doc_description = get_doc_comment(enum_node->values[i].line, true);
  1166. } else {
  1167. current_class->set_enum_value_doc(enum_node->values[i].identifier->name, get_doc_comment(enum_node->values[i].line, true));
  1168. }
  1169. }
  1170. } else {
  1171. // If two values are same line.
  1172. if (enum_node->values[i].line != enum_node->values[i + 1].line && has_comment(enum_node->values[i].line)) {
  1173. if (named) {
  1174. enum_node->values.write[i].doc_description = get_doc_comment(enum_node->values[i].line, true);
  1175. } else {
  1176. current_class->set_enum_value_doc(enum_node->values[i].identifier->name, get_doc_comment(enum_node->values[i].line, true));
  1177. }
  1178. }
  1179. }
  1180. }
  1181. #endif // TOOLS_ENABLED
  1182. complete_extents(enum_node);
  1183. end_statement("enum");
  1184. return enum_node;
  1185. }
  1186. void GDScriptParser::parse_function_signature(FunctionNode *p_function, SuiteNode *p_body, const String &p_type) {
  1187. if (!check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE) && !is_at_end()) {
  1188. bool default_used = false;
  1189. do {
  1190. if (check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE)) {
  1191. // Allow for trailing comma.
  1192. break;
  1193. }
  1194. ParameterNode *parameter = parse_parameter();
  1195. if (parameter == nullptr) {
  1196. break;
  1197. }
  1198. if (parameter->initializer != nullptr) {
  1199. default_used = true;
  1200. } else {
  1201. if (default_used) {
  1202. push_error("Cannot have mandatory parameters after optional parameters.");
  1203. continue;
  1204. }
  1205. }
  1206. if (p_function->parameters_indices.has(parameter->identifier->name)) {
  1207. push_error(vformat(R"(Parameter with name "%s" was already declared for this %s.)", parameter->identifier->name, p_type));
  1208. } else {
  1209. p_function->parameters_indices[parameter->identifier->name] = p_function->parameters.size();
  1210. p_function->parameters.push_back(parameter);
  1211. p_body->add_local(parameter, current_function);
  1212. }
  1213. } while (match(GDScriptTokenizer::Token::COMMA));
  1214. }
  1215. pop_multiline();
  1216. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, vformat(R"*(Expected closing ")" after %s parameters.)*", p_type));
  1217. if (match(GDScriptTokenizer::Token::FORWARD_ARROW)) {
  1218. make_completion_context(COMPLETION_TYPE_NAME_OR_VOID, p_function);
  1219. p_function->return_type = parse_type(true);
  1220. if (p_function->return_type == nullptr) {
  1221. push_error(R"(Expected return type or "void" after "->".)");
  1222. }
  1223. }
  1224. if (!p_function->source_lambda && p_function->identifier && p_function->identifier->name == GDScriptLanguage::get_singleton()->strings._static_init) {
  1225. if (!p_function->is_static) {
  1226. push_error(R"(Static constructor must be declared static.)");
  1227. }
  1228. if (p_function->parameters.size() != 0) {
  1229. push_error(R"(Static constructor cannot have parameters.)");
  1230. }
  1231. current_class->has_static_data = true;
  1232. }
  1233. // TODO: Improve token consumption so it synchronizes to a statement boundary. This way we can get into the function body with unrecognized tokens.
  1234. consume(GDScriptTokenizer::Token::COLON, vformat(R"(Expected ":" after %s declaration.)", p_type));
  1235. }
  1236. GDScriptParser::FunctionNode *GDScriptParser::parse_function(bool p_is_static) {
  1237. FunctionNode *function = alloc_node<FunctionNode>();
  1238. make_completion_context(COMPLETION_OVERRIDE_METHOD, function);
  1239. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected function name after "func".)")) {
  1240. complete_extents(function);
  1241. return nullptr;
  1242. }
  1243. FunctionNode *previous_function = current_function;
  1244. current_function = function;
  1245. function->identifier = parse_identifier();
  1246. function->is_static = p_is_static;
  1247. SuiteNode *body = alloc_node<SuiteNode>();
  1248. SuiteNode *previous_suite = current_suite;
  1249. current_suite = body;
  1250. push_multiline(true);
  1251. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected opening "(" after function name.)");
  1252. parse_function_signature(function, body, "function");
  1253. current_suite = previous_suite;
  1254. function->body = parse_suite("function declaration", body);
  1255. current_function = previous_function;
  1256. complete_extents(function);
  1257. return function;
  1258. }
  1259. GDScriptParser::AnnotationNode *GDScriptParser::parse_annotation(uint32_t p_valid_targets) {
  1260. AnnotationNode *annotation = alloc_node<AnnotationNode>();
  1261. annotation->name = previous.literal;
  1262. make_completion_context(COMPLETION_ANNOTATION, annotation);
  1263. bool valid = true;
  1264. if (!valid_annotations.has(annotation->name)) {
  1265. push_error(vformat(R"(Unrecognized annotation: "%s".)", annotation->name));
  1266. valid = false;
  1267. }
  1268. annotation->info = &valid_annotations[annotation->name];
  1269. if (!annotation->applies_to(p_valid_targets)) {
  1270. if (annotation->applies_to(AnnotationInfo::SCRIPT)) {
  1271. push_error(vformat(R"(Annotation "%s" must be at the top of the script, before "extends" and "class_name".)", annotation->name));
  1272. } else {
  1273. push_error(vformat(R"(Annotation "%s" is not allowed in this level.)", annotation->name));
  1274. }
  1275. valid = false;
  1276. }
  1277. if (check(GDScriptTokenizer::Token::PARENTHESIS_OPEN)) {
  1278. push_multiline(true);
  1279. advance();
  1280. // Arguments.
  1281. push_completion_call(annotation);
  1282. make_completion_context(COMPLETION_ANNOTATION_ARGUMENTS, annotation, 0, true);
  1283. int argument_index = 0;
  1284. do {
  1285. if (check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE)) {
  1286. // Allow for trailing comma.
  1287. break;
  1288. }
  1289. make_completion_context(COMPLETION_ANNOTATION_ARGUMENTS, annotation, argument_index, true);
  1290. set_last_completion_call_arg(argument_index++);
  1291. ExpressionNode *argument = parse_expression(false);
  1292. if (argument == nullptr) {
  1293. push_error("Expected expression as the annotation argument.");
  1294. valid = false;
  1295. continue;
  1296. }
  1297. annotation->arguments.push_back(argument);
  1298. } while (match(GDScriptTokenizer::Token::COMMA) && !is_at_end());
  1299. pop_multiline();
  1300. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected ")" after annotation arguments.)*");
  1301. pop_completion_call();
  1302. }
  1303. complete_extents(annotation);
  1304. match(GDScriptTokenizer::Token::NEWLINE); // Newline after annotation is optional.
  1305. if (valid) {
  1306. valid = validate_annotation_arguments(annotation);
  1307. }
  1308. return valid ? annotation : nullptr;
  1309. }
  1310. void GDScriptParser::clear_unused_annotations() {
  1311. for (const AnnotationNode *annotation : annotation_stack) {
  1312. push_error(vformat(R"(Annotation "%s" does not precede a valid target, so it will have no effect.)", annotation->name), annotation);
  1313. }
  1314. annotation_stack.clear();
  1315. }
  1316. bool GDScriptParser::register_annotation(const MethodInfo &p_info, uint32_t p_target_kinds, AnnotationAction p_apply, const Vector<Variant> &p_default_arguments, bool p_is_vararg) {
  1317. ERR_FAIL_COND_V_MSG(valid_annotations.has(p_info.name), false, vformat(R"(Annotation "%s" already registered.)", p_info.name));
  1318. AnnotationInfo new_annotation;
  1319. new_annotation.info = p_info;
  1320. new_annotation.info.default_arguments = p_default_arguments;
  1321. if (p_is_vararg) {
  1322. new_annotation.info.flags |= METHOD_FLAG_VARARG;
  1323. }
  1324. new_annotation.apply = p_apply;
  1325. new_annotation.target_kind = p_target_kinds;
  1326. valid_annotations[p_info.name] = new_annotation;
  1327. return true;
  1328. }
  1329. GDScriptParser::SuiteNode *GDScriptParser::parse_suite(const String &p_context, SuiteNode *p_suite, bool p_for_lambda) {
  1330. SuiteNode *suite = p_suite != nullptr ? p_suite : alloc_node<SuiteNode>();
  1331. suite->parent_block = current_suite;
  1332. suite->parent_function = current_function;
  1333. current_suite = suite;
  1334. bool multiline = false;
  1335. if (match(GDScriptTokenizer::Token::NEWLINE)) {
  1336. multiline = true;
  1337. }
  1338. if (multiline) {
  1339. if (!consume(GDScriptTokenizer::Token::INDENT, vformat(R"(Expected indented block after %s.)", p_context))) {
  1340. current_suite = suite->parent_block;
  1341. complete_extents(suite);
  1342. return suite;
  1343. }
  1344. }
  1345. reset_extents(suite, current);
  1346. int error_count = 0;
  1347. do {
  1348. if (is_at_end() || (!multiline && previous.type == GDScriptTokenizer::Token::SEMICOLON && check(GDScriptTokenizer::Token::NEWLINE))) {
  1349. break;
  1350. }
  1351. Node *statement = parse_statement();
  1352. if (statement == nullptr) {
  1353. if (error_count++ > 100) {
  1354. push_error("Too many statement errors.", suite);
  1355. break;
  1356. }
  1357. continue;
  1358. }
  1359. suite->statements.push_back(statement);
  1360. // Register locals.
  1361. switch (statement->type) {
  1362. case Node::VARIABLE: {
  1363. VariableNode *variable = static_cast<VariableNode *>(statement);
  1364. const SuiteNode::Local &local = current_suite->get_local(variable->identifier->name);
  1365. if (local.type != SuiteNode::Local::UNDEFINED) {
  1366. push_error(vformat(R"(There is already a %s named "%s" declared in this scope.)", local.get_name(), variable->identifier->name), variable->identifier);
  1367. }
  1368. current_suite->add_local(variable, current_function);
  1369. break;
  1370. }
  1371. case Node::CONSTANT: {
  1372. ConstantNode *constant = static_cast<ConstantNode *>(statement);
  1373. const SuiteNode::Local &local = current_suite->get_local(constant->identifier->name);
  1374. if (local.type != SuiteNode::Local::UNDEFINED) {
  1375. String name;
  1376. if (local.type == SuiteNode::Local::CONSTANT) {
  1377. name = "constant";
  1378. } else {
  1379. name = "variable";
  1380. }
  1381. push_error(vformat(R"(There is already a %s named "%s" declared in this scope.)", name, constant->identifier->name), constant->identifier);
  1382. }
  1383. current_suite->add_local(constant, current_function);
  1384. break;
  1385. }
  1386. default:
  1387. break;
  1388. }
  1389. } while ((multiline || previous.type == GDScriptTokenizer::Token::SEMICOLON) && !check(GDScriptTokenizer::Token::DEDENT) && !lambda_ended && !is_at_end());
  1390. complete_extents(suite);
  1391. if (multiline) {
  1392. if (!lambda_ended) {
  1393. consume(GDScriptTokenizer::Token::DEDENT, vformat(R"(Missing unindent at the end of %s.)", p_context));
  1394. } else {
  1395. match(GDScriptTokenizer::Token::DEDENT);
  1396. }
  1397. } else if (previous.type == GDScriptTokenizer::Token::SEMICOLON) {
  1398. consume(GDScriptTokenizer::Token::NEWLINE, vformat(R"(Expected newline after ";" at the end of %s.)", p_context));
  1399. }
  1400. if (p_for_lambda) {
  1401. lambda_ended = true;
  1402. }
  1403. current_suite = suite->parent_block;
  1404. return suite;
  1405. }
  1406. GDScriptParser::Node *GDScriptParser::parse_statement() {
  1407. Node *result = nullptr;
  1408. #ifdef DEBUG_ENABLED
  1409. bool unreachable = current_suite->has_return && !current_suite->has_unreachable_code;
  1410. #endif
  1411. bool is_annotation = false;
  1412. switch (current.type) {
  1413. case GDScriptTokenizer::Token::PASS:
  1414. advance();
  1415. result = alloc_node<PassNode>();
  1416. complete_extents(result);
  1417. end_statement(R"("pass")");
  1418. break;
  1419. case GDScriptTokenizer::Token::VAR:
  1420. advance();
  1421. result = parse_variable(false, false);
  1422. break;
  1423. case GDScriptTokenizer::Token::CONST:
  1424. advance();
  1425. result = parse_constant(false);
  1426. break;
  1427. case GDScriptTokenizer::Token::IF:
  1428. advance();
  1429. result = parse_if();
  1430. break;
  1431. case GDScriptTokenizer::Token::FOR:
  1432. advance();
  1433. result = parse_for();
  1434. break;
  1435. case GDScriptTokenizer::Token::WHILE:
  1436. advance();
  1437. result = parse_while();
  1438. break;
  1439. case GDScriptTokenizer::Token::MATCH:
  1440. advance();
  1441. result = parse_match();
  1442. break;
  1443. case GDScriptTokenizer::Token::BREAK:
  1444. advance();
  1445. result = parse_break();
  1446. break;
  1447. case GDScriptTokenizer::Token::CONTINUE:
  1448. advance();
  1449. result = parse_continue();
  1450. break;
  1451. case GDScriptTokenizer::Token::RETURN: {
  1452. advance();
  1453. ReturnNode *n_return = alloc_node<ReturnNode>();
  1454. if (!is_statement_end()) {
  1455. if (current_function && (current_function->identifier->name == GDScriptLanguage::get_singleton()->strings._init || current_function->identifier->name == GDScriptLanguage::get_singleton()->strings._static_init)) {
  1456. push_error(R"(Constructor cannot return a value.)");
  1457. }
  1458. n_return->return_value = parse_expression(false);
  1459. } else if (in_lambda && !is_statement_end_token()) {
  1460. // Try to parse it anyway as this might not be the statement end in a lambda.
  1461. // If this fails the expression will be nullptr, but that's the same as no return, so it's fine.
  1462. n_return->return_value = parse_expression(false);
  1463. }
  1464. complete_extents(n_return);
  1465. result = n_return;
  1466. current_suite->has_return = true;
  1467. end_statement("return statement");
  1468. break;
  1469. }
  1470. case GDScriptTokenizer::Token::BREAKPOINT:
  1471. advance();
  1472. result = alloc_node<BreakpointNode>();
  1473. complete_extents(result);
  1474. end_statement(R"("breakpoint")");
  1475. break;
  1476. case GDScriptTokenizer::Token::ASSERT:
  1477. advance();
  1478. result = parse_assert();
  1479. break;
  1480. case GDScriptTokenizer::Token::ANNOTATION: {
  1481. advance();
  1482. is_annotation = true;
  1483. AnnotationNode *annotation = parse_annotation(AnnotationInfo::STATEMENT);
  1484. if (annotation != nullptr) {
  1485. annotation_stack.push_back(annotation);
  1486. }
  1487. break;
  1488. }
  1489. default: {
  1490. // Expression statement.
  1491. ExpressionNode *expression = parse_expression(true); // Allow assignment here.
  1492. bool has_ended_lambda = false;
  1493. if (expression == nullptr) {
  1494. if (in_lambda) {
  1495. // If it's not a valid expression beginning, it might be the continuation of the outer expression where this lambda is.
  1496. lambda_ended = true;
  1497. has_ended_lambda = true;
  1498. } else {
  1499. advance();
  1500. push_error(vformat(R"(Expected statement, found "%s" instead.)", previous.get_name()));
  1501. }
  1502. } else {
  1503. end_statement("expression");
  1504. }
  1505. lambda_ended = lambda_ended || has_ended_lambda;
  1506. result = expression;
  1507. #ifdef DEBUG_ENABLED
  1508. if (expression != nullptr) {
  1509. switch (expression->type) {
  1510. case Node::CALL:
  1511. case Node::ASSIGNMENT:
  1512. case Node::AWAIT:
  1513. case Node::TERNARY_OPERATOR:
  1514. // Fine.
  1515. break;
  1516. case Node::LAMBDA:
  1517. // Standalone lambdas can't be used, so make this an error.
  1518. push_error("Standalone lambdas cannot be accessed. Consider assigning it to a variable.", expression);
  1519. break;
  1520. case Node::LITERAL:
  1521. if (static_cast<GDScriptParser::LiteralNode *>(expression)->value.get_type() == Variant::STRING) {
  1522. // Allow strings as multiline comments.
  1523. break;
  1524. }
  1525. [[fallthrough]];
  1526. default:
  1527. push_warning(expression, GDScriptWarning::STANDALONE_EXPRESSION);
  1528. }
  1529. }
  1530. #endif
  1531. break;
  1532. }
  1533. }
  1534. while (!is_annotation && result != nullptr && !annotation_stack.is_empty()) {
  1535. AnnotationNode *last_annotation = annotation_stack.back()->get();
  1536. if (last_annotation->applies_to(AnnotationInfo::STATEMENT)) {
  1537. result->annotations.push_front(last_annotation);
  1538. annotation_stack.pop_back();
  1539. } else {
  1540. push_error(vformat(R"(Annotation "%s" cannot be applied to a statement.)", last_annotation->name));
  1541. clear_unused_annotations();
  1542. }
  1543. }
  1544. #ifdef DEBUG_ENABLED
  1545. if (unreachable && result != nullptr) {
  1546. current_suite->has_unreachable_code = true;
  1547. if (current_function) {
  1548. push_warning(result, GDScriptWarning::UNREACHABLE_CODE, current_function->identifier ? current_function->identifier->name : "<anonymous lambda>");
  1549. } else {
  1550. // TODO: Properties setters and getters with unreachable code are not being warned
  1551. }
  1552. }
  1553. #endif
  1554. if (panic_mode) {
  1555. synchronize();
  1556. }
  1557. return result;
  1558. }
  1559. GDScriptParser::AssertNode *GDScriptParser::parse_assert() {
  1560. // TODO: Add assert message.
  1561. AssertNode *assert = alloc_node<AssertNode>();
  1562. push_multiline(true);
  1563. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected "(" after "assert".)");
  1564. assert->condition = parse_expression(false);
  1565. if (assert->condition == nullptr) {
  1566. push_error("Expected expression to assert.");
  1567. pop_multiline();
  1568. complete_extents(assert);
  1569. return nullptr;
  1570. }
  1571. if (match(GDScriptTokenizer::Token::COMMA) && !check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE)) {
  1572. assert->message = parse_expression(false);
  1573. if (assert->message == nullptr) {
  1574. push_error(R"(Expected error message for assert after ",".)");
  1575. pop_multiline();
  1576. complete_extents(assert);
  1577. return nullptr;
  1578. }
  1579. match(GDScriptTokenizer::Token::COMMA);
  1580. }
  1581. pop_multiline();
  1582. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected ")" after assert expression.)*");
  1583. complete_extents(assert);
  1584. end_statement(R"("assert")");
  1585. return assert;
  1586. }
  1587. GDScriptParser::BreakNode *GDScriptParser::parse_break() {
  1588. if (!can_break) {
  1589. push_error(R"(Cannot use "break" outside of a loop.)");
  1590. }
  1591. BreakNode *break_node = alloc_node<BreakNode>();
  1592. complete_extents(break_node);
  1593. end_statement(R"("break")");
  1594. return break_node;
  1595. }
  1596. GDScriptParser::ContinueNode *GDScriptParser::parse_continue() {
  1597. if (!can_continue) {
  1598. push_error(R"(Cannot use "continue" outside of a loop.)");
  1599. }
  1600. current_suite->has_continue = true;
  1601. ContinueNode *cont = alloc_node<ContinueNode>();
  1602. complete_extents(cont);
  1603. end_statement(R"("continue")");
  1604. return cont;
  1605. }
  1606. GDScriptParser::ForNode *GDScriptParser::parse_for() {
  1607. ForNode *n_for = alloc_node<ForNode>();
  1608. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected loop variable name after "for".)")) {
  1609. n_for->variable = parse_identifier();
  1610. }
  1611. consume(GDScriptTokenizer::Token::IN, R"(Expected "in" after "for" variable name.)");
  1612. n_for->list = parse_expression(false);
  1613. if (!n_for->list) {
  1614. push_error(R"(Expected iterable after "in".)");
  1615. }
  1616. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "for" condition.)");
  1617. // Save break/continue state.
  1618. bool could_break = can_break;
  1619. bool could_continue = can_continue;
  1620. // Allow break/continue.
  1621. can_break = true;
  1622. can_continue = true;
  1623. SuiteNode *suite = alloc_node<SuiteNode>();
  1624. if (n_for->variable) {
  1625. const SuiteNode::Local &local = current_suite->get_local(n_for->variable->name);
  1626. if (local.type != SuiteNode::Local::UNDEFINED) {
  1627. push_error(vformat(R"(There is already a %s named "%s" declared in this scope.)", local.get_name(), n_for->variable->name), n_for->variable);
  1628. }
  1629. suite->add_local(SuiteNode::Local(n_for->variable, current_function));
  1630. }
  1631. n_for->loop = parse_suite(R"("for" block)", suite);
  1632. n_for->loop->is_loop = true;
  1633. complete_extents(n_for);
  1634. // Reset break/continue state.
  1635. can_break = could_break;
  1636. can_continue = could_continue;
  1637. return n_for;
  1638. }
  1639. GDScriptParser::IfNode *GDScriptParser::parse_if(const String &p_token) {
  1640. IfNode *n_if = alloc_node<IfNode>();
  1641. n_if->condition = parse_expression(false);
  1642. if (n_if->condition == nullptr) {
  1643. push_error(vformat(R"(Expected conditional expression after "%s".)", p_token));
  1644. }
  1645. consume(GDScriptTokenizer::Token::COLON, vformat(R"(Expected ":" after "%s" condition.)", p_token));
  1646. n_if->true_block = parse_suite(vformat(R"("%s" block)", p_token));
  1647. n_if->true_block->parent_if = n_if;
  1648. if (n_if->true_block->has_continue) {
  1649. current_suite->has_continue = true;
  1650. }
  1651. if (match(GDScriptTokenizer::Token::ELIF)) {
  1652. SuiteNode *else_block = alloc_node<SuiteNode>();
  1653. else_block->parent_function = current_function;
  1654. else_block->parent_block = current_suite;
  1655. SuiteNode *previous_suite = current_suite;
  1656. current_suite = else_block;
  1657. IfNode *elif = parse_if("elif");
  1658. else_block->statements.push_back(elif);
  1659. complete_extents(else_block);
  1660. n_if->false_block = else_block;
  1661. current_suite = previous_suite;
  1662. } else if (match(GDScriptTokenizer::Token::ELSE)) {
  1663. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "else".)");
  1664. n_if->false_block = parse_suite(R"("else" block)");
  1665. }
  1666. complete_extents(n_if);
  1667. if (n_if->false_block != nullptr && n_if->false_block->has_return && n_if->true_block->has_return) {
  1668. current_suite->has_return = true;
  1669. }
  1670. if (n_if->false_block != nullptr && n_if->false_block->has_continue) {
  1671. current_suite->has_continue = true;
  1672. }
  1673. return n_if;
  1674. }
  1675. GDScriptParser::MatchNode *GDScriptParser::parse_match() {
  1676. MatchNode *match = alloc_node<MatchNode>();
  1677. match->test = parse_expression(false);
  1678. if (match->test == nullptr) {
  1679. push_error(R"(Expected expression to test after "match".)");
  1680. }
  1681. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "match" expression.)");
  1682. consume(GDScriptTokenizer::Token::NEWLINE, R"(Expected a newline after "match" statement.)");
  1683. if (!consume(GDScriptTokenizer::Token::INDENT, R"(Expected an indented block after "match" statement.)")) {
  1684. complete_extents(match);
  1685. return match;
  1686. }
  1687. bool all_have_return = true;
  1688. bool have_wildcard = false;
  1689. while (!check(GDScriptTokenizer::Token::DEDENT) && !is_at_end()) {
  1690. MatchBranchNode *branch = parse_match_branch();
  1691. if (branch == nullptr) {
  1692. advance();
  1693. continue;
  1694. }
  1695. #ifdef DEBUG_ENABLED
  1696. if (have_wildcard && !branch->patterns.is_empty()) {
  1697. push_warning(branch->patterns[0], GDScriptWarning::UNREACHABLE_PATTERN);
  1698. }
  1699. #endif
  1700. have_wildcard = have_wildcard || branch->has_wildcard;
  1701. all_have_return = all_have_return && branch->block->has_return;
  1702. match->branches.push_back(branch);
  1703. }
  1704. complete_extents(match);
  1705. consume(GDScriptTokenizer::Token::DEDENT, R"(Expected an indented block after "match" statement.)");
  1706. if (all_have_return && have_wildcard) {
  1707. current_suite->has_return = true;
  1708. }
  1709. return match;
  1710. }
  1711. GDScriptParser::MatchBranchNode *GDScriptParser::parse_match_branch() {
  1712. MatchBranchNode *branch = alloc_node<MatchBranchNode>();
  1713. reset_extents(branch, current);
  1714. bool has_bind = false;
  1715. do {
  1716. PatternNode *pattern = parse_match_pattern();
  1717. if (pattern == nullptr) {
  1718. continue;
  1719. }
  1720. if (pattern->binds.size() > 0) {
  1721. has_bind = true;
  1722. }
  1723. if (branch->patterns.size() > 0 && has_bind) {
  1724. push_error(R"(Cannot use a variable bind with multiple patterns.)");
  1725. }
  1726. if (pattern->pattern_type == PatternNode::PT_REST) {
  1727. push_error(R"(Rest pattern can only be used inside array and dictionary patterns.)");
  1728. } else if (pattern->pattern_type == PatternNode::PT_BIND || pattern->pattern_type == PatternNode::PT_WILDCARD) {
  1729. branch->has_wildcard = true;
  1730. }
  1731. branch->patterns.push_back(pattern);
  1732. } while (match(GDScriptTokenizer::Token::COMMA));
  1733. if (branch->patterns.is_empty()) {
  1734. push_error(R"(No pattern found for "match" branch.)");
  1735. }
  1736. if (!consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "match" patterns.)")) {
  1737. complete_extents(branch);
  1738. return nullptr;
  1739. }
  1740. SuiteNode *suite = alloc_node<SuiteNode>();
  1741. if (branch->patterns.size() > 0) {
  1742. for (const KeyValue<StringName, IdentifierNode *> &E : branch->patterns[0]->binds) {
  1743. SuiteNode::Local local(E.value, current_function);
  1744. local.type = SuiteNode::Local::PATTERN_BIND;
  1745. suite->add_local(local);
  1746. }
  1747. }
  1748. branch->block = parse_suite("match pattern block", suite);
  1749. complete_extents(branch);
  1750. return branch;
  1751. }
  1752. GDScriptParser::PatternNode *GDScriptParser::parse_match_pattern(PatternNode *p_root_pattern) {
  1753. PatternNode *pattern = alloc_node<PatternNode>();
  1754. reset_extents(pattern, current);
  1755. switch (current.type) {
  1756. case GDScriptTokenizer::Token::VAR: {
  1757. // Bind.
  1758. advance();
  1759. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected bind name after "var".)")) {
  1760. complete_extents(pattern);
  1761. return nullptr;
  1762. }
  1763. pattern->pattern_type = PatternNode::PT_BIND;
  1764. pattern->bind = parse_identifier();
  1765. PatternNode *root_pattern = p_root_pattern == nullptr ? pattern : p_root_pattern;
  1766. if (p_root_pattern != nullptr) {
  1767. if (p_root_pattern->has_bind(pattern->bind->name)) {
  1768. push_error(vformat(R"(Bind variable name "%s" was already used in this pattern.)", pattern->bind->name));
  1769. complete_extents(pattern);
  1770. return nullptr;
  1771. }
  1772. }
  1773. if (current_suite->has_local(pattern->bind->name)) {
  1774. push_error(vformat(R"(There's already a %s named "%s" in this scope.)", current_suite->get_local(pattern->bind->name).get_name(), pattern->bind->name));
  1775. complete_extents(pattern);
  1776. return nullptr;
  1777. }
  1778. root_pattern->binds[pattern->bind->name] = pattern->bind;
  1779. } break;
  1780. case GDScriptTokenizer::Token::UNDERSCORE:
  1781. // Wildcard.
  1782. advance();
  1783. pattern->pattern_type = PatternNode::PT_WILDCARD;
  1784. break;
  1785. case GDScriptTokenizer::Token::PERIOD_PERIOD:
  1786. // Rest.
  1787. advance();
  1788. pattern->pattern_type = PatternNode::PT_REST;
  1789. break;
  1790. case GDScriptTokenizer::Token::BRACKET_OPEN: {
  1791. // Array.
  1792. advance();
  1793. pattern->pattern_type = PatternNode::PT_ARRAY;
  1794. if (!check(GDScriptTokenizer::Token::BRACKET_CLOSE)) {
  1795. do {
  1796. PatternNode *sub_pattern = parse_match_pattern(p_root_pattern != nullptr ? p_root_pattern : pattern);
  1797. if (sub_pattern == nullptr) {
  1798. continue;
  1799. }
  1800. if (pattern->rest_used) {
  1801. push_error(R"(The ".." pattern must be the last element in the pattern array.)");
  1802. } else if (sub_pattern->pattern_type == PatternNode::PT_REST) {
  1803. pattern->rest_used = true;
  1804. }
  1805. pattern->array.push_back(sub_pattern);
  1806. } while (match(GDScriptTokenizer::Token::COMMA));
  1807. }
  1808. consume(GDScriptTokenizer::Token::BRACKET_CLOSE, R"(Expected "]" to close the array pattern.)");
  1809. break;
  1810. }
  1811. case GDScriptTokenizer::Token::BRACE_OPEN: {
  1812. // Dictionary.
  1813. advance();
  1814. pattern->pattern_type = PatternNode::PT_DICTIONARY;
  1815. do {
  1816. if (check(GDScriptTokenizer::Token::BRACE_CLOSE) || is_at_end()) {
  1817. break;
  1818. }
  1819. if (match(GDScriptTokenizer::Token::PERIOD_PERIOD)) {
  1820. // Rest.
  1821. if (pattern->rest_used) {
  1822. push_error(R"(The ".." pattern must be the last element in the pattern dictionary.)");
  1823. } else {
  1824. PatternNode *sub_pattern = alloc_node<PatternNode>();
  1825. complete_extents(sub_pattern);
  1826. sub_pattern->pattern_type = PatternNode::PT_REST;
  1827. pattern->dictionary.push_back({ nullptr, sub_pattern });
  1828. pattern->rest_used = true;
  1829. }
  1830. } else {
  1831. ExpressionNode *key = parse_expression(false);
  1832. if (key == nullptr) {
  1833. push_error(R"(Expected expression as key for dictionary pattern.)");
  1834. }
  1835. if (match(GDScriptTokenizer::Token::COLON)) {
  1836. // Value pattern.
  1837. PatternNode *sub_pattern = parse_match_pattern(p_root_pattern != nullptr ? p_root_pattern : pattern);
  1838. if (sub_pattern == nullptr) {
  1839. continue;
  1840. }
  1841. if (pattern->rest_used) {
  1842. push_error(R"(The ".." pattern must be the last element in the pattern dictionary.)");
  1843. } else if (sub_pattern->pattern_type == PatternNode::PT_REST) {
  1844. push_error(R"(The ".." pattern cannot be used as a value.)");
  1845. } else {
  1846. pattern->dictionary.push_back({ key, sub_pattern });
  1847. }
  1848. } else {
  1849. // Key match only.
  1850. pattern->dictionary.push_back({ key, nullptr });
  1851. }
  1852. }
  1853. } while (match(GDScriptTokenizer::Token::COMMA));
  1854. consume(GDScriptTokenizer::Token::BRACE_CLOSE, R"(Expected "}" to close the dictionary pattern.)");
  1855. break;
  1856. }
  1857. default: {
  1858. // Expression.
  1859. ExpressionNode *expression = parse_expression(false);
  1860. if (expression == nullptr) {
  1861. push_error(R"(Expected expression for match pattern.)");
  1862. return nullptr;
  1863. } else {
  1864. if (expression->type == GDScriptParser::Node::LITERAL) {
  1865. pattern->pattern_type = PatternNode::PT_LITERAL;
  1866. } else {
  1867. pattern->pattern_type = PatternNode::PT_EXPRESSION;
  1868. }
  1869. pattern->expression = expression;
  1870. }
  1871. break;
  1872. }
  1873. }
  1874. complete_extents(pattern);
  1875. return pattern;
  1876. }
  1877. bool GDScriptParser::PatternNode::has_bind(const StringName &p_name) {
  1878. return binds.has(p_name);
  1879. }
  1880. GDScriptParser::IdentifierNode *GDScriptParser::PatternNode::get_bind(const StringName &p_name) {
  1881. return binds[p_name];
  1882. }
  1883. GDScriptParser::WhileNode *GDScriptParser::parse_while() {
  1884. WhileNode *n_while = alloc_node<WhileNode>();
  1885. n_while->condition = parse_expression(false);
  1886. if (n_while->condition == nullptr) {
  1887. push_error(R"(Expected conditional expression after "while".)");
  1888. }
  1889. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "while" condition.)");
  1890. // Save break/continue state.
  1891. bool could_break = can_break;
  1892. bool could_continue = can_continue;
  1893. // Allow break/continue.
  1894. can_break = true;
  1895. can_continue = true;
  1896. n_while->loop = parse_suite(R"("while" block)");
  1897. n_while->loop->is_loop = true;
  1898. complete_extents(n_while);
  1899. // Reset break/continue state.
  1900. can_break = could_break;
  1901. can_continue = could_continue;
  1902. return n_while;
  1903. }
  1904. GDScriptParser::ExpressionNode *GDScriptParser::parse_precedence(Precedence p_precedence, bool p_can_assign, bool p_stop_on_assign) {
  1905. // Switch multiline mode on for grouping tokens.
  1906. // Do this early to avoid the tokenizer generating whitespace tokens.
  1907. switch (current.type) {
  1908. case GDScriptTokenizer::Token::PARENTHESIS_OPEN:
  1909. case GDScriptTokenizer::Token::BRACE_OPEN:
  1910. case GDScriptTokenizer::Token::BRACKET_OPEN:
  1911. push_multiline(true);
  1912. break;
  1913. default:
  1914. break; // Nothing to do.
  1915. }
  1916. // Completion can appear whenever an expression is expected.
  1917. make_completion_context(COMPLETION_IDENTIFIER, nullptr);
  1918. GDScriptTokenizer::Token token = current;
  1919. GDScriptTokenizer::Token::Type token_type = token.type;
  1920. if (token.is_identifier()) {
  1921. // Allow keywords that can be treated as identifiers.
  1922. token_type = GDScriptTokenizer::Token::IDENTIFIER;
  1923. }
  1924. ParseFunction prefix_rule = get_rule(token_type)->prefix;
  1925. if (prefix_rule == nullptr) {
  1926. // Expected expression. Let the caller give the proper error message.
  1927. return nullptr;
  1928. }
  1929. advance(); // Only consume the token if there's a valid rule.
  1930. ExpressionNode *previous_operand = (this->*prefix_rule)(nullptr, p_can_assign);
  1931. while (p_precedence <= get_rule(current.type)->precedence) {
  1932. if (previous_operand == nullptr || (p_stop_on_assign && current.type == GDScriptTokenizer::Token::EQUAL) || (previous_operand->type == Node::LAMBDA && lambda_ended)) {
  1933. return previous_operand;
  1934. }
  1935. // Also switch multiline mode on here for infix operators.
  1936. switch (current.type) {
  1937. // case GDScriptTokenizer::Token::BRACE_OPEN: // Not an infix operator.
  1938. case GDScriptTokenizer::Token::PARENTHESIS_OPEN:
  1939. case GDScriptTokenizer::Token::BRACKET_OPEN:
  1940. push_multiline(true);
  1941. break;
  1942. default:
  1943. break; // Nothing to do.
  1944. }
  1945. token = advance();
  1946. ParseFunction infix_rule = get_rule(token.type)->infix;
  1947. previous_operand = (this->*infix_rule)(previous_operand, p_can_assign);
  1948. }
  1949. return previous_operand;
  1950. }
  1951. GDScriptParser::ExpressionNode *GDScriptParser::parse_expression(bool p_can_assign, bool p_stop_on_assign) {
  1952. return parse_precedence(PREC_ASSIGNMENT, p_can_assign, p_stop_on_assign);
  1953. }
  1954. GDScriptParser::IdentifierNode *GDScriptParser::parse_identifier() {
  1955. IdentifierNode *identifier = static_cast<IdentifierNode *>(parse_identifier(nullptr, false));
  1956. #ifdef DEBUG_ENABLED
  1957. // Check for spoofing here (if available in TextServer) since this isn't called inside expressions. This is only relevant for declarations.
  1958. if (identifier && TS->has_feature(TextServer::FEATURE_UNICODE_SECURITY) && TS->spoof_check(identifier->name.operator String())) {
  1959. push_warning(identifier, GDScriptWarning::CONFUSABLE_IDENTIFIER, identifier->name.operator String());
  1960. }
  1961. #endif
  1962. return identifier;
  1963. }
  1964. GDScriptParser::ExpressionNode *GDScriptParser::parse_identifier(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1965. if (!previous.is_identifier()) {
  1966. ERR_FAIL_V_MSG(nullptr, "Parser bug: parsing identifier node without identifier token.");
  1967. }
  1968. IdentifierNode *identifier = alloc_node<IdentifierNode>();
  1969. complete_extents(identifier);
  1970. identifier->name = previous.get_identifier();
  1971. if (current_suite != nullptr && current_suite->has_local(identifier->name)) {
  1972. const SuiteNode::Local &declaration = current_suite->get_local(identifier->name);
  1973. identifier->source_function = declaration.source_function;
  1974. switch (declaration.type) {
  1975. case SuiteNode::Local::CONSTANT:
  1976. identifier->source = IdentifierNode::LOCAL_CONSTANT;
  1977. identifier->constant_source = declaration.constant;
  1978. declaration.constant->usages++;
  1979. break;
  1980. case SuiteNode::Local::VARIABLE:
  1981. identifier->source = IdentifierNode::LOCAL_VARIABLE;
  1982. identifier->variable_source = declaration.variable;
  1983. declaration.variable->usages++;
  1984. break;
  1985. case SuiteNode::Local::PARAMETER:
  1986. identifier->source = IdentifierNode::FUNCTION_PARAMETER;
  1987. identifier->parameter_source = declaration.parameter;
  1988. declaration.parameter->usages++;
  1989. break;
  1990. case SuiteNode::Local::FOR_VARIABLE:
  1991. identifier->source = IdentifierNode::LOCAL_ITERATOR;
  1992. identifier->bind_source = declaration.bind;
  1993. declaration.bind->usages++;
  1994. break;
  1995. case SuiteNode::Local::PATTERN_BIND:
  1996. identifier->source = IdentifierNode::LOCAL_BIND;
  1997. identifier->bind_source = declaration.bind;
  1998. declaration.bind->usages++;
  1999. break;
  2000. case SuiteNode::Local::UNDEFINED:
  2001. ERR_FAIL_V_MSG(nullptr, "Undefined local found.");
  2002. }
  2003. }
  2004. return identifier;
  2005. }
  2006. GDScriptParser::LiteralNode *GDScriptParser::parse_literal() {
  2007. return static_cast<LiteralNode *>(parse_literal(nullptr, false));
  2008. }
  2009. GDScriptParser::ExpressionNode *GDScriptParser::parse_literal(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2010. if (previous.type != GDScriptTokenizer::Token::LITERAL) {
  2011. push_error("Parser bug: parsing literal node without literal token.");
  2012. ERR_FAIL_V_MSG(nullptr, "Parser bug: parsing literal node without literal token.");
  2013. }
  2014. LiteralNode *literal = alloc_node<LiteralNode>();
  2015. complete_extents(literal);
  2016. literal->value = previous.literal;
  2017. return literal;
  2018. }
  2019. GDScriptParser::ExpressionNode *GDScriptParser::parse_self(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2020. if (current_function && current_function->is_static) {
  2021. push_error(R"(Cannot use "self" inside a static function.)");
  2022. }
  2023. SelfNode *self = alloc_node<SelfNode>();
  2024. complete_extents(self);
  2025. self->current_class = current_class;
  2026. return self;
  2027. }
  2028. GDScriptParser::ExpressionNode *GDScriptParser::parse_builtin_constant(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2029. GDScriptTokenizer::Token::Type op_type = previous.type;
  2030. LiteralNode *constant = alloc_node<LiteralNode>();
  2031. complete_extents(constant);
  2032. switch (op_type) {
  2033. case GDScriptTokenizer::Token::CONST_PI:
  2034. constant->value = Math_PI;
  2035. break;
  2036. case GDScriptTokenizer::Token::CONST_TAU:
  2037. constant->value = Math_TAU;
  2038. break;
  2039. case GDScriptTokenizer::Token::CONST_INF:
  2040. constant->value = INFINITY;
  2041. break;
  2042. case GDScriptTokenizer::Token::CONST_NAN:
  2043. constant->value = NAN;
  2044. break;
  2045. default:
  2046. return nullptr; // Unreachable.
  2047. }
  2048. return constant;
  2049. }
  2050. GDScriptParser::ExpressionNode *GDScriptParser::parse_unary_operator(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2051. GDScriptTokenizer::Token::Type op_type = previous.type;
  2052. UnaryOpNode *operation = alloc_node<UnaryOpNode>();
  2053. switch (op_type) {
  2054. case GDScriptTokenizer::Token::MINUS:
  2055. operation->operation = UnaryOpNode::OP_NEGATIVE;
  2056. operation->variant_op = Variant::OP_NEGATE;
  2057. operation->operand = parse_precedence(PREC_SIGN, false);
  2058. if (operation->operand == nullptr) {
  2059. push_error(R"(Expected expression after "-" operator.)");
  2060. }
  2061. break;
  2062. case GDScriptTokenizer::Token::PLUS:
  2063. operation->operation = UnaryOpNode::OP_POSITIVE;
  2064. operation->variant_op = Variant::OP_POSITIVE;
  2065. operation->operand = parse_precedence(PREC_SIGN, false);
  2066. if (operation->operand == nullptr) {
  2067. push_error(R"(Expected expression after "+" operator.)");
  2068. }
  2069. break;
  2070. case GDScriptTokenizer::Token::TILDE:
  2071. operation->operation = UnaryOpNode::OP_COMPLEMENT;
  2072. operation->variant_op = Variant::OP_BIT_NEGATE;
  2073. operation->operand = parse_precedence(PREC_BIT_NOT, false);
  2074. if (operation->operand == nullptr) {
  2075. push_error(R"(Expected expression after "~" operator.)");
  2076. }
  2077. break;
  2078. case GDScriptTokenizer::Token::NOT:
  2079. case GDScriptTokenizer::Token::BANG:
  2080. operation->operation = UnaryOpNode::OP_LOGIC_NOT;
  2081. operation->variant_op = Variant::OP_NOT;
  2082. operation->operand = parse_precedence(PREC_LOGIC_NOT, false);
  2083. if (operation->operand == nullptr) {
  2084. push_error(vformat(R"(Expected expression after "%s" operator.)", op_type == GDScriptTokenizer::Token::NOT ? "not" : "!"));
  2085. }
  2086. break;
  2087. default:
  2088. complete_extents(operation);
  2089. return nullptr; // Unreachable.
  2090. }
  2091. complete_extents(operation);
  2092. return operation;
  2093. }
  2094. GDScriptParser::ExpressionNode *GDScriptParser::parse_binary_not_in_operator(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2095. // check that NOT is followed by IN by consuming it before calling parse_binary_operator which will only receive a plain IN
  2096. UnaryOpNode *operation = alloc_node<UnaryOpNode>();
  2097. reset_extents(operation, p_previous_operand);
  2098. update_extents(operation);
  2099. consume(GDScriptTokenizer::Token::IN, R"(Expected "in" after "not" in content-test operator.)");
  2100. ExpressionNode *in_operation = parse_binary_operator(p_previous_operand, p_can_assign);
  2101. operation->operation = UnaryOpNode::OP_LOGIC_NOT;
  2102. operation->variant_op = Variant::OP_NOT;
  2103. operation->operand = in_operation;
  2104. complete_extents(operation);
  2105. return operation;
  2106. }
  2107. GDScriptParser::ExpressionNode *GDScriptParser::parse_binary_operator(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2108. GDScriptTokenizer::Token op = previous;
  2109. BinaryOpNode *operation = alloc_node<BinaryOpNode>();
  2110. reset_extents(operation, p_previous_operand);
  2111. update_extents(operation);
  2112. Precedence precedence = (Precedence)(get_rule(op.type)->precedence + 1);
  2113. operation->left_operand = p_previous_operand;
  2114. operation->right_operand = parse_precedence(precedence, false);
  2115. complete_extents(operation);
  2116. if (operation->right_operand == nullptr) {
  2117. push_error(vformat(R"(Expected expression after "%s" operator.")", op.get_name()));
  2118. }
  2119. // TODO: Also for unary, ternary, and assignment.
  2120. switch (op.type) {
  2121. case GDScriptTokenizer::Token::PLUS:
  2122. operation->operation = BinaryOpNode::OP_ADDITION;
  2123. operation->variant_op = Variant::OP_ADD;
  2124. break;
  2125. case GDScriptTokenizer::Token::MINUS:
  2126. operation->operation = BinaryOpNode::OP_SUBTRACTION;
  2127. operation->variant_op = Variant::OP_SUBTRACT;
  2128. break;
  2129. case GDScriptTokenizer::Token::STAR:
  2130. operation->operation = BinaryOpNode::OP_MULTIPLICATION;
  2131. operation->variant_op = Variant::OP_MULTIPLY;
  2132. break;
  2133. case GDScriptTokenizer::Token::SLASH:
  2134. operation->operation = BinaryOpNode::OP_DIVISION;
  2135. operation->variant_op = Variant::OP_DIVIDE;
  2136. break;
  2137. case GDScriptTokenizer::Token::PERCENT:
  2138. operation->operation = BinaryOpNode::OP_MODULO;
  2139. operation->variant_op = Variant::OP_MODULE;
  2140. break;
  2141. case GDScriptTokenizer::Token::STAR_STAR:
  2142. operation->operation = BinaryOpNode::OP_POWER;
  2143. operation->variant_op = Variant::OP_POWER;
  2144. break;
  2145. case GDScriptTokenizer::Token::LESS_LESS:
  2146. operation->operation = BinaryOpNode::OP_BIT_LEFT_SHIFT;
  2147. operation->variant_op = Variant::OP_SHIFT_LEFT;
  2148. break;
  2149. case GDScriptTokenizer::Token::GREATER_GREATER:
  2150. operation->operation = BinaryOpNode::OP_BIT_RIGHT_SHIFT;
  2151. operation->variant_op = Variant::OP_SHIFT_RIGHT;
  2152. break;
  2153. case GDScriptTokenizer::Token::AMPERSAND:
  2154. operation->operation = BinaryOpNode::OP_BIT_AND;
  2155. operation->variant_op = Variant::OP_BIT_AND;
  2156. break;
  2157. case GDScriptTokenizer::Token::PIPE:
  2158. operation->operation = BinaryOpNode::OP_BIT_OR;
  2159. operation->variant_op = Variant::OP_BIT_OR;
  2160. break;
  2161. case GDScriptTokenizer::Token::CARET:
  2162. operation->operation = BinaryOpNode::OP_BIT_XOR;
  2163. operation->variant_op = Variant::OP_BIT_XOR;
  2164. break;
  2165. case GDScriptTokenizer::Token::AND:
  2166. case GDScriptTokenizer::Token::AMPERSAND_AMPERSAND:
  2167. operation->operation = BinaryOpNode::OP_LOGIC_AND;
  2168. operation->variant_op = Variant::OP_AND;
  2169. break;
  2170. case GDScriptTokenizer::Token::OR:
  2171. case GDScriptTokenizer::Token::PIPE_PIPE:
  2172. operation->operation = BinaryOpNode::OP_LOGIC_OR;
  2173. operation->variant_op = Variant::OP_OR;
  2174. break;
  2175. case GDScriptTokenizer::Token::IN:
  2176. operation->operation = BinaryOpNode::OP_CONTENT_TEST;
  2177. operation->variant_op = Variant::OP_IN;
  2178. break;
  2179. case GDScriptTokenizer::Token::EQUAL_EQUAL:
  2180. operation->operation = BinaryOpNode::OP_COMP_EQUAL;
  2181. operation->variant_op = Variant::OP_EQUAL;
  2182. break;
  2183. case GDScriptTokenizer::Token::BANG_EQUAL:
  2184. operation->operation = BinaryOpNode::OP_COMP_NOT_EQUAL;
  2185. operation->variant_op = Variant::OP_NOT_EQUAL;
  2186. break;
  2187. case GDScriptTokenizer::Token::LESS:
  2188. operation->operation = BinaryOpNode::OP_COMP_LESS;
  2189. operation->variant_op = Variant::OP_LESS;
  2190. break;
  2191. case GDScriptTokenizer::Token::LESS_EQUAL:
  2192. operation->operation = BinaryOpNode::OP_COMP_LESS_EQUAL;
  2193. operation->variant_op = Variant::OP_LESS_EQUAL;
  2194. break;
  2195. case GDScriptTokenizer::Token::GREATER:
  2196. operation->operation = BinaryOpNode::OP_COMP_GREATER;
  2197. operation->variant_op = Variant::OP_GREATER;
  2198. break;
  2199. case GDScriptTokenizer::Token::GREATER_EQUAL:
  2200. operation->operation = BinaryOpNode::OP_COMP_GREATER_EQUAL;
  2201. operation->variant_op = Variant::OP_GREATER_EQUAL;
  2202. break;
  2203. default:
  2204. return nullptr; // Unreachable.
  2205. }
  2206. return operation;
  2207. }
  2208. GDScriptParser::ExpressionNode *GDScriptParser::parse_ternary_operator(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2209. // Only one ternary operation exists, so no abstraction here.
  2210. TernaryOpNode *operation = alloc_node<TernaryOpNode>();
  2211. reset_extents(operation, p_previous_operand);
  2212. update_extents(operation);
  2213. operation->true_expr = p_previous_operand;
  2214. operation->condition = parse_precedence(PREC_TERNARY, false);
  2215. if (operation->condition == nullptr) {
  2216. push_error(R"(Expected expression as ternary condition after "if".)");
  2217. }
  2218. consume(GDScriptTokenizer::Token::ELSE, R"(Expected "else" after ternary operator condition.)");
  2219. operation->false_expr = parse_precedence(PREC_TERNARY, false);
  2220. if (operation->false_expr == nullptr) {
  2221. push_error(R"(Expected expression after "else".)");
  2222. }
  2223. complete_extents(operation);
  2224. return operation;
  2225. }
  2226. GDScriptParser::ExpressionNode *GDScriptParser::parse_assignment(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2227. if (!p_can_assign) {
  2228. push_error("Assignment is not allowed inside an expression.");
  2229. return parse_expression(false); // Return the following expression.
  2230. }
  2231. if (p_previous_operand == nullptr) {
  2232. return parse_expression(false); // Return the following expression.
  2233. }
  2234. #ifdef DEBUG_ENABLED
  2235. VariableNode *source_variable = nullptr;
  2236. #endif
  2237. switch (p_previous_operand->type) {
  2238. case Node::IDENTIFIER: {
  2239. #ifdef DEBUG_ENABLED
  2240. // Get source to store assignment count.
  2241. // Also remove one usage since assignment isn't usage.
  2242. IdentifierNode *id = static_cast<IdentifierNode *>(p_previous_operand);
  2243. switch (id->source) {
  2244. case IdentifierNode::LOCAL_VARIABLE:
  2245. source_variable = id->variable_source;
  2246. id->variable_source->usages--;
  2247. break;
  2248. case IdentifierNode::LOCAL_CONSTANT:
  2249. id->constant_source->usages--;
  2250. break;
  2251. case IdentifierNode::FUNCTION_PARAMETER:
  2252. id->parameter_source->usages--;
  2253. break;
  2254. case IdentifierNode::LOCAL_ITERATOR:
  2255. case IdentifierNode::LOCAL_BIND:
  2256. id->bind_source->usages--;
  2257. break;
  2258. default:
  2259. break;
  2260. }
  2261. #endif
  2262. } break;
  2263. case Node::SUBSCRIPT:
  2264. // Okay.
  2265. break;
  2266. default:
  2267. push_error(R"(Only identifier, attribute access, and subscription access can be used as assignment target.)");
  2268. return parse_expression(false); // Return the following expression.
  2269. }
  2270. AssignmentNode *assignment = alloc_node<AssignmentNode>();
  2271. reset_extents(assignment, p_previous_operand);
  2272. update_extents(assignment);
  2273. make_completion_context(COMPLETION_ASSIGN, assignment);
  2274. #ifdef DEBUG_ENABLED
  2275. bool has_operator = true;
  2276. #endif
  2277. switch (previous.type) {
  2278. case GDScriptTokenizer::Token::EQUAL:
  2279. assignment->operation = AssignmentNode::OP_NONE;
  2280. assignment->variant_op = Variant::OP_MAX;
  2281. #ifdef DEBUG_ENABLED
  2282. has_operator = false;
  2283. #endif
  2284. break;
  2285. case GDScriptTokenizer::Token::PLUS_EQUAL:
  2286. assignment->operation = AssignmentNode::OP_ADDITION;
  2287. assignment->variant_op = Variant::OP_ADD;
  2288. break;
  2289. case GDScriptTokenizer::Token::MINUS_EQUAL:
  2290. assignment->operation = AssignmentNode::OP_SUBTRACTION;
  2291. assignment->variant_op = Variant::OP_SUBTRACT;
  2292. break;
  2293. case GDScriptTokenizer::Token::STAR_EQUAL:
  2294. assignment->operation = AssignmentNode::OP_MULTIPLICATION;
  2295. assignment->variant_op = Variant::OP_MULTIPLY;
  2296. break;
  2297. case GDScriptTokenizer::Token::STAR_STAR_EQUAL:
  2298. assignment->operation = AssignmentNode::OP_POWER;
  2299. assignment->variant_op = Variant::OP_POWER;
  2300. break;
  2301. case GDScriptTokenizer::Token::SLASH_EQUAL:
  2302. assignment->operation = AssignmentNode::OP_DIVISION;
  2303. assignment->variant_op = Variant::OP_DIVIDE;
  2304. break;
  2305. case GDScriptTokenizer::Token::PERCENT_EQUAL:
  2306. assignment->operation = AssignmentNode::OP_MODULO;
  2307. assignment->variant_op = Variant::OP_MODULE;
  2308. break;
  2309. case GDScriptTokenizer::Token::LESS_LESS_EQUAL:
  2310. assignment->operation = AssignmentNode::OP_BIT_SHIFT_LEFT;
  2311. assignment->variant_op = Variant::OP_SHIFT_LEFT;
  2312. break;
  2313. case GDScriptTokenizer::Token::GREATER_GREATER_EQUAL:
  2314. assignment->operation = AssignmentNode::OP_BIT_SHIFT_RIGHT;
  2315. assignment->variant_op = Variant::OP_SHIFT_RIGHT;
  2316. break;
  2317. case GDScriptTokenizer::Token::AMPERSAND_EQUAL:
  2318. assignment->operation = AssignmentNode::OP_BIT_AND;
  2319. assignment->variant_op = Variant::OP_BIT_AND;
  2320. break;
  2321. case GDScriptTokenizer::Token::PIPE_EQUAL:
  2322. assignment->operation = AssignmentNode::OP_BIT_OR;
  2323. assignment->variant_op = Variant::OP_BIT_OR;
  2324. break;
  2325. case GDScriptTokenizer::Token::CARET_EQUAL:
  2326. assignment->operation = AssignmentNode::OP_BIT_XOR;
  2327. assignment->variant_op = Variant::OP_BIT_XOR;
  2328. break;
  2329. default:
  2330. break; // Unreachable.
  2331. }
  2332. assignment->assignee = p_previous_operand;
  2333. assignment->assigned_value = parse_expression(false);
  2334. if (assignment->assigned_value == nullptr) {
  2335. push_error(R"(Expected an expression after "=".)");
  2336. }
  2337. complete_extents(assignment);
  2338. #ifdef DEBUG_ENABLED
  2339. if (source_variable != nullptr) {
  2340. if (has_operator && source_variable->assignments == 0) {
  2341. push_warning(assignment, GDScriptWarning::UNASSIGNED_VARIABLE_OP_ASSIGN, source_variable->identifier->name);
  2342. }
  2343. source_variable->assignments += 1;
  2344. }
  2345. #endif
  2346. return assignment;
  2347. }
  2348. GDScriptParser::ExpressionNode *GDScriptParser::parse_await(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2349. AwaitNode *await = alloc_node<AwaitNode>();
  2350. ExpressionNode *element = parse_precedence(PREC_AWAIT, false);
  2351. if (element == nullptr) {
  2352. push_error(R"(Expected signal or coroutine after "await".)");
  2353. }
  2354. await->to_await = element;
  2355. complete_extents(await);
  2356. if (current_function) { // Might be null in a getter or setter.
  2357. current_function->is_coroutine = true;
  2358. }
  2359. return await;
  2360. }
  2361. GDScriptParser::ExpressionNode *GDScriptParser::parse_array(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2362. ArrayNode *array = alloc_node<ArrayNode>();
  2363. if (!check(GDScriptTokenizer::Token::BRACKET_CLOSE)) {
  2364. do {
  2365. if (check(GDScriptTokenizer::Token::BRACKET_CLOSE)) {
  2366. // Allow for trailing comma.
  2367. break;
  2368. }
  2369. ExpressionNode *element = parse_expression(false);
  2370. if (element == nullptr) {
  2371. push_error(R"(Expected expression as array element.)");
  2372. } else {
  2373. array->elements.push_back(element);
  2374. }
  2375. } while (match(GDScriptTokenizer::Token::COMMA) && !is_at_end());
  2376. }
  2377. pop_multiline();
  2378. consume(GDScriptTokenizer::Token::BRACKET_CLOSE, R"(Expected closing "]" after array elements.)");
  2379. complete_extents(array);
  2380. return array;
  2381. }
  2382. GDScriptParser::ExpressionNode *GDScriptParser::parse_dictionary(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2383. DictionaryNode *dictionary = alloc_node<DictionaryNode>();
  2384. bool decided_style = false;
  2385. if (!check(GDScriptTokenizer::Token::BRACE_CLOSE)) {
  2386. do {
  2387. if (check(GDScriptTokenizer::Token::BRACE_CLOSE)) {
  2388. // Allow for trailing comma.
  2389. break;
  2390. }
  2391. // Key.
  2392. ExpressionNode *key = parse_expression(false, true); // Stop on "=" so we can check for Lua table style.
  2393. if (key == nullptr) {
  2394. push_error(R"(Expected expression as dictionary key.)");
  2395. }
  2396. if (!decided_style) {
  2397. switch (current.type) {
  2398. case GDScriptTokenizer::Token::COLON:
  2399. dictionary->style = DictionaryNode::PYTHON_DICT;
  2400. break;
  2401. case GDScriptTokenizer::Token::EQUAL:
  2402. dictionary->style = DictionaryNode::LUA_TABLE;
  2403. break;
  2404. default:
  2405. push_error(R"(Expected ":" or "=" after dictionary key.)");
  2406. break;
  2407. }
  2408. decided_style = true;
  2409. }
  2410. switch (dictionary->style) {
  2411. case DictionaryNode::LUA_TABLE:
  2412. if (key != nullptr && key->type != Node::IDENTIFIER && key->type != Node::LITERAL) {
  2413. push_error("Expected identifier or string as LUA-style dictionary key.");
  2414. advance();
  2415. break;
  2416. }
  2417. if (key != nullptr && key->type == Node::LITERAL && static_cast<LiteralNode *>(key)->value.get_type() != Variant::STRING) {
  2418. push_error("Expected identifier or string as LUA-style dictionary key.");
  2419. advance();
  2420. break;
  2421. }
  2422. if (!match(GDScriptTokenizer::Token::EQUAL)) {
  2423. if (match(GDScriptTokenizer::Token::COLON)) {
  2424. push_error(R"(Expected "=" after dictionary key. Mixing dictionary styles is not allowed.)");
  2425. advance(); // Consume wrong separator anyway.
  2426. } else {
  2427. push_error(R"(Expected "=" after dictionary key.)");
  2428. }
  2429. }
  2430. if (key != nullptr) {
  2431. key->is_constant = true;
  2432. if (key->type == Node::IDENTIFIER) {
  2433. key->reduced_value = static_cast<IdentifierNode *>(key)->name;
  2434. } else if (key->type == Node::LITERAL) {
  2435. key->reduced_value = StringName(static_cast<LiteralNode *>(key)->value.operator String());
  2436. }
  2437. }
  2438. break;
  2439. case DictionaryNode::PYTHON_DICT:
  2440. if (!match(GDScriptTokenizer::Token::COLON)) {
  2441. if (match(GDScriptTokenizer::Token::EQUAL)) {
  2442. push_error(R"(Expected ":" after dictionary key. Mixing dictionary styles is not allowed.)");
  2443. advance(); // Consume wrong separator anyway.
  2444. } else {
  2445. push_error(R"(Expected ":" after dictionary key.)");
  2446. }
  2447. }
  2448. break;
  2449. }
  2450. // Value.
  2451. ExpressionNode *value = parse_expression(false);
  2452. if (value == nullptr) {
  2453. push_error(R"(Expected expression as dictionary value.)");
  2454. }
  2455. if (key != nullptr && value != nullptr) {
  2456. dictionary->elements.push_back({ key, value });
  2457. }
  2458. } while (match(GDScriptTokenizer::Token::COMMA) && !is_at_end());
  2459. }
  2460. pop_multiline();
  2461. consume(GDScriptTokenizer::Token::BRACE_CLOSE, R"(Expected closing "}" after dictionary elements.)");
  2462. complete_extents(dictionary);
  2463. return dictionary;
  2464. }
  2465. GDScriptParser::ExpressionNode *GDScriptParser::parse_grouping(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2466. ExpressionNode *grouped = parse_expression(false);
  2467. pop_multiline();
  2468. if (grouped == nullptr) {
  2469. push_error(R"(Expected grouping expression.)");
  2470. } else {
  2471. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected closing ")" after grouping expression.)*");
  2472. }
  2473. return grouped;
  2474. }
  2475. GDScriptParser::ExpressionNode *GDScriptParser::parse_attribute(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2476. SubscriptNode *attribute = alloc_node<SubscriptNode>();
  2477. reset_extents(attribute, p_previous_operand);
  2478. update_extents(attribute);
  2479. if (for_completion) {
  2480. bool is_builtin = false;
  2481. if (p_previous_operand && p_previous_operand->type == Node::IDENTIFIER) {
  2482. const IdentifierNode *id = static_cast<const IdentifierNode *>(p_previous_operand);
  2483. Variant::Type builtin_type = get_builtin_type(id->name);
  2484. if (builtin_type < Variant::VARIANT_MAX) {
  2485. make_completion_context(COMPLETION_BUILT_IN_TYPE_CONSTANT_OR_STATIC_METHOD, builtin_type, true);
  2486. is_builtin = true;
  2487. }
  2488. }
  2489. if (!is_builtin) {
  2490. make_completion_context(COMPLETION_ATTRIBUTE, attribute, -1, true);
  2491. }
  2492. }
  2493. attribute->base = p_previous_operand;
  2494. if (current.is_node_name()) {
  2495. current.type = GDScriptTokenizer::Token::IDENTIFIER;
  2496. }
  2497. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected identifier after "." for attribute access.)")) {
  2498. complete_extents(attribute);
  2499. return attribute;
  2500. }
  2501. attribute->is_attribute = true;
  2502. attribute->attribute = parse_identifier();
  2503. complete_extents(attribute);
  2504. return attribute;
  2505. }
  2506. GDScriptParser::ExpressionNode *GDScriptParser::parse_subscript(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2507. SubscriptNode *subscript = alloc_node<SubscriptNode>();
  2508. reset_extents(subscript, p_previous_operand);
  2509. update_extents(subscript);
  2510. make_completion_context(COMPLETION_SUBSCRIPT, subscript);
  2511. subscript->base = p_previous_operand;
  2512. subscript->index = parse_expression(false);
  2513. if (subscript->index == nullptr) {
  2514. push_error(R"(Expected expression after "[".)");
  2515. }
  2516. pop_multiline();
  2517. consume(GDScriptTokenizer::Token::BRACKET_CLOSE, R"(Expected "]" after subscription index.)");
  2518. complete_extents(subscript);
  2519. return subscript;
  2520. }
  2521. GDScriptParser::ExpressionNode *GDScriptParser::parse_cast(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2522. CastNode *cast = alloc_node<CastNode>();
  2523. reset_extents(cast, p_previous_operand);
  2524. update_extents(cast);
  2525. cast->operand = p_previous_operand;
  2526. cast->cast_type = parse_type();
  2527. complete_extents(cast);
  2528. if (cast->cast_type == nullptr) {
  2529. push_error(R"(Expected type specifier after "as".)");
  2530. return p_previous_operand;
  2531. }
  2532. return cast;
  2533. }
  2534. GDScriptParser::ExpressionNode *GDScriptParser::parse_call(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2535. CallNode *call = alloc_node<CallNode>();
  2536. reset_extents(call, p_previous_operand);
  2537. if (previous.type == GDScriptTokenizer::Token::SUPER) {
  2538. // Super call.
  2539. call->is_super = true;
  2540. push_multiline(true);
  2541. if (match(GDScriptTokenizer::Token::PARENTHESIS_OPEN)) {
  2542. // Implicit call to the parent method of the same name.
  2543. if (current_function == nullptr) {
  2544. push_error(R"(Cannot use implicit "super" call outside of a function.)");
  2545. pop_multiline();
  2546. complete_extents(call);
  2547. return nullptr;
  2548. }
  2549. if (current_function->identifier) {
  2550. call->function_name = current_function->identifier->name;
  2551. } else {
  2552. call->function_name = SNAME("<anonymous>");
  2553. }
  2554. } else {
  2555. consume(GDScriptTokenizer::Token::PERIOD, R"(Expected "." or "(" after "super".)");
  2556. make_completion_context(COMPLETION_SUPER_METHOD, call, true);
  2557. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected function name after ".".)")) {
  2558. pop_multiline();
  2559. complete_extents(call);
  2560. return nullptr;
  2561. }
  2562. IdentifierNode *identifier = parse_identifier();
  2563. call->callee = identifier;
  2564. call->function_name = identifier->name;
  2565. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected "(" after function name.)");
  2566. }
  2567. } else {
  2568. call->callee = p_previous_operand;
  2569. if (call->callee == nullptr) {
  2570. push_error(R"*(Cannot call on an expression. Use ".call()" if it's a Callable.)*");
  2571. } else if (call->callee->type == Node::IDENTIFIER) {
  2572. call->function_name = static_cast<IdentifierNode *>(call->callee)->name;
  2573. make_completion_context(COMPLETION_METHOD, call->callee);
  2574. } else if (call->callee->type == Node::SUBSCRIPT) {
  2575. SubscriptNode *attribute = static_cast<SubscriptNode *>(call->callee);
  2576. if (attribute->is_attribute) {
  2577. if (attribute->attribute) {
  2578. call->function_name = attribute->attribute->name;
  2579. }
  2580. make_completion_context(COMPLETION_ATTRIBUTE_METHOD, call->callee);
  2581. } else {
  2582. // TODO: The analyzer can see if this is actually a Callable and give better error message.
  2583. push_error(R"*(Cannot call on an expression. Use ".call()" if it's a Callable.)*");
  2584. }
  2585. } else {
  2586. push_error(R"*(Cannot call on an expression. Use ".call()" if it's a Callable.)*");
  2587. }
  2588. }
  2589. // Arguments.
  2590. CompletionType ct = COMPLETION_CALL_ARGUMENTS;
  2591. if (call->function_name == SNAME("load")) {
  2592. ct = COMPLETION_RESOURCE_PATH;
  2593. }
  2594. push_completion_call(call);
  2595. int argument_index = 0;
  2596. do {
  2597. make_completion_context(ct, call, argument_index++, true);
  2598. if (check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE)) {
  2599. // Allow for trailing comma.
  2600. break;
  2601. }
  2602. bool use_identifier_completion = current.cursor_place == GDScriptTokenizer::CURSOR_END || current.cursor_place == GDScriptTokenizer::CURSOR_MIDDLE;
  2603. ExpressionNode *argument = parse_expression(false);
  2604. if (argument == nullptr) {
  2605. push_error(R"(Expected expression as the function argument.)");
  2606. } else {
  2607. call->arguments.push_back(argument);
  2608. if (argument->type == Node::IDENTIFIER && use_identifier_completion) {
  2609. completion_context.type = COMPLETION_IDENTIFIER;
  2610. }
  2611. }
  2612. ct = COMPLETION_CALL_ARGUMENTS;
  2613. } while (match(GDScriptTokenizer::Token::COMMA));
  2614. pop_completion_call();
  2615. pop_multiline();
  2616. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected closing ")" after call arguments.)*");
  2617. complete_extents(call);
  2618. return call;
  2619. }
  2620. GDScriptParser::ExpressionNode *GDScriptParser::parse_get_node(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2621. if (!current.is_node_name() && !check(GDScriptTokenizer::Token::LITERAL) && !check(GDScriptTokenizer::Token::SLASH) && !check(GDScriptTokenizer::Token::PERCENT)) {
  2622. push_error(vformat(R"(Expected node path as string or identifier after "%s".)", previous.get_name()));
  2623. return nullptr;
  2624. }
  2625. if (check(GDScriptTokenizer::Token::LITERAL)) {
  2626. if (current.literal.get_type() != Variant::STRING) {
  2627. push_error(vformat(R"(Expected node path as string or identifier after "%s".)", previous.get_name()));
  2628. return nullptr;
  2629. }
  2630. }
  2631. GetNodeNode *get_node = alloc_node<GetNodeNode>();
  2632. // Store the last item in the path so the parser knows what to expect.
  2633. // Allow allows more specific error messages.
  2634. enum PathState {
  2635. PATH_STATE_START,
  2636. PATH_STATE_SLASH,
  2637. PATH_STATE_PERCENT,
  2638. PATH_STATE_NODE_NAME,
  2639. } path_state = PATH_STATE_START;
  2640. if (previous.type == GDScriptTokenizer::Token::DOLLAR) {
  2641. // Detect initial slash, which will be handled in the loop if it matches.
  2642. match(GDScriptTokenizer::Token::SLASH);
  2643. #ifdef DEBUG_ENABLED
  2644. } else {
  2645. get_node->use_dollar = false;
  2646. #endif
  2647. }
  2648. int context_argument = 0;
  2649. do {
  2650. if (previous.type == GDScriptTokenizer::Token::PERCENT) {
  2651. if (path_state != PATH_STATE_START && path_state != PATH_STATE_SLASH) {
  2652. push_error(R"("%" is only valid in the beginning of a node name (either after "$" or after "/"))");
  2653. complete_extents(get_node);
  2654. return nullptr;
  2655. }
  2656. get_node->full_path += "%";
  2657. path_state = PATH_STATE_PERCENT;
  2658. } else if (previous.type == GDScriptTokenizer::Token::SLASH) {
  2659. if (path_state != PATH_STATE_START && path_state != PATH_STATE_NODE_NAME) {
  2660. push_error(R"("/" is only valid at the beginning of the path or after a node name.)");
  2661. complete_extents(get_node);
  2662. return nullptr;
  2663. }
  2664. get_node->full_path += "/";
  2665. path_state = PATH_STATE_SLASH;
  2666. }
  2667. make_completion_context(COMPLETION_GET_NODE, get_node, context_argument++);
  2668. if (match(GDScriptTokenizer::Token::LITERAL)) {
  2669. if (previous.literal.get_type() != Variant::STRING) {
  2670. String previous_token;
  2671. switch (path_state) {
  2672. case PATH_STATE_START:
  2673. previous_token = "$";
  2674. break;
  2675. case PATH_STATE_PERCENT:
  2676. previous_token = "%";
  2677. break;
  2678. case PATH_STATE_SLASH:
  2679. previous_token = "/";
  2680. break;
  2681. default:
  2682. break;
  2683. }
  2684. push_error(vformat(R"(Expected node path as string or identifier after "%s".)", previous_token));
  2685. complete_extents(get_node);
  2686. return nullptr;
  2687. }
  2688. get_node->full_path += previous.literal.operator String();
  2689. path_state = PATH_STATE_NODE_NAME;
  2690. } else if (current.is_node_name()) {
  2691. advance();
  2692. String identifier = previous.get_identifier();
  2693. #ifdef DEBUG_ENABLED
  2694. // Check spoofing.
  2695. if (TS->has_feature(TextServer::FEATURE_UNICODE_SECURITY) && TS->spoof_check(identifier)) {
  2696. push_warning(get_node, GDScriptWarning::CONFUSABLE_IDENTIFIER, identifier);
  2697. }
  2698. #endif
  2699. get_node->full_path += identifier;
  2700. path_state = PATH_STATE_NODE_NAME;
  2701. } else if (!check(GDScriptTokenizer::Token::SLASH) && !check(GDScriptTokenizer::Token::PERCENT)) {
  2702. push_error(vformat(R"(Unexpected "%s" in node path.)", current.get_name()));
  2703. complete_extents(get_node);
  2704. return nullptr;
  2705. }
  2706. } while (match(GDScriptTokenizer::Token::SLASH) || match(GDScriptTokenizer::Token::PERCENT));
  2707. complete_extents(get_node);
  2708. return get_node;
  2709. }
  2710. GDScriptParser::ExpressionNode *GDScriptParser::parse_preload(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2711. PreloadNode *preload = alloc_node<PreloadNode>();
  2712. preload->resolved_path = "<missing path>";
  2713. push_multiline(true);
  2714. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected "(" after "preload".)");
  2715. make_completion_context(COMPLETION_RESOURCE_PATH, preload);
  2716. push_completion_call(preload);
  2717. preload->path = parse_expression(false);
  2718. if (preload->path == nullptr) {
  2719. push_error(R"(Expected resource path after "(".)");
  2720. }
  2721. pop_completion_call();
  2722. pop_multiline();
  2723. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected ")" after preload path.)*");
  2724. complete_extents(preload);
  2725. return preload;
  2726. }
  2727. GDScriptParser::ExpressionNode *GDScriptParser::parse_lambda(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2728. LambdaNode *lambda = alloc_node<LambdaNode>();
  2729. lambda->parent_function = current_function;
  2730. FunctionNode *function = alloc_node<FunctionNode>();
  2731. function->source_lambda = lambda;
  2732. function->is_static = current_function != nullptr ? current_function->is_static : false;
  2733. if (match(GDScriptTokenizer::Token::IDENTIFIER)) {
  2734. function->identifier = parse_identifier();
  2735. }
  2736. bool multiline_context = multiline_stack.back()->get();
  2737. // Reset the multiline stack since we don't want the multiline mode one in the lambda body.
  2738. push_multiline(false);
  2739. if (multiline_context) {
  2740. tokenizer.push_expression_indented_block();
  2741. }
  2742. push_multiline(true); // For the parameters.
  2743. if (function->identifier) {
  2744. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected opening "(" after lambda name.)");
  2745. } else {
  2746. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected opening "(" after "func".)");
  2747. }
  2748. FunctionNode *previous_function = current_function;
  2749. current_function = function;
  2750. SuiteNode *body = alloc_node<SuiteNode>();
  2751. body->parent_function = current_function;
  2752. body->parent_block = current_suite;
  2753. SuiteNode *previous_suite = current_suite;
  2754. current_suite = body;
  2755. parse_function_signature(function, body, "lambda");
  2756. current_suite = previous_suite;
  2757. bool previous_in_lambda = in_lambda;
  2758. in_lambda = true;
  2759. // Save break/continue state.
  2760. bool could_break = can_break;
  2761. bool could_continue = can_continue;
  2762. // Disallow break/continue.
  2763. can_break = false;
  2764. can_continue = false;
  2765. function->body = parse_suite("lambda declaration", body, true);
  2766. complete_extents(function);
  2767. complete_extents(lambda);
  2768. pop_multiline();
  2769. if (multiline_context) {
  2770. // If we're in multiline mode, we want to skip the spurious DEDENT and NEWLINE tokens.
  2771. while (check(GDScriptTokenizer::Token::DEDENT) || check(GDScriptTokenizer::Token::INDENT) || check(GDScriptTokenizer::Token::NEWLINE)) {
  2772. current = tokenizer.scan(); // Not advance() since we don't want to change the previous token.
  2773. }
  2774. tokenizer.pop_expression_indented_block();
  2775. }
  2776. current_function = previous_function;
  2777. in_lambda = previous_in_lambda;
  2778. lambda->function = function;
  2779. // Reset break/continue state.
  2780. can_break = could_break;
  2781. can_continue = could_continue;
  2782. return lambda;
  2783. }
  2784. GDScriptParser::ExpressionNode *GDScriptParser::parse_type_test(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2785. TypeTestNode *type_test = alloc_node<TypeTestNode>();
  2786. reset_extents(type_test, p_previous_operand);
  2787. update_extents(type_test);
  2788. type_test->operand = p_previous_operand;
  2789. type_test->test_type = parse_type();
  2790. complete_extents(type_test);
  2791. if (type_test->test_type == nullptr) {
  2792. push_error(R"(Expected type specifier after "is".)");
  2793. }
  2794. return type_test;
  2795. }
  2796. GDScriptParser::ExpressionNode *GDScriptParser::parse_yield(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2797. push_error(R"("yield" was removed in Godot 4.0. Use "await" instead.)");
  2798. return nullptr;
  2799. }
  2800. GDScriptParser::ExpressionNode *GDScriptParser::parse_invalid_token(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2801. // Just for better error messages.
  2802. GDScriptTokenizer::Token::Type invalid = previous.type;
  2803. switch (invalid) {
  2804. case GDScriptTokenizer::Token::QUESTION_MARK:
  2805. push_error(R"(Unexpected "?" in source. If you want a ternary operator, use "truthy_value if true_condition else falsy_value".)");
  2806. break;
  2807. default:
  2808. return nullptr; // Unreachable.
  2809. }
  2810. // Return the previous expression.
  2811. return p_previous_operand;
  2812. }
  2813. GDScriptParser::TypeNode *GDScriptParser::parse_type(bool p_allow_void) {
  2814. TypeNode *type = alloc_node<TypeNode>();
  2815. make_completion_context(p_allow_void ? COMPLETION_TYPE_NAME_OR_VOID : COMPLETION_TYPE_NAME, type);
  2816. if (!match(GDScriptTokenizer::Token::IDENTIFIER)) {
  2817. if (match(GDScriptTokenizer::Token::VOID)) {
  2818. if (p_allow_void) {
  2819. complete_extents(type);
  2820. TypeNode *void_type = type;
  2821. return void_type;
  2822. } else {
  2823. push_error(R"("void" is only allowed for a function return type.)");
  2824. }
  2825. }
  2826. // Leave error message to the caller who knows the context.
  2827. complete_extents(type);
  2828. return nullptr;
  2829. }
  2830. IdentifierNode *type_element = parse_identifier();
  2831. type->type_chain.push_back(type_element);
  2832. if (match(GDScriptTokenizer::Token::BRACKET_OPEN)) {
  2833. // Typed collection (like Array[int]).
  2834. type->container_type = parse_type(false); // Don't allow void for array element type.
  2835. if (type->container_type == nullptr) {
  2836. push_error(R"(Expected type for collection after "[".)");
  2837. complete_extents(type);
  2838. type = nullptr;
  2839. } else if (type->container_type->container_type != nullptr) {
  2840. push_error("Nested typed collections are not supported.");
  2841. }
  2842. consume(GDScriptTokenizer::Token::BRACKET_CLOSE, R"(Expected closing "]" after collection type.)");
  2843. if (type != nullptr) {
  2844. complete_extents(type);
  2845. }
  2846. return type;
  2847. }
  2848. int chain_index = 1;
  2849. while (match(GDScriptTokenizer::Token::PERIOD)) {
  2850. make_completion_context(COMPLETION_TYPE_ATTRIBUTE, type, chain_index++);
  2851. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected inner type name after ".".)")) {
  2852. type_element = parse_identifier();
  2853. type->type_chain.push_back(type_element);
  2854. }
  2855. }
  2856. complete_extents(type);
  2857. return type;
  2858. }
  2859. #ifdef TOOLS_ENABLED
  2860. static bool _in_codeblock(String p_line, bool p_already_in, int *r_block_begins = nullptr) {
  2861. int start_block = p_line.rfind("[codeblock]");
  2862. int end_block = p_line.rfind("[/codeblock]");
  2863. if (start_block != -1 && r_block_begins) {
  2864. *r_block_begins = start_block;
  2865. }
  2866. if (p_already_in) {
  2867. if (end_block == -1) {
  2868. return true;
  2869. } else if (start_block == -1) {
  2870. return false;
  2871. } else {
  2872. return start_block > end_block;
  2873. }
  2874. } else {
  2875. if (start_block == -1) {
  2876. return false;
  2877. } else if (end_block == -1) {
  2878. return true;
  2879. } else {
  2880. return start_block > end_block;
  2881. }
  2882. }
  2883. }
  2884. bool GDScriptParser::has_comment(int p_line, bool p_must_be_doc) {
  2885. bool has_comment = tokenizer.get_comments().has(p_line);
  2886. // If there are no comments or if we don't care whether the comment
  2887. // is a docstring, we have our result.
  2888. if (!p_must_be_doc || !has_comment) {
  2889. return has_comment;
  2890. }
  2891. return tokenizer.get_comments()[p_line].comment.begins_with("##");
  2892. }
  2893. String GDScriptParser::get_doc_comment(int p_line, bool p_single_line) {
  2894. const HashMap<int, GDScriptTokenizer::CommentData> &comments = tokenizer.get_comments();
  2895. ERR_FAIL_COND_V(!comments.has(p_line), String());
  2896. if (p_single_line) {
  2897. if (comments[p_line].comment.begins_with("##")) {
  2898. return comments[p_line].comment.trim_prefix("##").strip_edges();
  2899. }
  2900. return "";
  2901. }
  2902. String doc;
  2903. int line = p_line;
  2904. bool in_codeblock = false;
  2905. while (comments.has(line - 1)) {
  2906. if (!comments[line - 1].new_line || !comments[line - 1].comment.begins_with("##")) {
  2907. break;
  2908. }
  2909. line--;
  2910. }
  2911. int codeblock_begins = 0;
  2912. while (comments.has(line)) {
  2913. if (!comments[line].new_line || !comments[line].comment.begins_with("##")) {
  2914. break;
  2915. }
  2916. String doc_line = comments[line].comment.trim_prefix("##");
  2917. in_codeblock = _in_codeblock(doc_line, in_codeblock, &codeblock_begins);
  2918. if (in_codeblock) {
  2919. int i = 0;
  2920. for (; i < codeblock_begins; i++) {
  2921. if (doc_line[i] != ' ') {
  2922. break;
  2923. }
  2924. }
  2925. doc_line = doc_line.substr(i);
  2926. } else {
  2927. doc_line = doc_line.strip_edges();
  2928. }
  2929. String line_join = (in_codeblock) ? "\n" : " ";
  2930. doc = (doc.is_empty()) ? doc_line : doc + line_join + doc_line;
  2931. line++;
  2932. }
  2933. return doc;
  2934. }
  2935. void GDScriptParser::get_class_doc_comment(int p_line, String &p_brief, String &p_desc, Vector<Pair<String, String>> &p_tutorials, bool p_inner_class) {
  2936. const HashMap<int, GDScriptTokenizer::CommentData> &comments = tokenizer.get_comments();
  2937. if (!comments.has(p_line)) {
  2938. return;
  2939. }
  2940. ERR_FAIL_COND(!p_brief.is_empty() || !p_desc.is_empty() || p_tutorials.size() != 0);
  2941. int line = p_line;
  2942. bool in_codeblock = false;
  2943. enum Mode {
  2944. BRIEF,
  2945. DESC,
  2946. TUTORIALS,
  2947. DONE,
  2948. };
  2949. Mode mode = BRIEF;
  2950. if (p_inner_class) {
  2951. while (comments.has(line - 1)) {
  2952. if (!comments[line - 1].new_line || !comments[line - 1].comment.begins_with("##")) {
  2953. break;
  2954. }
  2955. line--;
  2956. }
  2957. }
  2958. int codeblock_begins = 0;
  2959. while (comments.has(line)) {
  2960. if (!comments[line].new_line || !comments[line].comment.begins_with("##")) {
  2961. break;
  2962. }
  2963. String title, link; // For tutorials.
  2964. String doc_line = comments[line++].comment.trim_prefix("##");
  2965. String stripped_line = doc_line.strip_edges();
  2966. // Set the read mode.
  2967. if (stripped_line.is_empty() && mode == BRIEF && !p_brief.is_empty()) {
  2968. mode = DESC;
  2969. continue;
  2970. } else if (stripped_line.begins_with("@tutorial")) {
  2971. int begin_scan = String("@tutorial").length();
  2972. if (begin_scan >= stripped_line.length()) {
  2973. continue; // invalid syntax.
  2974. }
  2975. if (stripped_line[begin_scan] == ':') { // No title.
  2976. // Syntax: ## @tutorial: https://godotengine.org/ // The title argument is optional.
  2977. title = "";
  2978. link = stripped_line.trim_prefix("@tutorial:").strip_edges();
  2979. } else {
  2980. /* Syntax:
  2981. * @tutorial ( The Title Here ) : https://the.url/
  2982. * ^ open ^ close ^ colon ^ url
  2983. */
  2984. int open_bracket_pos = begin_scan, close_bracket_pos = 0;
  2985. while (open_bracket_pos < stripped_line.length() && (stripped_line[open_bracket_pos] == ' ' || stripped_line[open_bracket_pos] == '\t')) {
  2986. open_bracket_pos++;
  2987. }
  2988. if (open_bracket_pos == stripped_line.length() || stripped_line[open_bracket_pos++] != '(') {
  2989. continue; // invalid syntax.
  2990. }
  2991. close_bracket_pos = open_bracket_pos;
  2992. while (close_bracket_pos < stripped_line.length() && stripped_line[close_bracket_pos] != ')') {
  2993. close_bracket_pos++;
  2994. }
  2995. if (close_bracket_pos == stripped_line.length()) {
  2996. continue; // invalid syntax.
  2997. }
  2998. int colon_pos = close_bracket_pos + 1;
  2999. while (colon_pos < stripped_line.length() && (stripped_line[colon_pos] == ' ' || stripped_line[colon_pos] == '\t')) {
  3000. colon_pos++;
  3001. }
  3002. if (colon_pos == stripped_line.length() || stripped_line[colon_pos++] != ':') {
  3003. continue; // invalid syntax.
  3004. }
  3005. title = stripped_line.substr(open_bracket_pos, close_bracket_pos - open_bracket_pos).strip_edges();
  3006. link = stripped_line.substr(colon_pos).strip_edges();
  3007. }
  3008. mode = TUTORIALS;
  3009. in_codeblock = false;
  3010. } else if (stripped_line.is_empty()) {
  3011. continue;
  3012. } else {
  3013. // Tutorial docs are single line, we need a @tag after it.
  3014. if (mode == TUTORIALS) {
  3015. mode = DONE;
  3016. }
  3017. in_codeblock = _in_codeblock(doc_line, in_codeblock, &codeblock_begins);
  3018. }
  3019. if (in_codeblock) {
  3020. int i = 0;
  3021. for (; i < codeblock_begins; i++) {
  3022. if (doc_line[i] != ' ') {
  3023. break;
  3024. }
  3025. }
  3026. doc_line = doc_line.substr(i);
  3027. } else {
  3028. doc_line = stripped_line;
  3029. }
  3030. String line_join = (in_codeblock) ? "\n" : " ";
  3031. switch (mode) {
  3032. case BRIEF:
  3033. p_brief = (p_brief.length() == 0) ? doc_line : p_brief + line_join + doc_line;
  3034. break;
  3035. case DESC:
  3036. p_desc = (p_desc.length() == 0) ? doc_line : p_desc + line_join + doc_line;
  3037. break;
  3038. case TUTORIALS:
  3039. p_tutorials.append(Pair<String, String>(title, link));
  3040. break;
  3041. case DONE:
  3042. break;
  3043. }
  3044. }
  3045. if (current_class->members.size() > 0) {
  3046. const ClassNode::Member &m = current_class->members[0];
  3047. int first_member_line = m.get_line();
  3048. if (first_member_line == line) {
  3049. p_brief = "";
  3050. p_desc = "";
  3051. p_tutorials.clear();
  3052. }
  3053. }
  3054. }
  3055. #endif // TOOLS_ENABLED
  3056. GDScriptParser::ParseRule *GDScriptParser::get_rule(GDScriptTokenizer::Token::Type p_token_type) {
  3057. // Function table for expression parsing.
  3058. // clang-format destroys the alignment here, so turn off for the table.
  3059. /* clang-format off */
  3060. static ParseRule rules[] = {
  3061. // PREFIX INFIX PRECEDENCE (for infix)
  3062. { nullptr, nullptr, PREC_NONE }, // EMPTY,
  3063. // Basic
  3064. { nullptr, nullptr, PREC_NONE }, // ANNOTATION,
  3065. { &GDScriptParser::parse_identifier, nullptr, PREC_NONE }, // IDENTIFIER,
  3066. { &GDScriptParser::parse_literal, nullptr, PREC_NONE }, // LITERAL,
  3067. // Comparison
  3068. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // LESS,
  3069. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // LESS_EQUAL,
  3070. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // GREATER,
  3071. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // GREATER_EQUAL,
  3072. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // EQUAL_EQUAL,
  3073. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // BANG_EQUAL,
  3074. // Logical
  3075. { nullptr, &GDScriptParser::parse_binary_operator, PREC_LOGIC_AND }, // AND,
  3076. { nullptr, &GDScriptParser::parse_binary_operator, PREC_LOGIC_OR }, // OR,
  3077. { &GDScriptParser::parse_unary_operator, &GDScriptParser::parse_binary_not_in_operator, PREC_CONTENT_TEST }, // NOT,
  3078. { nullptr, &GDScriptParser::parse_binary_operator, PREC_LOGIC_AND }, // AMPERSAND_AMPERSAND,
  3079. { nullptr, &GDScriptParser::parse_binary_operator, PREC_LOGIC_OR }, // PIPE_PIPE,
  3080. { &GDScriptParser::parse_unary_operator, nullptr, PREC_NONE }, // BANG,
  3081. // Bitwise
  3082. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_AND }, // AMPERSAND,
  3083. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_OR }, // PIPE,
  3084. { &GDScriptParser::parse_unary_operator, nullptr, PREC_NONE }, // TILDE,
  3085. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_XOR }, // CARET,
  3086. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_SHIFT }, // LESS_LESS,
  3087. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_SHIFT }, // GREATER_GREATER,
  3088. // Math
  3089. { &GDScriptParser::parse_unary_operator, &GDScriptParser::parse_binary_operator, PREC_ADDITION_SUBTRACTION }, // PLUS,
  3090. { &GDScriptParser::parse_unary_operator, &GDScriptParser::parse_binary_operator, PREC_ADDITION_SUBTRACTION }, // MINUS,
  3091. { nullptr, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // STAR,
  3092. { nullptr, &GDScriptParser::parse_binary_operator, PREC_POWER }, // STAR_STAR,
  3093. { nullptr, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // SLASH,
  3094. { &GDScriptParser::parse_get_node, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // PERCENT,
  3095. // Assignment
  3096. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // EQUAL,
  3097. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // PLUS_EQUAL,
  3098. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // MINUS_EQUAL,
  3099. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // STAR_EQUAL,
  3100. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // STAR_STAR_EQUAL,
  3101. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // SLASH_EQUAL,
  3102. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // PERCENT_EQUAL,
  3103. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // LESS_LESS_EQUAL,
  3104. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // GREATER_GREATER_EQUAL,
  3105. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // AMPERSAND_EQUAL,
  3106. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // PIPE_EQUAL,
  3107. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // CARET_EQUAL,
  3108. // Control flow
  3109. { nullptr, &GDScriptParser::parse_ternary_operator, PREC_TERNARY }, // IF,
  3110. { nullptr, nullptr, PREC_NONE }, // ELIF,
  3111. { nullptr, nullptr, PREC_NONE }, // ELSE,
  3112. { nullptr, nullptr, PREC_NONE }, // FOR,
  3113. { nullptr, nullptr, PREC_NONE }, // WHILE,
  3114. { nullptr, nullptr, PREC_NONE }, // BREAK,
  3115. { nullptr, nullptr, PREC_NONE }, // CONTINUE,
  3116. { nullptr, nullptr, PREC_NONE }, // PASS,
  3117. { nullptr, nullptr, PREC_NONE }, // RETURN,
  3118. { nullptr, nullptr, PREC_NONE }, // MATCH,
  3119. // Keywords
  3120. { nullptr, &GDScriptParser::parse_cast, PREC_CAST }, // AS,
  3121. { nullptr, nullptr, PREC_NONE }, // ASSERT,
  3122. { &GDScriptParser::parse_await, nullptr, PREC_NONE }, // AWAIT,
  3123. { nullptr, nullptr, PREC_NONE }, // BREAKPOINT,
  3124. { nullptr, nullptr, PREC_NONE }, // CLASS,
  3125. { nullptr, nullptr, PREC_NONE }, // CLASS_NAME,
  3126. { nullptr, nullptr, PREC_NONE }, // CONST,
  3127. { nullptr, nullptr, PREC_NONE }, // ENUM,
  3128. { nullptr, nullptr, PREC_NONE }, // EXTENDS,
  3129. { &GDScriptParser::parse_lambda, nullptr, PREC_NONE }, // FUNC,
  3130. { nullptr, &GDScriptParser::parse_binary_operator, PREC_CONTENT_TEST }, // IN,
  3131. { nullptr, &GDScriptParser::parse_type_test, PREC_TYPE_TEST }, // IS,
  3132. { nullptr, nullptr, PREC_NONE }, // NAMESPACE,
  3133. { &GDScriptParser::parse_preload, nullptr, PREC_NONE }, // PRELOAD,
  3134. { &GDScriptParser::parse_self, nullptr, PREC_NONE }, // SELF,
  3135. { nullptr, nullptr, PREC_NONE }, // SIGNAL,
  3136. { nullptr, nullptr, PREC_NONE }, // STATIC,
  3137. { &GDScriptParser::parse_call, nullptr, PREC_NONE }, // SUPER,
  3138. { nullptr, nullptr, PREC_NONE }, // TRAIT,
  3139. { nullptr, nullptr, PREC_NONE }, // VAR,
  3140. { nullptr, nullptr, PREC_NONE }, // VOID,
  3141. { &GDScriptParser::parse_yield, nullptr, PREC_NONE }, // YIELD,
  3142. // Punctuation
  3143. { &GDScriptParser::parse_array, &GDScriptParser::parse_subscript, PREC_SUBSCRIPT }, // BRACKET_OPEN,
  3144. { nullptr, nullptr, PREC_NONE }, // BRACKET_CLOSE,
  3145. { &GDScriptParser::parse_dictionary, nullptr, PREC_NONE }, // BRACE_OPEN,
  3146. { nullptr, nullptr, PREC_NONE }, // BRACE_CLOSE,
  3147. { &GDScriptParser::parse_grouping, &GDScriptParser::parse_call, PREC_CALL }, // PARENTHESIS_OPEN,
  3148. { nullptr, nullptr, PREC_NONE }, // PARENTHESIS_CLOSE,
  3149. { nullptr, nullptr, PREC_NONE }, // COMMA,
  3150. { nullptr, nullptr, PREC_NONE }, // SEMICOLON,
  3151. { nullptr, &GDScriptParser::parse_attribute, PREC_ATTRIBUTE }, // PERIOD,
  3152. { nullptr, nullptr, PREC_NONE }, // PERIOD_PERIOD,
  3153. { nullptr, nullptr, PREC_NONE }, // COLON,
  3154. { &GDScriptParser::parse_get_node, nullptr, PREC_NONE }, // DOLLAR,
  3155. { nullptr, nullptr, PREC_NONE }, // FORWARD_ARROW,
  3156. { nullptr, nullptr, PREC_NONE }, // UNDERSCORE,
  3157. // Whitespace
  3158. { nullptr, nullptr, PREC_NONE }, // NEWLINE,
  3159. { nullptr, nullptr, PREC_NONE }, // INDENT,
  3160. { nullptr, nullptr, PREC_NONE }, // DEDENT,
  3161. // Constants
  3162. { &GDScriptParser::parse_builtin_constant, nullptr, PREC_NONE }, // CONST_PI,
  3163. { &GDScriptParser::parse_builtin_constant, nullptr, PREC_NONE }, // CONST_TAU,
  3164. { &GDScriptParser::parse_builtin_constant, nullptr, PREC_NONE }, // CONST_INF,
  3165. { &GDScriptParser::parse_builtin_constant, nullptr, PREC_NONE }, // CONST_NAN,
  3166. // Error message improvement
  3167. { nullptr, nullptr, PREC_NONE }, // VCS_CONFLICT_MARKER,
  3168. { nullptr, nullptr, PREC_NONE }, // BACKTICK,
  3169. { nullptr, &GDScriptParser::parse_invalid_token, PREC_CAST }, // QUESTION_MARK,
  3170. // Special
  3171. { nullptr, nullptr, PREC_NONE }, // ERROR,
  3172. { nullptr, nullptr, PREC_NONE }, // TK_EOF,
  3173. };
  3174. /* clang-format on */
  3175. // Avoid desync.
  3176. static_assert(sizeof(rules) / sizeof(rules[0]) == GDScriptTokenizer::Token::TK_MAX, "Amount of parse rules don't match the amount of token types.");
  3177. // Let's assume this is never invalid, since nothing generates a TK_MAX.
  3178. return &rules[p_token_type];
  3179. }
  3180. bool GDScriptParser::SuiteNode::has_local(const StringName &p_name) const {
  3181. if (locals_indices.has(p_name)) {
  3182. return true;
  3183. }
  3184. if (parent_block != nullptr) {
  3185. return parent_block->has_local(p_name);
  3186. }
  3187. return false;
  3188. }
  3189. const GDScriptParser::SuiteNode::Local &GDScriptParser::SuiteNode::get_local(const StringName &p_name) const {
  3190. if (locals_indices.has(p_name)) {
  3191. return locals[locals_indices[p_name]];
  3192. }
  3193. if (parent_block != nullptr) {
  3194. return parent_block->get_local(p_name);
  3195. }
  3196. return empty;
  3197. }
  3198. bool GDScriptParser::AnnotationNode::apply(GDScriptParser *p_this, Node *p_target) {
  3199. if (is_applied) {
  3200. return true;
  3201. }
  3202. is_applied = true;
  3203. return (p_this->*(p_this->valid_annotations[name].apply))(this, p_target);
  3204. }
  3205. bool GDScriptParser::AnnotationNode::applies_to(uint32_t p_target_kinds) const {
  3206. return (info->target_kind & p_target_kinds) > 0;
  3207. }
  3208. bool GDScriptParser::validate_annotation_arguments(AnnotationNode *p_annotation) {
  3209. ERR_FAIL_COND_V_MSG(!valid_annotations.has(p_annotation->name), false, vformat(R"(Annotation "%s" not found to validate.)", p_annotation->name));
  3210. const MethodInfo &info = valid_annotations[p_annotation->name].info;
  3211. if (((info.flags & METHOD_FLAG_VARARG) == 0) && p_annotation->arguments.size() > info.arguments.size()) {
  3212. push_error(vformat(R"(Annotation "%s" requires at most %d arguments, but %d were given.)", p_annotation->name, info.arguments.size(), p_annotation->arguments.size()));
  3213. return false;
  3214. }
  3215. if (p_annotation->arguments.size() < info.arguments.size() - info.default_arguments.size()) {
  3216. push_error(vformat(R"(Annotation "%s" requires at least %d arguments, but %d were given.)", p_annotation->name, info.arguments.size() - info.default_arguments.size(), p_annotation->arguments.size()));
  3217. return false;
  3218. }
  3219. // `@icon`'s argument needs to be resolved in the parser. See GH-72444.
  3220. if (p_annotation->name == SNAME("@icon")) {
  3221. ExpressionNode *argument = p_annotation->arguments[0];
  3222. if (argument->type != Node::LITERAL) {
  3223. push_error(R"(Argument 1 of annotation "@icon" must be a string literal.)", argument);
  3224. return false;
  3225. }
  3226. Variant value = static_cast<LiteralNode *>(argument)->value;
  3227. if (value.get_type() != Variant::STRING) {
  3228. push_error(R"(Argument 1 of annotation "@icon" must be a string literal.)", argument);
  3229. return false;
  3230. }
  3231. p_annotation->resolved_arguments.push_back(value);
  3232. }
  3233. // For other annotations, see `GDScriptAnalyzer::resolve_annotation()`.
  3234. return true;
  3235. }
  3236. bool GDScriptParser::tool_annotation(const AnnotationNode *p_annotation, Node *p_node) {
  3237. #ifdef DEBUG_ENABLED
  3238. if (this->_is_tool) {
  3239. push_error(R"("@tool" annotation can only be used once.)", p_annotation);
  3240. return false;
  3241. }
  3242. #endif // DEBUG_ENABLED
  3243. this->_is_tool = true;
  3244. return true;
  3245. }
  3246. bool GDScriptParser::icon_annotation(const AnnotationNode *p_annotation, Node *p_node) {
  3247. ERR_FAIL_COND_V_MSG(p_node->type != Node::CLASS, false, R"("@icon" annotation can only be applied to classes.)");
  3248. ERR_FAIL_COND_V(p_annotation->resolved_arguments.is_empty(), false);
  3249. ClassNode *p_class = static_cast<ClassNode *>(p_node);
  3250. #ifdef DEBUG_ENABLED
  3251. if (!p_class->icon_path.is_empty()) {
  3252. push_error(R"("@icon" annotation can only be used once.)", p_annotation);
  3253. return false;
  3254. }
  3255. if (String(p_annotation->resolved_arguments[0]).is_empty()) {
  3256. push_error(R"("@icon" annotation argument must contain the path to the icon.)", p_annotation->arguments[0]);
  3257. return false;
  3258. }
  3259. #endif // DEBUG_ENABLED
  3260. p_class->icon_path = p_annotation->resolved_arguments[0];
  3261. return true;
  3262. }
  3263. bool GDScriptParser::onready_annotation(const AnnotationNode *p_annotation, Node *p_node) {
  3264. ERR_FAIL_COND_V_MSG(p_node->type != Node::VARIABLE, false, R"("@onready" annotation can only be applied to class variables.)");
  3265. if (current_class && !ClassDB::is_parent_class(current_class->get_datatype().native_type, SNAME("Node"))) {
  3266. push_error(R"("@onready" can only be used in classes that inherit "Node".)", p_annotation);
  3267. }
  3268. VariableNode *variable = static_cast<VariableNode *>(p_node);
  3269. if (variable->onready) {
  3270. push_error(R"("@onready" annotation can only be used once per variable.)");
  3271. return false;
  3272. }
  3273. variable->onready = true;
  3274. current_class->onready_used = true;
  3275. return true;
  3276. }
  3277. template <PropertyHint t_hint, Variant::Type t_type>
  3278. bool GDScriptParser::export_annotations(const AnnotationNode *p_annotation, Node *p_node) {
  3279. ERR_FAIL_COND_V_MSG(p_node->type != Node::VARIABLE, false, vformat(R"("%s" annotation can only be applied to variables.)", p_annotation->name));
  3280. VariableNode *variable = static_cast<VariableNode *>(p_node);
  3281. if (variable->exported) {
  3282. push_error(vformat(R"(Annotation "%s" cannot be used with another "@export" annotation.)", p_annotation->name), p_annotation);
  3283. return false;
  3284. }
  3285. variable->exported = true;
  3286. variable->export_info.type = t_type;
  3287. variable->export_info.hint = t_hint;
  3288. String hint_string;
  3289. for (int i = 0; i < p_annotation->resolved_arguments.size(); i++) {
  3290. String arg_string = String(p_annotation->resolved_arguments[i]);
  3291. if (p_annotation->name != SNAME("@export_placeholder")) {
  3292. if (arg_string.is_empty()) {
  3293. push_error(vformat(R"(Argument %d of annotation "%s" is empty.)", i + 1, p_annotation->name), p_annotation->arguments[i]);
  3294. return false;
  3295. }
  3296. if (arg_string.contains(",")) {
  3297. push_error(vformat(R"(Argument %d of annotation "%s" contains a comma. Use separate arguments instead.)", i + 1, p_annotation->name), p_annotation->arguments[i]);
  3298. return false;
  3299. }
  3300. }
  3301. if (p_annotation->name == SNAME("@export_flags")) {
  3302. const int64_t max_flags = 32;
  3303. Vector<String> t = arg_string.split(":", true, 1);
  3304. if (t[0].is_empty()) {
  3305. push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": Expected flag name.)", i + 1), p_annotation->arguments[i]);
  3306. return false;
  3307. }
  3308. if (t.size() == 2) {
  3309. if (t[1].is_empty()) {
  3310. push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": Expected flag value.)", i + 1), p_annotation->arguments[i]);
  3311. return false;
  3312. }
  3313. if (!t[1].is_valid_int()) {
  3314. push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": The flag value must be a valid integer.)", i + 1), p_annotation->arguments[i]);
  3315. return false;
  3316. }
  3317. int64_t value = t[1].to_int();
  3318. if (value < 1 || value >= (1LL << max_flags)) {
  3319. push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": The flag value must be at least 1 and at most 2 ** %d - 1.)", i + 1, max_flags), p_annotation->arguments[i]);
  3320. return false;
  3321. }
  3322. } else if (i >= max_flags) {
  3323. push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": Starting from argument %d, the flag value must be specified explicitly.)", i + 1, max_flags + 1), p_annotation->arguments[i]);
  3324. return false;
  3325. }
  3326. }
  3327. if (i > 0) {
  3328. hint_string += ",";
  3329. }
  3330. hint_string += arg_string;
  3331. }
  3332. variable->export_info.hint_string = hint_string;
  3333. // This is called after the analyzer is done finding the type, so this should be set here.
  3334. DataType export_type = variable->get_datatype();
  3335. if (p_annotation->name == SNAME("@export_range")) {
  3336. if (export_type.builtin_type == Variant::INT) {
  3337. variable->export_info.type = Variant::INT;
  3338. }
  3339. }
  3340. if (p_annotation->name == SNAME("@export_multiline")) {
  3341. if (export_type.builtin_type == Variant::ARRAY && export_type.has_container_element_type()) {
  3342. DataType inner_type = export_type.get_container_element_type();
  3343. if (inner_type.builtin_type != Variant::STRING) {
  3344. push_error(vformat(R"("%s" annotation on arrays requires a string type but type "%s" was given instead.)", p_annotation->name.operator String(), inner_type.to_string()), variable);
  3345. return false;
  3346. }
  3347. String hint_prefix = itos(inner_type.builtin_type) + "/" + itos(variable->export_info.hint);
  3348. variable->export_info.hint = PROPERTY_HINT_TYPE_STRING;
  3349. variable->export_info.hint_string = hint_prefix + ":" + variable->export_info.hint_string;
  3350. variable->export_info.type = Variant::ARRAY;
  3351. return true;
  3352. } else if (export_type.builtin_type == Variant::DICTIONARY) {
  3353. variable->export_info.type = Variant::DICTIONARY;
  3354. return true;
  3355. } else if (export_type.builtin_type == Variant::PACKED_STRING_ARRAY) {
  3356. String hint_prefix = itos(Variant::STRING) + "/" + itos(variable->export_info.hint);
  3357. variable->export_info.hint = PROPERTY_HINT_TYPE_STRING;
  3358. variable->export_info.hint_string = hint_prefix + ":" + variable->export_info.hint_string;
  3359. variable->export_info.type = Variant::PACKED_STRING_ARRAY;
  3360. return true;
  3361. }
  3362. }
  3363. if (p_annotation->name == SNAME("@export")) {
  3364. if (variable->datatype_specifier == nullptr && variable->initializer == nullptr) {
  3365. push_error(R"(Cannot use simple "@export" annotation with variable without type or initializer, since type can't be inferred.)", p_annotation);
  3366. return false;
  3367. }
  3368. bool is_array = false;
  3369. if (export_type.builtin_type == Variant::ARRAY && export_type.has_container_element_type()) {
  3370. export_type = export_type.get_container_element_type(); // Use inner type for.
  3371. is_array = true;
  3372. }
  3373. if (export_type.is_variant() || export_type.has_no_type()) {
  3374. push_error(R"(Cannot use simple "@export" annotation because the type of the initialized value can't be inferred.)", p_annotation);
  3375. return false;
  3376. }
  3377. switch (export_type.kind) {
  3378. case GDScriptParser::DataType::BUILTIN:
  3379. variable->export_info.type = export_type.builtin_type;
  3380. variable->export_info.hint = PROPERTY_HINT_NONE;
  3381. variable->export_info.hint_string = Variant::get_type_name(export_type.builtin_type);
  3382. break;
  3383. case GDScriptParser::DataType::NATIVE:
  3384. if (ClassDB::is_parent_class(export_type.native_type, SNAME("Resource"))) {
  3385. variable->export_info.type = Variant::OBJECT;
  3386. variable->export_info.hint = PROPERTY_HINT_RESOURCE_TYPE;
  3387. variable->export_info.hint_string = export_type.native_type;
  3388. } else if (ClassDB::is_parent_class(export_type.native_type, SNAME("Node"))) {
  3389. variable->export_info.type = Variant::OBJECT;
  3390. variable->export_info.hint = PROPERTY_HINT_NODE_TYPE;
  3391. variable->export_info.hint_string = export_type.native_type;
  3392. } else {
  3393. push_error(R"(Export type can only be built-in, a resource, a node, or an enum.)", variable);
  3394. return false;
  3395. }
  3396. break;
  3397. case GDScriptParser::DataType::CLASS:
  3398. if (ClassDB::is_parent_class(export_type.native_type, SNAME("Resource"))) {
  3399. variable->export_info.type = Variant::OBJECT;
  3400. variable->export_info.hint = PROPERTY_HINT_RESOURCE_TYPE;
  3401. variable->export_info.hint_string = export_type.to_string();
  3402. } else if (ClassDB::is_parent_class(export_type.native_type, SNAME("Node"))) {
  3403. variable->export_info.type = Variant::OBJECT;
  3404. variable->export_info.hint = PROPERTY_HINT_NODE_TYPE;
  3405. variable->export_info.hint_string = export_type.to_string();
  3406. } else {
  3407. push_error(R"(Export type can only be built-in, a resource, a node, or an enum.)", variable);
  3408. return false;
  3409. }
  3410. break;
  3411. case GDScriptParser::DataType::SCRIPT: {
  3412. StringName class_name;
  3413. StringName native_base;
  3414. if (export_type.script_type.is_valid()) {
  3415. class_name = export_type.script_type->get_language()->get_global_class_name(export_type.script_type->get_path());
  3416. native_base = export_type.script_type->get_instance_base_type();
  3417. }
  3418. if (class_name == StringName()) {
  3419. Ref<Script> script = ResourceLoader::load(export_type.script_path, SNAME("Script"));
  3420. if (script.is_valid()) {
  3421. class_name = script->get_language()->get_global_class_name(export_type.script_path);
  3422. native_base = script->get_instance_base_type();
  3423. }
  3424. }
  3425. if (class_name != StringName() && native_base != StringName() && ClassDB::is_parent_class(native_base, SNAME("Resource"))) {
  3426. variable->export_info.type = Variant::OBJECT;
  3427. variable->export_info.hint = PROPERTY_HINT_RESOURCE_TYPE;
  3428. variable->export_info.hint_string = class_name;
  3429. }
  3430. } break;
  3431. case GDScriptParser::DataType::ENUM: {
  3432. variable->export_info.type = Variant::INT;
  3433. variable->export_info.hint = PROPERTY_HINT_ENUM;
  3434. String enum_hint_string;
  3435. bool first = true;
  3436. for (const KeyValue<StringName, int64_t> &E : export_type.enum_values) {
  3437. if (!first) {
  3438. enum_hint_string += ",";
  3439. } else {
  3440. first = false;
  3441. }
  3442. enum_hint_string += E.key.operator String().capitalize().xml_escape();
  3443. enum_hint_string += ":";
  3444. enum_hint_string += String::num_int64(E.value).xml_escape();
  3445. }
  3446. variable->export_info.hint_string = enum_hint_string;
  3447. } break;
  3448. default:
  3449. push_error(R"(Export type can only be built-in, a resource, a node, or an enum.)", variable);
  3450. break;
  3451. }
  3452. if (is_array) {
  3453. String hint_prefix = itos(variable->export_info.type);
  3454. if (variable->export_info.hint) {
  3455. hint_prefix += "/" + itos(variable->export_info.hint);
  3456. }
  3457. variable->export_info.hint = PROPERTY_HINT_TYPE_STRING;
  3458. variable->export_info.hint_string = hint_prefix + ":" + variable->export_info.hint_string;
  3459. variable->export_info.type = Variant::ARRAY;
  3460. }
  3461. } else if (p_annotation->name == SNAME("@export_enum")) {
  3462. Variant::Type enum_type = Variant::INT;
  3463. if (export_type.kind == DataType::BUILTIN && export_type.builtin_type == Variant::STRING) {
  3464. enum_type = Variant::STRING;
  3465. } else if (export_type.is_variant() && variable->initializer != nullptr) {
  3466. DataType initializer_type = variable->initializer->get_datatype();
  3467. if (initializer_type.kind == DataType::BUILTIN && initializer_type.builtin_type == Variant::STRING) {
  3468. enum_type = Variant::STRING;
  3469. }
  3470. }
  3471. variable->export_info.type = enum_type;
  3472. if (!export_type.is_variant() && (export_type.kind != DataType::BUILTIN || export_type.builtin_type != enum_type)) {
  3473. push_error(vformat(R"("@export_enum" annotation requires a variable of type "int" or "String" but type "%s" was given instead.)", export_type.to_string()), variable);
  3474. return false;
  3475. }
  3476. } else {
  3477. // Validate variable type with export.
  3478. if (!export_type.is_variant() && (export_type.kind != DataType::BUILTIN || export_type.builtin_type != t_type)) {
  3479. // Allow float/int conversion.
  3480. if ((t_type != Variant::FLOAT || export_type.builtin_type != Variant::INT) && (t_type != Variant::INT || export_type.builtin_type != Variant::FLOAT)) {
  3481. push_error(vformat(R"("%s" annotation requires a variable of type "%s" but type "%s" was given instead.)", p_annotation->name.operator String(), Variant::get_type_name(t_type), export_type.to_string()), variable);
  3482. return false;
  3483. }
  3484. }
  3485. }
  3486. return true;
  3487. }
  3488. template <PropertyUsageFlags t_usage>
  3489. bool GDScriptParser::export_group_annotations(const AnnotationNode *p_annotation, Node *p_node) {
  3490. AnnotationNode *annotation = const_cast<AnnotationNode *>(p_annotation);
  3491. if (annotation->resolved_arguments.is_empty()) {
  3492. return false;
  3493. }
  3494. annotation->export_info.name = annotation->resolved_arguments[0];
  3495. switch (t_usage) {
  3496. case PROPERTY_USAGE_CATEGORY: {
  3497. annotation->export_info.usage = t_usage;
  3498. } break;
  3499. case PROPERTY_USAGE_GROUP: {
  3500. annotation->export_info.usage = t_usage;
  3501. if (annotation->resolved_arguments.size() == 2) {
  3502. annotation->export_info.hint_string = annotation->resolved_arguments[1];
  3503. }
  3504. } break;
  3505. case PROPERTY_USAGE_SUBGROUP: {
  3506. annotation->export_info.usage = t_usage;
  3507. if (annotation->resolved_arguments.size() == 2) {
  3508. annotation->export_info.hint_string = annotation->resolved_arguments[1];
  3509. }
  3510. } break;
  3511. }
  3512. return true;
  3513. }
  3514. bool GDScriptParser::warning_annotations(const AnnotationNode *p_annotation, Node *p_node) {
  3515. #ifdef DEBUG_ENABLED
  3516. bool has_error = false;
  3517. for (const Variant &warning_name : p_annotation->resolved_arguments) {
  3518. GDScriptWarning::Code warning = GDScriptWarning::get_code_from_name(String(warning_name).to_upper());
  3519. if (warning == GDScriptWarning::WARNING_MAX) {
  3520. push_error(vformat(R"(Invalid warning name: "%s".)", warning_name), p_annotation);
  3521. has_error = true;
  3522. } else {
  3523. p_node->ignored_warnings.push_back(warning);
  3524. }
  3525. }
  3526. return !has_error;
  3527. #else // ! DEBUG_ENABLED
  3528. // Only available in debug builds.
  3529. return true;
  3530. #endif // DEBUG_ENABLED
  3531. }
  3532. bool GDScriptParser::rpc_annotation(const AnnotationNode *p_annotation, Node *p_node) {
  3533. ERR_FAIL_COND_V_MSG(p_node->type != Node::FUNCTION, false, vformat(R"("%s" annotation can only be applied to functions.)", p_annotation->name));
  3534. FunctionNode *function = static_cast<FunctionNode *>(p_node);
  3535. if (function->rpc_config.get_type() != Variant::NIL) {
  3536. push_error(R"(RPC annotations can only be used once per function.)", p_annotation);
  3537. return false;
  3538. }
  3539. Dictionary rpc_config;
  3540. rpc_config["rpc_mode"] = MultiplayerAPI::RPC_MODE_AUTHORITY;
  3541. if (!p_annotation->resolved_arguments.is_empty()) {
  3542. int last = p_annotation->resolved_arguments.size() - 1;
  3543. if (p_annotation->resolved_arguments[last].get_type() == Variant::INT) {
  3544. rpc_config["channel"] = p_annotation->resolved_arguments[last].operator int();
  3545. last -= 1;
  3546. }
  3547. if (last > 3) {
  3548. push_error(R"(Invalid RPC arguments. At most 4 arguments are allowed, where only the last argument can be an integer to specify the channel.')", p_annotation);
  3549. return false;
  3550. }
  3551. unsigned char locality_args = 0;
  3552. unsigned char permission_args = 0;
  3553. unsigned char transfer_mode_args = 0;
  3554. for (int i = last; i >= 0; i--) {
  3555. String arg = p_annotation->resolved_arguments[i].operator String();
  3556. if (arg == "call_local") {
  3557. locality_args++;
  3558. rpc_config["call_local"] = true;
  3559. } else if (arg == "call_remote") {
  3560. locality_args++;
  3561. rpc_config["call_local"] = false;
  3562. } else if (arg == "any_peer") {
  3563. permission_args++;
  3564. rpc_config["rpc_mode"] = MultiplayerAPI::RPC_MODE_ANY_PEER;
  3565. } else if (arg == "authority") {
  3566. permission_args++;
  3567. rpc_config["rpc_mode"] = MultiplayerAPI::RPC_MODE_AUTHORITY;
  3568. } else if (arg == "reliable") {
  3569. transfer_mode_args++;
  3570. rpc_config["transfer_mode"] = MultiplayerPeer::TRANSFER_MODE_RELIABLE;
  3571. } else if (arg == "unreliable") {
  3572. transfer_mode_args++;
  3573. rpc_config["transfer_mode"] = MultiplayerPeer::TRANSFER_MODE_UNRELIABLE;
  3574. } else if (arg == "unreliable_ordered") {
  3575. transfer_mode_args++;
  3576. rpc_config["transfer_mode"] = MultiplayerPeer::TRANSFER_MODE_UNRELIABLE_ORDERED;
  3577. } else {
  3578. push_error(R"(Invalid RPC argument. Must be one of: "call_local"/"call_remote" (local calls), "any_peer"/"authority" (permission), "reliable"/"unreliable"/"unreliable_ordered" (transfer mode).)", p_annotation);
  3579. }
  3580. }
  3581. if (locality_args > 1) {
  3582. push_error(R"(Invalid RPC config. The locality ("call_local"/"call_remote") must be specified no more than once.)", p_annotation);
  3583. } else if (permission_args > 1) {
  3584. push_error(R"(Invalid RPC config. The permission ("any_peer"/"authority") must be specified no more than once.)", p_annotation);
  3585. } else if (transfer_mode_args > 1) {
  3586. push_error(R"(Invalid RPC config. The transfer mode ("reliable"/"unreliable"/"unreliable_ordered") must be specified no more than once.)", p_annotation);
  3587. }
  3588. }
  3589. function->rpc_config = rpc_config;
  3590. return true;
  3591. }
  3592. bool GDScriptParser::static_unload_annotation(const AnnotationNode *p_annotation, Node *p_target) {
  3593. ERR_FAIL_COND_V_MSG(p_target->type != Node::CLASS, false, vformat(R"("%s" annotation can only be applied to classes.)", p_annotation->name));
  3594. ClassNode *p_class = static_cast<ClassNode *>(p_target);
  3595. if (p_class->annotated_static_unload) {
  3596. push_error(vformat(R"("%s" annotation can only be used once per script.)", p_annotation->name), p_annotation);
  3597. return false;
  3598. }
  3599. p_class->annotated_static_unload = true;
  3600. return true;
  3601. }
  3602. GDScriptParser::DataType GDScriptParser::SuiteNode::Local::get_datatype() const {
  3603. switch (type) {
  3604. case CONSTANT:
  3605. return constant->get_datatype();
  3606. case VARIABLE:
  3607. return variable->get_datatype();
  3608. case PARAMETER:
  3609. return parameter->get_datatype();
  3610. case FOR_VARIABLE:
  3611. case PATTERN_BIND:
  3612. return bind->get_datatype();
  3613. case UNDEFINED:
  3614. return DataType();
  3615. }
  3616. return DataType();
  3617. }
  3618. String GDScriptParser::SuiteNode::Local::get_name() const {
  3619. switch (type) {
  3620. case SuiteNode::Local::PARAMETER:
  3621. return "parameter";
  3622. case SuiteNode::Local::CONSTANT:
  3623. return "constant";
  3624. case SuiteNode::Local::VARIABLE:
  3625. return "variable";
  3626. case SuiteNode::Local::FOR_VARIABLE:
  3627. return "for loop iterator";
  3628. case SuiteNode::Local::PATTERN_BIND:
  3629. return "pattern_bind";
  3630. case SuiteNode::Local::UNDEFINED:
  3631. return "<undefined>";
  3632. default:
  3633. return String();
  3634. }
  3635. }
  3636. String GDScriptParser::DataType::to_string() const {
  3637. switch (kind) {
  3638. case VARIANT:
  3639. return "Variant";
  3640. case BUILTIN:
  3641. if (builtin_type == Variant::NIL) {
  3642. return "null";
  3643. }
  3644. if (builtin_type == Variant::ARRAY && has_container_element_type()) {
  3645. return vformat("Array[%s]", container_element_type->to_string());
  3646. }
  3647. return Variant::get_type_name(builtin_type);
  3648. case NATIVE:
  3649. if (is_meta_type) {
  3650. return GDScriptNativeClass::get_class_static();
  3651. }
  3652. return native_type.operator String();
  3653. case CLASS:
  3654. if (class_type->identifier != nullptr) {
  3655. return class_type->identifier->name.operator String();
  3656. }
  3657. return class_type->fqcn;
  3658. case SCRIPT: {
  3659. if (is_meta_type) {
  3660. return script_type->get_class_name().operator String();
  3661. }
  3662. String name = script_type != nullptr ? script_type->get_name() : "";
  3663. if (!name.is_empty()) {
  3664. return name;
  3665. }
  3666. name = script_path;
  3667. if (!name.is_empty()) {
  3668. return name;
  3669. }
  3670. return native_type.operator String();
  3671. }
  3672. case ENUM: {
  3673. // native_type contains either the native class defining the enum
  3674. // or the fully qualified class name of the script defining the enum
  3675. return String(native_type).get_file(); // Remove path, keep filename
  3676. }
  3677. case RESOLVING:
  3678. case UNRESOLVED:
  3679. return "<unresolved type>";
  3680. }
  3681. ERR_FAIL_V_MSG("<unresolved type>", "Kind set outside the enum range.");
  3682. }
  3683. static Variant::Type _variant_type_to_typed_array_element_type(Variant::Type p_type) {
  3684. switch (p_type) {
  3685. case Variant::PACKED_BYTE_ARRAY:
  3686. case Variant::PACKED_INT32_ARRAY:
  3687. case Variant::PACKED_INT64_ARRAY:
  3688. return Variant::INT;
  3689. case Variant::PACKED_FLOAT32_ARRAY:
  3690. case Variant::PACKED_FLOAT64_ARRAY:
  3691. return Variant::FLOAT;
  3692. case Variant::PACKED_STRING_ARRAY:
  3693. return Variant::STRING;
  3694. case Variant::PACKED_VECTOR2_ARRAY:
  3695. return Variant::VECTOR2;
  3696. case Variant::PACKED_VECTOR3_ARRAY:
  3697. return Variant::VECTOR3;
  3698. case Variant::PACKED_COLOR_ARRAY:
  3699. return Variant::COLOR;
  3700. default:
  3701. return Variant::NIL;
  3702. }
  3703. }
  3704. bool GDScriptParser::DataType::is_typed_container_type() const {
  3705. return kind == GDScriptParser::DataType::BUILTIN && _variant_type_to_typed_array_element_type(builtin_type) != Variant::NIL;
  3706. }
  3707. GDScriptParser::DataType GDScriptParser::DataType::get_typed_container_type() const {
  3708. GDScriptParser::DataType type;
  3709. type.kind = GDScriptParser::DataType::BUILTIN;
  3710. type.builtin_type = _variant_type_to_typed_array_element_type(builtin_type);
  3711. return type;
  3712. }
  3713. void GDScriptParser::complete_extents(Node *p_node) {
  3714. while (!nodes_in_progress.is_empty() && nodes_in_progress.back()->get() != p_node) {
  3715. ERR_PRINT("Parser bug: Mismatch in extents tracking stack.");
  3716. nodes_in_progress.pop_back();
  3717. }
  3718. if (nodes_in_progress.is_empty()) {
  3719. ERR_PRINT("Parser bug: Extents tracking stack is empty.");
  3720. } else {
  3721. nodes_in_progress.pop_back();
  3722. }
  3723. }
  3724. void GDScriptParser::update_extents(Node *p_node) {
  3725. p_node->end_line = previous.end_line;
  3726. p_node->end_column = previous.end_column;
  3727. p_node->leftmost_column = MIN(p_node->leftmost_column, previous.leftmost_column);
  3728. p_node->rightmost_column = MAX(p_node->rightmost_column, previous.rightmost_column);
  3729. }
  3730. void GDScriptParser::reset_extents(Node *p_node, GDScriptTokenizer::Token p_token) {
  3731. p_node->start_line = p_token.start_line;
  3732. p_node->end_line = p_token.end_line;
  3733. p_node->start_column = p_token.start_column;
  3734. p_node->end_column = p_token.end_column;
  3735. p_node->leftmost_column = p_token.leftmost_column;
  3736. p_node->rightmost_column = p_token.rightmost_column;
  3737. }
  3738. void GDScriptParser::reset_extents(Node *p_node, Node *p_from) {
  3739. if (p_from == nullptr) {
  3740. return;
  3741. }
  3742. p_node->start_line = p_from->start_line;
  3743. p_node->end_line = p_from->end_line;
  3744. p_node->start_column = p_from->start_column;
  3745. p_node->end_column = p_from->end_column;
  3746. p_node->leftmost_column = p_from->leftmost_column;
  3747. p_node->rightmost_column = p_from->rightmost_column;
  3748. }
  3749. /*---------- PRETTY PRINT FOR DEBUG ----------*/
  3750. #ifdef DEBUG_ENABLED
  3751. void GDScriptParser::TreePrinter::increase_indent() {
  3752. indent_level++;
  3753. indent = "";
  3754. for (int i = 0; i < indent_level * 4; i++) {
  3755. if (i % 4 == 0) {
  3756. indent += "|";
  3757. } else {
  3758. indent += " ";
  3759. }
  3760. }
  3761. }
  3762. void GDScriptParser::TreePrinter::decrease_indent() {
  3763. indent_level--;
  3764. indent = "";
  3765. for (int i = 0; i < indent_level * 4; i++) {
  3766. if (i % 4 == 0) {
  3767. indent += "|";
  3768. } else {
  3769. indent += " ";
  3770. }
  3771. }
  3772. }
  3773. void GDScriptParser::TreePrinter::push_line(const String &p_line) {
  3774. if (!p_line.is_empty()) {
  3775. push_text(p_line);
  3776. }
  3777. printed += "\n";
  3778. pending_indent = true;
  3779. }
  3780. void GDScriptParser::TreePrinter::push_text(const String &p_text) {
  3781. if (pending_indent) {
  3782. printed += indent;
  3783. pending_indent = false;
  3784. }
  3785. printed += p_text;
  3786. }
  3787. void GDScriptParser::TreePrinter::print_annotation(const AnnotationNode *p_annotation) {
  3788. push_text(p_annotation->name);
  3789. push_text(" (");
  3790. for (int i = 0; i < p_annotation->arguments.size(); i++) {
  3791. if (i > 0) {
  3792. push_text(" , ");
  3793. }
  3794. print_expression(p_annotation->arguments[i]);
  3795. }
  3796. push_line(")");
  3797. }
  3798. void GDScriptParser::TreePrinter::print_array(ArrayNode *p_array) {
  3799. push_text("[ ");
  3800. for (int i = 0; i < p_array->elements.size(); i++) {
  3801. if (i > 0) {
  3802. push_text(" , ");
  3803. }
  3804. print_expression(p_array->elements[i]);
  3805. }
  3806. push_text(" ]");
  3807. }
  3808. void GDScriptParser::TreePrinter::print_assert(AssertNode *p_assert) {
  3809. push_text("Assert ( ");
  3810. print_expression(p_assert->condition);
  3811. push_line(" )");
  3812. }
  3813. void GDScriptParser::TreePrinter::print_assignment(AssignmentNode *p_assignment) {
  3814. switch (p_assignment->assignee->type) {
  3815. case Node::IDENTIFIER:
  3816. print_identifier(static_cast<IdentifierNode *>(p_assignment->assignee));
  3817. break;
  3818. case Node::SUBSCRIPT:
  3819. print_subscript(static_cast<SubscriptNode *>(p_assignment->assignee));
  3820. break;
  3821. default:
  3822. break; // Unreachable.
  3823. }
  3824. push_text(" ");
  3825. switch (p_assignment->operation) {
  3826. case AssignmentNode::OP_ADDITION:
  3827. push_text("+");
  3828. break;
  3829. case AssignmentNode::OP_SUBTRACTION:
  3830. push_text("-");
  3831. break;
  3832. case AssignmentNode::OP_MULTIPLICATION:
  3833. push_text("*");
  3834. break;
  3835. case AssignmentNode::OP_DIVISION:
  3836. push_text("/");
  3837. break;
  3838. case AssignmentNode::OP_MODULO:
  3839. push_text("%");
  3840. break;
  3841. case AssignmentNode::OP_POWER:
  3842. push_text("**");
  3843. break;
  3844. case AssignmentNode::OP_BIT_SHIFT_LEFT:
  3845. push_text("<<");
  3846. break;
  3847. case AssignmentNode::OP_BIT_SHIFT_RIGHT:
  3848. push_text(">>");
  3849. break;
  3850. case AssignmentNode::OP_BIT_AND:
  3851. push_text("&");
  3852. break;
  3853. case AssignmentNode::OP_BIT_OR:
  3854. push_text("|");
  3855. break;
  3856. case AssignmentNode::OP_BIT_XOR:
  3857. push_text("^");
  3858. break;
  3859. case AssignmentNode::OP_NONE:
  3860. break;
  3861. }
  3862. push_text("= ");
  3863. print_expression(p_assignment->assigned_value);
  3864. push_line();
  3865. }
  3866. void GDScriptParser::TreePrinter::print_await(AwaitNode *p_await) {
  3867. push_text("Await ");
  3868. print_expression(p_await->to_await);
  3869. }
  3870. void GDScriptParser::TreePrinter::print_binary_op(BinaryOpNode *p_binary_op) {
  3871. // Surround in parenthesis for disambiguation.
  3872. push_text("(");
  3873. print_expression(p_binary_op->left_operand);
  3874. switch (p_binary_op->operation) {
  3875. case BinaryOpNode::OP_ADDITION:
  3876. push_text(" + ");
  3877. break;
  3878. case BinaryOpNode::OP_SUBTRACTION:
  3879. push_text(" - ");
  3880. break;
  3881. case BinaryOpNode::OP_MULTIPLICATION:
  3882. push_text(" * ");
  3883. break;
  3884. case BinaryOpNode::OP_DIVISION:
  3885. push_text(" / ");
  3886. break;
  3887. case BinaryOpNode::OP_MODULO:
  3888. push_text(" % ");
  3889. break;
  3890. case BinaryOpNode::OP_POWER:
  3891. push_text(" ** ");
  3892. break;
  3893. case BinaryOpNode::OP_BIT_LEFT_SHIFT:
  3894. push_text(" << ");
  3895. break;
  3896. case BinaryOpNode::OP_BIT_RIGHT_SHIFT:
  3897. push_text(" >> ");
  3898. break;
  3899. case BinaryOpNode::OP_BIT_AND:
  3900. push_text(" & ");
  3901. break;
  3902. case BinaryOpNode::OP_BIT_OR:
  3903. push_text(" | ");
  3904. break;
  3905. case BinaryOpNode::OP_BIT_XOR:
  3906. push_text(" ^ ");
  3907. break;
  3908. case BinaryOpNode::OP_LOGIC_AND:
  3909. push_text(" AND ");
  3910. break;
  3911. case BinaryOpNode::OP_LOGIC_OR:
  3912. push_text(" OR ");
  3913. break;
  3914. case BinaryOpNode::OP_CONTENT_TEST:
  3915. push_text(" IN ");
  3916. break;
  3917. case BinaryOpNode::OP_COMP_EQUAL:
  3918. push_text(" == ");
  3919. break;
  3920. case BinaryOpNode::OP_COMP_NOT_EQUAL:
  3921. push_text(" != ");
  3922. break;
  3923. case BinaryOpNode::OP_COMP_LESS:
  3924. push_text(" < ");
  3925. break;
  3926. case BinaryOpNode::OP_COMP_LESS_EQUAL:
  3927. push_text(" <= ");
  3928. break;
  3929. case BinaryOpNode::OP_COMP_GREATER:
  3930. push_text(" > ");
  3931. break;
  3932. case BinaryOpNode::OP_COMP_GREATER_EQUAL:
  3933. push_text(" >= ");
  3934. break;
  3935. }
  3936. print_expression(p_binary_op->right_operand);
  3937. // Surround in parenthesis for disambiguation.
  3938. push_text(")");
  3939. }
  3940. void GDScriptParser::TreePrinter::print_call(CallNode *p_call) {
  3941. if (p_call->is_super) {
  3942. push_text("super");
  3943. if (p_call->callee != nullptr) {
  3944. push_text(".");
  3945. print_expression(p_call->callee);
  3946. }
  3947. } else {
  3948. print_expression(p_call->callee);
  3949. }
  3950. push_text("( ");
  3951. for (int i = 0; i < p_call->arguments.size(); i++) {
  3952. if (i > 0) {
  3953. push_text(" , ");
  3954. }
  3955. print_expression(p_call->arguments[i]);
  3956. }
  3957. push_text(" )");
  3958. }
  3959. void GDScriptParser::TreePrinter::print_cast(CastNode *p_cast) {
  3960. print_expression(p_cast->operand);
  3961. push_text(" AS ");
  3962. print_type(p_cast->cast_type);
  3963. }
  3964. void GDScriptParser::TreePrinter::print_class(ClassNode *p_class) {
  3965. push_text("Class ");
  3966. if (p_class->identifier == nullptr) {
  3967. push_text("<unnamed>");
  3968. } else {
  3969. print_identifier(p_class->identifier);
  3970. }
  3971. if (p_class->extends_used) {
  3972. bool first = true;
  3973. push_text(" Extends ");
  3974. if (!p_class->extends_path.is_empty()) {
  3975. push_text(vformat(R"("%s")", p_class->extends_path));
  3976. first = false;
  3977. }
  3978. for (int i = 0; i < p_class->extends.size(); i++) {
  3979. if (!first) {
  3980. push_text(".");
  3981. } else {
  3982. first = false;
  3983. }
  3984. push_text(p_class->extends[i]->name);
  3985. }
  3986. }
  3987. push_line(" :");
  3988. increase_indent();
  3989. for (int i = 0; i < p_class->members.size(); i++) {
  3990. const ClassNode::Member &m = p_class->members[i];
  3991. switch (m.type) {
  3992. case ClassNode::Member::CLASS:
  3993. print_class(m.m_class);
  3994. break;
  3995. case ClassNode::Member::VARIABLE:
  3996. print_variable(m.variable);
  3997. break;
  3998. case ClassNode::Member::CONSTANT:
  3999. print_constant(m.constant);
  4000. break;
  4001. case ClassNode::Member::SIGNAL:
  4002. print_signal(m.signal);
  4003. break;
  4004. case ClassNode::Member::FUNCTION:
  4005. print_function(m.function);
  4006. break;
  4007. case ClassNode::Member::ENUM:
  4008. print_enum(m.m_enum);
  4009. break;
  4010. case ClassNode::Member::ENUM_VALUE:
  4011. break; // Nothing. Will be printed by enum.
  4012. case ClassNode::Member::GROUP:
  4013. break; // Nothing. Groups are only used by inspector.
  4014. case ClassNode::Member::UNDEFINED:
  4015. push_line("<unknown member>");
  4016. break;
  4017. }
  4018. }
  4019. decrease_indent();
  4020. }
  4021. void GDScriptParser::TreePrinter::print_constant(ConstantNode *p_constant) {
  4022. push_text("Constant ");
  4023. print_identifier(p_constant->identifier);
  4024. increase_indent();
  4025. push_line();
  4026. push_text("= ");
  4027. if (p_constant->initializer == nullptr) {
  4028. push_text("<missing value>");
  4029. } else {
  4030. print_expression(p_constant->initializer);
  4031. }
  4032. decrease_indent();
  4033. push_line();
  4034. }
  4035. void GDScriptParser::TreePrinter::print_dictionary(DictionaryNode *p_dictionary) {
  4036. push_line("{");
  4037. increase_indent();
  4038. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  4039. print_expression(p_dictionary->elements[i].key);
  4040. if (p_dictionary->style == DictionaryNode::PYTHON_DICT) {
  4041. push_text(" : ");
  4042. } else {
  4043. push_text(" = ");
  4044. }
  4045. print_expression(p_dictionary->elements[i].value);
  4046. push_line(" ,");
  4047. }
  4048. decrease_indent();
  4049. push_text("}");
  4050. }
  4051. void GDScriptParser::TreePrinter::print_expression(ExpressionNode *p_expression) {
  4052. if (p_expression == nullptr) {
  4053. push_text("<invalid expression>");
  4054. return;
  4055. }
  4056. switch (p_expression->type) {
  4057. case Node::ARRAY:
  4058. print_array(static_cast<ArrayNode *>(p_expression));
  4059. break;
  4060. case Node::ASSIGNMENT:
  4061. print_assignment(static_cast<AssignmentNode *>(p_expression));
  4062. break;
  4063. case Node::AWAIT:
  4064. print_await(static_cast<AwaitNode *>(p_expression));
  4065. break;
  4066. case Node::BINARY_OPERATOR:
  4067. print_binary_op(static_cast<BinaryOpNode *>(p_expression));
  4068. break;
  4069. case Node::CALL:
  4070. print_call(static_cast<CallNode *>(p_expression));
  4071. break;
  4072. case Node::CAST:
  4073. print_cast(static_cast<CastNode *>(p_expression));
  4074. break;
  4075. case Node::DICTIONARY:
  4076. print_dictionary(static_cast<DictionaryNode *>(p_expression));
  4077. break;
  4078. case Node::GET_NODE:
  4079. print_get_node(static_cast<GetNodeNode *>(p_expression));
  4080. break;
  4081. case Node::IDENTIFIER:
  4082. print_identifier(static_cast<IdentifierNode *>(p_expression));
  4083. break;
  4084. case Node::LAMBDA:
  4085. print_lambda(static_cast<LambdaNode *>(p_expression));
  4086. break;
  4087. case Node::LITERAL:
  4088. print_literal(static_cast<LiteralNode *>(p_expression));
  4089. break;
  4090. case Node::PRELOAD:
  4091. print_preload(static_cast<PreloadNode *>(p_expression));
  4092. break;
  4093. case Node::SELF:
  4094. print_self(static_cast<SelfNode *>(p_expression));
  4095. break;
  4096. case Node::SUBSCRIPT:
  4097. print_subscript(static_cast<SubscriptNode *>(p_expression));
  4098. break;
  4099. case Node::TERNARY_OPERATOR:
  4100. print_ternary_op(static_cast<TernaryOpNode *>(p_expression));
  4101. break;
  4102. case Node::TYPE_TEST:
  4103. print_type_test(static_cast<TypeTestNode *>(p_expression));
  4104. break;
  4105. case Node::UNARY_OPERATOR:
  4106. print_unary_op(static_cast<UnaryOpNode *>(p_expression));
  4107. break;
  4108. default:
  4109. push_text(vformat("<unknown expression %d>", p_expression->type));
  4110. break;
  4111. }
  4112. }
  4113. void GDScriptParser::TreePrinter::print_enum(EnumNode *p_enum) {
  4114. push_text("Enum ");
  4115. if (p_enum->identifier != nullptr) {
  4116. print_identifier(p_enum->identifier);
  4117. } else {
  4118. push_text("<unnamed>");
  4119. }
  4120. push_line(" {");
  4121. increase_indent();
  4122. for (int i = 0; i < p_enum->values.size(); i++) {
  4123. const EnumNode::Value &item = p_enum->values[i];
  4124. print_identifier(item.identifier);
  4125. push_text(" = ");
  4126. push_text(itos(item.value));
  4127. push_line(" ,");
  4128. }
  4129. decrease_indent();
  4130. push_line("}");
  4131. }
  4132. void GDScriptParser::TreePrinter::print_for(ForNode *p_for) {
  4133. push_text("For ");
  4134. print_identifier(p_for->variable);
  4135. push_text(" IN ");
  4136. print_expression(p_for->list);
  4137. push_line(" :");
  4138. increase_indent();
  4139. print_suite(p_for->loop);
  4140. decrease_indent();
  4141. }
  4142. void GDScriptParser::TreePrinter::print_function(FunctionNode *p_function, const String &p_context) {
  4143. for (const AnnotationNode *E : p_function->annotations) {
  4144. print_annotation(E);
  4145. }
  4146. push_text(p_context);
  4147. push_text(" ");
  4148. if (p_function->identifier) {
  4149. print_identifier(p_function->identifier);
  4150. } else {
  4151. push_text("<anonymous>");
  4152. }
  4153. push_text("( ");
  4154. for (int i = 0; i < p_function->parameters.size(); i++) {
  4155. if (i > 0) {
  4156. push_text(" , ");
  4157. }
  4158. print_parameter(p_function->parameters[i]);
  4159. }
  4160. push_line(" ) :");
  4161. increase_indent();
  4162. print_suite(p_function->body);
  4163. decrease_indent();
  4164. }
  4165. void GDScriptParser::TreePrinter::print_get_node(GetNodeNode *p_get_node) {
  4166. if (p_get_node->use_dollar) {
  4167. push_text("$");
  4168. }
  4169. push_text(p_get_node->full_path);
  4170. }
  4171. void GDScriptParser::TreePrinter::print_identifier(IdentifierNode *p_identifier) {
  4172. if (p_identifier != nullptr) {
  4173. push_text(p_identifier->name);
  4174. } else {
  4175. push_text("<invalid identifier>");
  4176. }
  4177. }
  4178. void GDScriptParser::TreePrinter::print_if(IfNode *p_if, bool p_is_elif) {
  4179. if (p_is_elif) {
  4180. push_text("Elif ");
  4181. } else {
  4182. push_text("If ");
  4183. }
  4184. print_expression(p_if->condition);
  4185. push_line(" :");
  4186. increase_indent();
  4187. print_suite(p_if->true_block);
  4188. decrease_indent();
  4189. // FIXME: Properly detect "elif" blocks.
  4190. if (p_if->false_block != nullptr) {
  4191. push_line("Else :");
  4192. increase_indent();
  4193. print_suite(p_if->false_block);
  4194. decrease_indent();
  4195. }
  4196. }
  4197. void GDScriptParser::TreePrinter::print_lambda(LambdaNode *p_lambda) {
  4198. print_function(p_lambda->function, "Lambda");
  4199. push_text("| captures [ ");
  4200. for (int i = 0; i < p_lambda->captures.size(); i++) {
  4201. if (i > 0) {
  4202. push_text(" , ");
  4203. }
  4204. push_text(p_lambda->captures[i]->name.operator String());
  4205. }
  4206. push_line(" ]");
  4207. }
  4208. void GDScriptParser::TreePrinter::print_literal(LiteralNode *p_literal) {
  4209. // Prefix for string types.
  4210. switch (p_literal->value.get_type()) {
  4211. case Variant::NODE_PATH:
  4212. push_text("^\"");
  4213. break;
  4214. case Variant::STRING:
  4215. push_text("\"");
  4216. break;
  4217. case Variant::STRING_NAME:
  4218. push_text("&\"");
  4219. break;
  4220. default:
  4221. break;
  4222. }
  4223. push_text(p_literal->value);
  4224. // Suffix for string types.
  4225. switch (p_literal->value.get_type()) {
  4226. case Variant::NODE_PATH:
  4227. case Variant::STRING:
  4228. case Variant::STRING_NAME:
  4229. push_text("\"");
  4230. break;
  4231. default:
  4232. break;
  4233. }
  4234. }
  4235. void GDScriptParser::TreePrinter::print_match(MatchNode *p_match) {
  4236. push_text("Match ");
  4237. print_expression(p_match->test);
  4238. push_line(" :");
  4239. increase_indent();
  4240. for (int i = 0; i < p_match->branches.size(); i++) {
  4241. print_match_branch(p_match->branches[i]);
  4242. }
  4243. decrease_indent();
  4244. }
  4245. void GDScriptParser::TreePrinter::print_match_branch(MatchBranchNode *p_match_branch) {
  4246. for (int i = 0; i < p_match_branch->patterns.size(); i++) {
  4247. if (i > 0) {
  4248. push_text(" , ");
  4249. }
  4250. print_match_pattern(p_match_branch->patterns[i]);
  4251. }
  4252. push_line(" :");
  4253. increase_indent();
  4254. print_suite(p_match_branch->block);
  4255. decrease_indent();
  4256. }
  4257. void GDScriptParser::TreePrinter::print_match_pattern(PatternNode *p_match_pattern) {
  4258. switch (p_match_pattern->pattern_type) {
  4259. case PatternNode::PT_LITERAL:
  4260. print_literal(p_match_pattern->literal);
  4261. break;
  4262. case PatternNode::PT_WILDCARD:
  4263. push_text("_");
  4264. break;
  4265. case PatternNode::PT_REST:
  4266. push_text("..");
  4267. break;
  4268. case PatternNode::PT_BIND:
  4269. push_text("Var ");
  4270. print_identifier(p_match_pattern->bind);
  4271. break;
  4272. case PatternNode::PT_EXPRESSION:
  4273. print_expression(p_match_pattern->expression);
  4274. break;
  4275. case PatternNode::PT_ARRAY:
  4276. push_text("[ ");
  4277. for (int i = 0; i < p_match_pattern->array.size(); i++) {
  4278. if (i > 0) {
  4279. push_text(" , ");
  4280. }
  4281. print_match_pattern(p_match_pattern->array[i]);
  4282. }
  4283. push_text(" ]");
  4284. break;
  4285. case PatternNode::PT_DICTIONARY:
  4286. push_text("{ ");
  4287. for (int i = 0; i < p_match_pattern->dictionary.size(); i++) {
  4288. if (i > 0) {
  4289. push_text(" , ");
  4290. }
  4291. if (p_match_pattern->dictionary[i].key != nullptr) {
  4292. // Key can be null for rest pattern.
  4293. print_expression(p_match_pattern->dictionary[i].key);
  4294. push_text(" : ");
  4295. }
  4296. print_match_pattern(p_match_pattern->dictionary[i].value_pattern);
  4297. }
  4298. push_text(" }");
  4299. break;
  4300. }
  4301. }
  4302. void GDScriptParser::TreePrinter::print_parameter(ParameterNode *p_parameter) {
  4303. print_identifier(p_parameter->identifier);
  4304. if (p_parameter->datatype_specifier != nullptr) {
  4305. push_text(" : ");
  4306. print_type(p_parameter->datatype_specifier);
  4307. }
  4308. if (p_parameter->initializer != nullptr) {
  4309. push_text(" = ");
  4310. print_expression(p_parameter->initializer);
  4311. }
  4312. }
  4313. void GDScriptParser::TreePrinter::print_preload(PreloadNode *p_preload) {
  4314. push_text(R"(Preload ( ")");
  4315. push_text(p_preload->resolved_path);
  4316. push_text(R"(" )");
  4317. }
  4318. void GDScriptParser::TreePrinter::print_return(ReturnNode *p_return) {
  4319. push_text("Return");
  4320. if (p_return->return_value != nullptr) {
  4321. push_text(" ");
  4322. print_expression(p_return->return_value);
  4323. }
  4324. push_line();
  4325. }
  4326. void GDScriptParser::TreePrinter::print_self(SelfNode *p_self) {
  4327. push_text("Self(");
  4328. if (p_self->current_class->identifier != nullptr) {
  4329. print_identifier(p_self->current_class->identifier);
  4330. } else {
  4331. push_text("<main class>");
  4332. }
  4333. push_text(")");
  4334. }
  4335. void GDScriptParser::TreePrinter::print_signal(SignalNode *p_signal) {
  4336. push_text("Signal ");
  4337. print_identifier(p_signal->identifier);
  4338. push_text("( ");
  4339. for (int i = 0; i < p_signal->parameters.size(); i++) {
  4340. print_parameter(p_signal->parameters[i]);
  4341. }
  4342. push_line(" )");
  4343. }
  4344. void GDScriptParser::TreePrinter::print_subscript(SubscriptNode *p_subscript) {
  4345. print_expression(p_subscript->base);
  4346. if (p_subscript->is_attribute) {
  4347. push_text(".");
  4348. print_identifier(p_subscript->attribute);
  4349. } else {
  4350. push_text("[ ");
  4351. print_expression(p_subscript->index);
  4352. push_text(" ]");
  4353. }
  4354. }
  4355. void GDScriptParser::TreePrinter::print_statement(Node *p_statement) {
  4356. switch (p_statement->type) {
  4357. case Node::ASSERT:
  4358. print_assert(static_cast<AssertNode *>(p_statement));
  4359. break;
  4360. case Node::VARIABLE:
  4361. print_variable(static_cast<VariableNode *>(p_statement));
  4362. break;
  4363. case Node::CONSTANT:
  4364. print_constant(static_cast<ConstantNode *>(p_statement));
  4365. break;
  4366. case Node::IF:
  4367. print_if(static_cast<IfNode *>(p_statement));
  4368. break;
  4369. case Node::FOR:
  4370. print_for(static_cast<ForNode *>(p_statement));
  4371. break;
  4372. case Node::WHILE:
  4373. print_while(static_cast<WhileNode *>(p_statement));
  4374. break;
  4375. case Node::MATCH:
  4376. print_match(static_cast<MatchNode *>(p_statement));
  4377. break;
  4378. case Node::RETURN:
  4379. print_return(static_cast<ReturnNode *>(p_statement));
  4380. break;
  4381. case Node::BREAK:
  4382. push_line("Break");
  4383. break;
  4384. case Node::CONTINUE:
  4385. push_line("Continue");
  4386. break;
  4387. case Node::PASS:
  4388. push_line("Pass");
  4389. break;
  4390. case Node::BREAKPOINT:
  4391. push_line("Breakpoint");
  4392. break;
  4393. case Node::ASSIGNMENT:
  4394. print_assignment(static_cast<AssignmentNode *>(p_statement));
  4395. break;
  4396. default:
  4397. if (p_statement->is_expression()) {
  4398. print_expression(static_cast<ExpressionNode *>(p_statement));
  4399. push_line();
  4400. } else {
  4401. push_line(vformat("<unknown statement %d>", p_statement->type));
  4402. }
  4403. break;
  4404. }
  4405. }
  4406. void GDScriptParser::TreePrinter::print_suite(SuiteNode *p_suite) {
  4407. for (int i = 0; i < p_suite->statements.size(); i++) {
  4408. print_statement(p_suite->statements[i]);
  4409. }
  4410. }
  4411. void GDScriptParser::TreePrinter::print_ternary_op(TernaryOpNode *p_ternary_op) {
  4412. // Surround in parenthesis for disambiguation.
  4413. push_text("(");
  4414. print_expression(p_ternary_op->true_expr);
  4415. push_text(") IF (");
  4416. print_expression(p_ternary_op->condition);
  4417. push_text(") ELSE (");
  4418. print_expression(p_ternary_op->false_expr);
  4419. push_text(")");
  4420. }
  4421. void GDScriptParser::TreePrinter::print_type(TypeNode *p_type) {
  4422. if (p_type->type_chain.is_empty()) {
  4423. push_text("Void");
  4424. } else {
  4425. for (int i = 0; i < p_type->type_chain.size(); i++) {
  4426. if (i > 0) {
  4427. push_text(".");
  4428. }
  4429. print_identifier(p_type->type_chain[i]);
  4430. }
  4431. }
  4432. }
  4433. void GDScriptParser::TreePrinter::print_type_test(TypeTestNode *p_test) {
  4434. print_expression(p_test->operand);
  4435. push_text(" IS ");
  4436. print_type(p_test->test_type);
  4437. }
  4438. void GDScriptParser::TreePrinter::print_unary_op(UnaryOpNode *p_unary_op) {
  4439. // Surround in parenthesis for disambiguation.
  4440. push_text("(");
  4441. switch (p_unary_op->operation) {
  4442. case UnaryOpNode::OP_POSITIVE:
  4443. push_text("+");
  4444. break;
  4445. case UnaryOpNode::OP_NEGATIVE:
  4446. push_text("-");
  4447. break;
  4448. case UnaryOpNode::OP_LOGIC_NOT:
  4449. push_text("NOT");
  4450. break;
  4451. case UnaryOpNode::OP_COMPLEMENT:
  4452. push_text("~");
  4453. break;
  4454. }
  4455. print_expression(p_unary_op->operand);
  4456. // Surround in parenthesis for disambiguation.
  4457. push_text(")");
  4458. }
  4459. void GDScriptParser::TreePrinter::print_variable(VariableNode *p_variable) {
  4460. for (const AnnotationNode *E : p_variable->annotations) {
  4461. print_annotation(E);
  4462. }
  4463. push_text("Variable ");
  4464. print_identifier(p_variable->identifier);
  4465. push_text(" : ");
  4466. if (p_variable->datatype_specifier != nullptr) {
  4467. print_type(p_variable->datatype_specifier);
  4468. } else if (p_variable->infer_datatype) {
  4469. push_text("<inferred type>");
  4470. } else {
  4471. push_text("Variant");
  4472. }
  4473. increase_indent();
  4474. push_line();
  4475. push_text("= ");
  4476. if (p_variable->initializer == nullptr) {
  4477. push_text("<default value>");
  4478. } else {
  4479. print_expression(p_variable->initializer);
  4480. }
  4481. push_line();
  4482. if (p_variable->property != VariableNode::PROP_NONE) {
  4483. if (p_variable->getter != nullptr) {
  4484. push_text("Get");
  4485. if (p_variable->property == VariableNode::PROP_INLINE) {
  4486. push_line(":");
  4487. increase_indent();
  4488. print_suite(p_variable->getter->body);
  4489. decrease_indent();
  4490. } else {
  4491. push_line(" =");
  4492. increase_indent();
  4493. print_identifier(p_variable->getter_pointer);
  4494. push_line();
  4495. decrease_indent();
  4496. }
  4497. }
  4498. if (p_variable->setter != nullptr) {
  4499. push_text("Set (");
  4500. if (p_variable->property == VariableNode::PROP_INLINE) {
  4501. if (p_variable->setter_parameter != nullptr) {
  4502. print_identifier(p_variable->setter_parameter);
  4503. } else {
  4504. push_text("<missing>");
  4505. }
  4506. push_line("):");
  4507. increase_indent();
  4508. print_suite(p_variable->setter->body);
  4509. decrease_indent();
  4510. } else {
  4511. push_line(" =");
  4512. increase_indent();
  4513. print_identifier(p_variable->setter_pointer);
  4514. push_line();
  4515. decrease_indent();
  4516. }
  4517. }
  4518. }
  4519. decrease_indent();
  4520. push_line();
  4521. }
  4522. void GDScriptParser::TreePrinter::print_while(WhileNode *p_while) {
  4523. push_text("While ");
  4524. print_expression(p_while->condition);
  4525. push_line(" :");
  4526. increase_indent();
  4527. print_suite(p_while->loop);
  4528. decrease_indent();
  4529. }
  4530. void GDScriptParser::TreePrinter::print_tree(const GDScriptParser &p_parser) {
  4531. ERR_FAIL_COND_MSG(p_parser.get_tree() == nullptr, "Parse the code before printing the parse tree.");
  4532. if (p_parser.is_tool()) {
  4533. push_line("@tool");
  4534. }
  4535. if (!p_parser.get_tree()->icon_path.is_empty()) {
  4536. push_text(R"(@icon (")");
  4537. push_text(p_parser.get_tree()->icon_path);
  4538. push_line("\")");
  4539. }
  4540. print_class(p_parser.get_tree());
  4541. print_line(String(printed));
  4542. }
  4543. #endif // DEBUG_ENABLED