gdscript_parser.cpp 167 KB

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