gdscript_parser.cpp 173 KB

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