gdscript_parser.cpp 156 KB

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