gdscript_parser.cpp 151 KB

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