gdscript_parser.cpp 155 KB

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