gdscript_parser.cpp 129 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840
  1. /*************************************************************************/
  2. /* gdscript_parser.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
  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/io/resource_loader.h"
  32. #include "core/math/math_defs.h"
  33. #include "core/os/file_access.h"
  34. #include "core/project_settings.h"
  35. #include "gdscript.h"
  36. #ifdef DEBUG_ENABLED
  37. #include "core/os/os.h"
  38. #include "core/string_builder.h"
  39. #endif // DEBUG_ENABLED
  40. #ifdef TOOLS_ENABLED
  41. #include "editor/editor_settings.h"
  42. #endif // TOOLS_ENABLED
  43. static HashMap<StringName, Variant::Type> builtin_types;
  44. Variant::Type GDScriptParser::get_builtin_type(const StringName &p_type) {
  45. if (builtin_types.empty()) {
  46. builtin_types["bool"] = Variant::BOOL;
  47. builtin_types["int"] = Variant::INT;
  48. builtin_types["float"] = Variant::FLOAT;
  49. builtin_types["String"] = Variant::STRING;
  50. builtin_types["Vector2"] = Variant::VECTOR2;
  51. builtin_types["Vector2i"] = Variant::VECTOR2I;
  52. builtin_types["Rect2"] = Variant::RECT2;
  53. builtin_types["Rect2i"] = Variant::RECT2I;
  54. builtin_types["Transform2D"] = Variant::TRANSFORM2D;
  55. builtin_types["Vector3"] = Variant::VECTOR3;
  56. builtin_types["Vector3i"] = Variant::VECTOR3I;
  57. builtin_types["AABB"] = Variant::AABB;
  58. builtin_types["Plane"] = Variant::PLANE;
  59. builtin_types["Quat"] = Variant::QUAT;
  60. builtin_types["Basis"] = Variant::BASIS;
  61. builtin_types["Transform"] = Variant::TRANSFORM;
  62. builtin_types["Color"] = Variant::COLOR;
  63. builtin_types["RID"] = Variant::_RID;
  64. builtin_types["Object"] = Variant::OBJECT;
  65. builtin_types["StringName"] = Variant::STRING_NAME;
  66. builtin_types["NodePath"] = Variant::NODE_PATH;
  67. builtin_types["Dictionary"] = Variant::DICTIONARY;
  68. builtin_types["Callable"] = Variant::CALLABLE;
  69. builtin_types["Signal"] = Variant::SIGNAL;
  70. builtin_types["Array"] = Variant::ARRAY;
  71. builtin_types["PackedByteArray"] = Variant::PACKED_BYTE_ARRAY;
  72. builtin_types["PackedInt32Array"] = Variant::PACKED_INT32_ARRAY;
  73. builtin_types["PackedInt64Array"] = Variant::PACKED_INT64_ARRAY;
  74. builtin_types["PackedFloat32Array"] = Variant::PACKED_FLOAT32_ARRAY;
  75. builtin_types["PackedFloat64Array"] = Variant::PACKED_FLOAT64_ARRAY;
  76. builtin_types["PackedStringArray"] = Variant::PACKED_STRING_ARRAY;
  77. builtin_types["PackedVector2Array"] = Variant::PACKED_VECTOR2_ARRAY;
  78. builtin_types["PackedVector3Array"] = Variant::PACKED_VECTOR3_ARRAY;
  79. builtin_types["PackedColorArray"] = Variant::PACKED_COLOR_ARRAY;
  80. // NIL is not here, hence the -1.
  81. if (builtin_types.size() != Variant::VARIANT_MAX - 1) {
  82. ERR_PRINT("Outdated parser: amount of built-in types don't match the amount of types in Variant.");
  83. }
  84. }
  85. if (builtin_types.has(p_type)) {
  86. return builtin_types[p_type];
  87. }
  88. return Variant::VARIANT_MAX;
  89. }
  90. void GDScriptParser::cleanup() {
  91. builtin_types.clear();
  92. }
  93. GDScriptFunctions::Function GDScriptParser::get_builtin_function(const StringName &p_name) {
  94. for (int i = 0; i < GDScriptFunctions::FUNC_MAX; i++) {
  95. if (p_name == GDScriptFunctions::get_func_name(GDScriptFunctions::Function(i))) {
  96. return GDScriptFunctions::Function(i);
  97. }
  98. }
  99. return GDScriptFunctions::FUNC_MAX;
  100. }
  101. void GDScriptParser::get_annotation_list(List<MethodInfo> *r_annotations) const {
  102. List<StringName> keys;
  103. valid_annotations.get_key_list(&keys);
  104. for (const List<StringName>::Element *E = keys.front(); E != nullptr; E = E->next()) {
  105. r_annotations->push_back(valid_annotations[E->get()].info);
  106. }
  107. }
  108. GDScriptParser::GDScriptParser() {
  109. // Register valid annotations.
  110. // TODO: Should this be static?
  111. // TODO: Validate applicable types (e.g. a VARIABLE annotation that only applies to string variables).
  112. register_annotation(MethodInfo("@tool"), AnnotationInfo::SCRIPT, &GDScriptParser::tool_annotation);
  113. register_annotation(MethodInfo("@icon", { Variant::STRING, "icon_path" }), AnnotationInfo::SCRIPT, &GDScriptParser::icon_annotation);
  114. register_annotation(MethodInfo("@onready"), AnnotationInfo::VARIABLE, &GDScriptParser::onready_annotation);
  115. // Export annotations.
  116. register_annotation(MethodInfo("@export"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_TYPE_STRING, Variant::NIL>);
  117. register_annotation(MethodInfo("@export_enum", { Variant::STRING, "names" }), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_ENUM, Variant::INT>, 0, true);
  118. register_annotation(MethodInfo("@export_file", { Variant::STRING, "filter" }), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_FILE, Variant::STRING>, 1, true);
  119. register_annotation(MethodInfo("@export_dir"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_DIR, Variant::STRING>);
  120. register_annotation(MethodInfo("@export_global_file", { Variant::STRING, "filter" }), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_GLOBAL_FILE, Variant::STRING>, 1, true);
  121. register_annotation(MethodInfo("@export_global_dir"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_GLOBAL_DIR, Variant::STRING>);
  122. register_annotation(MethodInfo("@export_multiline"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_MULTILINE_TEXT, Variant::STRING>);
  123. register_annotation(MethodInfo("@export_placeholder"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_PLACEHOLDER_TEXT, Variant::STRING>);
  124. register_annotation(MethodInfo("@export_range", { Variant::FLOAT, "min" }, { Variant::FLOAT, "max" }, { Variant::FLOAT, "step" }, { Variant::STRING, "slider1" }, { Variant::STRING, "slider2" }), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_RANGE, Variant::FLOAT>, 3);
  125. register_annotation(MethodInfo("@export_exp_range", { Variant::FLOAT, "min" }, { Variant::FLOAT, "max" }, { Variant::FLOAT, "step" }, { Variant::STRING, "slider1" }, { Variant::STRING, "slider2" }), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_EXP_RANGE, Variant::FLOAT>, 3);
  126. register_annotation(MethodInfo("@export_exp_easing", { Variant::STRING, "hint1" }, { Variant::STRING, "hint2" }), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_EXP_EASING, Variant::FLOAT>, 2);
  127. register_annotation(MethodInfo("@export_color_no_alpha"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_COLOR_NO_ALPHA, Variant::COLOR>);
  128. register_annotation(MethodInfo("@export_node_path", { Variant::STRING, "type" }), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_NODE_PATH_VALID_TYPES, Variant::NODE_PATH>, 1, true);
  129. register_annotation(MethodInfo("@export_flags", { Variant::STRING, "names" }), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_FLAGS, Variant::INT>, 0, true);
  130. register_annotation(MethodInfo("@export_flags_2d_render"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_2D_RENDER, Variant::INT>);
  131. register_annotation(MethodInfo("@export_flags_2d_physics"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_2D_PHYSICS, Variant::INT>);
  132. register_annotation(MethodInfo("@export_flags_3d_render"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_3D_RENDER, Variant::INT>);
  133. register_annotation(MethodInfo("@export_flags_3d_physics"), AnnotationInfo::VARIABLE, &GDScriptParser::export_annotations<PROPERTY_HINT_LAYERS_3D_PHYSICS, Variant::INT>);
  134. // Networking.
  135. register_annotation(MethodInfo("@remote"), AnnotationInfo::VARIABLE | AnnotationInfo::FUNCTION, &GDScriptParser::network_annotations<MultiplayerAPI::RPC_MODE_REMOTE>);
  136. register_annotation(MethodInfo("@master"), AnnotationInfo::VARIABLE | AnnotationInfo::FUNCTION, &GDScriptParser::network_annotations<MultiplayerAPI::RPC_MODE_MASTER>);
  137. register_annotation(MethodInfo("@puppet"), AnnotationInfo::VARIABLE | AnnotationInfo::FUNCTION, &GDScriptParser::network_annotations<MultiplayerAPI::RPC_MODE_PUPPET>);
  138. register_annotation(MethodInfo("@remotesync"), AnnotationInfo::VARIABLE | AnnotationInfo::FUNCTION, &GDScriptParser::network_annotations<MultiplayerAPI::RPC_MODE_REMOTESYNC>);
  139. register_annotation(MethodInfo("@mastersync"), AnnotationInfo::VARIABLE | AnnotationInfo::FUNCTION, &GDScriptParser::network_annotations<MultiplayerAPI::RPC_MODE_MASTERSYNC>);
  140. register_annotation(MethodInfo("@puppetsync"), AnnotationInfo::VARIABLE | AnnotationInfo::FUNCTION, &GDScriptParser::network_annotations<MultiplayerAPI::RPC_MODE_PUPPETSYNC>);
  141. // TODO: Warning annotations.
  142. }
  143. GDScriptParser::~GDScriptParser() {
  144. clear();
  145. }
  146. void GDScriptParser::clear() {
  147. while (list != nullptr) {
  148. Node *element = list;
  149. list = list->next;
  150. memdelete(element);
  151. }
  152. head = nullptr;
  153. list = nullptr;
  154. _is_tool = false;
  155. for_completion = false;
  156. errors.clear();
  157. multiline_stack.clear();
  158. }
  159. void GDScriptParser::push_error(const String &p_message, const Node *p_origin) {
  160. // TODO: Improve error reporting by pointing at source code.
  161. // TODO: Errors might point at more than one place at once (e.g. show previous declaration).
  162. panic_mode = true;
  163. // TODO: Improve positional information.
  164. if (p_origin == nullptr) {
  165. errors.push_back({ p_message, current.start_line, current.start_column });
  166. } else {
  167. errors.push_back({ p_message, p_origin->start_line, p_origin->leftmost_column });
  168. }
  169. }
  170. #ifdef DEBUG_ENABLED
  171. void GDScriptParser::push_warning(const Node *p_source, GDScriptWarning::Code p_code, const String &p_symbol1, const String &p_symbol2, const String &p_symbol3, const String &p_symbol4) {
  172. Vector<String> symbols;
  173. if (!p_symbol1.empty()) {
  174. symbols.push_back(p_symbol1);
  175. }
  176. if (!p_symbol2.empty()) {
  177. symbols.push_back(p_symbol2);
  178. }
  179. if (!p_symbol3.empty()) {
  180. symbols.push_back(p_symbol3);
  181. }
  182. if (!p_symbol4.empty()) {
  183. symbols.push_back(p_symbol4);
  184. }
  185. push_warning(p_source, p_code, symbols);
  186. }
  187. void GDScriptParser::push_warning(const Node *p_source, GDScriptWarning::Code p_code, const Vector<String> &p_symbols) {
  188. if (is_ignoring_warnings) {
  189. return;
  190. }
  191. if (GLOBAL_GET("debug/gdscript/warnings/exclude_addons").booleanize() && script_path.begins_with("res://addons/")) {
  192. return;
  193. }
  194. String warn_name = GDScriptWarning::get_name_from_code((GDScriptWarning::Code)p_code).to_lower();
  195. if (ignored_warnings.has(warn_name)) {
  196. return;
  197. }
  198. if (!GLOBAL_GET("debug/gdscript/warnings/" + warn_name)) {
  199. return;
  200. }
  201. GDScriptWarning warning;
  202. warning.code = p_code;
  203. warning.symbols = p_symbols;
  204. warning.start_line = p_source->start_line;
  205. warning.end_line = p_source->end_line;
  206. warning.leftmost_column = p_source->leftmost_column;
  207. warning.rightmost_column = p_source->rightmost_column;
  208. List<GDScriptWarning>::Element *before = nullptr;
  209. for (List<GDScriptWarning>::Element *E = warnings.front(); E != nullptr; E = E->next()) {
  210. if (E->get().start_line > warning.start_line) {
  211. break;
  212. }
  213. before = E;
  214. }
  215. if (before) {
  216. warnings.insert_after(before, warning);
  217. } else {
  218. warnings.push_front(warning);
  219. }
  220. }
  221. #endif
  222. void GDScriptParser::make_completion_context(CompletionType p_type, Node *p_node, int p_argument, bool p_force) {
  223. if (!for_completion || (!p_force && completion_context.type != COMPLETION_NONE)) {
  224. return;
  225. }
  226. if (previous.cursor_place != GDScriptTokenizer::CURSOR_MIDDLE && previous.cursor_place != GDScriptTokenizer::CURSOR_END && current.cursor_place == GDScriptTokenizer::CURSOR_NONE) {
  227. return;
  228. }
  229. CompletionContext context;
  230. context.type = p_type;
  231. context.current_class = current_class;
  232. context.current_function = current_function;
  233. context.current_suite = current_suite;
  234. context.current_line = tokenizer.get_cursor_line();
  235. context.current_argument = p_argument;
  236. context.node = p_node;
  237. completion_context = context;
  238. }
  239. void GDScriptParser::make_completion_context(CompletionType p_type, Variant::Type p_builtin_type, bool p_force) {
  240. if (!for_completion || (!p_force && completion_context.type != COMPLETION_NONE)) {
  241. return;
  242. }
  243. if (previous.cursor_place != GDScriptTokenizer::CURSOR_MIDDLE && previous.cursor_place != GDScriptTokenizer::CURSOR_END && current.cursor_place == GDScriptTokenizer::CURSOR_NONE) {
  244. return;
  245. }
  246. CompletionContext context;
  247. context.type = p_type;
  248. context.current_class = current_class;
  249. context.current_function = current_function;
  250. context.current_suite = current_suite;
  251. context.current_line = tokenizer.get_cursor_line();
  252. context.builtin_type = p_builtin_type;
  253. completion_context = context;
  254. }
  255. void GDScriptParser::push_completion_call(Node *p_call) {
  256. if (!for_completion) {
  257. return;
  258. }
  259. CompletionCall call;
  260. call.call = p_call;
  261. call.argument = 0;
  262. completion_call_stack.push_back(call);
  263. if (previous.cursor_place == GDScriptTokenizer::CURSOR_MIDDLE || previous.cursor_place == GDScriptTokenizer::CURSOR_END || current.cursor_place == GDScriptTokenizer::CURSOR_BEGINNING) {
  264. completion_call = call;
  265. }
  266. }
  267. void GDScriptParser::pop_completion_call() {
  268. if (!for_completion) {
  269. return;
  270. }
  271. ERR_FAIL_COND_MSG(completion_call_stack.empty(), "Trying to pop empty completion call stack");
  272. completion_call_stack.pop_back();
  273. }
  274. void GDScriptParser::set_last_completion_call_arg(int p_argument) {
  275. if (!for_completion || passed_cursor) {
  276. return;
  277. }
  278. ERR_FAIL_COND_MSG(completion_call_stack.empty(), "Trying to set argument on empty completion call stack");
  279. completion_call_stack.back()->get().argument = p_argument;
  280. }
  281. Error GDScriptParser::parse(const String &p_source_code, const String &p_script_path, bool p_for_completion) {
  282. clear();
  283. String source = p_source_code;
  284. int cursor_line = -1;
  285. int cursor_column = -1;
  286. for_completion = p_for_completion;
  287. int tab_size = 4;
  288. #ifdef TOOLS_ENABLED
  289. if (EditorSettings::get_singleton()) {
  290. tab_size = EditorSettings::get_singleton()->get_setting("text_editor/indent/size");
  291. }
  292. #endif // TOOLS_ENABLED
  293. if (p_for_completion) {
  294. // Remove cursor sentinel char.
  295. const Vector<String> lines = p_source_code.split("\n");
  296. cursor_line = 1;
  297. cursor_column = 1;
  298. for (int i = 0; i < lines.size(); i++) {
  299. bool found = false;
  300. const String &line = lines[i];
  301. for (int j = 0; j < line.size(); j++) {
  302. if (line[j] == CharType(0xFFFF)) {
  303. found = true;
  304. break;
  305. } else if (line[j] == '\t') {
  306. cursor_column += tab_size - 1;
  307. }
  308. cursor_column++;
  309. }
  310. if (found) {
  311. break;
  312. }
  313. cursor_line++;
  314. cursor_column = 1;
  315. }
  316. source = source.replace_first(String::chr(0xFFFF), String());
  317. }
  318. tokenizer.set_source_code(source);
  319. tokenizer.set_cursor_position(cursor_line, cursor_column);
  320. script_path = p_script_path;
  321. current = tokenizer.scan();
  322. // Avoid error as the first token.
  323. while (current.type == GDScriptTokenizer::Token::ERROR) {
  324. push_error(current.literal);
  325. current = tokenizer.scan();
  326. }
  327. push_multiline(false); // Keep one for the whole parsing.
  328. parse_program();
  329. pop_multiline();
  330. #ifdef DEBUG_ENABLED
  331. if (multiline_stack.size() > 0) {
  332. ERR_PRINT("Parser bug: Imbalanced multiline stack.");
  333. }
  334. #endif
  335. if (errors.empty()) {
  336. return OK;
  337. } else {
  338. return ERR_PARSE_ERROR;
  339. }
  340. }
  341. GDScriptTokenizer::Token GDScriptParser::advance() {
  342. if (current.type == GDScriptTokenizer::Token::TK_EOF) {
  343. ERR_FAIL_COND_V_MSG(current.type == GDScriptTokenizer::Token::TK_EOF, current, "GDScript parser bug: Trying to advance past the end of stream.");
  344. }
  345. if (for_completion && !completion_call_stack.empty()) {
  346. if (completion_call.call == nullptr && tokenizer.is_past_cursor()) {
  347. completion_call = completion_call_stack.back()->get();
  348. passed_cursor = true;
  349. }
  350. }
  351. previous = current;
  352. current = tokenizer.scan();
  353. while (current.type == GDScriptTokenizer::Token::ERROR) {
  354. push_error(current.literal);
  355. current = tokenizer.scan();
  356. }
  357. return previous;
  358. }
  359. bool GDScriptParser::match(GDScriptTokenizer::Token::Type p_token_type) {
  360. if (!check(p_token_type)) {
  361. return false;
  362. }
  363. advance();
  364. return true;
  365. }
  366. bool GDScriptParser::check(GDScriptTokenizer::Token::Type p_token_type) {
  367. if (p_token_type == GDScriptTokenizer::Token::IDENTIFIER) {
  368. return current.is_identifier();
  369. }
  370. return current.type == p_token_type;
  371. }
  372. bool GDScriptParser::consume(GDScriptTokenizer::Token::Type p_token_type, const String &p_error_message) {
  373. if (match(p_token_type)) {
  374. return true;
  375. }
  376. push_error(p_error_message);
  377. return false;
  378. }
  379. bool GDScriptParser::is_at_end() {
  380. return check(GDScriptTokenizer::Token::TK_EOF);
  381. }
  382. void GDScriptParser::synchronize() {
  383. panic_mode = false;
  384. while (!is_at_end()) {
  385. if (previous.type == GDScriptTokenizer::Token::NEWLINE || previous.type == GDScriptTokenizer::Token::SEMICOLON) {
  386. return;
  387. }
  388. switch (current.type) {
  389. case GDScriptTokenizer::Token::CLASS:
  390. case GDScriptTokenizer::Token::FUNC:
  391. case GDScriptTokenizer::Token::STATIC:
  392. case GDScriptTokenizer::Token::VAR:
  393. case GDScriptTokenizer::Token::CONST:
  394. case GDScriptTokenizer::Token::SIGNAL:
  395. //case GDScriptTokenizer::Token::IF: // Can also be inside expressions.
  396. case GDScriptTokenizer::Token::FOR:
  397. case GDScriptTokenizer::Token::WHILE:
  398. case GDScriptTokenizer::Token::MATCH:
  399. case GDScriptTokenizer::Token::RETURN:
  400. case GDScriptTokenizer::Token::ANNOTATION:
  401. return;
  402. default:
  403. // Do nothing.
  404. break;
  405. }
  406. advance();
  407. }
  408. }
  409. void GDScriptParser::push_multiline(bool p_state) {
  410. multiline_stack.push_back(p_state);
  411. tokenizer.set_multiline_mode(p_state);
  412. if (p_state) {
  413. // Consume potential whitespace tokens already waiting in line.
  414. while (current.type == GDScriptTokenizer::Token::NEWLINE || current.type == GDScriptTokenizer::Token::INDENT || current.type == GDScriptTokenizer::Token::DEDENT) {
  415. current = tokenizer.scan(); // Don't call advance() here, as we don't want to change the previous token.
  416. }
  417. }
  418. }
  419. void GDScriptParser::pop_multiline() {
  420. ERR_FAIL_COND_MSG(multiline_stack.size() == 0, "Parser bug: trying to pop from multiline stack without available value.");
  421. multiline_stack.pop_back();
  422. tokenizer.set_multiline_mode(multiline_stack.size() > 0 ? multiline_stack.back()->get() : false);
  423. }
  424. bool GDScriptParser::is_statement_end() {
  425. return check(GDScriptTokenizer::Token::NEWLINE) || check(GDScriptTokenizer::Token::SEMICOLON) || check(GDScriptTokenizer::Token::TK_EOF);
  426. }
  427. void GDScriptParser::end_statement(const String &p_context) {
  428. bool found = false;
  429. while (is_statement_end() && !is_at_end()) {
  430. // Remove sequential newlines/semicolons.
  431. found = true;
  432. advance();
  433. }
  434. if (!found && !is_at_end()) {
  435. push_error(vformat(R"(Expected end of statement after %s, found "%s" instead.)", p_context, current.get_name()));
  436. }
  437. }
  438. void GDScriptParser::parse_program() {
  439. head = alloc_node<ClassNode>();
  440. current_class = head;
  441. if (match(GDScriptTokenizer::Token::ANNOTATION)) {
  442. // Check for @tool annotation.
  443. AnnotationNode *annotation = parse_annotation(AnnotationInfo::SCRIPT | AnnotationInfo::CLASS_LEVEL);
  444. if (annotation != nullptr) {
  445. if (annotation->name == "@tool") {
  446. // TODO: don't allow @tool anywhere else. (Should all script annotations be the first thing?).
  447. _is_tool = true;
  448. if (previous.type != GDScriptTokenizer::Token::NEWLINE) {
  449. push_error(R"(Expected newline after "@tool" annotation.)");
  450. }
  451. // @tool annotation has no specific target.
  452. annotation->apply(this, nullptr);
  453. } else {
  454. annotation_stack.push_back(annotation);
  455. }
  456. }
  457. }
  458. for (bool should_break = false; !should_break;) {
  459. // Order here doesn't matter, but there should be only one of each at most.
  460. switch (current.type) {
  461. case GDScriptTokenizer::Token::CLASS_NAME:
  462. if (!annotation_stack.empty()) {
  463. push_error(R"("class_name" should be used before annotations.)");
  464. }
  465. advance();
  466. if (head->identifier != nullptr) {
  467. push_error(R"("class_name" can only be used once.)");
  468. } else {
  469. parse_class_name();
  470. }
  471. break;
  472. case GDScriptTokenizer::Token::EXTENDS:
  473. if (!annotation_stack.empty()) {
  474. push_error(R"("extends" should be used before annotations.)");
  475. }
  476. advance();
  477. if (head->extends_used) {
  478. push_error(R"("extends" can only be used once.)");
  479. } else {
  480. parse_extends();
  481. end_statement("superclass");
  482. }
  483. break;
  484. default:
  485. should_break = true;
  486. break;
  487. }
  488. if (panic_mode) {
  489. synchronize();
  490. }
  491. }
  492. if (match(GDScriptTokenizer::Token::ANNOTATION)) {
  493. // Check for @icon annotation.
  494. AnnotationNode *annotation = parse_annotation(AnnotationInfo::SCRIPT | AnnotationInfo::CLASS_LEVEL);
  495. if (annotation != nullptr) {
  496. if (annotation->name == "@icon") {
  497. if (previous.type != GDScriptTokenizer::Token::NEWLINE) {
  498. push_error(R"(Expected newline after "@icon" annotation.)");
  499. }
  500. annotation->apply(this, head);
  501. } else {
  502. annotation_stack.push_back(annotation);
  503. }
  504. }
  505. }
  506. parse_class_body();
  507. if (!check(GDScriptTokenizer::Token::TK_EOF)) {
  508. push_error("Expected end of file.");
  509. }
  510. clear_unused_annotations();
  511. }
  512. GDScriptParser::ClassNode *GDScriptParser::parse_class() {
  513. ClassNode *n_class = alloc_node<ClassNode>();
  514. ClassNode *previous_class = current_class;
  515. current_class = n_class;
  516. n_class->outer = previous_class;
  517. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected identifier for the class name after "class".)")) {
  518. n_class->identifier = parse_identifier();
  519. }
  520. if (match(GDScriptTokenizer::Token::EXTENDS)) {
  521. parse_extends();
  522. }
  523. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after class declaration.)");
  524. consume(GDScriptTokenizer::Token::NEWLINE, R"(Expected newline after class declaration.)");
  525. if (!consume(GDScriptTokenizer::Token::INDENT, R"(Expected indented block after class declaration.)")) {
  526. current_class = previous_class;
  527. return n_class;
  528. }
  529. parse_class_body();
  530. consume(GDScriptTokenizer::Token::DEDENT, R"(Missing unindent at the end of the class body.)");
  531. current_class = previous_class;
  532. return n_class;
  533. }
  534. void GDScriptParser::parse_class_name() {
  535. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected identifier for the global class name after "class_name".)")) {
  536. current_class->identifier = parse_identifier();
  537. }
  538. // TODO: Move this to annotation
  539. if (match(GDScriptTokenizer::Token::COMMA)) {
  540. // Icon path.
  541. if (consume(GDScriptTokenizer::Token::LITERAL, R"(Expected class icon path string after ",".)")) {
  542. if (previous.literal.get_type() != Variant::STRING) {
  543. push_error(vformat(R"(Only strings can be used for the class icon path, found "%s" instead.)", Variant::get_type_name(previous.literal.get_type())));
  544. }
  545. current_class->icon_path = previous.literal;
  546. }
  547. }
  548. if (match(GDScriptTokenizer::Token::EXTENDS)) {
  549. // Allow extends on the same line.
  550. parse_extends();
  551. end_statement("superclass");
  552. } else {
  553. end_statement("class_name statement");
  554. }
  555. }
  556. void GDScriptParser::parse_extends() {
  557. current_class->extends_used = true;
  558. int chain_index = 0;
  559. if (match(GDScriptTokenizer::Token::LITERAL)) {
  560. if (previous.literal.get_type() != Variant::STRING) {
  561. push_error(vformat(R"(Only strings or identifiers can be used after "extends", found "%s" instead.)", Variant::get_type_name(previous.literal.get_type())));
  562. }
  563. current_class->extends_path = previous.literal;
  564. if (!match(GDScriptTokenizer::Token::PERIOD)) {
  565. return;
  566. }
  567. }
  568. make_completion_context(COMPLETION_INHERIT_TYPE, current_class, chain_index++);
  569. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected superclass name after "extends".)")) {
  570. return;
  571. }
  572. current_class->extends.push_back(previous.literal);
  573. while (match(GDScriptTokenizer::Token::PERIOD)) {
  574. make_completion_context(COMPLETION_INHERIT_TYPE, current_class, chain_index++);
  575. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected superclass name after ".".)")) {
  576. return;
  577. }
  578. current_class->extends.push_back(previous.literal);
  579. }
  580. }
  581. template <class T>
  582. void GDScriptParser::parse_class_member(T *(GDScriptParser::*p_parse_function)(), AnnotationInfo::TargetKind p_target, const String &p_member_kind) {
  583. advance();
  584. T *member = (this->*p_parse_function)();
  585. if (member == nullptr) {
  586. return;
  587. }
  588. // Consume annotations.
  589. while (!annotation_stack.empty()) {
  590. AnnotationNode *last_annotation = annotation_stack.back()->get();
  591. if (last_annotation->applies_to(p_target)) {
  592. last_annotation->apply(this, member);
  593. member->annotations.push_front(last_annotation);
  594. annotation_stack.pop_back();
  595. } else {
  596. push_error(vformat(R"(Annotation "%s" cannot be applied to a %s.)", last_annotation->name, p_member_kind));
  597. clear_unused_annotations();
  598. return;
  599. }
  600. }
  601. if (member->identifier != nullptr) {
  602. // Enums may be unnamed.
  603. // TODO: Consider names in outer scope too, for constants and classes (and static functions?)
  604. if (current_class->members_indices.has(member->identifier->name)) {
  605. 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);
  606. } else {
  607. current_class->add_member(member);
  608. }
  609. }
  610. }
  611. void GDScriptParser::parse_class_body() {
  612. bool class_end = false;
  613. while (!class_end && !is_at_end()) {
  614. switch (current.type) {
  615. case GDScriptTokenizer::Token::VAR:
  616. parse_class_member(&GDScriptParser::parse_variable, AnnotationInfo::VARIABLE, "variable");
  617. break;
  618. case GDScriptTokenizer::Token::CONST:
  619. parse_class_member(&GDScriptParser::parse_constant, AnnotationInfo::CONSTANT, "constant");
  620. break;
  621. case GDScriptTokenizer::Token::SIGNAL:
  622. parse_class_member(&GDScriptParser::parse_signal, AnnotationInfo::SIGNAL, "signal");
  623. break;
  624. case GDScriptTokenizer::Token::STATIC:
  625. case GDScriptTokenizer::Token::FUNC:
  626. parse_class_member(&GDScriptParser::parse_function, AnnotationInfo::FUNCTION, "function");
  627. break;
  628. case GDScriptTokenizer::Token::CLASS:
  629. parse_class_member(&GDScriptParser::parse_class, AnnotationInfo::CLASS, "class");
  630. break;
  631. case GDScriptTokenizer::Token::ENUM:
  632. parse_class_member(&GDScriptParser::parse_enum, AnnotationInfo::NONE, "enum");
  633. break;
  634. case GDScriptTokenizer::Token::ANNOTATION: {
  635. advance();
  636. AnnotationNode *annotation = parse_annotation(AnnotationInfo::CLASS_LEVEL);
  637. if (annotation != nullptr) {
  638. annotation_stack.push_back(annotation);
  639. }
  640. break;
  641. }
  642. case GDScriptTokenizer::Token::PASS:
  643. advance();
  644. end_statement(R"("pass")");
  645. break;
  646. case GDScriptTokenizer::Token::DEDENT:
  647. class_end = true;
  648. break;
  649. default:
  650. push_error(vformat(R"(Unexpected "%s" in class body.)", current.get_name()));
  651. advance();
  652. break;
  653. }
  654. if (panic_mode) {
  655. synchronize();
  656. }
  657. }
  658. }
  659. GDScriptParser::VariableNode *GDScriptParser::parse_variable() {
  660. return parse_variable(true);
  661. }
  662. GDScriptParser::VariableNode *GDScriptParser::parse_variable(bool p_allow_property) {
  663. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected variable name after "var".)")) {
  664. return nullptr;
  665. }
  666. VariableNode *variable = alloc_node<VariableNode>();
  667. variable->identifier = parse_identifier();
  668. if (match(GDScriptTokenizer::Token::COLON)) {
  669. if (check(GDScriptTokenizer::Token::NEWLINE)) {
  670. if (p_allow_property) {
  671. advance();
  672. return parse_property(variable, true);
  673. } else {
  674. push_error(R"(Expected type after ":")");
  675. return nullptr;
  676. }
  677. } else if (check((GDScriptTokenizer::Token::EQUAL))) {
  678. // Infer type.
  679. variable->infer_datatype = true;
  680. } else {
  681. if (p_allow_property) {
  682. make_completion_context(COMPLETION_PROPERTY_DECLARATION_OR_TYPE, variable);
  683. if (check(GDScriptTokenizer::Token::IDENTIFIER)) {
  684. // Check if get or set.
  685. if (current.get_identifier() == "get" || current.get_identifier() == "set") {
  686. return parse_property(variable, false);
  687. }
  688. }
  689. }
  690. // Parse type.
  691. variable->datatype_specifier = parse_type();
  692. }
  693. }
  694. if (match(GDScriptTokenizer::Token::EQUAL)) {
  695. // Initializer.
  696. variable->initializer = parse_expression(false);
  697. variable->assignments++;
  698. }
  699. if (p_allow_property && match(GDScriptTokenizer::Token::COLON)) {
  700. if (match(GDScriptTokenizer::Token::NEWLINE)) {
  701. return parse_property(variable, true);
  702. } else {
  703. return parse_property(variable, false);
  704. }
  705. }
  706. end_statement("variable declaration");
  707. variable->export_info.name = variable->identifier->name;
  708. return variable;
  709. }
  710. GDScriptParser::VariableNode *GDScriptParser::parse_property(VariableNode *p_variable, bool p_need_indent) {
  711. if (p_need_indent) {
  712. if (!consume(GDScriptTokenizer::Token::INDENT, R"(Expected indented block for property after ":".)")) {
  713. return nullptr;
  714. }
  715. }
  716. VariableNode *property = p_variable;
  717. make_completion_context(COMPLETION_PROPERTY_DECLARATION, property);
  718. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected "get" or "set" for property declaration.)")) {
  719. return nullptr;
  720. }
  721. IdentifierNode *function = parse_identifier();
  722. if (check(GDScriptTokenizer::Token::EQUAL)) {
  723. p_variable->property = VariableNode::PROP_SETGET;
  724. } else {
  725. p_variable->property = VariableNode::PROP_INLINE;
  726. if (!p_need_indent) {
  727. push_error("Property with inline code must go to an indented block.");
  728. }
  729. }
  730. bool getter_used = false;
  731. bool setter_used = false;
  732. // Run with a loop because order doesn't matter.
  733. for (int i = 0; i < 2; i++) {
  734. if (function->name == "set") {
  735. if (setter_used) {
  736. push_error(R"(Properties can only have one setter.)");
  737. } else {
  738. parse_property_setter(property);
  739. setter_used = true;
  740. }
  741. } else if (function->name == "get") {
  742. if (getter_used) {
  743. push_error(R"(Properties can only have one getter.)");
  744. } else {
  745. parse_property_getter(property);
  746. getter_used = true;
  747. }
  748. } else {
  749. // TODO: Update message to only have the missing one if it's the case.
  750. push_error(R"(Expected "get" or "set" for property declaration.)");
  751. }
  752. if (i == 0 && p_variable->property == VariableNode::PROP_SETGET) {
  753. if (match(GDScriptTokenizer::Token::COMMA)) {
  754. // Consume potential newline.
  755. if (match(GDScriptTokenizer::Token::NEWLINE)) {
  756. if (!p_need_indent) {
  757. push_error(R"(Inline setter/getter setting cannot span across multiple lines (use "\\"" if needed).)");
  758. }
  759. }
  760. } else {
  761. break;
  762. }
  763. }
  764. if (!match(GDScriptTokenizer::Token::IDENTIFIER)) {
  765. break;
  766. }
  767. function = parse_identifier();
  768. }
  769. if (p_variable->property == VariableNode::PROP_SETGET) {
  770. end_statement("property declaration");
  771. }
  772. if (p_need_indent) {
  773. consume(GDScriptTokenizer::Token::DEDENT, R"(Expected end of indented block for property.)");
  774. }
  775. return property;
  776. }
  777. void GDScriptParser::parse_property_setter(VariableNode *p_variable) {
  778. switch (p_variable->property) {
  779. case VariableNode::PROP_INLINE:
  780. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected "(" after "set".)");
  781. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected parameter name after "(".)")) {
  782. p_variable->setter_parameter = parse_identifier();
  783. }
  784. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected ")" after parameter name.)*");
  785. consume(GDScriptTokenizer::Token::COLON, R"*(Expected ":" after ")".)*");
  786. p_variable->setter = parse_suite("setter definition");
  787. break;
  788. case VariableNode::PROP_SETGET:
  789. consume(GDScriptTokenizer::Token::EQUAL, R"(Expected "=" after "set")");
  790. make_completion_context(COMPLETION_PROPERTY_METHOD, p_variable);
  791. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected setter function name after "=".)")) {
  792. p_variable->setter_pointer = parse_identifier();
  793. }
  794. break;
  795. case VariableNode::PROP_NONE:
  796. break; // Unreachable.
  797. }
  798. }
  799. void GDScriptParser::parse_property_getter(VariableNode *p_variable) {
  800. switch (p_variable->property) {
  801. case VariableNode::PROP_INLINE:
  802. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "get".)");
  803. p_variable->getter = parse_suite("getter definition");
  804. break;
  805. case VariableNode::PROP_SETGET:
  806. consume(GDScriptTokenizer::Token::EQUAL, R"(Expected "=" after "get")");
  807. make_completion_context(COMPLETION_PROPERTY_METHOD, p_variable);
  808. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected getter function name after "=".)")) {
  809. p_variable->getter_pointer = parse_identifier();
  810. }
  811. break;
  812. case VariableNode::PROP_NONE:
  813. break; // Unreachable.
  814. }
  815. }
  816. GDScriptParser::ConstantNode *GDScriptParser::parse_constant() {
  817. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected constant name after "const".)")) {
  818. return nullptr;
  819. }
  820. ConstantNode *constant = alloc_node<ConstantNode>();
  821. constant->identifier = parse_identifier();
  822. if (match(GDScriptTokenizer::Token::COLON)) {
  823. if (check((GDScriptTokenizer::Token::EQUAL))) {
  824. // Infer type.
  825. constant->infer_datatype = true;
  826. } else {
  827. // Parse type.
  828. constant->datatype_specifier = parse_type();
  829. }
  830. }
  831. if (consume(GDScriptTokenizer::Token::EQUAL, R"(Expected initializer after constant name.)")) {
  832. // Initializer.
  833. constant->initializer = parse_expression(false);
  834. if (constant->initializer == nullptr) {
  835. push_error(R"(Expected initializer expression for constant.)");
  836. return nullptr;
  837. }
  838. }
  839. end_statement("constant declaration");
  840. return constant;
  841. }
  842. GDScriptParser::ParameterNode *GDScriptParser::parse_parameter() {
  843. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected parameter name.)")) {
  844. return nullptr;
  845. }
  846. ParameterNode *parameter = alloc_node<ParameterNode>();
  847. parameter->identifier = parse_identifier();
  848. if (match(GDScriptTokenizer::Token::COLON)) {
  849. if (check((GDScriptTokenizer::Token::EQUAL))) {
  850. // Infer type.
  851. parameter->infer_datatype = true;
  852. } else {
  853. // Parse type.
  854. make_completion_context(COMPLETION_TYPE_NAME, parameter);
  855. parameter->datatype_specifier = parse_type();
  856. }
  857. }
  858. if (match(GDScriptTokenizer::Token::EQUAL)) {
  859. // Default value.
  860. parameter->default_value = parse_expression(false);
  861. }
  862. return parameter;
  863. }
  864. GDScriptParser::SignalNode *GDScriptParser::parse_signal() {
  865. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected signal name after "signal".)")) {
  866. return nullptr;
  867. }
  868. SignalNode *signal = alloc_node<SignalNode>();
  869. signal->identifier = parse_identifier();
  870. if (match(GDScriptTokenizer::Token::PARENTHESIS_OPEN)) {
  871. do {
  872. if (check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE)) {
  873. // Allow for trailing comma.
  874. break;
  875. }
  876. ParameterNode *parameter = parse_parameter();
  877. if (parameter == nullptr) {
  878. push_error("Expected signal parameter name.");
  879. break;
  880. }
  881. if (parameter->default_value != nullptr) {
  882. push_error(R"(Signal parameters cannot have a default value.)");
  883. }
  884. if (signal->parameters_indices.has(parameter->identifier->name)) {
  885. push_error(vformat(R"(Parameter with name "%s" was already declared for this signal.)", parameter->identifier->name));
  886. } else {
  887. signal->parameters_indices[parameter->identifier->name] = signal->parameters.size();
  888. signal->parameters.push_back(parameter);
  889. }
  890. } while (match(GDScriptTokenizer::Token::COMMA) && !is_at_end());
  891. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected closing ")" after signal parameters.)*");
  892. }
  893. end_statement("signal declaration");
  894. return signal;
  895. }
  896. GDScriptParser::EnumNode *GDScriptParser::parse_enum() {
  897. EnumNode *enum_node = alloc_node<EnumNode>();
  898. bool named = false;
  899. if (check(GDScriptTokenizer::Token::IDENTIFIER)) {
  900. advance();
  901. enum_node->identifier = parse_identifier();
  902. named = true;
  903. }
  904. push_multiline(true);
  905. consume(GDScriptTokenizer::Token::BRACE_OPEN, vformat(R"(Expected "{" after %s.)", named ? "enum name" : R"("enum")"));
  906. HashMap<StringName, int> elements;
  907. do {
  908. if (check(GDScriptTokenizer::Token::BRACE_CLOSE)) {
  909. break; // Allow trailing comma.
  910. }
  911. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected identifer for enum key.)")) {
  912. EnumNode::Value item;
  913. item.identifier = parse_identifier();
  914. item.parent_enum = enum_node;
  915. item.line = previous.start_line;
  916. item.leftmost_column = previous.leftmost_column;
  917. if (elements.has(item.identifier->name)) {
  918. push_error(vformat(R"(Name "%s" was already in this enum (at line %d).)", item.identifier->name, elements[item.identifier->name]), item.identifier);
  919. } else if (!named) {
  920. // TODO: Abstract this recursive member check.
  921. ClassNode *parent = current_class;
  922. while (parent != nullptr) {
  923. if (parent->members_indices.has(item.identifier->name)) {
  924. push_error(vformat(R"(Name "%s" is already used as a class %s.)", item.identifier->name, parent->get_member(item.identifier->name).get_type_name()));
  925. break;
  926. }
  927. parent = parent->outer;
  928. }
  929. }
  930. elements[item.identifier->name] = item.line;
  931. if (match(GDScriptTokenizer::Token::EQUAL)) {
  932. ExpressionNode *value = parse_expression(false);
  933. if (value == nullptr) {
  934. push_error(R"(Expected expression value after "=".)");
  935. }
  936. item.custom_value = value;
  937. }
  938. item.rightmost_column = previous.rightmost_column;
  939. item.index = enum_node->values.size();
  940. enum_node->values.push_back(item);
  941. if (!named) {
  942. // Add as member of current class.
  943. current_class->add_member(item);
  944. }
  945. }
  946. } while (match(GDScriptTokenizer::Token::COMMA));
  947. pop_multiline();
  948. consume(GDScriptTokenizer::Token::BRACE_CLOSE, R"(Expected closing "}" for enum.)");
  949. end_statement("enum");
  950. return enum_node;
  951. }
  952. GDScriptParser::FunctionNode *GDScriptParser::parse_function() {
  953. bool _static = false;
  954. if (previous.type == GDScriptTokenizer::Token::STATIC) {
  955. // TODO: Improve message if user uses "static" with "var" or "const"
  956. if (!consume(GDScriptTokenizer::Token::FUNC, R"(Expected "func" after "static".)")) {
  957. return nullptr;
  958. }
  959. _static = true;
  960. }
  961. FunctionNode *function = alloc_node<FunctionNode>();
  962. make_completion_context(COMPLETION_OVERRIDE_METHOD, function);
  963. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected function name after "func".)")) {
  964. return nullptr;
  965. }
  966. FunctionNode *previous_function = current_function;
  967. current_function = function;
  968. function->identifier = parse_identifier();
  969. function->is_static = _static;
  970. push_multiline(true);
  971. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected opening "(" after function name.)");
  972. SuiteNode *body = alloc_node<SuiteNode>();
  973. SuiteNode *previous_suite = current_suite;
  974. current_suite = body;
  975. if (!check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE) && !is_at_end()) {
  976. bool default_used = false;
  977. do {
  978. if (check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE)) {
  979. // Allow for trailing comma.
  980. break;
  981. }
  982. ParameterNode *parameter = parse_parameter();
  983. if (parameter == nullptr) {
  984. break;
  985. }
  986. if (parameter->default_value != nullptr) {
  987. default_used = true;
  988. } else {
  989. if (default_used) {
  990. push_error("Cannot have a mandatory parameters after optional parameters.");
  991. continue;
  992. }
  993. }
  994. if (function->parameters_indices.has(parameter->identifier->name)) {
  995. push_error(vformat(R"(Parameter with name "%s" was already declared for this function.)", parameter->identifier->name));
  996. } else {
  997. function->parameters_indices[parameter->identifier->name] = function->parameters.size();
  998. function->parameters.push_back(parameter);
  999. body->add_local(parameter);
  1000. }
  1001. } while (match(GDScriptTokenizer::Token::COMMA));
  1002. }
  1003. pop_multiline();
  1004. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected closing ")" after function parameters.)*");
  1005. if (match(GDScriptTokenizer::Token::FORWARD_ARROW)) {
  1006. make_completion_context(COMPLETION_TYPE_NAME_OR_VOID, function);
  1007. function->return_type = parse_type(true);
  1008. if (function->return_type == nullptr) {
  1009. push_error(R"(Expected return type or "void" after "->".)");
  1010. }
  1011. }
  1012. // TODO: Improve token consumption so it synchronizes to a statement boundary. This way we can get into the function body with unrecognized tokens.
  1013. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after function declaration.)");
  1014. current_suite = previous_suite;
  1015. function->body = parse_suite("function declaration", body);
  1016. current_function = previous_function;
  1017. return function;
  1018. }
  1019. GDScriptParser::AnnotationNode *GDScriptParser::parse_annotation(uint32_t p_valid_targets) {
  1020. AnnotationNode *annotation = alloc_node<AnnotationNode>();
  1021. annotation->name = previous.literal;
  1022. make_completion_context(COMPLETION_ANNOTATION, annotation);
  1023. bool valid = true;
  1024. if (!valid_annotations.has(annotation->name)) {
  1025. push_error(vformat(R"(Unrecognized annotation: "%s".)", annotation->name));
  1026. valid = false;
  1027. }
  1028. annotation->info = &valid_annotations[annotation->name];
  1029. if (!annotation->applies_to(p_valid_targets)) {
  1030. push_error(vformat(R"(Annotation "%s" is not allowed in this level.)", annotation->name));
  1031. valid = false;
  1032. }
  1033. if (match(GDScriptTokenizer::Token::PARENTHESIS_OPEN)) {
  1034. // Arguments.
  1035. push_completion_call(annotation);
  1036. make_completion_context(COMPLETION_ANNOTATION_ARGUMENTS, annotation, 0, true);
  1037. if (!check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE) && !is_at_end()) {
  1038. int argument_index = 0;
  1039. do {
  1040. make_completion_context(COMPLETION_ANNOTATION_ARGUMENTS, annotation, argument_index, true);
  1041. set_last_completion_call_arg(argument_index++);
  1042. ExpressionNode *argument = parse_expression(false);
  1043. if (argument == nullptr) {
  1044. valid = false;
  1045. continue;
  1046. }
  1047. annotation->arguments.push_back(argument);
  1048. } while (match(GDScriptTokenizer::Token::COMMA));
  1049. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected ")" after annotation arguments.)*");
  1050. }
  1051. pop_completion_call();
  1052. }
  1053. match(GDScriptTokenizer::Token::NEWLINE); // Newline after annotation is optional.
  1054. if (valid) {
  1055. valid = validate_annotation_arguments(annotation);
  1056. }
  1057. return valid ? annotation : nullptr;
  1058. }
  1059. void GDScriptParser::clear_unused_annotations() {
  1060. for (const List<AnnotationNode *>::Element *E = annotation_stack.front(); E != nullptr; E = E->next()) {
  1061. AnnotationNode *annotation = E->get();
  1062. push_error(vformat(R"(Annotation "%s" does not precedes a valid target, so it will have no effect.)", annotation->name), annotation);
  1063. }
  1064. annotation_stack.clear();
  1065. }
  1066. bool GDScriptParser::register_annotation(const MethodInfo &p_info, uint32_t p_target_kinds, AnnotationAction p_apply, int p_optional_arguments, bool p_is_vararg) {
  1067. ERR_FAIL_COND_V_MSG(valid_annotations.has(p_info.name), false, vformat(R"(Annotation "%s" already registered.)", p_info.name));
  1068. AnnotationInfo new_annotation;
  1069. new_annotation.info = p_info;
  1070. new_annotation.info.default_arguments.resize(p_optional_arguments);
  1071. if (p_is_vararg) {
  1072. new_annotation.info.flags |= METHOD_FLAG_VARARG;
  1073. }
  1074. new_annotation.apply = p_apply;
  1075. new_annotation.target_kind = p_target_kinds;
  1076. valid_annotations[p_info.name] = new_annotation;
  1077. return true;
  1078. }
  1079. GDScriptParser::SuiteNode *GDScriptParser::parse_suite(const String &p_context, SuiteNode *p_suite) {
  1080. SuiteNode *suite = p_suite != nullptr ? p_suite : alloc_node<SuiteNode>();
  1081. suite->parent_block = current_suite;
  1082. current_suite = suite;
  1083. bool multiline = false;
  1084. if (check(GDScriptTokenizer::Token::NEWLINE)) {
  1085. multiline = true;
  1086. }
  1087. if (multiline) {
  1088. consume(GDScriptTokenizer::Token::NEWLINE, vformat(R"(Expected newline after %s.)", p_context));
  1089. if (!consume(GDScriptTokenizer::Token::INDENT, vformat(R"(Expected indented block after %s.)", p_context))) {
  1090. current_suite = suite->parent_block;
  1091. return suite;
  1092. }
  1093. }
  1094. do {
  1095. Node *statement = parse_statement();
  1096. if (statement == nullptr) {
  1097. continue;
  1098. }
  1099. suite->statements.push_back(statement);
  1100. // Register locals.
  1101. switch (statement->type) {
  1102. case Node::VARIABLE: {
  1103. VariableNode *variable = static_cast<VariableNode *>(statement);
  1104. const SuiteNode::Local &local = current_suite->get_local(variable->identifier->name);
  1105. if (local.type != SuiteNode::Local::UNDEFINED) {
  1106. push_error(vformat(R"(There is already a %s named "%s" declared in this scope.)", local.get_name(), variable->identifier->name));
  1107. }
  1108. current_suite->add_local(variable);
  1109. break;
  1110. }
  1111. case Node::CONSTANT: {
  1112. ConstantNode *constant = static_cast<ConstantNode *>(statement);
  1113. const SuiteNode::Local &local = current_suite->get_local(constant->identifier->name);
  1114. if (local.type != SuiteNode::Local::UNDEFINED) {
  1115. String name;
  1116. if (local.type == SuiteNode::Local::CONSTANT) {
  1117. name = "constant";
  1118. } else {
  1119. name = "variable";
  1120. }
  1121. push_error(vformat(R"(There is already a %s named "%s" declared in this scope.)", name, constant->identifier->name));
  1122. }
  1123. current_suite->add_local(constant);
  1124. break;
  1125. }
  1126. default:
  1127. break;
  1128. }
  1129. } while (multiline && !check(GDScriptTokenizer::Token::DEDENT) && !is_at_end());
  1130. if (multiline) {
  1131. consume(GDScriptTokenizer::Token::DEDENT, vformat(R"(Missing unindent at the end of %s.)", p_context));
  1132. }
  1133. current_suite = suite->parent_block;
  1134. return suite;
  1135. }
  1136. GDScriptParser::Node *GDScriptParser::parse_statement() {
  1137. Node *result = nullptr;
  1138. #ifdef DEBUG_ENABLED
  1139. bool unreachable = current_suite->has_return && !current_suite->has_unreachable_code;
  1140. #endif
  1141. switch (current.type) {
  1142. case GDScriptTokenizer::Token::PASS:
  1143. advance();
  1144. result = alloc_node<PassNode>();
  1145. end_statement(R"("pass")");
  1146. break;
  1147. case GDScriptTokenizer::Token::VAR:
  1148. advance();
  1149. result = parse_variable();
  1150. break;
  1151. case GDScriptTokenizer::Token::CONST:
  1152. advance();
  1153. result = parse_constant();
  1154. break;
  1155. case GDScriptTokenizer::Token::IF:
  1156. advance();
  1157. result = parse_if();
  1158. break;
  1159. case GDScriptTokenizer::Token::FOR:
  1160. advance();
  1161. result = parse_for();
  1162. break;
  1163. case GDScriptTokenizer::Token::WHILE:
  1164. advance();
  1165. result = parse_while();
  1166. break;
  1167. case GDScriptTokenizer::Token::MATCH:
  1168. advance();
  1169. result = parse_match();
  1170. break;
  1171. case GDScriptTokenizer::Token::BREAK:
  1172. advance();
  1173. result = parse_break();
  1174. break;
  1175. case GDScriptTokenizer::Token::CONTINUE:
  1176. advance();
  1177. result = parse_continue();
  1178. break;
  1179. case GDScriptTokenizer::Token::RETURN: {
  1180. advance();
  1181. ReturnNode *n_return = alloc_node<ReturnNode>();
  1182. if (!is_statement_end()) {
  1183. if (current_function->identifier->name == GDScriptLanguage::get_singleton()->strings._init) {
  1184. push_error(R"(Constructor cannot return a value.)");
  1185. }
  1186. n_return->return_value = parse_expression(false);
  1187. }
  1188. result = n_return;
  1189. current_suite->has_return = true;
  1190. end_statement("return statement");
  1191. break;
  1192. }
  1193. case GDScriptTokenizer::Token::BREAKPOINT:
  1194. advance();
  1195. result = alloc_node<BreakpointNode>();
  1196. end_statement(R"("breakpoint")");
  1197. break;
  1198. case GDScriptTokenizer::Token::ASSERT:
  1199. advance();
  1200. result = parse_assert();
  1201. break;
  1202. case GDScriptTokenizer::Token::ANNOTATION: {
  1203. advance();
  1204. AnnotationNode *annotation = parse_annotation(AnnotationInfo::STATEMENT);
  1205. if (annotation != nullptr) {
  1206. annotation_stack.push_back(annotation);
  1207. }
  1208. break;
  1209. }
  1210. default: {
  1211. // Expression statement.
  1212. ExpressionNode *expression = parse_expression(true); // Allow assignment here.
  1213. if (expression == nullptr) {
  1214. push_error(vformat(R"(Expected statement, found "%s" instead.)", previous.get_name()));
  1215. }
  1216. end_statement("expression");
  1217. result = expression;
  1218. #ifdef DEBUG_ENABLED
  1219. if (expression != nullptr) {
  1220. switch (expression->type) {
  1221. case Node::CALL:
  1222. case Node::ASSIGNMENT:
  1223. case Node::AWAIT:
  1224. // Fine.
  1225. break;
  1226. default:
  1227. push_warning(expression, GDScriptWarning::STANDALONE_EXPRESSION);
  1228. }
  1229. }
  1230. #endif
  1231. break;
  1232. }
  1233. }
  1234. #ifdef DEBUG_ENABLED
  1235. if (unreachable) {
  1236. current_suite->has_unreachable_code = true;
  1237. push_warning(result, GDScriptWarning::UNREACHABLE_CODE, current_function->identifier->name);
  1238. }
  1239. #endif
  1240. if (panic_mode) {
  1241. synchronize();
  1242. }
  1243. return result;
  1244. }
  1245. GDScriptParser::AssertNode *GDScriptParser::parse_assert() {
  1246. // TODO: Add assert message.
  1247. AssertNode *assert = alloc_node<AssertNode>();
  1248. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected "(" after "assert".)");
  1249. assert->condition = parse_expression(false);
  1250. if (assert->condition == nullptr) {
  1251. push_error("Expected expression to assert.");
  1252. return nullptr;
  1253. }
  1254. if (match(GDScriptTokenizer::Token::COMMA)) {
  1255. // Error message.
  1256. if (consume(GDScriptTokenizer::Token::LITERAL, R"(Expected error message for assert after ",".)")) {
  1257. assert->message = parse_literal();
  1258. if (assert->message->value.get_type() != Variant::STRING) {
  1259. push_error(R"(Expected string for assert error message.)");
  1260. }
  1261. } else {
  1262. return nullptr;
  1263. }
  1264. }
  1265. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected ")" after assert expression.)*");
  1266. end_statement(R"("assert")");
  1267. return assert;
  1268. }
  1269. GDScriptParser::BreakNode *GDScriptParser::parse_break() {
  1270. if (!can_break) {
  1271. push_error(R"(Cannot use "break" outside of a loop.)");
  1272. }
  1273. end_statement(R"("break")");
  1274. return alloc_node<BreakNode>();
  1275. }
  1276. GDScriptParser::ContinueNode *GDScriptParser::parse_continue() {
  1277. if (!can_continue) {
  1278. push_error(R"(Cannot use "continue" outside of a loop or pattern matching block.)");
  1279. }
  1280. current_suite->has_continue = true;
  1281. end_statement(R"("continue")");
  1282. return alloc_node<ContinueNode>();
  1283. }
  1284. GDScriptParser::ForNode *GDScriptParser::parse_for() {
  1285. ForNode *n_for = alloc_node<ForNode>();
  1286. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected loop variable name after "for".)")) {
  1287. n_for->variable = parse_identifier();
  1288. }
  1289. consume(GDScriptTokenizer::Token::IN, R"(Expected "in" after "for" variable name.)");
  1290. n_for->list = parse_expression(false);
  1291. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "for" condition.)");
  1292. // Save break/continue state.
  1293. bool could_break = can_break;
  1294. bool could_continue = can_continue;
  1295. // Allow break/continue.
  1296. can_break = true;
  1297. can_continue = true;
  1298. SuiteNode *suite = alloc_node<SuiteNode>();
  1299. if (n_for->variable) {
  1300. suite->add_local(SuiteNode::Local(n_for->variable));
  1301. }
  1302. suite->parent_for = n_for;
  1303. n_for->loop = parse_suite(R"("for" block)", suite);
  1304. // Reset break/continue state.
  1305. can_break = could_break;
  1306. can_continue = could_continue;
  1307. return n_for;
  1308. }
  1309. GDScriptParser::IfNode *GDScriptParser::parse_if(const String &p_token) {
  1310. IfNode *n_if = alloc_node<IfNode>();
  1311. n_if->condition = parse_expression(false);
  1312. if (n_if->condition == nullptr) {
  1313. push_error(vformat(R"(Expected conditional expression after "%s".)", p_token));
  1314. }
  1315. consume(GDScriptTokenizer::Token::COLON, vformat(R"(Expected ":" after "%s" condition.)", p_token));
  1316. n_if->true_block = parse_suite(vformat(R"("%s" block)", p_token));
  1317. n_if->true_block->parent_if = n_if;
  1318. if (n_if->true_block->has_continue) {
  1319. current_suite->has_continue = true;
  1320. }
  1321. if (match(GDScriptTokenizer::Token::ELIF)) {
  1322. IfNode *elif = parse_if("elif");
  1323. SuiteNode *else_block = alloc_node<SuiteNode>();
  1324. else_block->statements.push_back(elif);
  1325. n_if->false_block = else_block;
  1326. } else if (match(GDScriptTokenizer::Token::ELSE)) {
  1327. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "else".)");
  1328. n_if->false_block = parse_suite(R"("else" block)");
  1329. }
  1330. if (n_if->false_block != nullptr && n_if->false_block->has_return && n_if->true_block->has_return) {
  1331. current_suite->has_return = true;
  1332. }
  1333. if (n_if->false_block != nullptr && n_if->false_block->has_continue) {
  1334. current_suite->has_continue = true;
  1335. }
  1336. return n_if;
  1337. }
  1338. GDScriptParser::MatchNode *GDScriptParser::parse_match() {
  1339. MatchNode *match = alloc_node<MatchNode>();
  1340. match->test = parse_expression(false);
  1341. if (match->test == nullptr) {
  1342. push_error(R"(Expected expression to test after "match".)");
  1343. }
  1344. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "match" expression.)");
  1345. consume(GDScriptTokenizer::Token::NEWLINE, R"(Expected a newline after "match" statement.)");
  1346. if (!consume(GDScriptTokenizer::Token::INDENT, R"(Expected an indented block after "match" statement.)")) {
  1347. return match;
  1348. }
  1349. #ifdef DEBUG_ENABLED
  1350. bool all_have_return = true;
  1351. bool have_wildcard = false;
  1352. bool wildcard_has_return = false;
  1353. bool have_wildcard_without_continue = false;
  1354. #endif
  1355. while (!check(GDScriptTokenizer::Token::DEDENT) && !is_at_end()) {
  1356. MatchBranchNode *branch = parse_match_branch();
  1357. if (branch == nullptr) {
  1358. continue;
  1359. }
  1360. #ifdef DEBUG_ENABLED
  1361. if (have_wildcard_without_continue) {
  1362. push_warning(branch->patterns[0], GDScriptWarning::UNREACHABLE_PATTERN);
  1363. }
  1364. if (branch->has_wildcard) {
  1365. have_wildcard = true;
  1366. if (branch->block->has_return) {
  1367. wildcard_has_return = true;
  1368. }
  1369. if (!branch->block->has_continue) {
  1370. have_wildcard_without_continue = true;
  1371. }
  1372. }
  1373. if (!branch->block->has_return) {
  1374. all_have_return = false;
  1375. }
  1376. #endif
  1377. match->branches.push_back(branch);
  1378. }
  1379. consume(GDScriptTokenizer::Token::DEDENT, R"(Expected an indented block after "match" statement.)");
  1380. #ifdef DEBUG_ENABLED
  1381. if (wildcard_has_return || (all_have_return && have_wildcard)) {
  1382. current_suite->has_return = true;
  1383. }
  1384. #endif
  1385. return match;
  1386. }
  1387. GDScriptParser::MatchBranchNode *GDScriptParser::parse_match_branch() {
  1388. MatchBranchNode *branch = alloc_node<MatchBranchNode>();
  1389. bool has_bind = false;
  1390. do {
  1391. PatternNode *pattern = parse_match_pattern();
  1392. if (pattern == nullptr) {
  1393. continue;
  1394. }
  1395. if (pattern->pattern_type == PatternNode::PT_BIND) {
  1396. has_bind = true;
  1397. }
  1398. if (branch->patterns.size() > 0 && has_bind) {
  1399. push_error(R"(Cannot use a variable bind with multiple patterns.)");
  1400. }
  1401. if (pattern->pattern_type == PatternNode::PT_REST) {
  1402. push_error(R"(Rest pattern can only be used inside array and dictionary patterns.)");
  1403. } else if (pattern->pattern_type == PatternNode::PT_BIND || pattern->pattern_type == PatternNode::PT_WILDCARD) {
  1404. branch->has_wildcard = true;
  1405. }
  1406. branch->patterns.push_back(pattern);
  1407. } while (match(GDScriptTokenizer::Token::COMMA));
  1408. if (branch->patterns.empty()) {
  1409. push_error(R"(No pattern found for "match" branch.)");
  1410. }
  1411. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "match" patterns.)");
  1412. // Save continue state.
  1413. bool could_continue = can_continue;
  1414. // Allow continue for match.
  1415. can_continue = true;
  1416. SuiteNode *suite = alloc_node<SuiteNode>();
  1417. if (branch->patterns.size() > 0) {
  1418. List<StringName> binds;
  1419. branch->patterns[0]->binds.get_key_list(&binds);
  1420. for (List<StringName>::Element *E = binds.front(); E != nullptr; E = E->next()) {
  1421. SuiteNode::Local local(branch->patterns[0]->binds[E->get()]);
  1422. suite->add_local(local);
  1423. }
  1424. }
  1425. branch->block = parse_suite("match pattern block", suite);
  1426. // Restore continue state.
  1427. can_continue = could_continue;
  1428. return branch;
  1429. }
  1430. GDScriptParser::PatternNode *GDScriptParser::parse_match_pattern(PatternNode *p_root_pattern) {
  1431. PatternNode *pattern = alloc_node<PatternNode>();
  1432. switch (current.type) {
  1433. case GDScriptTokenizer::Token::LITERAL:
  1434. advance();
  1435. pattern->pattern_type = PatternNode::PT_LITERAL;
  1436. pattern->literal = parse_literal();
  1437. if (pattern->literal == nullptr) {
  1438. // Error happened.
  1439. return nullptr;
  1440. }
  1441. break;
  1442. case GDScriptTokenizer::Token::VAR: {
  1443. // Bind.
  1444. advance();
  1445. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected bind name after "var".)")) {
  1446. return nullptr;
  1447. }
  1448. pattern->pattern_type = PatternNode::PT_BIND;
  1449. pattern->bind = parse_identifier();
  1450. PatternNode *root_pattern = p_root_pattern == nullptr ? pattern : p_root_pattern;
  1451. if (p_root_pattern != nullptr) {
  1452. if (p_root_pattern->has_bind(pattern->bind->name)) {
  1453. push_error(vformat(R"(Bind variable name "%s" was already used in this pattern.)", pattern->bind->name));
  1454. return nullptr;
  1455. }
  1456. }
  1457. if (current_suite->has_local(pattern->bind->name)) {
  1458. 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));
  1459. return nullptr;
  1460. }
  1461. root_pattern->binds[pattern->bind->name] = pattern->bind;
  1462. } break;
  1463. case GDScriptTokenizer::Token::UNDERSCORE:
  1464. // Wildcard.
  1465. advance();
  1466. pattern->pattern_type = PatternNode::PT_WILDCARD;
  1467. break;
  1468. case GDScriptTokenizer::Token::PERIOD_PERIOD:
  1469. // Rest.
  1470. advance();
  1471. pattern->pattern_type = PatternNode::PT_REST;
  1472. break;
  1473. case GDScriptTokenizer::Token::BRACKET_OPEN: {
  1474. // Array.
  1475. advance();
  1476. pattern->pattern_type = PatternNode::PT_ARRAY;
  1477. if (!check(GDScriptTokenizer::Token::BRACKET_CLOSE)) {
  1478. do {
  1479. PatternNode *sub_pattern = parse_match_pattern(p_root_pattern != nullptr ? p_root_pattern : pattern);
  1480. if (sub_pattern == nullptr) {
  1481. continue;
  1482. }
  1483. if (pattern->rest_used) {
  1484. push_error(R"(The ".." pattern must be the last element in the pattern array.)");
  1485. } else if (sub_pattern->pattern_type == PatternNode::PT_REST) {
  1486. pattern->rest_used = true;
  1487. }
  1488. pattern->array.push_back(sub_pattern);
  1489. } while (match(GDScriptTokenizer::Token::COMMA));
  1490. }
  1491. consume(GDScriptTokenizer::Token::BRACKET_CLOSE, R"(Expected "]" to close the array pattern.)");
  1492. break;
  1493. }
  1494. case GDScriptTokenizer::Token::BRACE_OPEN: {
  1495. // Dictionary.
  1496. advance();
  1497. pattern->pattern_type = PatternNode::PT_DICTIONARY;
  1498. if (!check(GDScriptTokenizer::Token::BRACE_CLOSE) && !is_at_end()) {
  1499. do {
  1500. if (match(GDScriptTokenizer::Token::PERIOD_PERIOD)) {
  1501. // Rest.
  1502. if (pattern->rest_used) {
  1503. push_error(R"(The ".." pattern must be the last element in the pattern dictionary.)");
  1504. } else {
  1505. PatternNode *sub_pattern = alloc_node<PatternNode>();
  1506. sub_pattern->pattern_type = PatternNode::PT_REST;
  1507. pattern->dictionary.push_back({ nullptr, sub_pattern });
  1508. pattern->rest_used = true;
  1509. }
  1510. } else {
  1511. ExpressionNode *key = parse_expression(false);
  1512. if (key == nullptr) {
  1513. push_error(R"(Expected expression as key for dictionary pattern.)");
  1514. }
  1515. if (match(GDScriptTokenizer::Token::COLON)) {
  1516. // Value pattern.
  1517. PatternNode *sub_pattern = parse_match_pattern(p_root_pattern != nullptr ? p_root_pattern : pattern);
  1518. if (sub_pattern == nullptr) {
  1519. continue;
  1520. }
  1521. if (pattern->rest_used) {
  1522. push_error(R"(The ".." pattern must be the last element in the pattern dictionary.)");
  1523. } else if (sub_pattern->pattern_type == PatternNode::PT_REST) {
  1524. push_error(R"(The ".." pattern cannot be used as a value.)");
  1525. } else {
  1526. pattern->dictionary.push_back({ key, sub_pattern });
  1527. }
  1528. } else {
  1529. // Key match only.
  1530. pattern->dictionary.push_back({ key, nullptr });
  1531. }
  1532. }
  1533. } while (match(GDScriptTokenizer::Token::COMMA));
  1534. }
  1535. consume(GDScriptTokenizer::Token::BRACE_CLOSE, R"(Expected "}" to close the dictionary pattern.)");
  1536. break;
  1537. }
  1538. default: {
  1539. // Expression.
  1540. ExpressionNode *expression = parse_expression(false);
  1541. if (expression == nullptr) {
  1542. push_error(R"(Expected expression for match pattern.)");
  1543. } else {
  1544. pattern->pattern_type = PatternNode::PT_EXPRESSION;
  1545. pattern->expression = expression;
  1546. }
  1547. break;
  1548. }
  1549. }
  1550. return pattern;
  1551. }
  1552. bool GDScriptParser::PatternNode::has_bind(const StringName &p_name) {
  1553. return binds.has(p_name);
  1554. }
  1555. GDScriptParser::IdentifierNode *GDScriptParser::PatternNode::get_bind(const StringName &p_name) {
  1556. return binds[p_name];
  1557. }
  1558. GDScriptParser::WhileNode *GDScriptParser::parse_while() {
  1559. WhileNode *n_while = alloc_node<WhileNode>();
  1560. n_while->condition = parse_expression(false);
  1561. if (n_while->condition == nullptr) {
  1562. push_error(R"(Expected conditional expression after "while".)");
  1563. }
  1564. consume(GDScriptTokenizer::Token::COLON, R"(Expected ":" after "while" condition.)");
  1565. // Save break/continue state.
  1566. bool could_break = can_break;
  1567. bool could_continue = can_continue;
  1568. // Allow break/continue.
  1569. can_break = true;
  1570. can_continue = true;
  1571. n_while->loop = parse_suite(R"("while" block)");
  1572. // Reset break/continue state.
  1573. can_break = could_break;
  1574. can_continue = could_continue;
  1575. return n_while;
  1576. }
  1577. GDScriptParser::ExpressionNode *GDScriptParser::parse_precedence(Precedence p_precedence, bool p_can_assign, bool p_stop_on_assign) {
  1578. // Switch multiline mode on for grouping tokens.
  1579. // Do this early to avoid the tokenizer generating whitespace tokens.
  1580. switch (current.type) {
  1581. case GDScriptTokenizer::Token::PARENTHESIS_OPEN:
  1582. case GDScriptTokenizer::Token::BRACE_OPEN:
  1583. case GDScriptTokenizer::Token::BRACKET_OPEN:
  1584. push_multiline(true);
  1585. break;
  1586. default:
  1587. break; // Nothing to do.
  1588. }
  1589. // Completion can appear whenever an expression is expected.
  1590. make_completion_context(COMPLETION_IDENTIFIER, nullptr);
  1591. GDScriptTokenizer::Token token = advance();
  1592. ParseFunction prefix_rule = get_rule(token.type)->prefix;
  1593. if (prefix_rule == nullptr) {
  1594. // Expected expression. Let the caller give the proper error message.
  1595. return nullptr;
  1596. }
  1597. ExpressionNode *previous_operand = (this->*prefix_rule)(nullptr, p_can_assign);
  1598. while (p_precedence <= get_rule(current.type)->precedence) {
  1599. if (p_stop_on_assign && current.type == GDScriptTokenizer::Token::EQUAL) {
  1600. return previous_operand;
  1601. }
  1602. // Also switch multiline mode on here for infix operators.
  1603. switch (current.type) {
  1604. // case GDScriptTokenizer::Token::BRACE_OPEN: // Not an infix operator.
  1605. case GDScriptTokenizer::Token::PARENTHESIS_OPEN:
  1606. case GDScriptTokenizer::Token::BRACKET_OPEN:
  1607. push_multiline(true);
  1608. break;
  1609. default:
  1610. break; // Nothing to do.
  1611. }
  1612. token = advance();
  1613. ParseFunction infix_rule = get_rule(token.type)->infix;
  1614. previous_operand = (this->*infix_rule)(previous_operand, p_can_assign);
  1615. }
  1616. return previous_operand;
  1617. }
  1618. GDScriptParser::ExpressionNode *GDScriptParser::parse_expression(bool p_can_assign, bool p_stop_on_assign) {
  1619. return parse_precedence(PREC_ASSIGNMENT, p_can_assign, p_stop_on_assign);
  1620. }
  1621. GDScriptParser::IdentifierNode *GDScriptParser::parse_identifier() {
  1622. return static_cast<IdentifierNode *>(parse_identifier(nullptr, false));
  1623. }
  1624. GDScriptParser::ExpressionNode *GDScriptParser::parse_identifier(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1625. if (!previous.is_identifier()) {
  1626. ERR_FAIL_V_MSG(nullptr, "Parser bug: parsing literal node without literal token.");
  1627. }
  1628. IdentifierNode *identifier = alloc_node<IdentifierNode>();
  1629. identifier->name = previous.get_identifier();
  1630. if (current_suite != nullptr && current_suite->has_local(identifier->name)) {
  1631. const SuiteNode::Local &declaration = current_suite->get_local(identifier->name);
  1632. switch (declaration.type) {
  1633. case SuiteNode::Local::CONSTANT:
  1634. identifier->source = IdentifierNode::LOCAL_CONSTANT;
  1635. identifier->constant_source = declaration.constant;
  1636. declaration.constant->usages++;
  1637. break;
  1638. case SuiteNode::Local::VARIABLE:
  1639. identifier->source = IdentifierNode::LOCAL_VARIABLE;
  1640. identifier->variable_source = declaration.variable;
  1641. declaration.variable->usages++;
  1642. break;
  1643. case SuiteNode::Local::PARAMETER:
  1644. identifier->source = IdentifierNode::FUNCTION_PARAMETER;
  1645. identifier->parameter_source = declaration.parameter;
  1646. declaration.parameter->usages++;
  1647. break;
  1648. case SuiteNode::Local::FOR_VARIABLE:
  1649. identifier->source = IdentifierNode::LOCAL_ITERATOR;
  1650. identifier->bind_source = declaration.bind;
  1651. declaration.bind->usages++;
  1652. break;
  1653. case SuiteNode::Local::PATTERN_BIND:
  1654. identifier->source = IdentifierNode::LOCAL_BIND;
  1655. identifier->bind_source = declaration.bind;
  1656. declaration.bind->usages++;
  1657. break;
  1658. case SuiteNode::Local::UNDEFINED:
  1659. ERR_FAIL_V_MSG(nullptr, "Undefined local found.");
  1660. }
  1661. }
  1662. return identifier;
  1663. }
  1664. GDScriptParser::LiteralNode *GDScriptParser::parse_literal() {
  1665. return static_cast<LiteralNode *>(parse_literal(nullptr, false));
  1666. }
  1667. GDScriptParser::ExpressionNode *GDScriptParser::parse_literal(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1668. if (previous.type != GDScriptTokenizer::Token::LITERAL) {
  1669. push_error("Parser bug: parsing literal node without literal token.");
  1670. ERR_FAIL_V_MSG(nullptr, "Parser bug: parsing literal node without literal token.");
  1671. }
  1672. LiteralNode *literal = alloc_node<LiteralNode>();
  1673. literal->value = previous.literal;
  1674. return literal;
  1675. }
  1676. GDScriptParser::ExpressionNode *GDScriptParser::parse_self(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1677. if (!current_function || current_function->is_static) {
  1678. push_error(R"(Cannot use "self" outside a non-static function.)");
  1679. }
  1680. SelfNode *self = alloc_node<SelfNode>();
  1681. self->current_class = current_class;
  1682. return self;
  1683. }
  1684. GDScriptParser::ExpressionNode *GDScriptParser::parse_builtin_constant(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1685. GDScriptTokenizer::Token::Type op_type = previous.type;
  1686. LiteralNode *constant = alloc_node<LiteralNode>();
  1687. switch (op_type) {
  1688. case GDScriptTokenizer::Token::CONST_PI:
  1689. constant->value = Math_PI;
  1690. break;
  1691. case GDScriptTokenizer::Token::CONST_TAU:
  1692. constant->value = Math_TAU;
  1693. break;
  1694. case GDScriptTokenizer::Token::CONST_INF:
  1695. constant->value = Math_INF;
  1696. break;
  1697. case GDScriptTokenizer::Token::CONST_NAN:
  1698. constant->value = Math_NAN;
  1699. break;
  1700. default:
  1701. return nullptr; // Unreachable.
  1702. }
  1703. return constant;
  1704. }
  1705. GDScriptParser::ExpressionNode *GDScriptParser::parse_unary_operator(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1706. GDScriptTokenizer::Token::Type op_type = previous.type;
  1707. UnaryOpNode *operation = alloc_node<UnaryOpNode>();
  1708. switch (op_type) {
  1709. case GDScriptTokenizer::Token::MINUS:
  1710. operation->operation = UnaryOpNode::OP_NEGATIVE;
  1711. operation->variant_op = Variant::OP_NEGATE;
  1712. operation->operand = parse_precedence(PREC_SIGN, false);
  1713. break;
  1714. case GDScriptTokenizer::Token::PLUS:
  1715. operation->operation = UnaryOpNode::OP_POSITIVE;
  1716. operation->variant_op = Variant::OP_POSITIVE;
  1717. operation->operand = parse_precedence(PREC_SIGN, false);
  1718. break;
  1719. case GDScriptTokenizer::Token::TILDE:
  1720. operation->operation = UnaryOpNode::OP_COMPLEMENT;
  1721. operation->variant_op = Variant::OP_BIT_NEGATE;
  1722. operation->operand = parse_precedence(PREC_BIT_NOT, false);
  1723. break;
  1724. case GDScriptTokenizer::Token::NOT:
  1725. case GDScriptTokenizer::Token::BANG:
  1726. operation->operation = UnaryOpNode::OP_LOGIC_NOT;
  1727. operation->variant_op = Variant::OP_NOT;
  1728. operation->operand = parse_precedence(PREC_LOGIC_NOT, false);
  1729. break;
  1730. default:
  1731. return nullptr; // Unreachable.
  1732. }
  1733. return operation;
  1734. }
  1735. GDScriptParser::ExpressionNode *GDScriptParser::parse_binary_operator(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1736. GDScriptTokenizer::Token op = previous;
  1737. BinaryOpNode *operation = alloc_node<BinaryOpNode>();
  1738. Precedence precedence = (Precedence)(get_rule(op.type)->precedence + 1);
  1739. operation->left_operand = p_previous_operand;
  1740. operation->right_operand = parse_precedence(precedence, false);
  1741. if (operation->right_operand == nullptr) {
  1742. push_error(vformat(R"(Expected expression after "%s" operator.")", op.get_name()));
  1743. }
  1744. // TODO: Also for unary, ternary, and assignment.
  1745. switch (op.type) {
  1746. case GDScriptTokenizer::Token::PLUS:
  1747. operation->operation = BinaryOpNode::OP_ADDITION;
  1748. operation->variant_op = Variant::OP_ADD;
  1749. break;
  1750. case GDScriptTokenizer::Token::MINUS:
  1751. operation->operation = BinaryOpNode::OP_SUBTRACTION;
  1752. operation->variant_op = Variant::OP_SUBTRACT;
  1753. break;
  1754. case GDScriptTokenizer::Token::STAR:
  1755. operation->operation = BinaryOpNode::OP_MULTIPLICATION;
  1756. operation->variant_op = Variant::OP_MULTIPLY;
  1757. break;
  1758. case GDScriptTokenizer::Token::SLASH:
  1759. operation->operation = BinaryOpNode::OP_DIVISION;
  1760. operation->variant_op = Variant::OP_DIVIDE;
  1761. break;
  1762. case GDScriptTokenizer::Token::PERCENT:
  1763. operation->operation = BinaryOpNode::OP_MODULO;
  1764. operation->variant_op = Variant::OP_MODULE;
  1765. break;
  1766. case GDScriptTokenizer::Token::LESS_LESS:
  1767. operation->operation = BinaryOpNode::OP_BIT_LEFT_SHIFT;
  1768. operation->variant_op = Variant::OP_SHIFT_LEFT;
  1769. break;
  1770. case GDScriptTokenizer::Token::GREATER_GREATER:
  1771. operation->operation = BinaryOpNode::OP_BIT_RIGHT_SHIFT;
  1772. operation->variant_op = Variant::OP_SHIFT_RIGHT;
  1773. break;
  1774. case GDScriptTokenizer::Token::AMPERSAND:
  1775. operation->operation = BinaryOpNode::OP_BIT_AND;
  1776. operation->variant_op = Variant::OP_BIT_AND;
  1777. break;
  1778. case GDScriptTokenizer::Token::PIPE:
  1779. operation->operation = BinaryOpNode::OP_BIT_OR;
  1780. operation->variant_op = Variant::OP_BIT_OR;
  1781. break;
  1782. case GDScriptTokenizer::Token::CARET:
  1783. operation->operation = BinaryOpNode::OP_BIT_XOR;
  1784. operation->variant_op = Variant::OP_BIT_XOR;
  1785. break;
  1786. case GDScriptTokenizer::Token::AND:
  1787. case GDScriptTokenizer::Token::AMPERSAND_AMPERSAND:
  1788. operation->operation = BinaryOpNode::OP_LOGIC_AND;
  1789. operation->variant_op = Variant::OP_AND;
  1790. break;
  1791. case GDScriptTokenizer::Token::OR:
  1792. case GDScriptTokenizer::Token::PIPE_PIPE:
  1793. operation->operation = BinaryOpNode::OP_LOGIC_OR;
  1794. operation->variant_op = Variant::OP_OR;
  1795. break;
  1796. case GDScriptTokenizer::Token::IS:
  1797. operation->operation = BinaryOpNode::OP_TYPE_TEST;
  1798. break;
  1799. case GDScriptTokenizer::Token::IN:
  1800. operation->operation = BinaryOpNode::OP_CONTENT_TEST;
  1801. operation->variant_op = Variant::OP_IN;
  1802. break;
  1803. case GDScriptTokenizer::Token::EQUAL_EQUAL:
  1804. operation->operation = BinaryOpNode::OP_COMP_EQUAL;
  1805. operation->variant_op = Variant::OP_EQUAL;
  1806. break;
  1807. case GDScriptTokenizer::Token::BANG_EQUAL:
  1808. operation->operation = BinaryOpNode::OP_COMP_NOT_EQUAL;
  1809. operation->variant_op = Variant::OP_NOT_EQUAL;
  1810. break;
  1811. case GDScriptTokenizer::Token::LESS:
  1812. operation->operation = BinaryOpNode::OP_COMP_LESS;
  1813. operation->variant_op = Variant::OP_LESS;
  1814. break;
  1815. case GDScriptTokenizer::Token::LESS_EQUAL:
  1816. operation->operation = BinaryOpNode::OP_COMP_LESS_EQUAL;
  1817. operation->variant_op = Variant::OP_LESS_EQUAL;
  1818. break;
  1819. case GDScriptTokenizer::Token::GREATER:
  1820. operation->operation = BinaryOpNode::OP_COMP_GREATER;
  1821. operation->variant_op = Variant::OP_GREATER;
  1822. break;
  1823. case GDScriptTokenizer::Token::GREATER_EQUAL:
  1824. operation->operation = BinaryOpNode::OP_COMP_GREATER_EQUAL;
  1825. operation->variant_op = Variant::OP_GREATER_EQUAL;
  1826. break;
  1827. default:
  1828. return nullptr; // Unreachable.
  1829. }
  1830. return operation;
  1831. }
  1832. GDScriptParser::ExpressionNode *GDScriptParser::parse_ternary_operator(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1833. // Only one ternary operation exists, so no abstraction here.
  1834. TernaryOpNode *operation = alloc_node<TernaryOpNode>();
  1835. operation->true_expr = p_previous_operand;
  1836. operation->condition = parse_precedence(PREC_TERNARY, false);
  1837. if (operation->condition == nullptr) {
  1838. push_error(R"(Expected expression as ternary condition after "if".)");
  1839. }
  1840. consume(GDScriptTokenizer::Token::ELSE, R"(Expected "else" after ternary operator condition.)");
  1841. operation->false_expr = parse_precedence(PREC_TERNARY, false);
  1842. return operation;
  1843. }
  1844. GDScriptParser::ExpressionNode *GDScriptParser::parse_assignment(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1845. if (!p_can_assign) {
  1846. push_error("Assignment is not allowed inside an expression.");
  1847. return parse_expression(false); // Return the following expression.
  1848. }
  1849. #ifdef DEBUG_ENABLED
  1850. VariableNode *source_variable = nullptr;
  1851. #endif
  1852. switch (p_previous_operand->type) {
  1853. case Node::IDENTIFIER: {
  1854. #ifdef DEBUG_ENABLED
  1855. // Get source to store assignment count.
  1856. // Also remove one usage since assignment isn't usage.
  1857. IdentifierNode *id = static_cast<IdentifierNode *>(p_previous_operand);
  1858. switch (id->source) {
  1859. case IdentifierNode::LOCAL_VARIABLE:
  1860. source_variable = id->variable_source;
  1861. id->variable_source->usages--;
  1862. break;
  1863. case IdentifierNode::LOCAL_CONSTANT:
  1864. id->constant_source->usages--;
  1865. break;
  1866. case IdentifierNode::FUNCTION_PARAMETER:
  1867. id->parameter_source->usages--;
  1868. break;
  1869. case IdentifierNode::LOCAL_ITERATOR:
  1870. case IdentifierNode::LOCAL_BIND:
  1871. id->bind_source->usages--;
  1872. break;
  1873. default:
  1874. break;
  1875. }
  1876. #endif
  1877. } break;
  1878. case Node::SUBSCRIPT:
  1879. // Okay.
  1880. break;
  1881. default:
  1882. push_error(R"(Only identifier, attribute access, and subscription access can be used as assignment target.)");
  1883. return parse_expression(false); // Return the following expression.
  1884. }
  1885. AssignmentNode *assignment = alloc_node<AssignmentNode>();
  1886. make_completion_context(COMPLETION_ASSIGN, assignment);
  1887. #ifdef DEBUG_ENABLED
  1888. bool has_operator = true;
  1889. #endif
  1890. switch (previous.type) {
  1891. case GDScriptTokenizer::Token::EQUAL:
  1892. assignment->operation = AssignmentNode::OP_NONE;
  1893. assignment->variant_op = Variant::OP_MAX;
  1894. #ifdef DEBUG_ENABLED
  1895. has_operator = false;
  1896. #endif
  1897. break;
  1898. case GDScriptTokenizer::Token::PLUS_EQUAL:
  1899. assignment->operation = AssignmentNode::OP_ADDITION;
  1900. assignment->variant_op = Variant::OP_ADD;
  1901. break;
  1902. case GDScriptTokenizer::Token::MINUS_EQUAL:
  1903. assignment->operation = AssignmentNode::OP_SUBTRACTION;
  1904. assignment->variant_op = Variant::OP_SUBTRACT;
  1905. break;
  1906. case GDScriptTokenizer::Token::STAR_EQUAL:
  1907. assignment->operation = AssignmentNode::OP_MULTIPLICATION;
  1908. assignment->variant_op = Variant::OP_MULTIPLY;
  1909. break;
  1910. case GDScriptTokenizer::Token::SLASH_EQUAL:
  1911. assignment->operation = AssignmentNode::OP_DIVISION;
  1912. assignment->variant_op = Variant::OP_DIVIDE;
  1913. break;
  1914. case GDScriptTokenizer::Token::PERCENT_EQUAL:
  1915. assignment->operation = AssignmentNode::OP_MODULO;
  1916. assignment->variant_op = Variant::OP_MODULE;
  1917. break;
  1918. case GDScriptTokenizer::Token::LESS_LESS_EQUAL:
  1919. assignment->operation = AssignmentNode::OP_BIT_SHIFT_LEFT;
  1920. assignment->variant_op = Variant::OP_SHIFT_LEFT;
  1921. break;
  1922. case GDScriptTokenizer::Token::GREATER_GREATER_EQUAL:
  1923. assignment->operation = AssignmentNode::OP_BIT_SHIFT_RIGHT;
  1924. assignment->variant_op = Variant::OP_SHIFT_RIGHT;
  1925. break;
  1926. case GDScriptTokenizer::Token::AMPERSAND_EQUAL:
  1927. assignment->operation = AssignmentNode::OP_BIT_AND;
  1928. assignment->variant_op = Variant::OP_BIT_AND;
  1929. break;
  1930. case GDScriptTokenizer::Token::PIPE_EQUAL:
  1931. assignment->operation = AssignmentNode::OP_BIT_OR;
  1932. assignment->variant_op = Variant::OP_BIT_OR;
  1933. break;
  1934. case GDScriptTokenizer::Token::CARET_EQUAL:
  1935. assignment->operation = AssignmentNode::OP_BIT_XOR;
  1936. assignment->variant_op = Variant::OP_BIT_XOR;
  1937. break;
  1938. default:
  1939. break; // Unreachable.
  1940. }
  1941. assignment->assignee = p_previous_operand;
  1942. assignment->assigned_value = parse_expression(false);
  1943. #ifdef DEBUG_ENABLED
  1944. if (has_operator && source_variable != nullptr && source_variable->assignments == 0) {
  1945. push_warning(assignment, GDScriptWarning::UNASSIGNED_VARIABLE_OP_ASSIGN, source_variable->identifier->name);
  1946. }
  1947. #endif
  1948. return assignment;
  1949. }
  1950. GDScriptParser::ExpressionNode *GDScriptParser::parse_await(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1951. AwaitNode *await = alloc_node<AwaitNode>();
  1952. await->to_await = parse_precedence(PREC_AWAIT, false);
  1953. current_function->is_coroutine = true;
  1954. return await;
  1955. }
  1956. GDScriptParser::ExpressionNode *GDScriptParser::parse_array(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1957. ArrayNode *array = alloc_node<ArrayNode>();
  1958. if (!check(GDScriptTokenizer::Token::BRACKET_CLOSE)) {
  1959. do {
  1960. if (check(GDScriptTokenizer::Token::BRACKET_CLOSE)) {
  1961. // Allow for trailing comma.
  1962. break;
  1963. }
  1964. ExpressionNode *element = parse_expression(false);
  1965. if (element == nullptr) {
  1966. push_error(R"(Expected expression as array element.)");
  1967. } else {
  1968. array->elements.push_back(element);
  1969. }
  1970. } while (match(GDScriptTokenizer::Token::COMMA) && !is_at_end());
  1971. }
  1972. pop_multiline();
  1973. consume(GDScriptTokenizer::Token::BRACKET_CLOSE, R"(Expected closing "]" after array elements.)");
  1974. return array;
  1975. }
  1976. GDScriptParser::ExpressionNode *GDScriptParser::parse_dictionary(ExpressionNode *p_previous_operand, bool p_can_assign) {
  1977. DictionaryNode *dictionary = alloc_node<DictionaryNode>();
  1978. bool decided_style = false;
  1979. if (!check(GDScriptTokenizer::Token::BRACE_CLOSE)) {
  1980. do {
  1981. if (check(GDScriptTokenizer::Token::BRACE_CLOSE)) {
  1982. // Allow for trailing comma.
  1983. break;
  1984. }
  1985. // Key.
  1986. ExpressionNode *key = parse_expression(false, true); // Stop on "=" so we can check for Lua table style.
  1987. if (key == nullptr) {
  1988. push_error(R"(Expected expression as dictionary key.)");
  1989. }
  1990. if (!decided_style) {
  1991. switch (current.type) {
  1992. case GDScriptTokenizer::Token::COLON:
  1993. dictionary->style = DictionaryNode::PYTHON_DICT;
  1994. break;
  1995. case GDScriptTokenizer::Token::EQUAL:
  1996. dictionary->style = DictionaryNode::LUA_TABLE;
  1997. break;
  1998. default:
  1999. push_error(R"(Expected ":" or "=" after dictionary key.)");
  2000. break;
  2001. }
  2002. decided_style = true;
  2003. }
  2004. switch (dictionary->style) {
  2005. case DictionaryNode::LUA_TABLE:
  2006. if (key != nullptr && key->type != Node::IDENTIFIER) {
  2007. push_error("Expected identifier as dictionary key.");
  2008. }
  2009. if (!match(GDScriptTokenizer::Token::EQUAL)) {
  2010. if (match(GDScriptTokenizer::Token::COLON)) {
  2011. push_error(R"(Expected "=" after dictionary key. Mixing dictionary styles is not allowed.)");
  2012. advance(); // Consume wrong separator anyway.
  2013. } else {
  2014. push_error(R"(Expected "=" after dictionary key.)");
  2015. }
  2016. }
  2017. break;
  2018. case DictionaryNode::PYTHON_DICT:
  2019. if (!match(GDScriptTokenizer::Token::COLON)) {
  2020. if (match(GDScriptTokenizer::Token::EQUAL)) {
  2021. push_error(R"(Expected ":" after dictionary key. Mixing dictionary styles is not allowed.)");
  2022. advance(); // Consume wrong separator anyway.
  2023. } else {
  2024. push_error(R"(Expected ":" after dictionary key.)");
  2025. }
  2026. }
  2027. break;
  2028. }
  2029. // Value.
  2030. ExpressionNode *value = parse_expression(false);
  2031. if (value == nullptr) {
  2032. push_error(R"(Expected expression as dictionary value.)");
  2033. }
  2034. if (key != nullptr && value != nullptr) {
  2035. dictionary->elements.push_back({ key, value });
  2036. }
  2037. } while (match(GDScriptTokenizer::Token::COMMA) && !is_at_end());
  2038. }
  2039. pop_multiline();
  2040. consume(GDScriptTokenizer::Token::BRACE_CLOSE, R"(Expected closing "}" after dictionary elements.)");
  2041. return dictionary;
  2042. }
  2043. GDScriptParser::ExpressionNode *GDScriptParser::parse_grouping(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2044. ExpressionNode *grouped = parse_expression(false);
  2045. pop_multiline();
  2046. if (grouped == nullptr) {
  2047. push_error(R"(Expected grouping expression.)");
  2048. } else {
  2049. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected closing ")" after grouping expression.)*");
  2050. }
  2051. return grouped;
  2052. }
  2053. GDScriptParser::ExpressionNode *GDScriptParser::parse_attribute(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2054. SubscriptNode *attribute = alloc_node<SubscriptNode>();
  2055. if (for_completion) {
  2056. bool is_builtin = false;
  2057. if (p_previous_operand->type == Node::IDENTIFIER) {
  2058. const IdentifierNode *id = static_cast<const IdentifierNode *>(p_previous_operand);
  2059. Variant::Type builtin_type = get_builtin_type(id->name);
  2060. if (builtin_type < Variant::VARIANT_MAX) {
  2061. make_completion_context(COMPLETION_BUILT_IN_TYPE_CONSTANT, builtin_type, true);
  2062. is_builtin = true;
  2063. }
  2064. }
  2065. if (!is_builtin) {
  2066. make_completion_context(COMPLETION_ATTRIBUTE, attribute, -1, true);
  2067. }
  2068. }
  2069. attribute->is_attribute = true;
  2070. attribute->base = p_previous_operand;
  2071. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected identifier after "." for attribute access.)")) {
  2072. return attribute;
  2073. }
  2074. attribute->attribute = parse_identifier();
  2075. return attribute;
  2076. }
  2077. GDScriptParser::ExpressionNode *GDScriptParser::parse_subscript(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2078. SubscriptNode *subscript = alloc_node<SubscriptNode>();
  2079. make_completion_context(COMPLETION_SUBSCRIPT, subscript);
  2080. subscript->base = p_previous_operand;
  2081. subscript->index = parse_expression(false);
  2082. pop_multiline();
  2083. consume(GDScriptTokenizer::Token::BRACKET_CLOSE, R"(Expected "]" after subscription index.)");
  2084. return subscript;
  2085. }
  2086. GDScriptParser::ExpressionNode *GDScriptParser::parse_cast(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2087. CastNode *cast = alloc_node<CastNode>();
  2088. cast->operand = p_previous_operand;
  2089. cast->cast_type = parse_type();
  2090. if (cast->cast_type == nullptr) {
  2091. push_error(R"(Expected type specifier after "as".)");
  2092. return p_previous_operand;
  2093. }
  2094. return cast;
  2095. }
  2096. GDScriptParser::ExpressionNode *GDScriptParser::parse_call(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2097. CallNode *call = alloc_node<CallNode>();
  2098. if (previous.type == GDScriptTokenizer::Token::SUPER) {
  2099. // Super call.
  2100. call->is_super = true;
  2101. push_multiline(true);
  2102. if (match(GDScriptTokenizer::Token::PARENTHESIS_OPEN)) {
  2103. // Implicit call to the parent method of the same name.
  2104. if (current_function == nullptr) {
  2105. push_error(R"(Cannot use implicit "super" call outside of a function.)");
  2106. pop_multiline();
  2107. return nullptr;
  2108. }
  2109. call->function_name = current_function->identifier->name;
  2110. } else {
  2111. consume(GDScriptTokenizer::Token::PERIOD, R"(Expected "." or "(" after "super".)");
  2112. make_completion_context(COMPLETION_SUPER_METHOD, call, true);
  2113. if (!consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected function name after ".".)")) {
  2114. pop_multiline();
  2115. return nullptr;
  2116. }
  2117. IdentifierNode *identifier = parse_identifier();
  2118. call->callee = identifier;
  2119. call->function_name = identifier->name;
  2120. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected "(" after function name.)");
  2121. }
  2122. } else {
  2123. call->callee = p_previous_operand;
  2124. if (call->callee == nullptr) {
  2125. push_error(R"*(Cannot call on an expression. Use ".call()" if it's a Callable.)*");
  2126. } else if (call->callee->type == Node::IDENTIFIER) {
  2127. call->function_name = static_cast<IdentifierNode *>(call->callee)->name;
  2128. make_completion_context(COMPLETION_METHOD, call->callee);
  2129. } else if (call->callee->type == Node::SUBSCRIPT) {
  2130. SubscriptNode *attribute = static_cast<SubscriptNode *>(call->callee);
  2131. if (attribute->is_attribute) {
  2132. if (attribute->attribute) {
  2133. call->function_name = attribute->attribute->name;
  2134. }
  2135. make_completion_context(COMPLETION_ATTRIBUTE_METHOD, call->callee);
  2136. } else {
  2137. // TODO: The analyzer can see if this is actually a Callable and give better error message.
  2138. push_error(R"*(Cannot call on an expression. Use ".call()" if it's a Callable.)*");
  2139. }
  2140. } else {
  2141. push_error(R"*(Cannot call on an expression. Use ".call()" if it's a Callable.)*");
  2142. }
  2143. }
  2144. if (!check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE)) {
  2145. // Arguments.
  2146. push_completion_call(call);
  2147. make_completion_context(COMPLETION_CALL_ARGUMENTS, call, 0, true);
  2148. int argument_index = 0;
  2149. do {
  2150. make_completion_context(COMPLETION_CALL_ARGUMENTS, call, argument_index++, true);
  2151. if (check(GDScriptTokenizer::Token::PARENTHESIS_CLOSE)) {
  2152. // Allow for trailing comma.
  2153. break;
  2154. }
  2155. ExpressionNode *argument = parse_expression(false);
  2156. if (argument == nullptr) {
  2157. push_error(R"(Expected expression as the function argument.)");
  2158. } else {
  2159. call->arguments.push_back(argument);
  2160. }
  2161. } while (match(GDScriptTokenizer::Token::COMMA));
  2162. pop_completion_call();
  2163. }
  2164. pop_multiline();
  2165. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected closing ")" after call arguments.)*");
  2166. return call;
  2167. }
  2168. GDScriptParser::ExpressionNode *GDScriptParser::parse_get_node(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2169. if (match(GDScriptTokenizer::Token::LITERAL)) {
  2170. if (previous.literal.get_type() != Variant::STRING) {
  2171. push_error(R"(Expect node path as string or identifer after "$".)");
  2172. return nullptr;
  2173. }
  2174. GetNodeNode *get_node = alloc_node<GetNodeNode>();
  2175. make_completion_context(COMPLETION_GET_NODE, get_node);
  2176. get_node->string = parse_literal();
  2177. return get_node;
  2178. } else if (current.is_node_name()) {
  2179. GetNodeNode *get_node = alloc_node<GetNodeNode>();
  2180. int chain_position = 0;
  2181. do {
  2182. make_completion_context(COMPLETION_GET_NODE, get_node, chain_position++);
  2183. if (!current.is_node_name()) {
  2184. push_error(R"(Expect node path after "/".)");
  2185. return nullptr;
  2186. }
  2187. advance();
  2188. IdentifierNode *identifier = alloc_node<IdentifierNode>();
  2189. identifier->name = previous.get_identifier();
  2190. get_node->chain.push_back(identifier);
  2191. } while (match(GDScriptTokenizer::Token::SLASH));
  2192. return get_node;
  2193. } else {
  2194. push_error(R"(Expect node path as string or identifer after "$".)");
  2195. return nullptr;
  2196. }
  2197. }
  2198. GDScriptParser::ExpressionNode *GDScriptParser::parse_preload(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2199. PreloadNode *preload = alloc_node<PreloadNode>();
  2200. preload->resolved_path = "<missing path>";
  2201. push_multiline(true);
  2202. consume(GDScriptTokenizer::Token::PARENTHESIS_OPEN, R"(Expected "(" after "preload".)");
  2203. make_completion_context(COMPLETION_RESOURCE_PATH, preload);
  2204. push_completion_call(preload);
  2205. preload->path = parse_expression(false);
  2206. if (preload->path == nullptr) {
  2207. push_error(R"(Expected resource path after "(".)");
  2208. }
  2209. pop_completion_call();
  2210. pop_multiline();
  2211. consume(GDScriptTokenizer::Token::PARENTHESIS_CLOSE, R"*(Expected ")" after preload path.)*");
  2212. return preload;
  2213. }
  2214. GDScriptParser::ExpressionNode *GDScriptParser::parse_invalid_token(ExpressionNode *p_previous_operand, bool p_can_assign) {
  2215. // Just for better error messages.
  2216. GDScriptTokenizer::Token::Type invalid = previous.type;
  2217. switch (invalid) {
  2218. case GDScriptTokenizer::Token::QUESTION_MARK:
  2219. push_error(R"(Unexpected "?" in source. If you want a ternary operator, use "truthy_value if true_condition else falsy_value".)");
  2220. break;
  2221. default:
  2222. return nullptr; // Unreachable.
  2223. }
  2224. // Return the previous expression.
  2225. return p_previous_operand;
  2226. }
  2227. GDScriptParser::TypeNode *GDScriptParser::parse_type(bool p_allow_void) {
  2228. TypeNode *type = alloc_node<TypeNode>();
  2229. make_completion_context(p_allow_void ? COMPLETION_TYPE_NAME_OR_VOID : COMPLETION_TYPE_NAME, type);
  2230. if (!match(GDScriptTokenizer::Token::IDENTIFIER)) {
  2231. if (match(GDScriptTokenizer::Token::VOID)) {
  2232. if (p_allow_void) {
  2233. TypeNode *void_type = alloc_node<TypeNode>();
  2234. return void_type;
  2235. } else {
  2236. push_error(R"("void" is only allowed for a function return type.)");
  2237. }
  2238. }
  2239. // Leave error message to the caller who knows the context.
  2240. return nullptr;
  2241. }
  2242. IdentifierNode *type_element = parse_identifier();
  2243. type->type_chain.push_back(type_element);
  2244. int chain_index = 1;
  2245. while (match(GDScriptTokenizer::Token::PERIOD)) {
  2246. make_completion_context(COMPLETION_TYPE_ATTRIBUTE, type, chain_index++);
  2247. if (consume(GDScriptTokenizer::Token::IDENTIFIER, R"(Expected inner type name after ".".)")) {
  2248. type_element = parse_identifier();
  2249. type->type_chain.push_back(type_element);
  2250. }
  2251. }
  2252. return type;
  2253. }
  2254. GDScriptParser::ParseRule *GDScriptParser::get_rule(GDScriptTokenizer::Token::Type p_token_type) {
  2255. // Function table for expression parsing.
  2256. // clang-format destroys the alignment here, so turn off for the table.
  2257. /* clang-format off */
  2258. static ParseRule rules[] = {
  2259. // PREFIX INFIX PRECEDENCE (for infix)
  2260. { nullptr, nullptr, PREC_NONE }, // EMPTY,
  2261. // Basic
  2262. { nullptr, nullptr, PREC_NONE }, // ANNOTATION,
  2263. { &GDScriptParser::parse_identifier, nullptr, PREC_NONE }, // IDENTIFIER,
  2264. { &GDScriptParser::parse_literal, nullptr, PREC_NONE }, // LITERAL,
  2265. // Comparison
  2266. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // LESS,
  2267. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // LESS_EQUAL,
  2268. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // GREATER,
  2269. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // GREATER_EQUAL,
  2270. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // EQUAL_EQUAL,
  2271. { nullptr, &GDScriptParser::parse_binary_operator, PREC_COMPARISON }, // BANG_EQUAL,
  2272. // Logical
  2273. { nullptr, &GDScriptParser::parse_binary_operator, PREC_LOGIC_AND }, // AND,
  2274. { nullptr, &GDScriptParser::parse_binary_operator, PREC_LOGIC_OR }, // OR,
  2275. { &GDScriptParser::parse_unary_operator, nullptr, PREC_NONE }, // NOT,
  2276. { nullptr, &GDScriptParser::parse_binary_operator, PREC_LOGIC_AND }, // AMPERSAND_AMPERSAND,
  2277. { nullptr, &GDScriptParser::parse_binary_operator, PREC_LOGIC_OR }, // PIPE_PIPE,
  2278. { &GDScriptParser::parse_unary_operator, nullptr, PREC_NONE }, // BANG,
  2279. // Bitwise
  2280. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_AND }, // AMPERSAND,
  2281. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_OR }, // PIPE,
  2282. { &GDScriptParser::parse_unary_operator, nullptr, PREC_NONE }, // TILDE,
  2283. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_XOR }, // CARET,
  2284. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_SHIFT }, // LESS_LESS,
  2285. { nullptr, &GDScriptParser::parse_binary_operator, PREC_BIT_SHIFT }, // GREATER_GREATER,
  2286. // Math
  2287. { &GDScriptParser::parse_unary_operator, &GDScriptParser::parse_binary_operator, PREC_ADDITION }, // PLUS,
  2288. { &GDScriptParser::parse_unary_operator, &GDScriptParser::parse_binary_operator, PREC_SUBTRACTION }, // MINUS,
  2289. { nullptr, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // STAR,
  2290. { nullptr, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // SLASH,
  2291. { nullptr, &GDScriptParser::parse_binary_operator, PREC_FACTOR }, // PERCENT,
  2292. // Assignment
  2293. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // EQUAL,
  2294. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // PLUS_EQUAL,
  2295. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // MINUS_EQUAL,
  2296. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // STAR_EQUAL,
  2297. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // SLASH_EQUAL,
  2298. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // PERCENT_EQUAL,
  2299. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // LESS_LESS_EQUAL,
  2300. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // GREATER_GREATER_EQUAL,
  2301. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // AMPERSAND_EQUAL,
  2302. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // PIPE_EQUAL,
  2303. { nullptr, &GDScriptParser::parse_assignment, PREC_ASSIGNMENT }, // CARET_EQUAL,
  2304. // Control flow
  2305. { nullptr, &GDScriptParser::parse_ternary_operator, PREC_TERNARY }, // IF,
  2306. { nullptr, nullptr, PREC_NONE }, // ELIF,
  2307. { nullptr, nullptr, PREC_NONE }, // ELSE,
  2308. { nullptr, nullptr, PREC_NONE }, // FOR,
  2309. { nullptr, nullptr, PREC_NONE }, // WHILE,
  2310. { nullptr, nullptr, PREC_NONE }, // BREAK,
  2311. { nullptr, nullptr, PREC_NONE }, // CONTINUE,
  2312. { nullptr, nullptr, PREC_NONE }, // PASS,
  2313. { nullptr, nullptr, PREC_NONE }, // RETURN,
  2314. { nullptr, nullptr, PREC_NONE }, // MATCH,
  2315. // Keywords
  2316. { nullptr, &GDScriptParser::parse_cast, PREC_CAST }, // AS,
  2317. { nullptr, nullptr, PREC_NONE }, // ASSERT,
  2318. { &GDScriptParser::parse_await, nullptr, PREC_NONE }, // AWAIT,
  2319. { nullptr, nullptr, PREC_NONE }, // BREAKPOINT,
  2320. { nullptr, nullptr, PREC_NONE }, // CLASS,
  2321. { nullptr, nullptr, PREC_NONE }, // CLASS_NAME,
  2322. { nullptr, nullptr, PREC_NONE }, // CONST,
  2323. { nullptr, nullptr, PREC_NONE }, // ENUM,
  2324. { nullptr, nullptr, PREC_NONE }, // EXTENDS,
  2325. { nullptr, nullptr, PREC_NONE }, // FUNC,
  2326. { nullptr, &GDScriptParser::parse_binary_operator, PREC_CONTENT_TEST }, // IN,
  2327. { nullptr, &GDScriptParser::parse_binary_operator, PREC_TYPE_TEST }, // IS,
  2328. { nullptr, nullptr, PREC_NONE }, // NAMESPACE,
  2329. { &GDScriptParser::parse_preload, nullptr, PREC_NONE }, // PRELOAD,
  2330. { &GDScriptParser::parse_self, nullptr, PREC_NONE }, // SELF,
  2331. { nullptr, nullptr, PREC_NONE }, // SIGNAL,
  2332. { nullptr, nullptr, PREC_NONE }, // STATIC,
  2333. { &GDScriptParser::parse_call, nullptr, PREC_NONE }, // SUPER,
  2334. { nullptr, nullptr, PREC_NONE }, // TRAIT,
  2335. { nullptr, nullptr, PREC_NONE }, // VAR,
  2336. { nullptr, nullptr, PREC_NONE }, // VOID,
  2337. { nullptr, nullptr, PREC_NONE }, // YIELD,
  2338. // Punctuation
  2339. { &GDScriptParser::parse_array, &GDScriptParser::parse_subscript, PREC_SUBSCRIPT }, // BRACKET_OPEN,
  2340. { nullptr, nullptr, PREC_NONE }, // BRACKET_CLOSE,
  2341. { &GDScriptParser::parse_dictionary, nullptr, PREC_NONE }, // BRACE_OPEN,
  2342. { nullptr, nullptr, PREC_NONE }, // BRACE_CLOSE,
  2343. { &GDScriptParser::parse_grouping, &GDScriptParser::parse_call, PREC_CALL }, // PARENTHESIS_OPEN,
  2344. { nullptr, nullptr, PREC_NONE }, // PARENTHESIS_CLOSE,
  2345. { nullptr, nullptr, PREC_NONE }, // COMMA,
  2346. { nullptr, nullptr, PREC_NONE }, // SEMICOLON,
  2347. { nullptr, &GDScriptParser::parse_attribute, PREC_ATTRIBUTE }, // PERIOD,
  2348. { nullptr, nullptr, PREC_NONE }, // PERIOD_PERIOD,
  2349. { nullptr, nullptr, PREC_NONE }, // COLON,
  2350. { &GDScriptParser::parse_get_node, nullptr, PREC_NONE }, // DOLLAR,
  2351. { nullptr, nullptr, PREC_NONE }, // FORWARD_ARROW,
  2352. { nullptr, nullptr, PREC_NONE }, // UNDERSCORE,
  2353. // Whitespace
  2354. { nullptr, nullptr, PREC_NONE }, // NEWLINE,
  2355. { nullptr, nullptr, PREC_NONE }, // INDENT,
  2356. { nullptr, nullptr, PREC_NONE }, // DEDENT,
  2357. // Constants
  2358. { &GDScriptParser::parse_builtin_constant, nullptr, PREC_NONE }, // CONST_PI,
  2359. { &GDScriptParser::parse_builtin_constant, nullptr, PREC_NONE }, // CONST_TAU,
  2360. { &GDScriptParser::parse_builtin_constant, nullptr, PREC_NONE }, // CONST_INF,
  2361. { &GDScriptParser::parse_builtin_constant, nullptr, PREC_NONE }, // CONST_NAN,
  2362. // Error message improvement
  2363. { nullptr, nullptr, PREC_NONE }, // VCS_CONFLICT_MARKER,
  2364. { nullptr, nullptr, PREC_NONE }, // BACKTICK,
  2365. { nullptr, &GDScriptParser::parse_invalid_token, PREC_CAST }, // QUESTION_MARK,
  2366. // Special
  2367. { nullptr, nullptr, PREC_NONE }, // ERROR,
  2368. { nullptr, nullptr, PREC_NONE }, // TK_EOF,
  2369. };
  2370. /* clang-format on */
  2371. // Avoid desync.
  2372. static_assert(sizeof(rules) / sizeof(rules[0]) == GDScriptTokenizer::Token::TK_MAX, "Amount of parse rules don't match the amount of token types.");
  2373. // Let's assume this this never invalid, since nothing generates a TK_MAX.
  2374. return &rules[p_token_type];
  2375. }
  2376. bool GDScriptParser::SuiteNode::has_local(const StringName &p_name) const {
  2377. if (locals_indices.has(p_name)) {
  2378. return true;
  2379. }
  2380. if (parent_block != nullptr) {
  2381. return parent_block->has_local(p_name);
  2382. }
  2383. return false;
  2384. }
  2385. const GDScriptParser::SuiteNode::Local &GDScriptParser::SuiteNode::get_local(const StringName &p_name) const {
  2386. if (locals_indices.has(p_name)) {
  2387. return locals[locals_indices[p_name]];
  2388. }
  2389. if (parent_block != nullptr) {
  2390. return parent_block->get_local(p_name);
  2391. }
  2392. return empty;
  2393. }
  2394. bool GDScriptParser::AnnotationNode::apply(GDScriptParser *p_this, Node *p_target) const {
  2395. return (p_this->*(p_this->valid_annotations[name].apply))(this, p_target);
  2396. }
  2397. bool GDScriptParser::AnnotationNode::applies_to(uint32_t p_target_kinds) const {
  2398. return (info->target_kind & p_target_kinds) > 0;
  2399. }
  2400. bool GDScriptParser::validate_annotation_arguments(AnnotationNode *p_annotation) {
  2401. ERR_FAIL_COND_V_MSG(!valid_annotations.has(p_annotation->name), false, vformat(R"(Annotation "%s" not found to validate.)", p_annotation->name));
  2402. const MethodInfo &info = valid_annotations[p_annotation->name].info;
  2403. if (((info.flags & METHOD_FLAG_VARARG) == 0) && p_annotation->arguments.size() > info.arguments.size()) {
  2404. 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()));
  2405. return false;
  2406. }
  2407. if (p_annotation->arguments.size() < info.arguments.size() - info.default_arguments.size()) {
  2408. 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()));
  2409. return false;
  2410. }
  2411. const List<PropertyInfo>::Element *E = info.arguments.front();
  2412. for (int i = 0; i < p_annotation->arguments.size(); i++) {
  2413. ExpressionNode *argument = p_annotation->arguments[i];
  2414. const PropertyInfo &parameter = E->get();
  2415. if (E->next() != nullptr) {
  2416. E = E->next();
  2417. }
  2418. switch (parameter.type) {
  2419. case Variant::STRING:
  2420. case Variant::STRING_NAME:
  2421. case Variant::NODE_PATH:
  2422. // Allow "quote-less strings", as long as they are recognized as identifiers.
  2423. if (argument->type == Node::IDENTIFIER) {
  2424. IdentifierNode *string = static_cast<IdentifierNode *>(argument);
  2425. Callable::CallError error;
  2426. Vector<Variant> args = varray(string->name);
  2427. const Variant *name = args.ptr();
  2428. p_annotation->resolved_arguments.push_back(Variant::construct(parameter.type, &(name), 1, error));
  2429. if (error.error != Callable::CallError::CALL_OK) {
  2430. push_error(vformat(R"(Expected %s as argument %d of annotation "%s").)", Variant::get_type_name(parameter.type), i + 1, p_annotation->name));
  2431. p_annotation->resolved_arguments.remove(p_annotation->resolved_arguments.size() - 1);
  2432. return false;
  2433. }
  2434. break;
  2435. }
  2436. [[fallthrough]];
  2437. default: {
  2438. if (argument->type != Node::LITERAL) {
  2439. push_error(vformat(R"(Expected %s as argument %d of annotation "%s").)", Variant::get_type_name(parameter.type), i + 1, p_annotation->name));
  2440. return false;
  2441. }
  2442. Variant value = static_cast<LiteralNode *>(argument)->value;
  2443. if (!Variant::can_convert_strict(value.get_type(), parameter.type)) {
  2444. push_error(vformat(R"(Expected %s as argument %d of annotation "%s").)", Variant::get_type_name(parameter.type), i + 1, p_annotation->name));
  2445. return false;
  2446. }
  2447. Callable::CallError error;
  2448. const Variant *args = &value;
  2449. p_annotation->resolved_arguments.push_back(Variant::construct(parameter.type, &(args), 1, error));
  2450. if (error.error != Callable::CallError::CALL_OK) {
  2451. push_error(vformat(R"(Expected %s as argument %d of annotation "%s").)", Variant::get_type_name(parameter.type), i + 1, p_annotation->name));
  2452. p_annotation->resolved_arguments.remove(p_annotation->resolved_arguments.size() - 1);
  2453. return false;
  2454. }
  2455. break;
  2456. }
  2457. }
  2458. }
  2459. return true;
  2460. }
  2461. bool GDScriptParser::tool_annotation(const AnnotationNode *p_annotation, Node *p_node) {
  2462. this->_is_tool = true;
  2463. return true;
  2464. }
  2465. bool GDScriptParser::icon_annotation(const AnnotationNode *p_annotation, Node *p_node) {
  2466. ERR_FAIL_COND_V_MSG(p_node->type != Node::CLASS, false, R"("@icon" annotation can only be applied to classes.)");
  2467. ClassNode *p_class = static_cast<ClassNode *>(p_node);
  2468. p_class->icon_path = p_annotation->resolved_arguments[0];
  2469. return true;
  2470. }
  2471. bool GDScriptParser::onready_annotation(const AnnotationNode *p_annotation, Node *p_node) {
  2472. ERR_FAIL_COND_V_MSG(p_node->type != Node::VARIABLE, false, R"("@onready" annotation can only be applied to class variables.)");
  2473. VariableNode *variable = static_cast<VariableNode *>(p_node);
  2474. if (variable->onready) {
  2475. push_error(R"("@onready" annotation can only be used once per variable.)");
  2476. return false;
  2477. }
  2478. variable->onready = true;
  2479. current_class->onready_used = true;
  2480. return true;
  2481. }
  2482. template <PropertyHint t_hint, Variant::Type t_type>
  2483. bool GDScriptParser::export_annotations(const AnnotationNode *p_annotation, Node *p_node) {
  2484. ERR_FAIL_COND_V_MSG(p_node->type != Node::VARIABLE, false, vformat(R"("%s" annotation can only be applied to variables.)", p_annotation->name));
  2485. VariableNode *variable = static_cast<VariableNode *>(p_node);
  2486. if (variable->exported) {
  2487. push_error(vformat(R"(Annotation "%s" cannot be used with another "@export" annotation.)", p_annotation->name), p_annotation);
  2488. return false;
  2489. }
  2490. variable->exported = true;
  2491. // TODO: Improving setting type, especially for range hints, which can be int or float.
  2492. variable->export_info.type = t_type;
  2493. variable->export_info.hint = t_hint;
  2494. if (p_annotation->name == "@export") {
  2495. if (variable->datatype_specifier == nullptr) {
  2496. if (variable->initializer == nullptr) {
  2497. push_error(R"(Cannot use "@export" annotation with variable without type or initializer, since type can't be inferred.)", p_annotation);
  2498. return false;
  2499. }
  2500. if (variable->initializer->type != Node::LITERAL) {
  2501. push_error(R"(To use "@export" annotation with type-less variable, the default value must be a literal.)", p_annotation);
  2502. return false;
  2503. }
  2504. variable->export_info.type = static_cast<LiteralNode *>(variable->initializer)->value.get_type();
  2505. } // else: Actual type will be set by the analyzer, which can infer the proper type.
  2506. }
  2507. String hint_string;
  2508. for (int i = 0; i < p_annotation->resolved_arguments.size(); i++) {
  2509. if (i > 0) {
  2510. hint_string += ",";
  2511. }
  2512. hint_string += String(p_annotation->resolved_arguments[i]);
  2513. }
  2514. variable->export_info.hint_string = hint_string;
  2515. return true;
  2516. }
  2517. bool GDScriptParser::warning_annotations(const AnnotationNode *p_annotation, Node *p_node) {
  2518. ERR_FAIL_V_MSG(false, "Not implemented.");
  2519. }
  2520. template <MultiplayerAPI::RPCMode t_mode>
  2521. bool GDScriptParser::network_annotations(const AnnotationNode *p_annotation, Node *p_node) {
  2522. ERR_FAIL_COND_V_MSG(p_node->type != Node::VARIABLE && p_node->type != Node::FUNCTION, false, vformat(R"("%s" annotation can only be applied to variables and functions.)", p_annotation->name));
  2523. switch (p_node->type) {
  2524. case Node::VARIABLE: {
  2525. VariableNode *variable = static_cast<VariableNode *>(p_node);
  2526. if (variable->rpc_mode != MultiplayerAPI::RPC_MODE_DISABLED) {
  2527. push_error(R"(RPC annotations can only be used once per variable.)", p_annotation);
  2528. }
  2529. variable->rpc_mode = t_mode;
  2530. break;
  2531. }
  2532. case Node::FUNCTION: {
  2533. FunctionNode *function = static_cast<FunctionNode *>(p_node);
  2534. if (function->rpc_mode != MultiplayerAPI::RPC_MODE_DISABLED) {
  2535. push_error(R"(RPC annotations can only be used once per function.)", p_annotation);
  2536. }
  2537. function->rpc_mode = t_mode;
  2538. break;
  2539. }
  2540. default:
  2541. return false; // Unreachable.
  2542. }
  2543. return true;
  2544. }
  2545. GDScriptParser::DataType GDScriptParser::SuiteNode::Local::get_datatype() const {
  2546. switch (type) {
  2547. case CONSTANT:
  2548. return constant->get_datatype();
  2549. case VARIABLE:
  2550. return variable->get_datatype();
  2551. case PARAMETER:
  2552. return parameter->get_datatype();
  2553. case FOR_VARIABLE:
  2554. case PATTERN_BIND:
  2555. return bind->get_datatype();
  2556. case UNDEFINED:
  2557. return DataType();
  2558. }
  2559. return DataType();
  2560. }
  2561. String GDScriptParser::SuiteNode::Local::get_name() const {
  2562. String name;
  2563. switch (type) {
  2564. case SuiteNode::Local::PARAMETER:
  2565. name = "parameter";
  2566. break;
  2567. case SuiteNode::Local::CONSTANT:
  2568. name = "constant";
  2569. break;
  2570. case SuiteNode::Local::VARIABLE:
  2571. name = "variable";
  2572. break;
  2573. case SuiteNode::Local::FOR_VARIABLE:
  2574. name = "for loop iterator";
  2575. break;
  2576. case SuiteNode::Local::PATTERN_BIND:
  2577. name = "pattern_bind";
  2578. break;
  2579. case SuiteNode::Local::UNDEFINED:
  2580. name = "<undefined>";
  2581. break;
  2582. }
  2583. return name;
  2584. }
  2585. String GDScriptParser::DataType::to_string() const {
  2586. switch (kind) {
  2587. case VARIANT:
  2588. return "Variant";
  2589. case BUILTIN:
  2590. if (builtin_type == Variant::NIL) {
  2591. return "null";
  2592. }
  2593. return Variant::get_type_name(builtin_type);
  2594. case NATIVE:
  2595. if (is_meta_type) {
  2596. return GDScriptNativeClass::get_class_static();
  2597. }
  2598. return native_type.operator String();
  2599. case CLASS:
  2600. if (is_meta_type) {
  2601. return GDScript::get_class_static();
  2602. }
  2603. if (class_type->identifier != nullptr) {
  2604. return class_type->identifier->name.operator String();
  2605. }
  2606. return class_type->fqcn;
  2607. case SCRIPT: {
  2608. if (is_meta_type) {
  2609. return script_type->get_class_name().operator String();
  2610. }
  2611. String name = script_type->get_name();
  2612. if (!name.empty()) {
  2613. return name;
  2614. }
  2615. name = script_path;
  2616. if (!name.empty()) {
  2617. return name;
  2618. }
  2619. return native_type.operator String();
  2620. }
  2621. case ENUM:
  2622. return enum_type.operator String() + " (enum)";
  2623. case ENUM_VALUE:
  2624. return enum_type.operator String() + " (enum value)";
  2625. case UNRESOLVED:
  2626. return "<unresolved type>";
  2627. }
  2628. ERR_FAIL_V_MSG("<unresolved type", "Kind set outside the enum range.");
  2629. }
  2630. /*---------- PRETTY PRINT FOR DEBUG ----------*/
  2631. #ifdef DEBUG_ENABLED
  2632. void GDScriptParser::TreePrinter::increase_indent() {
  2633. indent_level++;
  2634. indent = "";
  2635. for (int i = 0; i < indent_level * 4; i++) {
  2636. if (i % 4 == 0) {
  2637. indent += "|";
  2638. } else {
  2639. indent += " ";
  2640. }
  2641. }
  2642. }
  2643. void GDScriptParser::TreePrinter::decrease_indent() {
  2644. indent_level--;
  2645. indent = "";
  2646. for (int i = 0; i < indent_level * 4; i++) {
  2647. if (i % 4 == 0) {
  2648. indent += "|";
  2649. } else {
  2650. indent += " ";
  2651. }
  2652. }
  2653. }
  2654. void GDScriptParser::TreePrinter::push_line(const String &p_line) {
  2655. if (!p_line.empty()) {
  2656. push_text(p_line);
  2657. }
  2658. printed += "\n";
  2659. pending_indent = true;
  2660. }
  2661. void GDScriptParser::TreePrinter::push_text(const String &p_text) {
  2662. if (pending_indent) {
  2663. printed += indent;
  2664. pending_indent = false;
  2665. }
  2666. printed += p_text;
  2667. }
  2668. void GDScriptParser::TreePrinter::print_annotation(AnnotationNode *p_annotation) {
  2669. push_text(p_annotation->name);
  2670. push_text(" (");
  2671. for (int i = 0; i < p_annotation->arguments.size(); i++) {
  2672. if (i > 0) {
  2673. push_text(" , ");
  2674. }
  2675. print_expression(p_annotation->arguments[i]);
  2676. }
  2677. push_line(")");
  2678. }
  2679. void GDScriptParser::TreePrinter::print_array(ArrayNode *p_array) {
  2680. push_text("[ ");
  2681. for (int i = 0; i < p_array->elements.size(); i++) {
  2682. if (i > 0) {
  2683. push_text(" , ");
  2684. }
  2685. print_expression(p_array->elements[i]);
  2686. }
  2687. push_text(" ]");
  2688. }
  2689. void GDScriptParser::TreePrinter::print_assert(AssertNode *p_assert) {
  2690. push_text("Assert ( ");
  2691. print_expression(p_assert->condition);
  2692. push_line(" )");
  2693. }
  2694. void GDScriptParser::TreePrinter::print_assignment(AssignmentNode *p_assignment) {
  2695. switch (p_assignment->assignee->type) {
  2696. case Node::IDENTIFIER:
  2697. print_identifier(static_cast<IdentifierNode *>(p_assignment->assignee));
  2698. break;
  2699. case Node::SUBSCRIPT:
  2700. print_subscript(static_cast<SubscriptNode *>(p_assignment->assignee));
  2701. break;
  2702. default:
  2703. break; // Unreachable.
  2704. }
  2705. push_text(" ");
  2706. switch (p_assignment->operation) {
  2707. case AssignmentNode::OP_ADDITION:
  2708. push_text("+");
  2709. break;
  2710. case AssignmentNode::OP_SUBTRACTION:
  2711. push_text("-");
  2712. break;
  2713. case AssignmentNode::OP_MULTIPLICATION:
  2714. push_text("*");
  2715. break;
  2716. case AssignmentNode::OP_DIVISION:
  2717. push_text("/");
  2718. break;
  2719. case AssignmentNode::OP_MODULO:
  2720. push_text("%");
  2721. break;
  2722. case AssignmentNode::OP_BIT_SHIFT_LEFT:
  2723. push_text("<<");
  2724. break;
  2725. case AssignmentNode::OP_BIT_SHIFT_RIGHT:
  2726. push_text(">>");
  2727. break;
  2728. case AssignmentNode::OP_BIT_AND:
  2729. push_text("&");
  2730. break;
  2731. case AssignmentNode::OP_BIT_OR:
  2732. push_text("|");
  2733. break;
  2734. case AssignmentNode::OP_BIT_XOR:
  2735. push_text("^");
  2736. break;
  2737. case AssignmentNode::OP_NONE:
  2738. break;
  2739. }
  2740. push_text("= ");
  2741. print_expression(p_assignment->assigned_value);
  2742. push_line();
  2743. }
  2744. void GDScriptParser::TreePrinter::print_await(AwaitNode *p_await) {
  2745. push_text("Await ");
  2746. print_expression(p_await->to_await);
  2747. }
  2748. void GDScriptParser::TreePrinter::print_binary_op(BinaryOpNode *p_binary_op) {
  2749. // Surround in parenthesis for disambiguation.
  2750. push_text("(");
  2751. print_expression(p_binary_op->left_operand);
  2752. switch (p_binary_op->operation) {
  2753. case BinaryOpNode::OP_ADDITION:
  2754. push_text(" + ");
  2755. break;
  2756. case BinaryOpNode::OP_SUBTRACTION:
  2757. push_text(" - ");
  2758. break;
  2759. case BinaryOpNode::OP_MULTIPLICATION:
  2760. push_text(" * ");
  2761. break;
  2762. case BinaryOpNode::OP_DIVISION:
  2763. push_text(" / ");
  2764. break;
  2765. case BinaryOpNode::OP_MODULO:
  2766. push_text(" % ");
  2767. break;
  2768. case BinaryOpNode::OP_BIT_LEFT_SHIFT:
  2769. push_text(" << ");
  2770. break;
  2771. case BinaryOpNode::OP_BIT_RIGHT_SHIFT:
  2772. push_text(" >> ");
  2773. break;
  2774. case BinaryOpNode::OP_BIT_AND:
  2775. push_text(" & ");
  2776. break;
  2777. case BinaryOpNode::OP_BIT_OR:
  2778. push_text(" | ");
  2779. break;
  2780. case BinaryOpNode::OP_BIT_XOR:
  2781. push_text(" ^ ");
  2782. break;
  2783. case BinaryOpNode::OP_LOGIC_AND:
  2784. push_text(" AND ");
  2785. break;
  2786. case BinaryOpNode::OP_LOGIC_OR:
  2787. push_text(" OR ");
  2788. break;
  2789. case BinaryOpNode::OP_TYPE_TEST:
  2790. push_text(" IS ");
  2791. break;
  2792. case BinaryOpNode::OP_CONTENT_TEST:
  2793. push_text(" IN ");
  2794. break;
  2795. case BinaryOpNode::OP_COMP_EQUAL:
  2796. push_text(" == ");
  2797. break;
  2798. case BinaryOpNode::OP_COMP_NOT_EQUAL:
  2799. push_text(" != ");
  2800. break;
  2801. case BinaryOpNode::OP_COMP_LESS:
  2802. push_text(" < ");
  2803. break;
  2804. case BinaryOpNode::OP_COMP_LESS_EQUAL:
  2805. push_text(" <= ");
  2806. break;
  2807. case BinaryOpNode::OP_COMP_GREATER:
  2808. push_text(" > ");
  2809. break;
  2810. case BinaryOpNode::OP_COMP_GREATER_EQUAL:
  2811. push_text(" >= ");
  2812. break;
  2813. }
  2814. print_expression(p_binary_op->right_operand);
  2815. // Surround in parenthesis for disambiguation.
  2816. push_text(")");
  2817. }
  2818. void GDScriptParser::TreePrinter::print_call(CallNode *p_call) {
  2819. if (p_call->is_super) {
  2820. push_text("super");
  2821. if (p_call->callee != nullptr) {
  2822. push_text(".");
  2823. print_expression(p_call->callee);
  2824. }
  2825. } else {
  2826. print_expression(p_call->callee);
  2827. }
  2828. push_text("( ");
  2829. for (int i = 0; i < p_call->arguments.size(); i++) {
  2830. if (i > 0) {
  2831. push_text(" , ");
  2832. }
  2833. print_expression(p_call->arguments[i]);
  2834. }
  2835. push_text(" )");
  2836. }
  2837. void GDScriptParser::TreePrinter::print_cast(CastNode *p_cast) {
  2838. print_expression(p_cast->operand);
  2839. push_text(" AS ");
  2840. print_type(p_cast->cast_type);
  2841. }
  2842. void GDScriptParser::TreePrinter::print_class(ClassNode *p_class) {
  2843. push_text("Class ");
  2844. if (p_class->identifier == nullptr) {
  2845. push_text("<unnamed>");
  2846. } else {
  2847. print_identifier(p_class->identifier);
  2848. }
  2849. if (p_class->extends_used) {
  2850. bool first = true;
  2851. push_text(" Extends ");
  2852. if (!p_class->extends_path.empty()) {
  2853. push_text(vformat(R"("%s")", p_class->extends_path));
  2854. first = false;
  2855. }
  2856. for (int i = 0; i < p_class->extends.size(); i++) {
  2857. if (!first) {
  2858. push_text(".");
  2859. } else {
  2860. first = false;
  2861. }
  2862. push_text(p_class->extends[i]);
  2863. }
  2864. }
  2865. push_line(" :");
  2866. increase_indent();
  2867. for (int i = 0; i < p_class->members.size(); i++) {
  2868. const ClassNode::Member &m = p_class->members[i];
  2869. switch (m.type) {
  2870. case ClassNode::Member::CLASS:
  2871. print_class(m.m_class);
  2872. break;
  2873. case ClassNode::Member::VARIABLE:
  2874. print_variable(m.variable);
  2875. break;
  2876. case ClassNode::Member::CONSTANT:
  2877. print_constant(m.constant);
  2878. break;
  2879. case ClassNode::Member::SIGNAL:
  2880. print_signal(m.signal);
  2881. break;
  2882. case ClassNode::Member::FUNCTION:
  2883. print_function(m.function);
  2884. break;
  2885. case ClassNode::Member::ENUM:
  2886. print_enum(m.m_enum);
  2887. break;
  2888. case ClassNode::Member::ENUM_VALUE:
  2889. break; // Nothing. Will be printed by enum.
  2890. case ClassNode::Member::UNDEFINED:
  2891. push_line("<unknown member>");
  2892. break;
  2893. }
  2894. }
  2895. decrease_indent();
  2896. }
  2897. void GDScriptParser::TreePrinter::print_constant(ConstantNode *p_constant) {
  2898. push_text("Constant ");
  2899. print_identifier(p_constant->identifier);
  2900. increase_indent();
  2901. push_line();
  2902. push_text("= ");
  2903. if (p_constant->initializer == nullptr) {
  2904. push_text("<missing value>");
  2905. } else {
  2906. print_expression(p_constant->initializer);
  2907. }
  2908. decrease_indent();
  2909. push_line();
  2910. }
  2911. void GDScriptParser::TreePrinter::print_dictionary(DictionaryNode *p_dictionary) {
  2912. push_line("{");
  2913. increase_indent();
  2914. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  2915. print_expression(p_dictionary->elements[i].key);
  2916. if (p_dictionary->style == DictionaryNode::PYTHON_DICT) {
  2917. push_text(" : ");
  2918. } else {
  2919. push_text(" = ");
  2920. }
  2921. print_expression(p_dictionary->elements[i].value);
  2922. push_line(" ,");
  2923. }
  2924. decrease_indent();
  2925. push_text("}");
  2926. }
  2927. void GDScriptParser::TreePrinter::print_expression(ExpressionNode *p_expression) {
  2928. switch (p_expression->type) {
  2929. case Node::ARRAY:
  2930. print_array(static_cast<ArrayNode *>(p_expression));
  2931. break;
  2932. case Node::ASSIGNMENT:
  2933. print_assignment(static_cast<AssignmentNode *>(p_expression));
  2934. break;
  2935. case Node::AWAIT:
  2936. print_await(static_cast<AwaitNode *>(p_expression));
  2937. break;
  2938. case Node::BINARY_OPERATOR:
  2939. print_binary_op(static_cast<BinaryOpNode *>(p_expression));
  2940. break;
  2941. case Node::CALL:
  2942. print_call(static_cast<CallNode *>(p_expression));
  2943. break;
  2944. case Node::CAST:
  2945. print_cast(static_cast<CastNode *>(p_expression));
  2946. break;
  2947. case Node::DICTIONARY:
  2948. print_dictionary(static_cast<DictionaryNode *>(p_expression));
  2949. break;
  2950. case Node::GET_NODE:
  2951. print_get_node(static_cast<GetNodeNode *>(p_expression));
  2952. break;
  2953. case Node::IDENTIFIER:
  2954. print_identifier(static_cast<IdentifierNode *>(p_expression));
  2955. break;
  2956. case Node::LITERAL:
  2957. print_literal(static_cast<LiteralNode *>(p_expression));
  2958. break;
  2959. case Node::PRELOAD:
  2960. print_preload(static_cast<PreloadNode *>(p_expression));
  2961. break;
  2962. case Node::SELF:
  2963. print_self(static_cast<SelfNode *>(p_expression));
  2964. break;
  2965. case Node::SUBSCRIPT:
  2966. print_subscript(static_cast<SubscriptNode *>(p_expression));
  2967. break;
  2968. case Node::TERNARY_OPERATOR:
  2969. print_ternary_op(static_cast<TernaryOpNode *>(p_expression));
  2970. break;
  2971. case Node::UNARY_OPERATOR:
  2972. print_unary_op(static_cast<UnaryOpNode *>(p_expression));
  2973. break;
  2974. default:
  2975. push_text(vformat("<unknown expression %d>", p_expression->type));
  2976. break;
  2977. }
  2978. }
  2979. void GDScriptParser::TreePrinter::print_enum(EnumNode *p_enum) {
  2980. push_text("Enum ");
  2981. if (p_enum->identifier != nullptr) {
  2982. print_identifier(p_enum->identifier);
  2983. } else {
  2984. push_text("<unnamed>");
  2985. }
  2986. push_line(" {");
  2987. increase_indent();
  2988. for (int i = 0; i < p_enum->values.size(); i++) {
  2989. const EnumNode::Value &item = p_enum->values[i];
  2990. print_identifier(item.identifier);
  2991. push_text(" = ");
  2992. push_text(itos(item.value));
  2993. push_line(" ,");
  2994. }
  2995. decrease_indent();
  2996. push_line("}");
  2997. }
  2998. void GDScriptParser::TreePrinter::print_for(ForNode *p_for) {
  2999. push_text("For ");
  3000. print_identifier(p_for->variable);
  3001. push_text(" IN ");
  3002. print_expression(p_for->list);
  3003. push_line(" :");
  3004. increase_indent();
  3005. print_suite(p_for->loop);
  3006. decrease_indent();
  3007. }
  3008. void GDScriptParser::TreePrinter::print_function(FunctionNode *p_function) {
  3009. for (const List<AnnotationNode *>::Element *E = p_function->annotations.front(); E != nullptr; E = E->next()) {
  3010. print_annotation(E->get());
  3011. }
  3012. push_text("Function ");
  3013. print_identifier(p_function->identifier);
  3014. push_text("( ");
  3015. for (int i = 0; i < p_function->parameters.size(); i++) {
  3016. if (i > 0) {
  3017. push_text(" , ");
  3018. }
  3019. print_parameter(p_function->parameters[i]);
  3020. }
  3021. push_line(" ) :");
  3022. increase_indent();
  3023. print_suite(p_function->body);
  3024. decrease_indent();
  3025. }
  3026. void GDScriptParser::TreePrinter::print_get_node(GetNodeNode *p_get_node) {
  3027. push_text("$");
  3028. if (p_get_node->string != nullptr) {
  3029. print_literal(p_get_node->string);
  3030. } else {
  3031. for (int i = 0; i < p_get_node->chain.size(); i++) {
  3032. if (i > 0) {
  3033. push_text("/");
  3034. }
  3035. print_identifier(p_get_node->chain[i]);
  3036. }
  3037. }
  3038. }
  3039. void GDScriptParser::TreePrinter::print_identifier(IdentifierNode *p_identifier) {
  3040. push_text(p_identifier->name);
  3041. }
  3042. void GDScriptParser::TreePrinter::print_if(IfNode *p_if, bool p_is_elif) {
  3043. if (p_is_elif) {
  3044. push_text("Elif ");
  3045. } else {
  3046. push_text("If ");
  3047. }
  3048. print_expression(p_if->condition);
  3049. push_line(" :");
  3050. increase_indent();
  3051. print_suite(p_if->true_block);
  3052. decrease_indent();
  3053. // FIXME: Properly detect "elif" blocks.
  3054. if (p_if->false_block != nullptr) {
  3055. push_line("Else :");
  3056. increase_indent();
  3057. print_suite(p_if->false_block);
  3058. decrease_indent();
  3059. }
  3060. }
  3061. void GDScriptParser::TreePrinter::print_literal(LiteralNode *p_literal) {
  3062. // Prefix for string types.
  3063. switch (p_literal->value.get_type()) {
  3064. case Variant::NODE_PATH:
  3065. push_text("^\"");
  3066. break;
  3067. case Variant::STRING:
  3068. push_text("\"");
  3069. break;
  3070. case Variant::STRING_NAME:
  3071. push_text("&\"");
  3072. break;
  3073. default:
  3074. break;
  3075. }
  3076. push_text(p_literal->value);
  3077. // Suffix for string types.
  3078. switch (p_literal->value.get_type()) {
  3079. case Variant::NODE_PATH:
  3080. case Variant::STRING:
  3081. case Variant::STRING_NAME:
  3082. push_text("\"");
  3083. break;
  3084. default:
  3085. break;
  3086. }
  3087. }
  3088. void GDScriptParser::TreePrinter::print_match(MatchNode *p_match) {
  3089. push_text("Match ");
  3090. print_expression(p_match->test);
  3091. push_line(" :");
  3092. increase_indent();
  3093. for (int i = 0; i < p_match->branches.size(); i++) {
  3094. print_match_branch(p_match->branches[i]);
  3095. }
  3096. decrease_indent();
  3097. }
  3098. void GDScriptParser::TreePrinter::print_match_branch(MatchBranchNode *p_match_branch) {
  3099. for (int i = 0; i < p_match_branch->patterns.size(); i++) {
  3100. if (i > 0) {
  3101. push_text(" , ");
  3102. }
  3103. print_match_pattern(p_match_branch->patterns[i]);
  3104. }
  3105. push_line(" :");
  3106. increase_indent();
  3107. print_suite(p_match_branch->block);
  3108. decrease_indent();
  3109. }
  3110. void GDScriptParser::TreePrinter::print_match_pattern(PatternNode *p_match_pattern) {
  3111. switch (p_match_pattern->pattern_type) {
  3112. case PatternNode::PT_LITERAL:
  3113. print_literal(p_match_pattern->literal);
  3114. break;
  3115. case PatternNode::PT_WILDCARD:
  3116. push_text("_");
  3117. break;
  3118. case PatternNode::PT_REST:
  3119. push_text("..");
  3120. break;
  3121. case PatternNode::PT_BIND:
  3122. push_text("Var ");
  3123. print_identifier(p_match_pattern->bind);
  3124. break;
  3125. case PatternNode::PT_EXPRESSION:
  3126. print_expression(p_match_pattern->expression);
  3127. break;
  3128. case PatternNode::PT_ARRAY:
  3129. push_text("[ ");
  3130. for (int i = 0; i < p_match_pattern->array.size(); i++) {
  3131. if (i > 0) {
  3132. push_text(" , ");
  3133. }
  3134. print_match_pattern(p_match_pattern->array[i]);
  3135. }
  3136. push_text(" ]");
  3137. break;
  3138. case PatternNode::PT_DICTIONARY:
  3139. push_text("{ ");
  3140. for (int i = 0; i < p_match_pattern->dictionary.size(); i++) {
  3141. if (i > 0) {
  3142. push_text(" , ");
  3143. }
  3144. if (p_match_pattern->dictionary[i].key != nullptr) {
  3145. // Key can be null for rest pattern.
  3146. print_expression(p_match_pattern->dictionary[i].key);
  3147. push_text(" : ");
  3148. }
  3149. print_match_pattern(p_match_pattern->dictionary[i].value_pattern);
  3150. }
  3151. push_text(" }");
  3152. break;
  3153. }
  3154. }
  3155. void GDScriptParser::TreePrinter::print_parameter(ParameterNode *p_parameter) {
  3156. print_identifier(p_parameter->identifier);
  3157. if (p_parameter->datatype_specifier != nullptr) {
  3158. push_text(" : ");
  3159. print_type(p_parameter->datatype_specifier);
  3160. }
  3161. if (p_parameter->default_value != nullptr) {
  3162. push_text(" = ");
  3163. print_expression(p_parameter->default_value);
  3164. }
  3165. }
  3166. void GDScriptParser::TreePrinter::print_preload(PreloadNode *p_preload) {
  3167. push_text(R"(Preload ( ")");
  3168. push_text(p_preload->resolved_path);
  3169. push_text(R"(" )");
  3170. }
  3171. void GDScriptParser::TreePrinter::print_return(ReturnNode *p_return) {
  3172. push_text("Return");
  3173. if (p_return->return_value != nullptr) {
  3174. push_text(" ");
  3175. print_expression(p_return->return_value);
  3176. }
  3177. push_line();
  3178. }
  3179. void GDScriptParser::TreePrinter::print_self(SelfNode *p_self) {
  3180. push_text("Self(");
  3181. if (p_self->current_class->identifier != nullptr) {
  3182. print_identifier(p_self->current_class->identifier);
  3183. } else {
  3184. push_text("<main class>");
  3185. }
  3186. push_text(")");
  3187. }
  3188. void GDScriptParser::TreePrinter::print_signal(SignalNode *p_signal) {
  3189. push_text("Signal ");
  3190. print_identifier(p_signal->identifier);
  3191. push_text("( ");
  3192. for (int i = 0; i < p_signal->parameters.size(); i++) {
  3193. print_parameter(p_signal->parameters[i]);
  3194. }
  3195. push_line(" )");
  3196. }
  3197. void GDScriptParser::TreePrinter::print_subscript(SubscriptNode *p_subscript) {
  3198. print_expression(p_subscript->base);
  3199. if (p_subscript->is_attribute) {
  3200. push_text(".");
  3201. print_identifier(p_subscript->attribute);
  3202. } else {
  3203. push_text("[ ");
  3204. print_expression(p_subscript->index);
  3205. push_text(" ]");
  3206. }
  3207. }
  3208. void GDScriptParser::TreePrinter::print_statement(Node *p_statement) {
  3209. switch (p_statement->type) {
  3210. case Node::ASSERT:
  3211. print_assert(static_cast<AssertNode *>(p_statement));
  3212. break;
  3213. case Node::VARIABLE:
  3214. print_variable(static_cast<VariableNode *>(p_statement));
  3215. break;
  3216. case Node::CONSTANT:
  3217. print_constant(static_cast<ConstantNode *>(p_statement));
  3218. break;
  3219. case Node::IF:
  3220. print_if(static_cast<IfNode *>(p_statement));
  3221. break;
  3222. case Node::FOR:
  3223. print_for(static_cast<ForNode *>(p_statement));
  3224. break;
  3225. case Node::WHILE:
  3226. print_while(static_cast<WhileNode *>(p_statement));
  3227. break;
  3228. case Node::MATCH:
  3229. print_match(static_cast<MatchNode *>(p_statement));
  3230. break;
  3231. case Node::RETURN:
  3232. print_return(static_cast<ReturnNode *>(p_statement));
  3233. break;
  3234. case Node::BREAK:
  3235. push_line("Break");
  3236. break;
  3237. case Node::CONTINUE:
  3238. push_line("Continue");
  3239. break;
  3240. case Node::PASS:
  3241. push_line("Pass");
  3242. break;
  3243. case Node::BREAKPOINT:
  3244. push_line("Breakpoint");
  3245. break;
  3246. case Node::ASSIGNMENT:
  3247. print_assignment(static_cast<AssignmentNode *>(p_statement));
  3248. break;
  3249. default:
  3250. if (p_statement->is_expression()) {
  3251. print_expression(static_cast<ExpressionNode *>(p_statement));
  3252. push_line();
  3253. } else {
  3254. push_line(vformat("<unknown statement %d>", p_statement->type));
  3255. }
  3256. break;
  3257. }
  3258. }
  3259. void GDScriptParser::TreePrinter::print_suite(SuiteNode *p_suite) {
  3260. for (int i = 0; i < p_suite->statements.size(); i++) {
  3261. print_statement(p_suite->statements[i]);
  3262. }
  3263. }
  3264. void GDScriptParser::TreePrinter::print_ternary_op(TernaryOpNode *p_ternary_op) {
  3265. // Surround in parenthesis for disambiguation.
  3266. push_text("(");
  3267. print_expression(p_ternary_op->true_expr);
  3268. push_text(") IF (");
  3269. print_expression(p_ternary_op->condition);
  3270. push_text(") ELSE (");
  3271. print_expression(p_ternary_op->false_expr);
  3272. push_text(")");
  3273. }
  3274. void GDScriptParser::TreePrinter::print_type(TypeNode *p_type) {
  3275. if (p_type->type_chain.empty()) {
  3276. push_text("Void");
  3277. } else {
  3278. for (int i = 0; i < p_type->type_chain.size(); i++) {
  3279. if (i > 0) {
  3280. push_text(".");
  3281. }
  3282. print_identifier(p_type->type_chain[i]);
  3283. }
  3284. }
  3285. }
  3286. void GDScriptParser::TreePrinter::print_unary_op(UnaryOpNode *p_unary_op) {
  3287. // Surround in parenthesis for disambiguation.
  3288. push_text("(");
  3289. switch (p_unary_op->operation) {
  3290. case UnaryOpNode::OP_POSITIVE:
  3291. push_text("+");
  3292. break;
  3293. case UnaryOpNode::OP_NEGATIVE:
  3294. push_text("-");
  3295. break;
  3296. case UnaryOpNode::OP_LOGIC_NOT:
  3297. push_text("NOT");
  3298. break;
  3299. case UnaryOpNode::OP_COMPLEMENT:
  3300. push_text("~");
  3301. break;
  3302. }
  3303. print_expression(p_unary_op->operand);
  3304. // Surround in parenthesis for disambiguation.
  3305. push_text(")");
  3306. }
  3307. void GDScriptParser::TreePrinter::print_variable(VariableNode *p_variable) {
  3308. for (const List<AnnotationNode *>::Element *E = p_variable->annotations.front(); E != nullptr; E = E->next()) {
  3309. print_annotation(E->get());
  3310. }
  3311. push_text("Variable ");
  3312. print_identifier(p_variable->identifier);
  3313. push_text(" : ");
  3314. if (p_variable->datatype_specifier != nullptr) {
  3315. print_type(p_variable->datatype_specifier);
  3316. } else if (p_variable->infer_datatype) {
  3317. push_text("<inferred type>");
  3318. } else {
  3319. push_text("Variant");
  3320. }
  3321. increase_indent();
  3322. push_line();
  3323. push_text("= ");
  3324. if (p_variable->initializer == nullptr) {
  3325. push_text("<default value>");
  3326. } else {
  3327. print_expression(p_variable->initializer);
  3328. }
  3329. push_line();
  3330. if (p_variable->property != VariableNode::PROP_NONE) {
  3331. if (p_variable->getter != nullptr) {
  3332. push_text("Get");
  3333. if (p_variable->property == VariableNode::PROP_INLINE) {
  3334. push_line(":");
  3335. increase_indent();
  3336. print_suite(p_variable->getter);
  3337. decrease_indent();
  3338. } else {
  3339. push_line(" =");
  3340. increase_indent();
  3341. print_identifier(p_variable->getter_pointer);
  3342. push_line();
  3343. decrease_indent();
  3344. }
  3345. }
  3346. if (p_variable->setter != nullptr) {
  3347. push_text("Set (");
  3348. if (p_variable->property == VariableNode::PROP_INLINE) {
  3349. if (p_variable->setter_parameter != nullptr) {
  3350. print_identifier(p_variable->setter_parameter);
  3351. } else {
  3352. push_text("<missing>");
  3353. }
  3354. push_line("):");
  3355. increase_indent();
  3356. print_suite(p_variable->setter);
  3357. decrease_indent();
  3358. } else {
  3359. push_line(" =");
  3360. increase_indent();
  3361. print_identifier(p_variable->setter_pointer);
  3362. push_line();
  3363. decrease_indent();
  3364. }
  3365. }
  3366. }
  3367. decrease_indent();
  3368. push_line();
  3369. }
  3370. void GDScriptParser::TreePrinter::print_while(WhileNode *p_while) {
  3371. push_text("While ");
  3372. print_expression(p_while->condition);
  3373. push_line(" :");
  3374. increase_indent();
  3375. print_suite(p_while->loop);
  3376. decrease_indent();
  3377. }
  3378. void GDScriptParser::TreePrinter::print_tree(const GDScriptParser &p_parser) {
  3379. ERR_FAIL_COND_MSG(p_parser.get_tree() == nullptr, "Parse the code before printing the parse tree.");
  3380. if (p_parser.is_tool()) {
  3381. push_line("@tool");
  3382. }
  3383. if (!p_parser.get_tree()->icon_path.empty()) {
  3384. push_text(R"(@icon (")");
  3385. push_text(p_parser.get_tree()->icon_path);
  3386. push_line("\")");
  3387. }
  3388. print_class(p_parser.get_tree());
  3389. print_line(printed);
  3390. }
  3391. #endif // DEBUG_ENABLED