gdscript_parser.cpp 130 KB

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