gdscript_parser.cpp 170 KB

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