gdscript_parser.cpp 138 KB

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