gdscript_parser.cpp 167 KB

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