gdscript_editor.cpp 164 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547
  1. /**************************************************************************/
  2. /* gdscript_editor.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "gdscript.h"
  31. #include "gdscript_analyzer.h"
  32. #include "gdscript_parser.h"
  33. #include "gdscript_tokenizer.h"
  34. #include "gdscript_utility_functions.h"
  35. #ifdef TOOLS_ENABLED
  36. #include "editor/gdscript_docgen.h"
  37. #include "editor/script_templates/templates.gen.h"
  38. #endif
  39. #include "core/config/engine.h"
  40. #include "core/core_constants.h"
  41. #include "core/io/file_access.h"
  42. #include "core/math/expression.h"
  43. #ifdef TOOLS_ENABLED
  44. #include "core/config/project_settings.h"
  45. #include "editor/editor_node.h"
  46. #include "editor/editor_string_names.h"
  47. #include "editor/file_system/editor_file_system.h"
  48. #include "editor/settings/editor_settings.h"
  49. #endif
  50. Vector<String> GDScriptLanguage::get_comment_delimiters() const {
  51. static const Vector<String> delimiters = { "#" };
  52. return delimiters;
  53. }
  54. Vector<String> GDScriptLanguage::get_doc_comment_delimiters() const {
  55. static const Vector<String> delimiters = { "##" };
  56. return delimiters;
  57. }
  58. Vector<String> GDScriptLanguage::get_string_delimiters() const {
  59. static const Vector<String> delimiters = {
  60. "\" \"",
  61. "' '",
  62. "\"\"\" \"\"\"",
  63. "''' '''",
  64. };
  65. // NOTE: StringName, NodePath and r-strings are not listed here.
  66. return delimiters;
  67. }
  68. bool GDScriptLanguage::is_using_templates() {
  69. return true;
  70. }
  71. Ref<Script> GDScriptLanguage::make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const {
  72. Ref<GDScript> scr;
  73. scr.instantiate();
  74. String processed_template = p_template;
  75. #ifdef TOOLS_ENABLED
  76. const bool type_hints = EditorSettings::get_singleton()->get_setting("text_editor/completion/add_type_hints");
  77. #else
  78. const bool type_hints = true;
  79. #endif
  80. if (!type_hints) {
  81. processed_template = processed_template.replace(": int", "")
  82. .replace(": Shader.Mode", "")
  83. .replace(": VisualShader.Type", "")
  84. .replace(": float", "")
  85. .replace(": String", "")
  86. .replace(": Array[String]", "")
  87. .replace(": Node", "")
  88. .replace(": CharFXTransform", "")
  89. .replace(":=", "=")
  90. .replace(" -> void", "")
  91. .replace(" -> bool", "")
  92. .replace(" -> int", "")
  93. .replace(" -> PortType", "")
  94. .replace(" -> String", "")
  95. .replace(" -> Object", "");
  96. }
  97. processed_template = processed_template.replace("_BASE_", p_base_class_name)
  98. .replace("_CLASS_SNAKE_CASE_", p_class_name.to_snake_case().validate_unicode_identifier())
  99. .replace("_CLASS_", p_class_name.to_pascal_case().validate_unicode_identifier())
  100. .replace("_TS_", _get_indentation());
  101. scr->set_source_code(processed_template);
  102. return scr;
  103. }
  104. Vector<ScriptLanguage::ScriptTemplate> GDScriptLanguage::get_built_in_templates(const StringName &p_object) {
  105. Vector<ScriptLanguage::ScriptTemplate> templates;
  106. #ifdef TOOLS_ENABLED
  107. for (int i = 0; i < TEMPLATES_ARRAY_SIZE; i++) {
  108. if (TEMPLATES[i].inherit == p_object) {
  109. templates.append(TEMPLATES[i]);
  110. }
  111. }
  112. #endif
  113. return templates;
  114. }
  115. static void get_function_names_recursively(const GDScriptParser::ClassNode *p_class, const String &p_prefix, HashMap<int, String> &r_funcs) {
  116. for (int i = 0; i < p_class->members.size(); i++) {
  117. if (p_class->members[i].type == GDScriptParser::ClassNode::Member::FUNCTION) {
  118. const GDScriptParser::FunctionNode *function = p_class->members[i].function;
  119. r_funcs[function->start_line] = p_prefix.is_empty() ? String(function->identifier->name) : p_prefix + "." + String(function->identifier->name);
  120. } else if (p_class->members[i].type == GDScriptParser::ClassNode::Member::CLASS) {
  121. String new_prefix = p_class->members[i].m_class->identifier->name;
  122. get_function_names_recursively(p_class->members[i].m_class, p_prefix.is_empty() ? new_prefix : p_prefix + "." + new_prefix, r_funcs);
  123. }
  124. }
  125. }
  126. bool GDScriptLanguage::validate(const String &p_script, const String &p_path, List<String> *r_functions, List<ScriptLanguage::ScriptError> *r_errors, List<ScriptLanguage::Warning> *r_warnings, HashSet<int> *r_safe_lines) const {
  127. GDScriptParser parser;
  128. GDScriptAnalyzer analyzer(&parser);
  129. Error err = parser.parse(p_script, p_path, false);
  130. if (err == OK) {
  131. err = analyzer.analyze();
  132. }
  133. #ifdef DEBUG_ENABLED
  134. if (r_warnings) {
  135. for (const GDScriptWarning &E : parser.get_warnings()) {
  136. const GDScriptWarning &warn = E;
  137. ScriptLanguage::Warning w;
  138. w.start_line = warn.start_line;
  139. w.end_line = warn.end_line;
  140. w.code = (int)warn.code;
  141. w.string_code = GDScriptWarning::get_name_from_code(warn.code);
  142. w.message = warn.get_message();
  143. r_warnings->push_back(w);
  144. }
  145. }
  146. #endif
  147. if (err) {
  148. if (r_errors) {
  149. for (const GDScriptParser::ParserError &pe : parser.get_errors()) {
  150. ScriptLanguage::ScriptError e;
  151. e.path = p_path;
  152. e.line = pe.line;
  153. e.column = pe.column;
  154. e.message = pe.message;
  155. r_errors->push_back(e);
  156. }
  157. for (KeyValue<String, Ref<GDScriptParserRef>> E : parser.get_depended_parsers()) {
  158. GDScriptParser *depended_parser = E.value->get_parser();
  159. for (const GDScriptParser::ParserError &pe : depended_parser->get_errors()) {
  160. ScriptLanguage::ScriptError e;
  161. e.path = E.key;
  162. e.line = pe.line;
  163. e.column = pe.column;
  164. e.message = pe.message;
  165. r_errors->push_back(e);
  166. }
  167. }
  168. }
  169. return false;
  170. } else if (r_functions) {
  171. const GDScriptParser::ClassNode *cl = parser.get_tree();
  172. HashMap<int, String> funcs;
  173. get_function_names_recursively(cl, "", funcs);
  174. for (const KeyValue<int, String> &E : funcs) {
  175. r_functions->push_back(E.value + ":" + itos(E.key));
  176. }
  177. }
  178. #ifdef DEBUG_ENABLED
  179. if (r_safe_lines) {
  180. const HashSet<int> &unsafe_lines = parser.get_unsafe_lines();
  181. for (int i = 1; i <= parser.get_last_line_number(); i++) {
  182. if (!unsafe_lines.has(i)) {
  183. r_safe_lines->insert(i);
  184. }
  185. }
  186. }
  187. #endif
  188. return true;
  189. }
  190. bool GDScriptLanguage::supports_builtin_mode() const {
  191. return true;
  192. }
  193. bool GDScriptLanguage::supports_documentation() const {
  194. return true;
  195. }
  196. int GDScriptLanguage::find_function(const String &p_function, const String &p_code) const {
  197. GDScriptTokenizerText tokenizer;
  198. tokenizer.set_source_code(p_code);
  199. int indent = 0;
  200. GDScriptTokenizer::Token current = tokenizer.scan();
  201. while (current.type != GDScriptTokenizer::Token::TK_EOF && current.type != GDScriptTokenizer::Token::ERROR) {
  202. if (current.type == GDScriptTokenizer::Token::INDENT) {
  203. indent++;
  204. } else if (current.type == GDScriptTokenizer::Token::DEDENT) {
  205. indent--;
  206. }
  207. if (indent == 0 && current.type == GDScriptTokenizer::Token::FUNC) {
  208. current = tokenizer.scan();
  209. if (current.is_identifier()) {
  210. String identifier = current.get_identifier();
  211. if (identifier == p_function) {
  212. return current.start_line;
  213. }
  214. }
  215. }
  216. current = tokenizer.scan();
  217. }
  218. return -1;
  219. }
  220. Script *GDScriptLanguage::create_script() const {
  221. return memnew(GDScript);
  222. }
  223. /* DEBUGGER FUNCTIONS */
  224. thread_local int GDScriptLanguage::_debug_parse_err_line = -1;
  225. thread_local String GDScriptLanguage::_debug_parse_err_file;
  226. thread_local String GDScriptLanguage::_debug_error;
  227. bool GDScriptLanguage::debug_break_parse(const String &p_file, int p_line, const String &p_error) {
  228. // break because of parse error
  229. if (EngineDebugger::is_active() && Thread::get_caller_id() == Thread::get_main_id()) {
  230. _debug_parse_err_line = p_line;
  231. _debug_parse_err_file = p_file;
  232. _debug_error = p_error;
  233. EngineDebugger::get_script_debugger()->debug(this, false, true);
  234. // Because this is thread local, clear the memory afterwards.
  235. _debug_parse_err_file = String();
  236. _debug_error = String();
  237. return true;
  238. } else {
  239. return false;
  240. }
  241. }
  242. bool GDScriptLanguage::debug_break(const String &p_error, bool p_allow_continue) {
  243. if (EngineDebugger::is_active()) {
  244. _debug_parse_err_line = -1;
  245. _debug_parse_err_file = "";
  246. _debug_error = p_error;
  247. bool is_error_breakpoint = p_error != "Breakpoint";
  248. EngineDebugger::get_script_debugger()->debug(this, p_allow_continue, is_error_breakpoint);
  249. // Because this is thread local, clear the memory afterwards.
  250. _debug_parse_err_file = String();
  251. _debug_error = String();
  252. return true;
  253. } else {
  254. return false;
  255. }
  256. }
  257. String GDScriptLanguage::debug_get_error() const {
  258. return _debug_error;
  259. }
  260. int GDScriptLanguage::debug_get_stack_level_count() const {
  261. if (_debug_parse_err_line >= 0) {
  262. return 1;
  263. }
  264. return _call_stack_size;
  265. }
  266. int GDScriptLanguage::debug_get_stack_level_line(int p_level) const {
  267. if (_debug_parse_err_line >= 0) {
  268. return _debug_parse_err_line;
  269. }
  270. ERR_FAIL_INDEX_V(p_level, (int)_call_stack_size, -1);
  271. return *(_get_stack_level(p_level)->line);
  272. }
  273. String GDScriptLanguage::debug_get_stack_level_function(int p_level) const {
  274. if (_debug_parse_err_line >= 0) {
  275. return "";
  276. }
  277. ERR_FAIL_INDEX_V(p_level, (int)_call_stack_size, "");
  278. GDScriptFunction *func = _get_stack_level(p_level)->function;
  279. return func ? func->get_name().operator String() : "";
  280. }
  281. String GDScriptLanguage::debug_get_stack_level_source(int p_level) const {
  282. if (_debug_parse_err_line >= 0) {
  283. return _debug_parse_err_file;
  284. }
  285. ERR_FAIL_INDEX_V(p_level, (int)_call_stack_size, "");
  286. return _get_stack_level(p_level)->function->get_source();
  287. }
  288. void GDScriptLanguage::debug_get_stack_level_locals(int p_level, List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  289. if (_debug_parse_err_line >= 0) {
  290. return;
  291. }
  292. ERR_FAIL_INDEX(p_level, (int)_call_stack_size);
  293. CallLevel *cl = _get_stack_level(p_level);
  294. GDScriptFunction *f = cl->function;
  295. List<Pair<StringName, int>> locals;
  296. f->debug_get_stack_member_state(*cl->line, &locals);
  297. for (const Pair<StringName, int> &E : locals) {
  298. p_locals->push_back(E.first);
  299. p_values->push_back(cl->stack[E.second]);
  300. }
  301. }
  302. void GDScriptLanguage::debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  303. if (_debug_parse_err_line >= 0) {
  304. return;
  305. }
  306. ERR_FAIL_INDEX(p_level, (int)_call_stack_size);
  307. CallLevel *cl = _get_stack_level(p_level);
  308. GDScriptInstance *instance = cl->instance;
  309. if (!instance) {
  310. return;
  311. }
  312. Ref<GDScript> scr = instance->get_script();
  313. ERR_FAIL_COND(scr.is_null());
  314. const HashMap<StringName, GDScript::MemberInfo> &mi = scr->debug_get_member_indices();
  315. for (const KeyValue<StringName, GDScript::MemberInfo> &E : mi) {
  316. p_members->push_back(E.key);
  317. p_values->push_back(instance->debug_get_member_by_index(E.value.index));
  318. }
  319. }
  320. ScriptInstance *GDScriptLanguage::debug_get_stack_level_instance(int p_level) {
  321. if (_debug_parse_err_line >= 0) {
  322. return nullptr;
  323. }
  324. ERR_FAIL_INDEX_V(p_level, (int)_call_stack_size, nullptr);
  325. return _get_stack_level(p_level)->instance;
  326. }
  327. void GDScriptLanguage::debug_get_globals(List<String> *p_globals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  328. const HashMap<StringName, int> &name_idx = GDScriptLanguage::get_singleton()->get_global_map();
  329. const Variant *gl_array = GDScriptLanguage::get_singleton()->get_global_array();
  330. List<Pair<String, Variant>> cinfo;
  331. get_public_constants(&cinfo);
  332. for (const KeyValue<StringName, int> &E : name_idx) {
  333. if (ClassDB::class_exists(E.key) || Engine::get_singleton()->has_singleton(E.key)) {
  334. continue;
  335. }
  336. bool is_script_constant = false;
  337. for (List<Pair<String, Variant>>::Element *CE = cinfo.front(); CE; CE = CE->next()) {
  338. if (CE->get().first == E.key) {
  339. is_script_constant = true;
  340. break;
  341. }
  342. }
  343. if (is_script_constant) {
  344. continue;
  345. }
  346. const Variant &var = gl_array[E.value];
  347. bool freed = false;
  348. const Object *obj = var.get_validated_object_with_check(freed);
  349. if (obj && !freed) {
  350. if (Object::cast_to<GDScriptNativeClass>(obj)) {
  351. continue;
  352. }
  353. }
  354. bool skip = false;
  355. for (int i = 0; i < CoreConstants::get_global_constant_count(); i++) {
  356. if (E.key == CoreConstants::get_global_constant_name(i)) {
  357. skip = true;
  358. break;
  359. }
  360. }
  361. if (skip) {
  362. continue;
  363. }
  364. p_globals->push_back(E.key);
  365. p_values->push_back(var);
  366. }
  367. }
  368. String GDScriptLanguage::debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems, int p_max_depth) {
  369. List<String> names;
  370. List<Variant> values;
  371. debug_get_stack_level_locals(p_level, &names, &values, p_max_subitems, p_max_depth);
  372. Vector<String> name_vector;
  373. for (const String &name : names) {
  374. name_vector.push_back(name);
  375. }
  376. Array value_array;
  377. for (const Variant &value : values) {
  378. value_array.push_back(value);
  379. }
  380. Expression expression;
  381. if (expression.parse(p_expression, name_vector) == OK) {
  382. ScriptInstance *instance = debug_get_stack_level_instance(p_level);
  383. if (instance) {
  384. Variant return_val = expression.execute(value_array, instance->get_owner());
  385. return return_val.get_construct_string();
  386. }
  387. }
  388. return String();
  389. }
  390. void GDScriptLanguage::get_recognized_extensions(List<String> *p_extensions) const {
  391. p_extensions->push_back("gd");
  392. }
  393. void GDScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const {
  394. List<StringName> functions;
  395. GDScriptUtilityFunctions::get_function_list(&functions);
  396. for (const StringName &E : functions) {
  397. p_functions->push_back(GDScriptUtilityFunctions::get_function_info(E));
  398. }
  399. // Not really "functions", but show in documentation.
  400. {
  401. MethodInfo mi;
  402. mi.name = "preload";
  403. mi.arguments.push_back(PropertyInfo(Variant::STRING, "path"));
  404. mi.return_val = PropertyInfo(Variant::OBJECT, "", PROPERTY_HINT_RESOURCE_TYPE, "Resource");
  405. p_functions->push_back(mi);
  406. }
  407. {
  408. MethodInfo mi;
  409. mi.name = "assert";
  410. mi.return_val.type = Variant::NIL;
  411. mi.arguments.push_back(PropertyInfo(Variant::BOOL, "condition"));
  412. mi.arguments.push_back(PropertyInfo(Variant::STRING, "message"));
  413. mi.default_arguments.push_back(String());
  414. p_functions->push_back(mi);
  415. }
  416. }
  417. void GDScriptLanguage::get_public_constants(List<Pair<String, Variant>> *p_constants) const {
  418. Pair<String, Variant> pi;
  419. pi.first = "PI";
  420. pi.second = Math::PI;
  421. p_constants->push_back(pi);
  422. Pair<String, Variant> tau;
  423. tau.first = "TAU";
  424. tau.second = Math::TAU;
  425. p_constants->push_back(tau);
  426. Pair<String, Variant> infinity;
  427. infinity.first = "INF";
  428. infinity.second = Math::INF;
  429. p_constants->push_back(infinity);
  430. Pair<String, Variant> nan;
  431. nan.first = "NAN";
  432. nan.second = Math::NaN;
  433. p_constants->push_back(nan);
  434. }
  435. void GDScriptLanguage::get_public_annotations(List<MethodInfo> *p_annotations) const {
  436. GDScriptParser parser;
  437. List<MethodInfo> annotations;
  438. parser.get_annotation_list(&annotations);
  439. for (const MethodInfo &E : annotations) {
  440. p_annotations->push_back(E);
  441. }
  442. }
  443. String GDScriptLanguage::make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const {
  444. #ifdef TOOLS_ENABLED
  445. const bool type_hints = EditorSettings::get_singleton()->get_setting("text_editor/completion/add_type_hints");
  446. #else
  447. const bool type_hints = true;
  448. #endif
  449. String result = "func " + p_name + "(";
  450. if (p_args.size()) {
  451. for (int i = 0; i < p_args.size(); i++) {
  452. if (i > 0) {
  453. result += ", ";
  454. }
  455. const String name_unstripped = p_args[i].get_slicec(':', 0);
  456. result += name_unstripped.strip_edges();
  457. if (type_hints) {
  458. const String type_stripped = p_args[i].substr(name_unstripped.length() + 1).strip_edges();
  459. if (!type_stripped.is_empty()) {
  460. result += ": " + type_stripped;
  461. }
  462. }
  463. }
  464. }
  465. result += String(")") + (type_hints ? " -> void" : "") + ":\n" +
  466. _get_indentation() + "pass # Replace with function body.\n";
  467. return result;
  468. }
  469. //////// COMPLETION //////////
  470. #ifdef TOOLS_ENABLED
  471. #define COMPLETION_RECURSION_LIMIT 200
  472. struct GDScriptCompletionIdentifier {
  473. GDScriptParser::DataType type;
  474. String enumeration;
  475. Variant value;
  476. const GDScriptParser::ExpressionNode *assigned_expression = nullptr;
  477. };
  478. // LOCATION METHODS
  479. // These methods are used to populate the `CodeCompletionOption::location` integer.
  480. // For these methods, the location is based on the depth in the inheritance chain that the property
  481. // appears. For example, if you are completing code in a class that inherits Node2D, a property found on Node2D
  482. // will have a "better" (lower) location "score" than a property that is found on CanvasItem.
  483. static int _get_property_location(const StringName &p_class, const StringName &p_property) {
  484. if (!ClassDB::has_property(p_class, p_property)) {
  485. return ScriptLanguage::LOCATION_OTHER;
  486. }
  487. int depth = 0;
  488. StringName class_test = p_class;
  489. while (class_test && !ClassDB::has_property(class_test, p_property, true)) {
  490. class_test = ClassDB::get_parent_class(class_test);
  491. depth++;
  492. }
  493. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  494. }
  495. static int _get_property_location(Ref<Script> p_script, const StringName &p_property) {
  496. int depth = 0;
  497. Ref<Script> scr = p_script;
  498. while (scr.is_valid()) {
  499. if (scr->get_member_line(p_property) != -1) {
  500. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  501. }
  502. depth++;
  503. scr = scr->get_base_script();
  504. }
  505. return depth + _get_property_location(p_script->get_instance_base_type(), p_property);
  506. }
  507. static int _get_constant_location(const StringName &p_class, const StringName &p_constant) {
  508. if (!ClassDB::has_integer_constant(p_class, p_constant)) {
  509. return ScriptLanguage::LOCATION_OTHER;
  510. }
  511. int depth = 0;
  512. StringName class_test = p_class;
  513. while (class_test && !ClassDB::has_integer_constant(class_test, p_constant, true)) {
  514. class_test = ClassDB::get_parent_class(class_test);
  515. depth++;
  516. }
  517. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  518. }
  519. static int _get_constant_location(Ref<Script> p_script, const StringName &p_constant) {
  520. int depth = 0;
  521. Ref<Script> scr = p_script;
  522. while (scr.is_valid()) {
  523. if (scr->get_member_line(p_constant) != -1) {
  524. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  525. }
  526. depth++;
  527. scr = scr->get_base_script();
  528. }
  529. return depth + _get_constant_location(p_script->get_instance_base_type(), p_constant);
  530. }
  531. static int _get_signal_location(const StringName &p_class, const StringName &p_signal) {
  532. if (!ClassDB::has_signal(p_class, p_signal)) {
  533. return ScriptLanguage::LOCATION_OTHER;
  534. }
  535. int depth = 0;
  536. StringName class_test = p_class;
  537. while (class_test && !ClassDB::has_signal(class_test, p_signal, true)) {
  538. class_test = ClassDB::get_parent_class(class_test);
  539. depth++;
  540. }
  541. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  542. }
  543. static int _get_signal_location(Ref<Script> p_script, const StringName &p_signal) {
  544. int depth = 0;
  545. Ref<Script> scr = p_script;
  546. while (scr.is_valid()) {
  547. if (scr->get_member_line(p_signal) != -1) {
  548. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  549. }
  550. depth++;
  551. scr = scr->get_base_script();
  552. }
  553. return depth + _get_signal_location(p_script->get_instance_base_type(), p_signal);
  554. }
  555. static int _get_method_location(const StringName &p_class, const StringName &p_method) {
  556. if (!ClassDB::has_method(p_class, p_method)) {
  557. return ScriptLanguage::LOCATION_OTHER;
  558. }
  559. int depth = 0;
  560. StringName class_test = p_class;
  561. while (class_test && !ClassDB::has_method(class_test, p_method, true)) {
  562. class_test = ClassDB::get_parent_class(class_test);
  563. depth++;
  564. }
  565. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  566. }
  567. static int _get_enum_constant_location(const StringName &p_class, const StringName &p_enum_constant) {
  568. if (!ClassDB::get_integer_constant_enum(p_class, p_enum_constant)) {
  569. return ScriptLanguage::LOCATION_OTHER;
  570. }
  571. int depth = 0;
  572. StringName class_test = p_class;
  573. while (class_test && !ClassDB::get_integer_constant_enum(class_test, p_enum_constant, true)) {
  574. class_test = ClassDB::get_parent_class(class_test);
  575. depth++;
  576. }
  577. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  578. }
  579. static int _get_enum_location(const StringName &p_class, const StringName &p_enum) {
  580. if (!ClassDB::has_enum(p_class, p_enum)) {
  581. return ScriptLanguage::LOCATION_OTHER;
  582. }
  583. int depth = 0;
  584. StringName class_test = p_class;
  585. while (class_test && !ClassDB::has_enum(class_test, p_enum, true)) {
  586. class_test = ClassDB::get_parent_class(class_test);
  587. depth++;
  588. }
  589. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  590. }
  591. // END LOCATION METHODS
  592. static String _trim_parent_class(const String &p_class, const String &p_base_class) {
  593. if (p_base_class.is_empty()) {
  594. return p_class;
  595. }
  596. Vector<String> names = p_class.split(".", false, 1);
  597. if (names.size() == 2) {
  598. const String &first = names[0];
  599. if (ClassDB::class_exists(p_base_class) && ClassDB::class_exists(first) && ClassDB::is_parent_class(p_base_class, first)) {
  600. const String &rest = names[1];
  601. return rest;
  602. }
  603. }
  604. return p_class;
  605. }
  606. static String _get_visual_datatype(const PropertyInfo &p_info, bool p_is_arg, const String &p_base_class = "") {
  607. String class_name = p_info.class_name;
  608. bool is_enum = p_info.type == Variant::INT && p_info.usage & PROPERTY_USAGE_CLASS_IS_ENUM;
  609. // PROPERTY_USAGE_CLASS_IS_BITFIELD: BitField[T] isn't supported (yet?), use plain int.
  610. if ((p_info.type == Variant::OBJECT || is_enum) && !class_name.is_empty()) {
  611. if (is_enum && CoreConstants::is_global_enum(p_info.class_name)) {
  612. return class_name;
  613. }
  614. return _trim_parent_class(class_name, p_base_class);
  615. } else if (p_info.type == Variant::ARRAY && p_info.hint == PROPERTY_HINT_ARRAY_TYPE && !p_info.hint_string.is_empty()) {
  616. return "Array[" + _trim_parent_class(p_info.hint_string, p_base_class) + "]";
  617. } else if (p_info.type == Variant::DICTIONARY && p_info.hint == PROPERTY_HINT_DICTIONARY_TYPE && !p_info.hint_string.is_empty()) {
  618. const String key = p_info.hint_string.get_slicec(';', 0);
  619. const String value = p_info.hint_string.get_slicec(';', 1);
  620. return "Dictionary[" + _trim_parent_class(key, p_base_class) + ", " + _trim_parent_class(value, p_base_class) + "]";
  621. } else if (p_info.type == Variant::NIL) {
  622. if (p_is_arg || (p_info.usage & PROPERTY_USAGE_NIL_IS_VARIANT)) {
  623. return "Variant";
  624. } else {
  625. return "void";
  626. }
  627. }
  628. return Variant::get_type_name(p_info.type);
  629. }
  630. static String _make_arguments_hint(const MethodInfo &p_info, int p_arg_idx, bool p_is_annotation = false) {
  631. String arghint;
  632. if (!p_is_annotation) {
  633. arghint += _get_visual_datatype(p_info.return_val, false) + " ";
  634. }
  635. arghint += p_info.name + "(";
  636. int def_args = p_info.arguments.size() - p_info.default_arguments.size();
  637. int i = 0;
  638. for (const PropertyInfo &E : p_info.arguments) {
  639. if (i > 0) {
  640. arghint += ", ";
  641. }
  642. if (i == p_arg_idx) {
  643. arghint += String::chr(0xFFFF);
  644. }
  645. arghint += E.name + ": " + _get_visual_datatype(E, true);
  646. if (i - def_args >= 0) {
  647. arghint += String(" = ") + p_info.default_arguments[i - def_args].get_construct_string();
  648. }
  649. if (i == p_arg_idx) {
  650. arghint += String::chr(0xFFFF);
  651. }
  652. i++;
  653. }
  654. if (p_info.flags & METHOD_FLAG_VARARG) {
  655. if (p_info.arguments.size() > 0) {
  656. arghint += ", ";
  657. }
  658. if (p_arg_idx >= p_info.arguments.size()) {
  659. arghint += String::chr(0xFFFF);
  660. }
  661. arghint += "...args: Array"; // `MethodInfo` does not support the rest parameter name.
  662. if (p_arg_idx >= p_info.arguments.size()) {
  663. arghint += String::chr(0xFFFF);
  664. }
  665. }
  666. arghint += ")";
  667. return arghint;
  668. }
  669. static String _make_arguments_hint(const GDScriptParser::FunctionNode *p_function, int p_arg_idx, bool p_just_args = false) {
  670. String arghint;
  671. if (p_just_args) {
  672. arghint = "(";
  673. } else {
  674. if (p_function->get_datatype().builtin_type == Variant::NIL) {
  675. arghint = "void " + p_function->identifier->name + "(";
  676. } else {
  677. arghint = p_function->get_datatype().to_string() + " " + p_function->identifier->name + "(";
  678. }
  679. }
  680. for (int i = 0; i < p_function->parameters.size(); i++) {
  681. if (i > 0) {
  682. arghint += ", ";
  683. }
  684. if (i == p_arg_idx) {
  685. arghint += String::chr(0xFFFF);
  686. }
  687. const GDScriptParser::ParameterNode *par = p_function->parameters[i];
  688. if (!par->get_datatype().is_hard_type()) {
  689. arghint += par->identifier->name.operator String() + ": Variant";
  690. } else {
  691. arghint += par->identifier->name.operator String() + ": " + par->get_datatype().to_string();
  692. }
  693. if (par->initializer) {
  694. String def_val = "<unknown>";
  695. switch (par->initializer->type) {
  696. case GDScriptParser::Node::LITERAL: {
  697. const GDScriptParser::LiteralNode *literal = static_cast<const GDScriptParser::LiteralNode *>(par->initializer);
  698. def_val = literal->value.get_construct_string();
  699. } break;
  700. case GDScriptParser::Node::IDENTIFIER: {
  701. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(par->initializer);
  702. def_val = id->name.operator String();
  703. } break;
  704. case GDScriptParser::Node::CALL: {
  705. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(par->initializer);
  706. if (call->is_constant && call->reduced) {
  707. def_val = call->reduced_value.get_construct_string();
  708. } else if (call->get_callee_type() == GDScriptParser::Node::IDENTIFIER) {
  709. def_val = call->function_name.operator String() + (call->arguments.is_empty() ? "()" : "(...)");
  710. }
  711. } break;
  712. case GDScriptParser::Node::ARRAY: {
  713. const GDScriptParser::ArrayNode *arr = static_cast<const GDScriptParser::ArrayNode *>(par->initializer);
  714. if (arr->is_constant && arr->reduced) {
  715. def_val = arr->reduced_value.get_construct_string();
  716. } else {
  717. def_val = arr->elements.is_empty() ? "[]" : "[...]";
  718. }
  719. } break;
  720. case GDScriptParser::Node::DICTIONARY: {
  721. const GDScriptParser::DictionaryNode *dict = static_cast<const GDScriptParser::DictionaryNode *>(par->initializer);
  722. if (dict->is_constant && dict->reduced) {
  723. def_val = dict->reduced_value.get_construct_string();
  724. } else {
  725. def_val = dict->elements.is_empty() ? "{}" : "{...}";
  726. }
  727. } break;
  728. case GDScriptParser::Node::SUBSCRIPT: {
  729. const GDScriptParser::SubscriptNode *sub = static_cast<const GDScriptParser::SubscriptNode *>(par->initializer);
  730. if (sub->is_attribute && sub->datatype.kind == GDScriptParser::DataType::ENUM && !sub->datatype.is_meta_type) {
  731. def_val = sub->get_datatype().to_string() + "." + sub->attribute->name;
  732. } else if (sub->is_constant && sub->reduced) {
  733. def_val = sub->reduced_value.get_construct_string();
  734. }
  735. } break;
  736. default:
  737. break;
  738. }
  739. arghint += " = " + def_val;
  740. }
  741. if (i == p_arg_idx) {
  742. arghint += String::chr(0xFFFF);
  743. }
  744. }
  745. if (p_function->is_vararg()) {
  746. if (!p_function->parameters.is_empty()) {
  747. arghint += ", ";
  748. }
  749. if (p_arg_idx >= p_function->parameters.size()) {
  750. arghint += String::chr(0xFFFF);
  751. }
  752. const GDScriptParser::ParameterNode *rest_param = p_function->rest_parameter;
  753. arghint += "..." + rest_param->identifier->name + ": " + rest_param->get_datatype().to_string();
  754. if (p_arg_idx >= p_function->parameters.size()) {
  755. arghint += String::chr(0xFFFF);
  756. }
  757. }
  758. arghint += ")";
  759. return arghint;
  760. }
  761. static void _get_directory_contents(EditorFileSystemDirectory *p_dir, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_list, const StringName &p_required_type = StringName()) {
  762. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  763. const bool requires_type = !p_required_type.is_empty();
  764. for (int i = 0; i < p_dir->get_file_count(); i++) {
  765. if (requires_type && !ClassDB::is_parent_class(p_dir->get_file_type(i), p_required_type)) {
  766. continue;
  767. }
  768. ScriptLanguage::CodeCompletionOption option(p_dir->get_file_path(i).quote(quote_style), ScriptLanguage::CODE_COMPLETION_KIND_FILE_PATH);
  769. r_list.insert(option.display, option);
  770. }
  771. for (int i = 0; i < p_dir->get_subdir_count(); i++) {
  772. _get_directory_contents(p_dir->get_subdir(i), r_list, p_required_type);
  773. }
  774. }
  775. static void _find_annotation_arguments(const GDScriptParser::AnnotationNode *p_annotation, int p_argument, const String p_quote_style, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, String &r_arghint) {
  776. ERR_FAIL_NULL(p_annotation);
  777. if (p_annotation->info != nullptr) {
  778. r_arghint = _make_arguments_hint(p_annotation->info->info, p_argument, true);
  779. }
  780. if (p_annotation->name == SNAME("@export_range")) {
  781. if (p_argument == 3 || p_argument == 4 || p_argument == 5) {
  782. // Slider hint.
  783. ScriptLanguage::CodeCompletionOption slider1("or_greater", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  784. slider1.insert_text = slider1.display.quote(p_quote_style);
  785. r_result.insert(slider1.display, slider1);
  786. ScriptLanguage::CodeCompletionOption slider2("or_less", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  787. slider2.insert_text = slider2.display.quote(p_quote_style);
  788. r_result.insert(slider2.display, slider2);
  789. ScriptLanguage::CodeCompletionOption slider3("hide_slider", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  790. slider3.insert_text = slider3.display.quote(p_quote_style);
  791. r_result.insert(slider3.display, slider3);
  792. }
  793. } else if (p_annotation->name == SNAME("@export_exp_easing")) {
  794. if (p_argument == 0 || p_argument == 1) {
  795. // Easing hint.
  796. ScriptLanguage::CodeCompletionOption hint1("attenuation", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  797. hint1.insert_text = hint1.display.quote(p_quote_style);
  798. r_result.insert(hint1.display, hint1);
  799. ScriptLanguage::CodeCompletionOption hint2("inout", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  800. hint2.insert_text = hint2.display.quote(p_quote_style);
  801. r_result.insert(hint2.display, hint2);
  802. }
  803. } else if (p_annotation->name == SNAME("@export_node_path")) {
  804. ScriptLanguage::CodeCompletionOption node("Node", ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  805. node.insert_text = node.display.quote(p_quote_style);
  806. r_result.insert(node.display, node);
  807. LocalVector<StringName> native_classes;
  808. ClassDB::get_inheriters_from_class("Node", native_classes);
  809. for (const StringName &E : native_classes) {
  810. if (!ClassDB::is_class_exposed(E)) {
  811. continue;
  812. }
  813. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  814. option.insert_text = option.display.quote(p_quote_style);
  815. r_result.insert(option.display, option);
  816. }
  817. List<StringName> global_script_classes;
  818. ScriptServer::get_global_class_list(&global_script_classes);
  819. for (const StringName &E : global_script_classes) {
  820. if (!ClassDB::is_parent_class(ScriptServer::get_global_class_native_base(E), "Node")) {
  821. continue;
  822. }
  823. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  824. option.insert_text = option.display.quote(p_quote_style);
  825. r_result.insert(option.display, option);
  826. }
  827. } else if (p_annotation->name == SNAME("@export_tool_button")) {
  828. if (p_argument == 1) {
  829. const Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
  830. if (theme.is_valid()) {
  831. List<StringName> icon_list;
  832. theme->get_icon_list(EditorStringName(EditorIcons), &icon_list);
  833. for (const StringName &E : icon_list) {
  834. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  835. option.insert_text = option.display.quote(p_quote_style);
  836. r_result.insert(option.display, option);
  837. }
  838. }
  839. }
  840. } else if (p_annotation->name == SNAME("@export_custom")) {
  841. switch (p_argument) {
  842. case 0: {
  843. static HashMap<StringName, int64_t> items;
  844. if (unlikely(items.is_empty())) {
  845. CoreConstants::get_enum_values(SNAME("PropertyHint"), &items);
  846. }
  847. for (const KeyValue<StringName, int64_t> &item : items) {
  848. ScriptLanguage::CodeCompletionOption option(item.key, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  849. r_result.insert(option.display, option);
  850. }
  851. } break;
  852. case 2: {
  853. static HashMap<StringName, int64_t> items;
  854. if (unlikely(items.is_empty())) {
  855. CoreConstants::get_enum_values(SNAME("PropertyUsageFlags"), &items);
  856. }
  857. for (const KeyValue<StringName, int64_t> &item : items) {
  858. ScriptLanguage::CodeCompletionOption option(item.key, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  859. r_result.insert(option.display, option);
  860. }
  861. } break;
  862. }
  863. } else if (p_annotation->name == SNAME("@warning_ignore") || p_annotation->name == SNAME("@warning_ignore_start") || p_annotation->name == SNAME("@warning_ignore_restore")) {
  864. for (int warning_code = 0; warning_code < GDScriptWarning::WARNING_MAX; warning_code++) {
  865. #ifndef DISABLE_DEPRECATED
  866. if (warning_code >= GDScriptWarning::FIRST_DEPRECATED_WARNING) {
  867. break; // Don't suggest deprecated warnings as they are never produced.
  868. }
  869. #endif
  870. ScriptLanguage::CodeCompletionOption warning(GDScriptWarning::get_name_from_code((GDScriptWarning::Code)warning_code).to_lower(), ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  871. warning.insert_text = warning.display.quote(p_quote_style);
  872. r_result.insert(warning.display, warning);
  873. }
  874. } else if (p_annotation->name == SNAME("@rpc")) {
  875. if (p_argument == 0 || p_argument == 1 || p_argument == 2) {
  876. static const char *options[7] = { "call_local", "call_remote", "any_peer", "authority", "reliable", "unreliable", "unreliable_ordered" };
  877. for (int i = 0; i < 7; i++) {
  878. ScriptLanguage::CodeCompletionOption option(options[i], ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  879. option.insert_text = option.display.quote(p_quote_style);
  880. r_result.insert(option.display, option);
  881. }
  882. }
  883. }
  884. }
  885. static void _find_built_in_variants(HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, bool exclude_nil = false) {
  886. for (int i = 0; i < Variant::VARIANT_MAX; i++) {
  887. if (!exclude_nil && Variant::Type(i) == Variant::Type::NIL) {
  888. ScriptLanguage::CodeCompletionOption option("null", ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  889. r_result.insert(option.display, option);
  890. } else {
  891. ScriptLanguage::CodeCompletionOption option(Variant::get_type_name(Variant::Type(i)), ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  892. r_result.insert(option.display, option);
  893. }
  894. }
  895. }
  896. static void _find_global_enums(HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result) {
  897. List<StringName> global_enums;
  898. CoreConstants::get_global_enums(&global_enums);
  899. for (const StringName &enum_name : global_enums) {
  900. ScriptLanguage::CodeCompletionOption option(enum_name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, ScriptLanguage::LOCATION_OTHER);
  901. r_result.insert(option.display, option);
  902. }
  903. }
  904. static void _list_available_types(bool p_inherit_only, GDScriptParser::CompletionContext &p_context, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result) {
  905. // Built-in Variant Types
  906. _find_built_in_variants(r_result, true);
  907. List<StringName> native_types;
  908. ClassDB::get_class_list(&native_types);
  909. for (const StringName &E : native_types) {
  910. if (ClassDB::is_class_exposed(E) && !Engine::get_singleton()->has_singleton(E)) {
  911. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  912. r_result.insert(option.display, option);
  913. }
  914. }
  915. // TODO: Unify with _find_identifiers_in_class.
  916. if (p_context.current_class) {
  917. if (!p_inherit_only && p_context.current_class->base_type.is_set()) {
  918. // Native enums from base class
  919. List<StringName> enums;
  920. ClassDB::get_enum_list(p_context.current_class->base_type.native_type, &enums);
  921. for (const StringName &E : enums) {
  922. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_ENUM);
  923. r_result.insert(option.display, option);
  924. }
  925. }
  926. // Check current class for potential types.
  927. // TODO: Also check classes the current class inherits from.
  928. const GDScriptParser::ClassNode *current = p_context.current_class;
  929. int location_offset = 0;
  930. while (current) {
  931. for (int i = 0; i < current->members.size(); i++) {
  932. const GDScriptParser::ClassNode::Member &member = current->members[i];
  933. switch (member.type) {
  934. case GDScriptParser::ClassNode::Member::CLASS: {
  935. ScriptLanguage::CodeCompletionOption option(member.m_class->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_LOCAL + location_offset);
  936. r_result.insert(option.display, option);
  937. } break;
  938. case GDScriptParser::ClassNode::Member::ENUM: {
  939. if (!p_inherit_only) {
  940. ScriptLanguage::CodeCompletionOption option(member.m_enum->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, ScriptLanguage::LOCATION_LOCAL + location_offset);
  941. r_result.insert(option.display, option);
  942. }
  943. } break;
  944. case GDScriptParser::ClassNode::Member::CONSTANT: {
  945. if (member.constant->get_datatype().is_meta_type) {
  946. ScriptLanguage::CodeCompletionOption option(member.constant->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_LOCAL + location_offset);
  947. r_result.insert(option.display, option);
  948. }
  949. } break;
  950. default:
  951. break;
  952. }
  953. }
  954. location_offset += 1;
  955. current = current->outer;
  956. }
  957. }
  958. // Global scripts
  959. List<StringName> global_classes;
  960. ScriptServer::get_global_class_list(&global_classes);
  961. for (const StringName &E : global_classes) {
  962. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_OTHER_USER_CODE);
  963. r_result.insert(option.display, option);
  964. }
  965. // Global enums
  966. if (!p_inherit_only) {
  967. _find_global_enums(r_result);
  968. }
  969. // Autoload singletons
  970. HashMap<StringName, ProjectSettings::AutoloadInfo> autoloads = ProjectSettings::get_singleton()->get_autoload_list();
  971. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : autoloads) {
  972. const ProjectSettings::AutoloadInfo &info = E.value;
  973. if (!info.is_singleton || info.path.get_extension().to_lower() != "gd") {
  974. continue;
  975. }
  976. ScriptLanguage::CodeCompletionOption option(info.name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_OTHER_USER_CODE);
  977. r_result.insert(option.display, option);
  978. }
  979. }
  980. static void _find_identifiers_in_suite(const GDScriptParser::SuiteNode *p_suite, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth = 0) {
  981. for (int i = 0; i < p_suite->locals.size(); i++) {
  982. ScriptLanguage::CodeCompletionOption option;
  983. int location = p_recursion_depth == 0 ? ScriptLanguage::LOCATION_LOCAL : (p_recursion_depth | ScriptLanguage::LOCATION_PARENT_MASK);
  984. if (p_suite->locals[i].type == GDScriptParser::SuiteNode::Local::CONSTANT) {
  985. option = ScriptLanguage::CodeCompletionOption(p_suite->locals[i].name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  986. option.default_value = p_suite->locals[i].constant->initializer->reduced_value;
  987. } else {
  988. option = ScriptLanguage::CodeCompletionOption(p_suite->locals[i].name, ScriptLanguage::CODE_COMPLETION_KIND_VARIABLE, location);
  989. }
  990. r_result.insert(option.display, option);
  991. }
  992. if (p_suite->parent_block) {
  993. _find_identifiers_in_suite(p_suite->parent_block, r_result, p_recursion_depth + 1);
  994. }
  995. }
  996. static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base, bool p_only_functions, bool p_types_only, bool p_add_braces, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth);
  997. static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class, bool p_only_functions, bool p_types_only, bool p_static, bool p_parent_only, bool p_add_braces, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth) {
  998. ERR_FAIL_COND(p_recursion_depth > COMPLETION_RECURSION_LIMIT);
  999. if (!p_parent_only) {
  1000. bool outer = false;
  1001. const GDScriptParser::ClassNode *clss = p_class;
  1002. int classes_processed = 0;
  1003. while (clss) {
  1004. for (int i = 0; i < clss->members.size(); i++) {
  1005. const int location = p_recursion_depth == 0 ? classes_processed : (p_recursion_depth | ScriptLanguage::LOCATION_PARENT_MASK);
  1006. const GDScriptParser::ClassNode::Member &member = clss->members[i];
  1007. ScriptLanguage::CodeCompletionOption option;
  1008. switch (member.type) {
  1009. case GDScriptParser::ClassNode::Member::VARIABLE:
  1010. if (p_types_only || p_only_functions || outer || (p_static && !member.variable->is_static)) {
  1011. continue;
  1012. }
  1013. option = ScriptLanguage::CodeCompletionOption(member.variable->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  1014. break;
  1015. case GDScriptParser::ClassNode::Member::CONSTANT:
  1016. if ((p_types_only && !member.constant->datatype.is_meta_type) || p_only_functions) {
  1017. continue;
  1018. }
  1019. if (r_result.has(member.constant->identifier->name)) {
  1020. continue;
  1021. }
  1022. option = ScriptLanguage::CodeCompletionOption(member.constant->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1023. if (member.constant->initializer) {
  1024. option.default_value = member.constant->initializer->reduced_value;
  1025. }
  1026. break;
  1027. case GDScriptParser::ClassNode::Member::CLASS:
  1028. if (p_only_functions) {
  1029. continue;
  1030. }
  1031. option = ScriptLanguage::CodeCompletionOption(member.m_class->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, location);
  1032. break;
  1033. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  1034. if (p_types_only || p_only_functions) {
  1035. continue;
  1036. }
  1037. option = ScriptLanguage::CodeCompletionOption(member.enum_value.identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1038. break;
  1039. case GDScriptParser::ClassNode::Member::ENUM:
  1040. if (p_only_functions) {
  1041. continue;
  1042. }
  1043. option = ScriptLanguage::CodeCompletionOption(member.m_enum->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, location);
  1044. break;
  1045. case GDScriptParser::ClassNode::Member::FUNCTION:
  1046. if (p_types_only || outer || (p_static && !member.function->is_static) || member.function->identifier->name.operator String().begins_with("@")) {
  1047. continue;
  1048. }
  1049. option = ScriptLanguage::CodeCompletionOption(member.function->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  1050. if (p_add_braces) {
  1051. if (member.function->parameters.size() > 0 || (member.function->info.flags & METHOD_FLAG_VARARG)) {
  1052. option.insert_text += "(";
  1053. option.display += U"(\u2026)";
  1054. } else {
  1055. option.insert_text += "()";
  1056. option.display += "()";
  1057. }
  1058. }
  1059. break;
  1060. case GDScriptParser::ClassNode::Member::SIGNAL:
  1061. if (p_types_only || p_only_functions || outer || p_static) {
  1062. continue;
  1063. }
  1064. option = ScriptLanguage::CodeCompletionOption(member.signal->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL, location);
  1065. break;
  1066. case GDScriptParser::ClassNode::Member::GROUP:
  1067. break; // No-op, but silences warnings.
  1068. case GDScriptParser::ClassNode::Member::UNDEFINED:
  1069. break;
  1070. }
  1071. r_result.insert(option.display, option);
  1072. }
  1073. if (p_types_only) {
  1074. break; // Otherwise, it will fill the results with types from the outer class (which is undesired for that case).
  1075. }
  1076. outer = true;
  1077. clss = clss->outer;
  1078. classes_processed++;
  1079. }
  1080. }
  1081. // Parents.
  1082. GDScriptCompletionIdentifier base_type;
  1083. base_type.type = p_class->base_type;
  1084. base_type.type.is_meta_type = p_static;
  1085. _find_identifiers_in_base(base_type, p_only_functions, p_types_only, p_add_braces, r_result, p_recursion_depth + 1);
  1086. }
  1087. static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base, bool p_only_functions, bool p_types_only, bool p_add_braces, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth) {
  1088. ERR_FAIL_COND(p_recursion_depth > COMPLETION_RECURSION_LIMIT);
  1089. GDScriptParser::DataType base_type = p_base.type;
  1090. if (!p_types_only && base_type.is_meta_type && base_type.kind != GDScriptParser::DataType::BUILTIN && base_type.kind != GDScriptParser::DataType::ENUM) {
  1091. ScriptLanguage::CodeCompletionOption option("new", ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, ScriptLanguage::LOCATION_LOCAL);
  1092. if (p_add_braces) {
  1093. option.insert_text += "(";
  1094. option.display += U"(\u2026)";
  1095. }
  1096. r_result.insert(option.display, option);
  1097. }
  1098. while (!base_type.has_no_type()) {
  1099. switch (base_type.kind) {
  1100. case GDScriptParser::DataType::CLASS: {
  1101. _find_identifiers_in_class(base_type.class_type, p_only_functions, p_types_only, base_type.is_meta_type, false, p_add_braces, r_result, p_recursion_depth);
  1102. // This already finds all parent identifiers, so we are done.
  1103. base_type = GDScriptParser::DataType();
  1104. } break;
  1105. case GDScriptParser::DataType::SCRIPT: {
  1106. Ref<Script> scr = base_type.script_type;
  1107. if (scr.is_valid()) {
  1108. if (p_types_only) {
  1109. // TODO: Need to implement Script::get_script_enum_list and retrieve the enum list from a script.
  1110. } else if (!p_only_functions) {
  1111. if (!base_type.is_meta_type) {
  1112. List<PropertyInfo> members;
  1113. scr->get_script_property_list(&members);
  1114. for (const PropertyInfo &E : members) {
  1115. if (E.usage & (PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_INTERNAL)) {
  1116. continue;
  1117. }
  1118. if (E.name.contains_char('/')) {
  1119. continue;
  1120. }
  1121. int location = p_recursion_depth + _get_property_location(scr, E.name);
  1122. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  1123. r_result.insert(option.display, option);
  1124. }
  1125. List<MethodInfo> signals;
  1126. scr->get_script_signal_list(&signals);
  1127. for (const MethodInfo &E : signals) {
  1128. int location = p_recursion_depth + _get_signal_location(scr, E.name);
  1129. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL, location);
  1130. r_result.insert(option.display, option);
  1131. }
  1132. }
  1133. HashMap<StringName, Variant> constants;
  1134. scr->get_constants(&constants);
  1135. for (const KeyValue<StringName, Variant> &E : constants) {
  1136. int location = p_recursion_depth + _get_constant_location(scr, E.key);
  1137. ScriptLanguage::CodeCompletionOption option(E.key.operator String(), ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1138. r_result.insert(option.display, option);
  1139. }
  1140. }
  1141. if (!p_types_only) {
  1142. List<MethodInfo> methods;
  1143. scr->get_script_method_list(&methods);
  1144. for (const MethodInfo &E : methods) {
  1145. if (E.name.begins_with("@")) {
  1146. continue;
  1147. }
  1148. int location = p_recursion_depth + _get_method_location(scr->get_class_name(), E.name);
  1149. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  1150. if (p_add_braces) {
  1151. if (E.arguments.size() || (E.flags & METHOD_FLAG_VARARG)) {
  1152. option.insert_text += "(";
  1153. option.display += U"(\u2026)";
  1154. } else {
  1155. option.insert_text += "()";
  1156. option.display += "()";
  1157. }
  1158. }
  1159. r_result.insert(option.display, option);
  1160. }
  1161. }
  1162. Ref<Script> base_script = scr->get_base_script();
  1163. if (base_script.is_valid()) {
  1164. base_type.script_type = base_script;
  1165. } else {
  1166. base_type.kind = GDScriptParser::DataType::NATIVE;
  1167. base_type.builtin_type = Variant::OBJECT;
  1168. base_type.native_type = scr->get_instance_base_type();
  1169. }
  1170. } else {
  1171. return;
  1172. }
  1173. } break;
  1174. case GDScriptParser::DataType::NATIVE: {
  1175. StringName type = base_type.native_type;
  1176. if (!ClassDB::class_exists(type)) {
  1177. return;
  1178. }
  1179. List<StringName> enums;
  1180. ClassDB::get_enum_list(type, &enums);
  1181. for (const StringName &E : enums) {
  1182. int location = p_recursion_depth + _get_enum_location(type, E);
  1183. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, location);
  1184. r_result.insert(option.display, option);
  1185. }
  1186. if (p_types_only) {
  1187. return;
  1188. }
  1189. if (!p_only_functions) {
  1190. List<String> constants;
  1191. ClassDB::get_integer_constant_list(type, &constants);
  1192. for (const String &E : constants) {
  1193. int location = p_recursion_depth + _get_constant_location(type, StringName(E));
  1194. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1195. r_result.insert(option.display, option);
  1196. }
  1197. if (!base_type.is_meta_type || Engine::get_singleton()->has_singleton(type)) {
  1198. List<PropertyInfo> pinfo;
  1199. ClassDB::get_property_list(type, &pinfo);
  1200. for (const PropertyInfo &E : pinfo) {
  1201. if (E.usage & (PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_INTERNAL)) {
  1202. continue;
  1203. }
  1204. if (E.name.contains_char('/')) {
  1205. continue;
  1206. }
  1207. int location = p_recursion_depth + _get_property_location(type, E.name);
  1208. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  1209. r_result.insert(option.display, option);
  1210. }
  1211. List<MethodInfo> signals;
  1212. ClassDB::get_signal_list(type, &signals);
  1213. for (const MethodInfo &E : signals) {
  1214. int location = p_recursion_depth + _get_signal_location(type, StringName(E.name));
  1215. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL, location);
  1216. r_result.insert(option.display, option);
  1217. }
  1218. }
  1219. }
  1220. bool only_static = base_type.is_meta_type && !Engine::get_singleton()->has_singleton(type);
  1221. List<MethodInfo> methods;
  1222. ClassDB::get_method_list(type, &methods, false, true);
  1223. for (const MethodInfo &E : methods) {
  1224. if (only_static && (E.flags & METHOD_FLAG_STATIC) == 0) {
  1225. continue;
  1226. }
  1227. if (E.name.begins_with("_")) {
  1228. continue;
  1229. }
  1230. int location = p_recursion_depth + _get_method_location(type, E.name);
  1231. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  1232. if (p_add_braces) {
  1233. if (E.arguments.size() || (E.flags & METHOD_FLAG_VARARG)) {
  1234. option.insert_text += "(";
  1235. option.display += U"(\u2026)";
  1236. } else {
  1237. option.insert_text += "()";
  1238. option.display += "()";
  1239. }
  1240. }
  1241. r_result.insert(option.display, option);
  1242. }
  1243. return;
  1244. } break;
  1245. case GDScriptParser::DataType::ENUM: {
  1246. if (p_types_only) {
  1247. return;
  1248. }
  1249. String type_str = base_type.native_type;
  1250. if (type_str.contains_char('.')) {
  1251. StringName type = type_str.get_slicec('.', 0);
  1252. StringName type_enum = base_type.enum_type;
  1253. List<StringName> enum_values;
  1254. ClassDB::get_enum_constants(type, type_enum, &enum_values);
  1255. for (const StringName &E : enum_values) {
  1256. int location = p_recursion_depth + _get_enum_constant_location(type, E);
  1257. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1258. r_result.insert(option.display, option);
  1259. }
  1260. } else if (CoreConstants::is_global_enum(base_type.enum_type)) {
  1261. HashMap<StringName, int64_t> enum_values;
  1262. CoreConstants::get_enum_values(base_type.enum_type, &enum_values);
  1263. for (const KeyValue<StringName, int64_t> &enum_value : enum_values) {
  1264. int location = p_recursion_depth + ScriptLanguage::LOCATION_OTHER;
  1265. ScriptLanguage::CodeCompletionOption option(enum_value.key, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1266. r_result.insert(option.display, option);
  1267. }
  1268. }
  1269. }
  1270. [[fallthrough]];
  1271. case GDScriptParser::DataType::BUILTIN: {
  1272. if (p_types_only) {
  1273. return;
  1274. }
  1275. Callable::CallError err;
  1276. Variant tmp;
  1277. Variant::construct(base_type.builtin_type, tmp, nullptr, 0, err);
  1278. if (err.error != Callable::CallError::CALL_OK) {
  1279. return;
  1280. }
  1281. int location = ScriptLanguage::LOCATION_OTHER;
  1282. if (!p_only_functions) {
  1283. List<PropertyInfo> members;
  1284. if (p_base.value.get_type() != Variant::NIL) {
  1285. p_base.value.get_property_list(&members);
  1286. } else {
  1287. tmp.get_property_list(&members);
  1288. }
  1289. for (const PropertyInfo &E : members) {
  1290. if (E.usage & (PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_INTERNAL)) {
  1291. continue;
  1292. }
  1293. if (!String(E.name).contains_char('/')) {
  1294. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  1295. if (base_type.kind == GDScriptParser::DataType::ENUM) {
  1296. // Sort enum members in their declaration order.
  1297. location += 1;
  1298. }
  1299. if (GDScriptParser::theme_color_names.has(E.name)) {
  1300. option.theme_color_name = GDScriptParser::theme_color_names[E.name];
  1301. }
  1302. r_result.insert(option.display, option);
  1303. }
  1304. }
  1305. }
  1306. List<MethodInfo> methods;
  1307. tmp.get_method_list(&methods);
  1308. for (const MethodInfo &E : methods) {
  1309. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type && !(E.flags & METHOD_FLAG_CONST)) {
  1310. // Enum types are static and cannot change, therefore we skip non-const dictionary methods.
  1311. continue;
  1312. }
  1313. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  1314. if (p_add_braces) {
  1315. if (E.arguments.size() || (E.flags & METHOD_FLAG_VARARG)) {
  1316. option.insert_text += "(";
  1317. option.display += U"(\u2026)";
  1318. } else {
  1319. option.insert_text += "()";
  1320. option.display += "()";
  1321. }
  1322. }
  1323. r_result.insert(option.display, option);
  1324. }
  1325. return;
  1326. } break;
  1327. default: {
  1328. return;
  1329. } break;
  1330. }
  1331. }
  1332. }
  1333. static void _find_identifiers(const GDScriptParser::CompletionContext &p_context, bool p_only_functions, bool p_add_braces, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth) {
  1334. if (!p_only_functions && p_context.current_suite) {
  1335. // This includes function parameters, since they are also locals.
  1336. _find_identifiers_in_suite(p_context.current_suite, r_result);
  1337. }
  1338. if (p_context.current_class) {
  1339. _find_identifiers_in_class(p_context.current_class, p_only_functions, false, (!p_context.current_function || p_context.current_function->is_static), false, p_add_braces, r_result, p_recursion_depth);
  1340. }
  1341. List<StringName> functions;
  1342. GDScriptUtilityFunctions::get_function_list(&functions);
  1343. for (const StringName &E : functions) {
  1344. MethodInfo function = GDScriptUtilityFunctions::get_function_info(E);
  1345. ScriptLanguage::CodeCompletionOption option(String(E), ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1346. if (p_add_braces) {
  1347. if (function.arguments.size() || (function.flags & METHOD_FLAG_VARARG)) {
  1348. option.insert_text += "(";
  1349. option.display += U"(\u2026)";
  1350. } else {
  1351. option.insert_text += "()";
  1352. option.display += "()";
  1353. }
  1354. }
  1355. r_result.insert(option.display, option);
  1356. }
  1357. if (p_only_functions) {
  1358. return;
  1359. }
  1360. _find_built_in_variants(r_result);
  1361. static const char *_keywords[] = {
  1362. "true", "false", "PI", "TAU", "INF", "NAN", "null", "self", "super",
  1363. "break", "breakpoint", "continue", "pass", "return",
  1364. nullptr
  1365. };
  1366. const char **kw = _keywords;
  1367. while (*kw) {
  1368. ScriptLanguage::CodeCompletionOption option(*kw, ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  1369. r_result.insert(option.display, option);
  1370. kw++;
  1371. }
  1372. static const char *_keywords_with_space[] = {
  1373. "and", "not", "or", "in", "as", "class", "class_name", "extends", "is", "func", "signal", "await",
  1374. "const", "enum", "static", "var", "if", "elif", "else", "for", "match", "when", "while",
  1375. nullptr
  1376. };
  1377. const char **kws = _keywords_with_space;
  1378. while (*kws) {
  1379. ScriptLanguage::CodeCompletionOption option(*kws, ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  1380. option.insert_text += " ";
  1381. r_result.insert(option.display, option);
  1382. kws++;
  1383. }
  1384. static const char *_keywords_with_args[] = {
  1385. "assert", "preload",
  1386. nullptr
  1387. };
  1388. const char **kwa = _keywords_with_args;
  1389. while (*kwa) {
  1390. ScriptLanguage::CodeCompletionOption option(*kwa, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1391. if (p_add_braces) {
  1392. option.insert_text += "(";
  1393. option.display += U"(\u2026)";
  1394. }
  1395. r_result.insert(option.display, option);
  1396. kwa++;
  1397. }
  1398. List<StringName> utility_func_names;
  1399. Variant::get_utility_function_list(&utility_func_names);
  1400. for (const StringName &util_func_name : utility_func_names) {
  1401. ScriptLanguage::CodeCompletionOption option(util_func_name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1402. if (p_add_braces) {
  1403. option.insert_text += "(";
  1404. option.display += U"(\u2026)"; // As all utility functions contain an argument or more, this is hardcoded here.
  1405. }
  1406. r_result.insert(option.display, option);
  1407. }
  1408. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : ProjectSettings::get_singleton()->get_autoload_list()) {
  1409. if (!E.value.is_singleton) {
  1410. continue;
  1411. }
  1412. ScriptLanguage::CodeCompletionOption option(E.key, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  1413. r_result.insert(option.display, option);
  1414. }
  1415. // Native classes and global constants.
  1416. for (const KeyValue<StringName, int> &E : GDScriptLanguage::get_singleton()->get_global_map()) {
  1417. ScriptLanguage::CodeCompletionOption option;
  1418. if (ClassDB::class_exists(E.key) || Engine::get_singleton()->has_singleton(E.key)) {
  1419. option = ScriptLanguage::CodeCompletionOption(E.key.operator String(), ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  1420. } else {
  1421. option = ScriptLanguage::CodeCompletionOption(E.key.operator String(), ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  1422. }
  1423. r_result.insert(option.display, option);
  1424. }
  1425. // Global enums
  1426. _find_global_enums(r_result);
  1427. // Global classes
  1428. List<StringName> global_classes;
  1429. ScriptServer::get_global_class_list(&global_classes);
  1430. for (const StringName &E : global_classes) {
  1431. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_OTHER_USER_CODE);
  1432. r_result.insert(option.display, option);
  1433. }
  1434. }
  1435. static GDScriptCompletionIdentifier _type_from_variant(const Variant &p_value, GDScriptParser::CompletionContext &p_context) {
  1436. GDScriptCompletionIdentifier ci;
  1437. ci.value = p_value;
  1438. ci.type.is_constant = true;
  1439. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1440. ci.type.kind = GDScriptParser::DataType::BUILTIN;
  1441. ci.type.builtin_type = p_value.get_type();
  1442. if (ci.type.builtin_type == Variant::OBJECT) {
  1443. Object *obj = p_value.operator Object *();
  1444. if (!obj) {
  1445. return ci;
  1446. }
  1447. ci.type.native_type = obj->get_class_name();
  1448. Ref<Script> scr = p_value;
  1449. if (scr.is_valid()) {
  1450. ci.type.is_meta_type = true;
  1451. } else {
  1452. ci.type.is_meta_type = false;
  1453. scr = obj->get_script();
  1454. }
  1455. if (scr.is_valid()) {
  1456. ci.type.script_path = scr->get_path();
  1457. ci.type.script_type = scr;
  1458. ci.type.native_type = scr->get_instance_base_type();
  1459. ci.type.kind = GDScriptParser::DataType::SCRIPT;
  1460. if (scr->get_path().ends_with(".gd")) {
  1461. Ref<GDScriptParserRef> parser = p_context.parser->get_depended_parser_for(scr->get_path());
  1462. if (parser.is_valid() && parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED) == OK) {
  1463. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1464. ci.type.class_type = parser->get_parser()->get_tree();
  1465. ci.type.kind = GDScriptParser::DataType::CLASS;
  1466. return ci;
  1467. }
  1468. }
  1469. } else {
  1470. ci.type.kind = GDScriptParser::DataType::NATIVE;
  1471. }
  1472. }
  1473. return ci;
  1474. }
  1475. static GDScriptCompletionIdentifier _type_from_property(const PropertyInfo &p_property) {
  1476. GDScriptCompletionIdentifier ci;
  1477. if (p_property.type == Variant::NIL) {
  1478. // Variant
  1479. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1480. ci.type.kind = GDScriptParser::DataType::VARIANT;
  1481. return ci;
  1482. }
  1483. if (p_property.usage & (PROPERTY_USAGE_CLASS_IS_ENUM | PROPERTY_USAGE_CLASS_IS_BITFIELD)) {
  1484. ci.enumeration = p_property.class_name;
  1485. }
  1486. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1487. ci.type.builtin_type = p_property.type;
  1488. if (p_property.type == Variant::OBJECT) {
  1489. if (ScriptServer::is_global_class(p_property.class_name)) {
  1490. ci.type.kind = GDScriptParser::DataType::SCRIPT;
  1491. ci.type.script_path = ScriptServer::get_global_class_path(p_property.class_name);
  1492. ci.type.native_type = ScriptServer::get_global_class_native_base(p_property.class_name);
  1493. Ref<Script> scr = ResourceLoader::load(ScriptServer::get_global_class_path(p_property.class_name));
  1494. if (scr.is_valid()) {
  1495. ci.type.script_type = scr;
  1496. }
  1497. } else {
  1498. ci.type.kind = GDScriptParser::DataType::NATIVE;
  1499. ci.type.native_type = p_property.class_name == StringName() ? "Object" : p_property.class_name;
  1500. }
  1501. } else {
  1502. ci.type.kind = GDScriptParser::DataType::BUILTIN;
  1503. }
  1504. return ci;
  1505. }
  1506. static GDScriptCompletionIdentifier _callable_type_from_method_info(const MethodInfo &p_method) {
  1507. GDScriptCompletionIdentifier ci;
  1508. ci.type.kind = GDScriptParser::DataType::BUILTIN;
  1509. ci.type.builtin_type = Variant::CALLABLE;
  1510. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1511. ci.type.is_constant = true;
  1512. ci.type.method_info = p_method;
  1513. return ci;
  1514. }
  1515. #define MAX_COMPLETION_RECURSION 100
  1516. struct RecursionCheck {
  1517. int *counter;
  1518. _FORCE_INLINE_ bool check() {
  1519. return (*counter) > MAX_COMPLETION_RECURSION;
  1520. }
  1521. RecursionCheck(int *p_counter) :
  1522. counter(p_counter) {
  1523. (*counter)++;
  1524. }
  1525. ~RecursionCheck() {
  1526. (*counter)--;
  1527. }
  1528. };
  1529. static bool _guess_identifier_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::IdentifierNode *p_identifier, GDScriptCompletionIdentifier &r_type);
  1530. static bool _guess_identifier_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_identifier, GDScriptCompletionIdentifier &r_type);
  1531. static bool _guess_method_return_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_method, GDScriptCompletionIdentifier &r_type);
  1532. static bool _is_expression_named_identifier(const GDScriptParser::ExpressionNode *p_expression, const StringName &p_name) {
  1533. if (p_expression) {
  1534. switch (p_expression->type) {
  1535. case GDScriptParser::Node::IDENTIFIER: {
  1536. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(p_expression);
  1537. if (id->name == p_name) {
  1538. return true;
  1539. }
  1540. } break;
  1541. case GDScriptParser::Node::CAST: {
  1542. const GDScriptParser::CastNode *cn = static_cast<const GDScriptParser::CastNode *>(p_expression);
  1543. return _is_expression_named_identifier(cn->operand, p_name);
  1544. } break;
  1545. default:
  1546. break;
  1547. }
  1548. }
  1549. return false;
  1550. }
  1551. static bool _guess_expression_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::ExpressionNode *p_expression, GDScriptCompletionIdentifier &r_type) {
  1552. bool found = false;
  1553. if (p_expression == nullptr) {
  1554. return false;
  1555. }
  1556. static int recursion_depth = 0;
  1557. RecursionCheck recursion(&recursion_depth);
  1558. if (unlikely(recursion.check())) {
  1559. ERR_FAIL_V_MSG(false, "Reached recursion limit while trying to guess type.");
  1560. }
  1561. if (p_expression->is_constant) {
  1562. // Already has a value, so just use that.
  1563. r_type = _type_from_variant(p_expression->reduced_value, p_context);
  1564. switch (p_expression->get_datatype().kind) {
  1565. case GDScriptParser::DataType::ENUM:
  1566. case GDScriptParser::DataType::CLASS:
  1567. r_type.type = p_expression->get_datatype();
  1568. break;
  1569. default:
  1570. break;
  1571. }
  1572. found = true;
  1573. } else {
  1574. switch (p_expression->type) {
  1575. case GDScriptParser::Node::LITERAL: {
  1576. const GDScriptParser::LiteralNode *literal = static_cast<const GDScriptParser::LiteralNode *>(p_expression);
  1577. r_type = _type_from_variant(literal->value, p_context);
  1578. found = true;
  1579. } break;
  1580. case GDScriptParser::Node::SELF: {
  1581. if (p_context.current_class) {
  1582. r_type.type = p_context.current_class->get_datatype();
  1583. r_type.type.is_meta_type = false;
  1584. found = true;
  1585. }
  1586. } break;
  1587. case GDScriptParser::Node::IDENTIFIER: {
  1588. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(p_expression);
  1589. found = _guess_identifier_type(p_context, id, r_type);
  1590. } break;
  1591. case GDScriptParser::Node::DICTIONARY: {
  1592. // Try to recreate the dictionary.
  1593. const GDScriptParser::DictionaryNode *dn = static_cast<const GDScriptParser::DictionaryNode *>(p_expression);
  1594. Dictionary d;
  1595. bool full = true;
  1596. for (int i = 0; i < dn->elements.size(); i++) {
  1597. GDScriptCompletionIdentifier key;
  1598. if (_guess_expression_type(p_context, dn->elements[i].key, key)) {
  1599. if (!key.type.is_constant) {
  1600. full = false;
  1601. break;
  1602. }
  1603. GDScriptCompletionIdentifier value;
  1604. if (_guess_expression_type(p_context, dn->elements[i].value, value)) {
  1605. if (!value.type.is_constant) {
  1606. full = false;
  1607. break;
  1608. }
  1609. d[key.value] = value.value;
  1610. } else {
  1611. full = false;
  1612. break;
  1613. }
  1614. } else {
  1615. full = false;
  1616. break;
  1617. }
  1618. }
  1619. if (full) {
  1620. r_type.value = d;
  1621. r_type.type.is_constant = true;
  1622. }
  1623. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1624. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1625. r_type.type.builtin_type = Variant::DICTIONARY;
  1626. found = true;
  1627. } break;
  1628. case GDScriptParser::Node::ARRAY: {
  1629. // Try to recreate the array
  1630. const GDScriptParser::ArrayNode *an = static_cast<const GDScriptParser::ArrayNode *>(p_expression);
  1631. Array a;
  1632. bool full = true;
  1633. a.resize(an->elements.size());
  1634. for (int i = 0; i < an->elements.size(); i++) {
  1635. GDScriptCompletionIdentifier value;
  1636. if (_guess_expression_type(p_context, an->elements[i], value)) {
  1637. if (value.type.is_constant) {
  1638. a[i] = value.value;
  1639. } else {
  1640. full = false;
  1641. break;
  1642. }
  1643. } else {
  1644. full = false;
  1645. break;
  1646. }
  1647. }
  1648. if (full) {
  1649. // If not fully constant, setting this value is detrimental to the inference.
  1650. r_type.value = a;
  1651. r_type.type.is_constant = true;
  1652. }
  1653. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1654. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1655. r_type.type.builtin_type = Variant::ARRAY;
  1656. found = true;
  1657. } break;
  1658. case GDScriptParser::Node::CAST: {
  1659. const GDScriptParser::CastNode *cn = static_cast<const GDScriptParser::CastNode *>(p_expression);
  1660. GDScriptCompletionIdentifier value;
  1661. if (_guess_expression_type(p_context, cn->operand, r_type)) {
  1662. r_type.type = cn->get_datatype();
  1663. found = true;
  1664. }
  1665. } break;
  1666. case GDScriptParser::Node::CALL: {
  1667. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(p_expression);
  1668. if (GDScriptParser::get_builtin_type(call->function_name) < Variant::VARIANT_MAX) {
  1669. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1670. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1671. r_type.type.builtin_type = GDScriptParser::get_builtin_type(call->function_name);
  1672. found = true;
  1673. break;
  1674. } else if (GDScriptUtilityFunctions::function_exists(call->function_name)) {
  1675. MethodInfo mi = GDScriptUtilityFunctions::get_function_info(call->function_name);
  1676. r_type = _type_from_property(mi.return_val);
  1677. found = true;
  1678. break;
  1679. } else {
  1680. GDScriptParser::CompletionContext c = p_context;
  1681. c.current_line = call->start_line;
  1682. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  1683. GDScriptCompletionIdentifier base;
  1684. if (callee_type == GDScriptParser::Node::IDENTIFIER || call->is_super) {
  1685. // Simple call, so base is 'self'.
  1686. if (p_context.current_class) {
  1687. if (call->is_super) {
  1688. base.type = p_context.current_class->base_type;
  1689. base.value = p_context.base;
  1690. } else {
  1691. base.type.kind = GDScriptParser::DataType::CLASS;
  1692. base.type.type_source = GDScriptParser::DataType::INFERRED;
  1693. base.type.is_constant = true;
  1694. base.type.class_type = p_context.current_class;
  1695. base.value = p_context.base;
  1696. }
  1697. } else {
  1698. break;
  1699. }
  1700. } else if (callee_type == GDScriptParser::Node::SUBSCRIPT && static_cast<const GDScriptParser::SubscriptNode *>(call->callee)->is_attribute) {
  1701. if (!_guess_expression_type(c, static_cast<const GDScriptParser::SubscriptNode *>(call->callee)->base, base)) {
  1702. found = false;
  1703. break;
  1704. }
  1705. } else {
  1706. break;
  1707. }
  1708. // Try call if constant methods with constant arguments
  1709. if (base.type.is_constant && base.value.get_type() == Variant::OBJECT) {
  1710. GDScriptParser::DataType native_type = base.type;
  1711. while (native_type.kind == GDScriptParser::DataType::CLASS) {
  1712. native_type = native_type.class_type->base_type;
  1713. }
  1714. while (native_type.kind == GDScriptParser::DataType::SCRIPT) {
  1715. if (native_type.script_type.is_valid()) {
  1716. Ref<Script> parent = native_type.script_type->get_base_script();
  1717. if (parent.is_valid()) {
  1718. native_type.script_type = parent;
  1719. } else {
  1720. native_type.kind = GDScriptParser::DataType::NATIVE;
  1721. native_type.builtin_type = Variant::OBJECT;
  1722. native_type.native_type = native_type.script_type->get_instance_base_type();
  1723. if (!ClassDB::class_exists(native_type.native_type)) {
  1724. native_type.kind = GDScriptParser::DataType::UNRESOLVED;
  1725. }
  1726. }
  1727. }
  1728. }
  1729. if (native_type.kind == GDScriptParser::DataType::NATIVE) {
  1730. MethodBind *mb = ClassDB::get_method(native_type.native_type, call->function_name);
  1731. if (mb && mb->is_const()) {
  1732. bool all_is_const = true;
  1733. Vector<Variant> args;
  1734. for (int i = 0; all_is_const && i < call->arguments.size(); i++) {
  1735. GDScriptCompletionIdentifier arg;
  1736. if (!call->arguments[i]->is_constant) {
  1737. all_is_const = false;
  1738. }
  1739. }
  1740. Object *baseptr = base.value;
  1741. if (all_is_const && call->function_name == SNAME("get_node") && ClassDB::is_parent_class(native_type.native_type, SNAME("Node")) && args.size()) {
  1742. String arg1 = args[0];
  1743. if (arg1.begins_with("/root/")) {
  1744. String which = arg1.get_slicec('/', 2);
  1745. if (!which.is_empty()) {
  1746. // Try singletons first
  1747. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(which)) {
  1748. r_type = _type_from_variant(GDScriptLanguage::get_singleton()->get_named_globals_map()[which], p_context);
  1749. found = true;
  1750. } else {
  1751. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : ProjectSettings::get_singleton()->get_autoload_list()) {
  1752. String name = E.key;
  1753. if (name == which) {
  1754. String script = E.value.path;
  1755. if (!script.begins_with("res://")) {
  1756. script = "res://" + script;
  1757. }
  1758. if (!script.ends_with(".gd")) {
  1759. // not a script, try find the script anyway,
  1760. // may have some success
  1761. script = script.get_basename() + ".gd";
  1762. }
  1763. if (FileAccess::exists(script)) {
  1764. Ref<GDScriptParserRef> parser = p_context.parser->get_depended_parser_for(script);
  1765. if (parser.is_valid() && parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED) == OK) {
  1766. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1767. r_type.type.script_path = script;
  1768. r_type.type.class_type = parser->get_parser()->get_tree();
  1769. r_type.type.is_constant = false;
  1770. r_type.type.kind = GDScriptParser::DataType::CLASS;
  1771. r_type.value = Variant();
  1772. found = true;
  1773. }
  1774. }
  1775. break;
  1776. }
  1777. }
  1778. }
  1779. }
  1780. }
  1781. }
  1782. if (!found && all_is_const && baseptr) {
  1783. Vector<const Variant *> argptr;
  1784. for (int i = 0; i < args.size(); i++) {
  1785. argptr.push_back(&args[i]);
  1786. }
  1787. Callable::CallError ce;
  1788. Variant ret = mb->call(baseptr, (const Variant **)argptr.ptr(), argptr.size(), ce);
  1789. if (ce.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1790. if (ret.get_type() != Variant::OBJECT || ret.operator Object *() != nullptr) {
  1791. r_type = _type_from_variant(ret, p_context);
  1792. found = true;
  1793. }
  1794. }
  1795. }
  1796. }
  1797. }
  1798. }
  1799. if (!found) {
  1800. found = _guess_method_return_type_from_base(c, base, call->function_name, r_type);
  1801. }
  1802. }
  1803. } break;
  1804. case GDScriptParser::Node::SUBSCRIPT: {
  1805. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(p_expression);
  1806. if (subscript->is_attribute) {
  1807. GDScriptParser::CompletionContext c = p_context;
  1808. c.current_line = subscript->start_line;
  1809. GDScriptCompletionIdentifier base;
  1810. if (!_guess_expression_type(c, subscript->base, base)) {
  1811. found = false;
  1812. break;
  1813. }
  1814. if (base.value.get_type() == Variant::DICTIONARY && base.value.operator Dictionary().has(String(subscript->attribute->name))) {
  1815. Variant value = base.value.operator Dictionary()[String(subscript->attribute->name)];
  1816. r_type = _type_from_variant(value, p_context);
  1817. found = true;
  1818. break;
  1819. }
  1820. const GDScriptParser::DictionaryNode *dn = nullptr;
  1821. if (subscript->base->type == GDScriptParser::Node::DICTIONARY) {
  1822. dn = static_cast<const GDScriptParser::DictionaryNode *>(subscript->base);
  1823. } else if (base.assigned_expression && base.assigned_expression->type == GDScriptParser::Node::DICTIONARY) {
  1824. dn = static_cast<const GDScriptParser::DictionaryNode *>(base.assigned_expression);
  1825. }
  1826. if (dn) {
  1827. for (int i = 0; i < dn->elements.size(); i++) {
  1828. GDScriptCompletionIdentifier key;
  1829. if (!_guess_expression_type(c, dn->elements[i].key, key)) {
  1830. continue;
  1831. }
  1832. if (key.value == String(subscript->attribute->name)) {
  1833. r_type.assigned_expression = dn->elements[i].value;
  1834. found = _guess_expression_type(c, dn->elements[i].value, r_type);
  1835. break;
  1836. }
  1837. }
  1838. }
  1839. if (!found) {
  1840. found = _guess_identifier_type_from_base(c, base, subscript->attribute->name, r_type);
  1841. }
  1842. } else {
  1843. if (subscript->index == nullptr) {
  1844. found = false;
  1845. break;
  1846. }
  1847. GDScriptParser::CompletionContext c = p_context;
  1848. c.current_line = subscript->start_line;
  1849. GDScriptCompletionIdentifier base;
  1850. if (!_guess_expression_type(c, subscript->base, base)) {
  1851. found = false;
  1852. break;
  1853. }
  1854. GDScriptCompletionIdentifier index;
  1855. if (!_guess_expression_type(c, subscript->index, index)) {
  1856. found = false;
  1857. break;
  1858. }
  1859. {
  1860. bool valid;
  1861. Variant value = base.value.get(index.value, &valid);
  1862. if (valid) {
  1863. r_type = _type_from_variant(value, p_context);
  1864. found = true;
  1865. break;
  1866. }
  1867. }
  1868. // Look if it is a dictionary node.
  1869. const GDScriptParser::DictionaryNode *dn = nullptr;
  1870. if (subscript->base->type == GDScriptParser::Node::DICTIONARY) {
  1871. dn = static_cast<const GDScriptParser::DictionaryNode *>(subscript->base);
  1872. } else if (base.assigned_expression && base.assigned_expression->type == GDScriptParser::Node::DICTIONARY) {
  1873. dn = static_cast<const GDScriptParser::DictionaryNode *>(base.assigned_expression);
  1874. }
  1875. if (dn) {
  1876. for (int i = 0; i < dn->elements.size(); i++) {
  1877. GDScriptCompletionIdentifier key;
  1878. if (!_guess_expression_type(c, dn->elements[i].key, key)) {
  1879. continue;
  1880. }
  1881. if (key.value == index.value) {
  1882. r_type.assigned_expression = dn->elements[i].value;
  1883. found = _guess_expression_type(p_context, dn->elements[i].value, r_type);
  1884. break;
  1885. }
  1886. }
  1887. }
  1888. // Look if it is an array node.
  1889. if (!found && index.value.is_num()) {
  1890. int idx = index.value;
  1891. const GDScriptParser::ArrayNode *an = nullptr;
  1892. if (subscript->base->type == GDScriptParser::Node::ARRAY) {
  1893. an = static_cast<const GDScriptParser::ArrayNode *>(subscript->base);
  1894. } else if (base.assigned_expression && base.assigned_expression->type == GDScriptParser::Node::ARRAY) {
  1895. an = static_cast<const GDScriptParser::ArrayNode *>(base.assigned_expression);
  1896. }
  1897. if (an && idx >= 0 && an->elements.size() > idx) {
  1898. r_type.assigned_expression = an->elements[idx];
  1899. found = _guess_expression_type(c, an->elements[idx], r_type);
  1900. break;
  1901. }
  1902. }
  1903. // Look for valid indexing in other types
  1904. if (!found && (index.value.is_string() || index.value.get_type() == Variant::NODE_PATH)) {
  1905. StringName id = index.value;
  1906. found = _guess_identifier_type_from_base(c, base, id, r_type);
  1907. } else if (!found && index.type.kind == GDScriptParser::DataType::BUILTIN) {
  1908. Callable::CallError err;
  1909. Variant base_val;
  1910. Variant::construct(base.type.builtin_type, base_val, nullptr, 0, err);
  1911. bool valid = false;
  1912. Variant res = base_val.get(index.value, &valid);
  1913. if (valid) {
  1914. r_type = _type_from_variant(res, p_context);
  1915. r_type.value = Variant();
  1916. r_type.type.is_constant = false;
  1917. found = true;
  1918. }
  1919. }
  1920. }
  1921. } break;
  1922. case GDScriptParser::Node::BINARY_OPERATOR: {
  1923. const GDScriptParser::BinaryOpNode *op = static_cast<const GDScriptParser::BinaryOpNode *>(p_expression);
  1924. if (op->variant_op == Variant::OP_MAX) {
  1925. break;
  1926. }
  1927. GDScriptParser::CompletionContext context = p_context;
  1928. context.current_line = op->start_line;
  1929. GDScriptCompletionIdentifier p1;
  1930. GDScriptCompletionIdentifier p2;
  1931. if (!_guess_expression_type(context, op->left_operand, p1)) {
  1932. found = false;
  1933. break;
  1934. }
  1935. if (!_guess_expression_type(context, op->right_operand, p2)) {
  1936. found = false;
  1937. break;
  1938. }
  1939. Callable::CallError ce;
  1940. bool v1_use_value = p1.value.get_type() != Variant::NIL && p1.value.get_type() != Variant::OBJECT;
  1941. Variant d1;
  1942. Variant::construct(p1.type.builtin_type, d1, nullptr, 0, ce);
  1943. Variant d2;
  1944. Variant::construct(p2.type.builtin_type, d2, nullptr, 0, ce);
  1945. Variant v1 = (v1_use_value) ? p1.value : d1;
  1946. bool v2_use_value = p2.value.get_type() != Variant::NIL && p2.value.get_type() != Variant::OBJECT;
  1947. Variant v2 = (v2_use_value) ? p2.value : d2;
  1948. // avoid potential invalid ops
  1949. if ((op->variant_op == Variant::OP_DIVIDE || op->variant_op == Variant::OP_MODULE) && v2.get_type() == Variant::INT) {
  1950. v2 = 1;
  1951. v2_use_value = false;
  1952. }
  1953. if (op->variant_op == Variant::OP_DIVIDE && v2.get_type() == Variant::FLOAT) {
  1954. v2 = 1.0;
  1955. v2_use_value = false;
  1956. }
  1957. Variant res;
  1958. bool valid;
  1959. Variant::evaluate(op->variant_op, v1, v2, res, valid);
  1960. if (!valid) {
  1961. found = false;
  1962. break;
  1963. }
  1964. r_type = _type_from_variant(res, p_context);
  1965. if (!v1_use_value || !v2_use_value) {
  1966. r_type.value = Variant();
  1967. r_type.type.is_constant = false;
  1968. }
  1969. found = true;
  1970. } break;
  1971. default:
  1972. break;
  1973. }
  1974. }
  1975. // It may have found a null, but that's never useful
  1976. if (found && r_type.type.kind == GDScriptParser::DataType::BUILTIN && r_type.type.builtin_type == Variant::NIL) {
  1977. found = false;
  1978. }
  1979. // If the found type was not fully analyzed we analyze it now.
  1980. if (found && r_type.type.kind == GDScriptParser::DataType::CLASS && !r_type.type.class_type->resolved_body) {
  1981. Error err;
  1982. Ref<GDScriptParserRef> r = GDScriptCache::get_parser(r_type.type.script_path, GDScriptParserRef::FULLY_SOLVED, err);
  1983. }
  1984. // Check type hint last. For collections we want chance to get the actual value first
  1985. // This way we can detect types from the content of dictionaries and arrays
  1986. if (!found && p_expression->get_datatype().is_hard_type()) {
  1987. r_type.type = p_expression->get_datatype();
  1988. if (!r_type.assigned_expression) {
  1989. r_type.assigned_expression = p_expression;
  1990. }
  1991. found = true;
  1992. }
  1993. return found;
  1994. }
  1995. static bool _guess_identifier_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::IdentifierNode *p_identifier, GDScriptCompletionIdentifier &r_type) {
  1996. static int recursion_depth = 0;
  1997. RecursionCheck recursion(&recursion_depth);
  1998. if (unlikely(recursion.check())) {
  1999. ERR_FAIL_V_MSG(false, "Reached recursion limit while trying to guess type.");
  2000. }
  2001. // Look in blocks first.
  2002. int last_assign_line = -1;
  2003. const GDScriptParser::ExpressionNode *last_assigned_expression = nullptr;
  2004. GDScriptCompletionIdentifier id_type;
  2005. GDScriptParser::SuiteNode *suite = p_context.current_suite;
  2006. bool is_function_parameter = false;
  2007. bool can_be_local = true;
  2008. switch (p_identifier->source) {
  2009. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  2010. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  2011. case GDScriptParser::IdentifierNode::MEMBER_FUNCTION:
  2012. case GDScriptParser::IdentifierNode::MEMBER_SIGNAL:
  2013. case GDScriptParser::IdentifierNode::MEMBER_CLASS:
  2014. case GDScriptParser::IdentifierNode::INHERITED_VARIABLE:
  2015. case GDScriptParser::IdentifierNode::STATIC_VARIABLE:
  2016. can_be_local = false;
  2017. break;
  2018. default:
  2019. break;
  2020. }
  2021. if (can_be_local && suite && suite->has_local(p_identifier->name)) {
  2022. const GDScriptParser::SuiteNode::Local &local = suite->get_local(p_identifier->name);
  2023. id_type.type = local.get_datatype();
  2024. // Check initializer as the first assignment.
  2025. switch (local.type) {
  2026. case GDScriptParser::SuiteNode::Local::VARIABLE:
  2027. if (local.variable->initializer) {
  2028. last_assign_line = local.variable->initializer->end_line;
  2029. last_assigned_expression = local.variable->initializer;
  2030. }
  2031. break;
  2032. case GDScriptParser::SuiteNode::Local::CONSTANT:
  2033. if (local.constant->initializer) {
  2034. last_assign_line = local.constant->initializer->end_line;
  2035. last_assigned_expression = local.constant->initializer;
  2036. }
  2037. break;
  2038. case GDScriptParser::SuiteNode::Local::PARAMETER:
  2039. if (local.parameter->initializer) {
  2040. last_assign_line = local.parameter->initializer->end_line;
  2041. last_assigned_expression = local.parameter->initializer;
  2042. }
  2043. is_function_parameter = true;
  2044. break;
  2045. default:
  2046. break;
  2047. }
  2048. } else {
  2049. if (p_context.current_class) {
  2050. GDScriptCompletionIdentifier base_identifier;
  2051. GDScriptCompletionIdentifier base;
  2052. base.value = p_context.base;
  2053. base.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2054. base.type.kind = GDScriptParser::DataType::CLASS;
  2055. base.type.class_type = p_context.current_class;
  2056. base.type.is_meta_type = p_context.current_function && p_context.current_function->is_static;
  2057. if (_guess_identifier_type_from_base(p_context, base, p_identifier->name, base_identifier)) {
  2058. id_type = base_identifier;
  2059. }
  2060. }
  2061. }
  2062. while (suite) {
  2063. for (int i = 0; i < suite->statements.size(); i++) {
  2064. if (suite->statements[i]->end_line >= p_context.current_line) {
  2065. break;
  2066. }
  2067. switch (suite->statements[i]->type) {
  2068. case GDScriptParser::Node::ASSIGNMENT: {
  2069. const GDScriptParser::AssignmentNode *assign = static_cast<const GDScriptParser::AssignmentNode *>(suite->statements[i]);
  2070. if (assign->end_line > last_assign_line && assign->assignee && assign->assigned_value && assign->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  2071. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(assign->assignee);
  2072. if (id->name == p_identifier->name && id->source == p_identifier->source) {
  2073. last_assign_line = assign->assigned_value->end_line;
  2074. last_assigned_expression = assign->assigned_value;
  2075. }
  2076. }
  2077. } break;
  2078. default:
  2079. // TODO: Check sub blocks (control flow statements) as they might also reassign stuff.
  2080. break;
  2081. }
  2082. }
  2083. if (suite->parent_if && suite->parent_if->condition && suite->parent_if->condition->type == GDScriptParser::Node::TYPE_TEST) {
  2084. // Operator `is` used, check if identifier is in there! this helps resolve in blocks that are (if (identifier is value)): which are very common..
  2085. // Super dirty hack, but very useful.
  2086. // Credit: Zylann.
  2087. // TODO: this could be hacked to detect AND-ed conditions too...
  2088. const GDScriptParser::TypeTestNode *type_test = static_cast<const GDScriptParser::TypeTestNode *>(suite->parent_if->condition);
  2089. if (type_test->operand && type_test->test_type && type_test->operand->type == GDScriptParser::Node::IDENTIFIER && static_cast<const GDScriptParser::IdentifierNode *>(type_test->operand)->name == p_identifier->name && static_cast<const GDScriptParser::IdentifierNode *>(type_test->operand)->source == p_identifier->source) {
  2090. // Bingo.
  2091. GDScriptParser::CompletionContext c = p_context;
  2092. c.current_line = type_test->operand->start_line;
  2093. c.current_suite = suite;
  2094. if (type_test->test_datatype.is_hard_type()) {
  2095. id_type.type = type_test->test_datatype;
  2096. if (last_assign_line < c.current_line) {
  2097. // Override last assignment.
  2098. last_assign_line = c.current_line;
  2099. last_assigned_expression = nullptr;
  2100. }
  2101. }
  2102. }
  2103. }
  2104. suite = suite->parent_block;
  2105. }
  2106. if (last_assigned_expression && last_assign_line < p_context.current_line) {
  2107. GDScriptParser::CompletionContext c = p_context;
  2108. c.current_line = last_assign_line;
  2109. GDScriptCompletionIdentifier assigned_type;
  2110. if (_guess_expression_type(c, last_assigned_expression, assigned_type)) {
  2111. if (id_type.type.is_set() && (assigned_type.type.kind == GDScriptParser::DataType::VARIANT || (assigned_type.type.is_set() && !GDScriptAnalyzer::check_type_compatibility(id_type.type, assigned_type.type)))) {
  2112. // The assigned type is incompatible. The annotated type takes priority.
  2113. r_type = id_type;
  2114. r_type.assigned_expression = last_assigned_expression;
  2115. } else {
  2116. r_type = assigned_type;
  2117. }
  2118. return true;
  2119. }
  2120. }
  2121. if (is_function_parameter && p_context.current_function && p_context.current_function->source_lambda == nullptr && p_context.current_class) {
  2122. // Check if it's override of native function, then we can assume the type from the signature.
  2123. GDScriptParser::DataType base_type = p_context.current_class->base_type;
  2124. while (base_type.is_set()) {
  2125. switch (base_type.kind) {
  2126. case GDScriptParser::DataType::CLASS:
  2127. if (base_type.class_type->has_function(p_context.current_function->identifier->name)) {
  2128. GDScriptParser::FunctionNode *parent_function = base_type.class_type->get_member(p_context.current_function->identifier->name).function;
  2129. if (parent_function->parameters_indices.has(p_identifier->name)) {
  2130. const GDScriptParser::ParameterNode *parameter = parent_function->parameters[parent_function->parameters_indices[p_identifier->name]];
  2131. if ((!id_type.type.is_set() || id_type.type.is_variant()) && parameter->get_datatype().is_hard_type()) {
  2132. id_type.type = parameter->get_datatype();
  2133. }
  2134. if (parameter->initializer) {
  2135. GDScriptParser::CompletionContext c = p_context;
  2136. c.current_function = parent_function;
  2137. c.current_class = base_type.class_type;
  2138. c.base = nullptr;
  2139. if (_guess_expression_type(c, parameter->initializer, r_type)) {
  2140. return true;
  2141. }
  2142. }
  2143. }
  2144. }
  2145. base_type = base_type.class_type->base_type;
  2146. break;
  2147. case GDScriptParser::DataType::NATIVE: {
  2148. if (id_type.type.is_set() && !id_type.type.is_variant()) {
  2149. base_type = GDScriptParser::DataType();
  2150. break;
  2151. }
  2152. MethodInfo info;
  2153. if (ClassDB::get_method_info(base_type.native_type, p_context.current_function->identifier->name, &info)) {
  2154. for (const PropertyInfo &E : info.arguments) {
  2155. if (E.name == p_identifier->name) {
  2156. r_type = _type_from_property(E);
  2157. return true;
  2158. }
  2159. }
  2160. }
  2161. base_type = GDScriptParser::DataType();
  2162. } break;
  2163. default:
  2164. break;
  2165. }
  2166. }
  2167. }
  2168. if (id_type.type.is_set() && !id_type.type.is_variant()) {
  2169. r_type = id_type;
  2170. return true;
  2171. }
  2172. // Check global scripts.
  2173. if (ScriptServer::is_global_class(p_identifier->name)) {
  2174. String script = ScriptServer::get_global_class_path(p_identifier->name);
  2175. if (script.to_lower().ends_with(".gd")) {
  2176. Ref<GDScriptParserRef> parser = p_context.parser->get_depended_parser_for(script);
  2177. if (parser.is_valid() && parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED) == OK) {
  2178. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2179. r_type.type.script_path = script;
  2180. r_type.type.class_type = parser->get_parser()->get_tree();
  2181. r_type.type.is_meta_type = true;
  2182. r_type.type.is_constant = false;
  2183. r_type.type.kind = GDScriptParser::DataType::CLASS;
  2184. r_type.value = Variant();
  2185. return true;
  2186. }
  2187. } else {
  2188. Ref<Script> scr = ResourceLoader::load(ScriptServer::get_global_class_path(p_identifier->name));
  2189. if (scr.is_valid()) {
  2190. r_type = _type_from_variant(scr, p_context);
  2191. r_type.type.is_meta_type = true;
  2192. return true;
  2193. }
  2194. }
  2195. return false;
  2196. }
  2197. // Check global variables (including autoloads).
  2198. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(p_identifier->name)) {
  2199. r_type = _type_from_variant(GDScriptLanguage::get_singleton()->get_named_globals_map()[p_identifier->name], p_context);
  2200. return true;
  2201. }
  2202. // Check ClassDB.
  2203. if (ClassDB::class_exists(p_identifier->name) && ClassDB::is_class_exposed(p_identifier->name)) {
  2204. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2205. r_type.type.kind = GDScriptParser::DataType::NATIVE;
  2206. r_type.type.builtin_type = Variant::OBJECT;
  2207. r_type.type.native_type = p_identifier->name;
  2208. r_type.type.is_constant = true;
  2209. if (Engine::get_singleton()->has_singleton(p_identifier->name)) {
  2210. r_type.type.is_meta_type = false;
  2211. r_type.value = Engine::get_singleton()->get_singleton_object(p_identifier->name);
  2212. } else {
  2213. r_type.type.is_meta_type = true;
  2214. r_type.value = Variant();
  2215. }
  2216. return true;
  2217. }
  2218. return false;
  2219. }
  2220. static bool _guess_identifier_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_identifier, GDScriptCompletionIdentifier &r_type) {
  2221. static int recursion_depth = 0;
  2222. RecursionCheck recursion(&recursion_depth);
  2223. if (unlikely(recursion.check())) {
  2224. ERR_FAIL_V_MSG(false, "Reached recursion limit while trying to guess type.");
  2225. }
  2226. GDScriptParser::DataType base_type = p_base.type;
  2227. bool is_static = base_type.is_meta_type;
  2228. while (base_type.is_set()) {
  2229. switch (base_type.kind) {
  2230. case GDScriptParser::DataType::CLASS:
  2231. if (base_type.class_type->has_member(p_identifier)) {
  2232. const GDScriptParser::ClassNode::Member &member = base_type.class_type->get_member(p_identifier);
  2233. switch (member.type) {
  2234. case GDScriptParser::ClassNode::Member::CONSTANT:
  2235. r_type.type = member.constant->get_datatype();
  2236. if (member.constant->initializer && member.constant->initializer->is_constant) {
  2237. r_type.value = member.constant->initializer->reduced_value;
  2238. }
  2239. return true;
  2240. case GDScriptParser::ClassNode::Member::VARIABLE:
  2241. if (!is_static || member.variable->is_static) {
  2242. if (member.variable->get_datatype().is_set() && !member.variable->get_datatype().is_variant()) {
  2243. r_type.type = member.variable->get_datatype();
  2244. return true;
  2245. } else if (member.variable->initializer) {
  2246. const GDScriptParser::ExpressionNode *init = member.variable->initializer;
  2247. if (init->is_constant) {
  2248. r_type.value = init->reduced_value;
  2249. r_type = _type_from_variant(init->reduced_value, p_context);
  2250. return true;
  2251. } else if (init->start_line == p_context.current_line) {
  2252. return false;
  2253. // Detects if variable is assigned to itself
  2254. } else if (_is_expression_named_identifier(init, member.variable->identifier->name)) {
  2255. if (member.variable->initializer->get_datatype().is_set()) {
  2256. r_type.type = member.variable->initializer->get_datatype();
  2257. } else if (member.variable->get_datatype().is_set() && !member.variable->get_datatype().is_variant()) {
  2258. r_type.type = member.variable->get_datatype();
  2259. }
  2260. return true;
  2261. } else if (_guess_expression_type(p_context, init, r_type)) {
  2262. return true;
  2263. } else if (init->get_datatype().is_set() && !init->get_datatype().is_variant()) {
  2264. r_type.type = init->get_datatype();
  2265. return true;
  2266. }
  2267. }
  2268. }
  2269. // TODO: Check assignments in constructor.
  2270. return false;
  2271. case GDScriptParser::ClassNode::Member::ENUM:
  2272. r_type.type = member.m_enum->get_datatype();
  2273. r_type.enumeration = member.m_enum->identifier->name;
  2274. return true;
  2275. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  2276. r_type = _type_from_variant(member.enum_value.value, p_context);
  2277. return true;
  2278. case GDScriptParser::ClassNode::Member::SIGNAL:
  2279. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2280. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  2281. r_type.type.builtin_type = Variant::SIGNAL;
  2282. r_type.type.method_info = member.signal->method_info;
  2283. return true;
  2284. case GDScriptParser::ClassNode::Member::FUNCTION:
  2285. if (is_static && !member.function->is_static) {
  2286. return false;
  2287. }
  2288. r_type = _callable_type_from_method_info(member.function->info);
  2289. return true;
  2290. case GDScriptParser::ClassNode::Member::CLASS:
  2291. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2292. r_type.type.kind = GDScriptParser::DataType::CLASS;
  2293. r_type.type.class_type = member.m_class;
  2294. r_type.type.is_meta_type = true;
  2295. return true;
  2296. case GDScriptParser::ClassNode::Member::GROUP:
  2297. return false; // No-op, but silences warnings.
  2298. case GDScriptParser::ClassNode::Member::UNDEFINED:
  2299. return false; // Unreachable.
  2300. }
  2301. return false;
  2302. }
  2303. base_type = base_type.class_type->base_type;
  2304. break;
  2305. case GDScriptParser::DataType::SCRIPT: {
  2306. Ref<Script> scr = base_type.script_type;
  2307. if (scr.is_valid()) {
  2308. HashMap<StringName, Variant> constants;
  2309. scr->get_constants(&constants);
  2310. if (constants.has(p_identifier)) {
  2311. r_type = _type_from_variant(constants[p_identifier], p_context);
  2312. return true;
  2313. }
  2314. List<PropertyInfo> members;
  2315. if (is_static) {
  2316. scr->get_property_list(&members);
  2317. } else {
  2318. scr->get_script_property_list(&members);
  2319. }
  2320. for (const PropertyInfo &prop : members) {
  2321. if (prop.name == p_identifier) {
  2322. r_type = _type_from_property(prop);
  2323. return true;
  2324. }
  2325. }
  2326. if (scr->has_method(p_identifier)) {
  2327. MethodInfo mi = scr->get_method_info(p_identifier);
  2328. r_type = _callable_type_from_method_info(mi);
  2329. return true;
  2330. }
  2331. Ref<Script> parent = scr->get_base_script();
  2332. if (parent.is_valid()) {
  2333. base_type.script_type = parent;
  2334. } else {
  2335. base_type.kind = GDScriptParser::DataType::NATIVE;
  2336. base_type.builtin_type = Variant::OBJECT;
  2337. base_type.native_type = scr->get_instance_base_type();
  2338. }
  2339. } else {
  2340. return false;
  2341. }
  2342. } break;
  2343. case GDScriptParser::DataType::NATIVE: {
  2344. StringName class_name = base_type.native_type;
  2345. if (!ClassDB::class_exists(class_name)) {
  2346. return false;
  2347. }
  2348. // Skip constants since they're all integers. Type does not matter because int has no members.
  2349. PropertyInfo prop;
  2350. if (ClassDB::get_property_info(class_name, p_identifier, &prop)) {
  2351. StringName getter = ClassDB::get_property_getter(class_name, p_identifier);
  2352. if (getter != StringName()) {
  2353. MethodBind *g = ClassDB::get_method(class_name, getter);
  2354. if (g) {
  2355. r_type = _type_from_property(g->get_return_info());
  2356. return true;
  2357. }
  2358. } else {
  2359. r_type = _type_from_property(prop);
  2360. return true;
  2361. }
  2362. }
  2363. MethodInfo method;
  2364. if (ClassDB::get_method_info(class_name, p_identifier, &method)) {
  2365. r_type = _callable_type_from_method_info(method);
  2366. return true;
  2367. }
  2368. if (ClassDB::has_enum(class_name, p_identifier)) {
  2369. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2370. r_type.type.kind = GDScriptParser::DataType::ENUM;
  2371. r_type.type.enum_type = p_identifier;
  2372. r_type.type.is_constant = true;
  2373. r_type.type.is_meta_type = true;
  2374. r_type.type.native_type = String(class_name) + "." + p_identifier;
  2375. return true;
  2376. }
  2377. return false;
  2378. } break;
  2379. case GDScriptParser::DataType::BUILTIN: {
  2380. if (Variant::has_builtin_method(base_type.builtin_type, p_identifier)) {
  2381. r_type = _callable_type_from_method_info(Variant::get_builtin_method_info(base_type.builtin_type, p_identifier));
  2382. return true;
  2383. } else {
  2384. Callable::CallError err;
  2385. Variant tmp;
  2386. Variant::construct(base_type.builtin_type, tmp, nullptr, 0, err);
  2387. if (err.error != Callable::CallError::CALL_OK) {
  2388. return false;
  2389. }
  2390. bool valid = false;
  2391. Variant res = tmp.get(p_identifier, &valid);
  2392. if (valid) {
  2393. r_type = _type_from_variant(res, p_context);
  2394. r_type.value = Variant();
  2395. r_type.type.is_constant = false;
  2396. return true;
  2397. }
  2398. }
  2399. return false;
  2400. } break;
  2401. default: {
  2402. return false;
  2403. } break;
  2404. }
  2405. }
  2406. return false;
  2407. }
  2408. static void _find_last_return_in_block(GDScriptParser::CompletionContext &p_context, int &r_last_return_line, const GDScriptParser::ExpressionNode **r_last_returned_value) {
  2409. if (!p_context.current_suite) {
  2410. return;
  2411. }
  2412. for (int i = 0; i < p_context.current_suite->statements.size(); i++) {
  2413. if (p_context.current_suite->statements[i]->start_line < r_last_return_line) {
  2414. break;
  2415. }
  2416. GDScriptParser::CompletionContext c = p_context;
  2417. switch (p_context.current_suite->statements[i]->type) {
  2418. case GDScriptParser::Node::FOR:
  2419. c.current_suite = static_cast<const GDScriptParser::ForNode *>(p_context.current_suite->statements[i])->loop;
  2420. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2421. break;
  2422. case GDScriptParser::Node::WHILE:
  2423. c.current_suite = static_cast<const GDScriptParser::WhileNode *>(p_context.current_suite->statements[i])->loop;
  2424. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2425. break;
  2426. case GDScriptParser::Node::IF: {
  2427. const GDScriptParser::IfNode *_if = static_cast<const GDScriptParser::IfNode *>(p_context.current_suite->statements[i]);
  2428. c.current_suite = _if->true_block;
  2429. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2430. if (_if->false_block) {
  2431. c.current_suite = _if->false_block;
  2432. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2433. }
  2434. } break;
  2435. case GDScriptParser::Node::MATCH: {
  2436. const GDScriptParser::MatchNode *match = static_cast<const GDScriptParser::MatchNode *>(p_context.current_suite->statements[i]);
  2437. for (int j = 0; j < match->branches.size(); j++) {
  2438. c.current_suite = match->branches[j]->block;
  2439. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2440. }
  2441. } break;
  2442. case GDScriptParser::Node::RETURN: {
  2443. const GDScriptParser::ReturnNode *ret = static_cast<const GDScriptParser::ReturnNode *>(p_context.current_suite->statements[i]);
  2444. if (ret->return_value) {
  2445. if (ret->start_line > r_last_return_line) {
  2446. r_last_return_line = ret->start_line;
  2447. *r_last_returned_value = ret->return_value;
  2448. }
  2449. }
  2450. } break;
  2451. default:
  2452. break;
  2453. }
  2454. }
  2455. }
  2456. static bool _guess_method_return_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_method, GDScriptCompletionIdentifier &r_type) {
  2457. static int recursion_depth = 0;
  2458. RecursionCheck recursion(&recursion_depth);
  2459. if (unlikely(recursion.check())) {
  2460. ERR_FAIL_V_MSG(false, "Reached recursion limit while trying to guess type.");
  2461. }
  2462. GDScriptParser::DataType base_type = p_base.type;
  2463. bool is_static = base_type.is_meta_type;
  2464. if (is_static && p_method == SNAME("new")) {
  2465. r_type.type = base_type;
  2466. r_type.type.is_meta_type = false;
  2467. r_type.type.is_constant = false;
  2468. return true;
  2469. }
  2470. while (base_type.is_set() && !base_type.is_variant()) {
  2471. switch (base_type.kind) {
  2472. case GDScriptParser::DataType::CLASS:
  2473. if (base_type.class_type->has_function(p_method)) {
  2474. GDScriptParser::FunctionNode *method = base_type.class_type->get_member(p_method).function;
  2475. if (!is_static || method->is_static) {
  2476. if (method->get_datatype().is_set() && !method->get_datatype().is_variant()) {
  2477. r_type.type = method->get_datatype();
  2478. return true;
  2479. }
  2480. int last_return_line = -1;
  2481. const GDScriptParser::ExpressionNode *last_returned_value = nullptr;
  2482. GDScriptParser::CompletionContext c = p_context;
  2483. c.current_class = base_type.class_type;
  2484. c.current_function = method;
  2485. c.current_suite = method->body;
  2486. _find_last_return_in_block(c, last_return_line, &last_returned_value);
  2487. if (last_returned_value) {
  2488. c.current_line = c.current_suite->end_line;
  2489. if (_guess_expression_type(c, last_returned_value, r_type)) {
  2490. return true;
  2491. }
  2492. }
  2493. }
  2494. }
  2495. base_type = base_type.class_type->base_type;
  2496. break;
  2497. case GDScriptParser::DataType::SCRIPT: {
  2498. Ref<Script> scr = base_type.script_type;
  2499. if (scr.is_valid()) {
  2500. List<MethodInfo> methods;
  2501. scr->get_script_method_list(&methods);
  2502. for (const MethodInfo &mi : methods) {
  2503. if (mi.name == p_method) {
  2504. r_type = _type_from_property(mi.return_val);
  2505. return true;
  2506. }
  2507. }
  2508. Ref<Script> base_script = scr->get_base_script();
  2509. if (base_script.is_valid()) {
  2510. base_type.script_type = base_script;
  2511. } else {
  2512. base_type.kind = GDScriptParser::DataType::NATIVE;
  2513. base_type.builtin_type = Variant::OBJECT;
  2514. base_type.native_type = scr->get_instance_base_type();
  2515. }
  2516. } else {
  2517. return false;
  2518. }
  2519. } break;
  2520. case GDScriptParser::DataType::NATIVE: {
  2521. if (!ClassDB::class_exists(base_type.native_type)) {
  2522. return false;
  2523. }
  2524. MethodBind *mb = ClassDB::get_method(base_type.native_type, p_method);
  2525. if (mb) {
  2526. r_type = _type_from_property(mb->get_return_info());
  2527. return true;
  2528. }
  2529. return false;
  2530. } break;
  2531. case GDScriptParser::DataType::BUILTIN: {
  2532. Callable::CallError err;
  2533. Variant tmp;
  2534. Variant::construct(base_type.builtin_type, tmp, nullptr, 0, err);
  2535. if (err.error != Callable::CallError::CALL_OK) {
  2536. return false;
  2537. }
  2538. List<MethodInfo> methods;
  2539. tmp.get_method_list(&methods);
  2540. for (const MethodInfo &mi : methods) {
  2541. if (mi.name == p_method) {
  2542. r_type = _type_from_property(mi.return_val);
  2543. return true;
  2544. }
  2545. }
  2546. return false;
  2547. } break;
  2548. default: {
  2549. return false;
  2550. }
  2551. }
  2552. }
  2553. return false;
  2554. }
  2555. static bool _guess_expecting_callable(GDScriptParser::CompletionContext &p_context) {
  2556. if (p_context.call.call != nullptr && p_context.call.call->type == GDScriptParser::Node::CALL) {
  2557. GDScriptParser::CallNode *call_node = static_cast<GDScriptParser::CallNode *>(p_context.call.call);
  2558. GDScriptCompletionIdentifier ci;
  2559. if (_guess_expression_type(p_context, call_node->callee, ci)) {
  2560. if (ci.type.kind == GDScriptParser::DataType::BUILTIN && ci.type.builtin_type == Variant::CALLABLE) {
  2561. if (p_context.call.argument >= 0 && p_context.call.argument < ci.type.method_info.arguments.size()) {
  2562. return ci.type.method_info.arguments.get(p_context.call.argument).type == Variant::CALLABLE;
  2563. }
  2564. }
  2565. }
  2566. }
  2567. return false;
  2568. }
  2569. static void _find_enumeration_candidates(GDScriptParser::CompletionContext &p_context, const String &p_enum_hint, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result) {
  2570. if (!p_enum_hint.contains_char('.')) {
  2571. // Global constant or in the current class.
  2572. StringName current_enum = p_enum_hint;
  2573. if (p_context.current_class && p_context.current_class->has_member(current_enum) && p_context.current_class->get_member(current_enum).type == GDScriptParser::ClassNode::Member::ENUM) {
  2574. const GDScriptParser::EnumNode *_enum = p_context.current_class->get_member(current_enum).m_enum;
  2575. for (int i = 0; i < _enum->values.size(); i++) {
  2576. ScriptLanguage::CodeCompletionOption option(_enum->values[i].identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM);
  2577. r_result.insert(option.display, option);
  2578. }
  2579. } else {
  2580. for (int i = 0; i < CoreConstants::get_global_constant_count(); i++) {
  2581. if (CoreConstants::get_global_constant_enum(i) == current_enum) {
  2582. ScriptLanguage::CodeCompletionOption option(CoreConstants::get_global_constant_name(i), ScriptLanguage::CODE_COMPLETION_KIND_ENUM);
  2583. r_result.insert(option.display, option);
  2584. }
  2585. }
  2586. }
  2587. } else {
  2588. String class_name = p_enum_hint.get_slicec('.', 0);
  2589. String enum_name = p_enum_hint.get_slicec('.', 1);
  2590. if (!ClassDB::class_exists(class_name)) {
  2591. return;
  2592. }
  2593. List<StringName> enum_constants;
  2594. ClassDB::get_enum_constants(class_name, enum_name, &enum_constants);
  2595. for (const StringName &E : enum_constants) {
  2596. String candidate = class_name + "." + E;
  2597. int location = _get_enum_constant_location(class_name, E);
  2598. ScriptLanguage::CodeCompletionOption option(candidate, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, location);
  2599. r_result.insert(option.display, option);
  2600. }
  2601. }
  2602. }
  2603. static void _find_call_arguments(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_method, int p_argidx, bool p_static, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, String &r_arghint) {
  2604. Variant base = p_base.value;
  2605. GDScriptParser::DataType base_type = p_base.type;
  2606. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  2607. const bool use_string_names = EDITOR_GET("text_editor/completion/add_string_name_literals");
  2608. const bool use_node_paths = EDITOR_GET("text_editor/completion/add_node_path_literals");
  2609. while (base_type.is_set() && !base_type.is_variant()) {
  2610. switch (base_type.kind) {
  2611. case GDScriptParser::DataType::CLASS: {
  2612. if (base_type.is_meta_type && p_method == SNAME("new")) {
  2613. const GDScriptParser::ClassNode *current = base_type.class_type;
  2614. do {
  2615. if (current->has_member("_init")) {
  2616. const GDScriptParser::ClassNode::Member &member = current->get_member("_init");
  2617. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION) {
  2618. r_arghint = base_type.class_type->get_datatype().to_string() + " new" + _make_arguments_hint(member.function, p_argidx, true);
  2619. return;
  2620. }
  2621. }
  2622. current = current->base_type.class_type;
  2623. } while (current != nullptr);
  2624. r_arghint = base_type.class_type->get_datatype().to_string() + " new()";
  2625. return;
  2626. }
  2627. if (base_type.class_type->has_member(p_method)) {
  2628. const GDScriptParser::ClassNode::Member &member = base_type.class_type->get_member(p_method);
  2629. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION) {
  2630. r_arghint = _make_arguments_hint(member.function, p_argidx);
  2631. return;
  2632. }
  2633. }
  2634. base_type = base_type.class_type->base_type;
  2635. } break;
  2636. case GDScriptParser::DataType::SCRIPT: {
  2637. if (base_type.script_type->is_valid() && base_type.script_type->has_method(p_method)) {
  2638. r_arghint = _make_arguments_hint(base_type.script_type->get_method_info(p_method), p_argidx);
  2639. return;
  2640. }
  2641. Ref<Script> base_script = base_type.script_type->get_base_script();
  2642. if (base_script.is_valid()) {
  2643. base_type.script_type = base_script;
  2644. } else {
  2645. base_type.kind = GDScriptParser::DataType::NATIVE;
  2646. base_type.builtin_type = Variant::OBJECT;
  2647. base_type.native_type = base_type.script_type->get_instance_base_type();
  2648. }
  2649. } break;
  2650. case GDScriptParser::DataType::NATIVE: {
  2651. StringName class_name = base_type.native_type;
  2652. if (!ClassDB::class_exists(class_name)) {
  2653. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2654. break;
  2655. }
  2656. MethodInfo info;
  2657. int method_args = 0;
  2658. if (ClassDB::get_method_info(class_name, p_method, &info)) {
  2659. method_args = info.arguments.size();
  2660. if (base.get_type() == Variant::OBJECT) {
  2661. Object *obj = base.operator Object *();
  2662. if (obj) {
  2663. List<String> options;
  2664. obj->get_argument_options(p_method, p_argidx, &options);
  2665. for (String &opt : options) {
  2666. // Handle user preference.
  2667. if (opt.is_quoted()) {
  2668. opt = opt.unquote().quote(quote_style);
  2669. if (use_string_names && info.arguments[p_argidx].type == Variant::STRING_NAME) {
  2670. opt = "&" + opt;
  2671. } else if (use_node_paths && info.arguments[p_argidx].type == Variant::NODE_PATH) {
  2672. opt = "^" + opt;
  2673. }
  2674. }
  2675. ScriptLanguage::CodeCompletionOption option(opt, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  2676. r_result.insert(option.display, option);
  2677. }
  2678. }
  2679. }
  2680. if (p_argidx < method_args) {
  2681. const PropertyInfo &arg_info = info.arguments[p_argidx];
  2682. if (arg_info.usage & (PROPERTY_USAGE_CLASS_IS_ENUM | PROPERTY_USAGE_CLASS_IS_BITFIELD)) {
  2683. _find_enumeration_candidates(p_context, arg_info.class_name, r_result);
  2684. }
  2685. }
  2686. r_arghint = _make_arguments_hint(info, p_argidx);
  2687. }
  2688. if (p_argidx == 1 && p_context.node && p_context.node->type == GDScriptParser::Node::CALL && ClassDB::is_parent_class(class_name, SNAME("Tween")) && p_method == SNAME("tween_property")) {
  2689. // Get tweened objects properties.
  2690. if (static_cast<GDScriptParser::CallNode *>(p_context.node)->arguments.is_empty()) {
  2691. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2692. break;
  2693. }
  2694. GDScriptParser::ExpressionNode *tweened_object = static_cast<GDScriptParser::CallNode *>(p_context.node)->arguments[0];
  2695. if (!tweened_object) {
  2696. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2697. break;
  2698. }
  2699. StringName native_type = tweened_object->datatype.native_type;
  2700. switch (tweened_object->datatype.kind) {
  2701. case GDScriptParser::DataType::SCRIPT: {
  2702. Ref<Script> script = tweened_object->datatype.script_type;
  2703. native_type = script->get_instance_base_type();
  2704. int n = 0;
  2705. while (script.is_valid()) {
  2706. List<PropertyInfo> properties;
  2707. script->get_script_property_list(&properties);
  2708. for (const PropertyInfo &E : properties) {
  2709. if (E.usage & (PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_INTERNAL)) {
  2710. continue;
  2711. }
  2712. String name = E.name.quote(quote_style);
  2713. if (use_node_paths) {
  2714. name = "^" + name;
  2715. }
  2716. ScriptLanguage::CodeCompletionOption option(name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, ScriptLanguage::CodeCompletionLocation::LOCATION_LOCAL + n);
  2717. r_result.insert(option.display, option);
  2718. }
  2719. script = script->get_base_script();
  2720. n++;
  2721. }
  2722. } break;
  2723. case GDScriptParser::DataType::CLASS: {
  2724. GDScriptParser::ClassNode *clss = tweened_object->datatype.class_type;
  2725. native_type = clss->base_type.native_type;
  2726. int n = 0;
  2727. while (clss) {
  2728. for (GDScriptParser::ClassNode::Member member : clss->members) {
  2729. if (member.type == GDScriptParser::ClassNode::Member::VARIABLE) {
  2730. String name = member.get_name().quote(quote_style);
  2731. if (use_node_paths) {
  2732. name = "^" + name;
  2733. }
  2734. ScriptLanguage::CodeCompletionOption option(name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, ScriptLanguage::CodeCompletionLocation::LOCATION_LOCAL + n);
  2735. r_result.insert(option.display, option);
  2736. }
  2737. }
  2738. if (clss->base_type.kind == GDScriptParser::DataType::Kind::CLASS) {
  2739. clss = clss->base_type.class_type;
  2740. n++;
  2741. } else {
  2742. native_type = clss->base_type.native_type;
  2743. clss = nullptr;
  2744. }
  2745. }
  2746. } break;
  2747. default:
  2748. break;
  2749. }
  2750. List<PropertyInfo> properties;
  2751. ClassDB::get_property_list(native_type, &properties);
  2752. for (const PropertyInfo &E : properties) {
  2753. if (E.usage & (PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_INTERNAL)) {
  2754. continue;
  2755. }
  2756. String name = E.name.quote(quote_style);
  2757. if (use_node_paths) {
  2758. name = "^" + name;
  2759. }
  2760. ScriptLanguage::CodeCompletionOption option(name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER);
  2761. r_result.insert(option.display, option);
  2762. }
  2763. }
  2764. if (p_argidx == 0 && ClassDB::is_parent_class(class_name, SNAME("Node")) && (p_method == SNAME("get_node") || p_method == SNAME("has_node"))) {
  2765. // Get autoloads
  2766. List<PropertyInfo> props;
  2767. ProjectSettings::get_singleton()->get_property_list(&props);
  2768. for (const PropertyInfo &E : props) {
  2769. String s = E.name;
  2770. if (!s.begins_with("autoload/")) {
  2771. continue;
  2772. }
  2773. String name = s.get_slicec('/', 1);
  2774. String path = ("/root/" + name).quote(quote_style);
  2775. if (use_node_paths) {
  2776. path = "^" + path;
  2777. }
  2778. ScriptLanguage::CodeCompletionOption option(path, ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH);
  2779. r_result.insert(option.display, option);
  2780. }
  2781. }
  2782. if (p_argidx == 0 && method_args > 0 && ClassDB::is_parent_class(class_name, SNAME("InputEvent")) && p_method.operator String().contains("action")) {
  2783. // Get input actions
  2784. List<PropertyInfo> props;
  2785. ProjectSettings::get_singleton()->get_property_list(&props);
  2786. for (const PropertyInfo &E : props) {
  2787. String s = E.name;
  2788. if (!s.begins_with("input/")) {
  2789. continue;
  2790. }
  2791. String name = s.get_slicec('/', 1).quote(quote_style);
  2792. if (use_string_names) {
  2793. name = "&" + name;
  2794. }
  2795. ScriptLanguage::CodeCompletionOption option(name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  2796. r_result.insert(option.display, option);
  2797. }
  2798. }
  2799. if (EDITOR_GET("text_editor/completion/complete_file_paths")) {
  2800. if (p_argidx == 0 && p_method == SNAME("change_scene_to_file") && ClassDB::is_parent_class(class_name, SNAME("SceneTree"))) {
  2801. HashMap<String, ScriptLanguage::CodeCompletionOption> list;
  2802. _get_directory_contents(EditorFileSystem::get_singleton()->get_filesystem(), list, SNAME("PackedScene"));
  2803. for (const KeyValue<String, ScriptLanguage::CodeCompletionOption> &key_value_pair : list) {
  2804. ScriptLanguage::CodeCompletionOption option = key_value_pair.value;
  2805. r_result.insert(option.display, option);
  2806. }
  2807. }
  2808. }
  2809. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2810. } break;
  2811. case GDScriptParser::DataType::BUILTIN: {
  2812. if (base.get_type() == Variant::NIL) {
  2813. Callable::CallError err;
  2814. Variant::construct(base_type.builtin_type, base, nullptr, 0, err);
  2815. if (err.error != Callable::CallError::CALL_OK) {
  2816. return;
  2817. }
  2818. }
  2819. List<MethodInfo> methods;
  2820. base.get_method_list(&methods);
  2821. for (const MethodInfo &E : methods) {
  2822. if (E.name == p_method) {
  2823. r_arghint = _make_arguments_hint(E, p_argidx);
  2824. return;
  2825. }
  2826. }
  2827. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2828. } break;
  2829. default: {
  2830. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2831. } break;
  2832. }
  2833. }
  2834. }
  2835. static bool _get_subscript_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::SubscriptNode *p_subscript, GDScriptParser::DataType &r_base_type, Variant *r_base = nullptr) {
  2836. if (p_context.base == nullptr) {
  2837. return false;
  2838. }
  2839. const GDScriptParser::GetNodeNode *get_node = nullptr;
  2840. switch (p_subscript->base->type) {
  2841. case GDScriptParser::Node::GET_NODE: {
  2842. get_node = static_cast<GDScriptParser::GetNodeNode *>(p_subscript->base);
  2843. } break;
  2844. case GDScriptParser::Node::IDENTIFIER: {
  2845. const GDScriptParser::IdentifierNode *identifier_node = static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base);
  2846. switch (identifier_node->source) {
  2847. case GDScriptParser::IdentifierNode::Source::MEMBER_VARIABLE: {
  2848. if (p_context.current_class != nullptr) {
  2849. const StringName &member_name = identifier_node->name;
  2850. const GDScriptParser::ClassNode *current_class = p_context.current_class;
  2851. if (current_class->has_member(member_name)) {
  2852. const GDScriptParser::ClassNode::Member &member = current_class->get_member(member_name);
  2853. if (member.type == GDScriptParser::ClassNode::Member::VARIABLE) {
  2854. const GDScriptParser::VariableNode *variable = static_cast<GDScriptParser::VariableNode *>(member.variable);
  2855. if (variable->initializer && variable->initializer->type == GDScriptParser::Node::GET_NODE) {
  2856. get_node = static_cast<GDScriptParser::GetNodeNode *>(variable->initializer);
  2857. }
  2858. }
  2859. }
  2860. }
  2861. } break;
  2862. case GDScriptParser::IdentifierNode::Source::LOCAL_VARIABLE: {
  2863. // TODO: Do basic assignment flow analysis like in `_guess_expression_type`.
  2864. const GDScriptParser::SuiteNode::Local local = identifier_node->suite->get_local(identifier_node->name);
  2865. switch (local.type) {
  2866. case GDScriptParser::SuiteNode::Local::CONSTANT: {
  2867. if (local.constant->initializer && local.constant->initializer->type == GDScriptParser::Node::GET_NODE) {
  2868. get_node = static_cast<GDScriptParser::GetNodeNode *>(local.constant->initializer);
  2869. }
  2870. } break;
  2871. case GDScriptParser::SuiteNode::Local::VARIABLE: {
  2872. if (local.variable->initializer && local.variable->initializer->type == GDScriptParser::Node::GET_NODE) {
  2873. get_node = static_cast<GDScriptParser::GetNodeNode *>(local.variable->initializer);
  2874. }
  2875. } break;
  2876. default: {
  2877. } break;
  2878. }
  2879. } break;
  2880. default: {
  2881. } break;
  2882. }
  2883. } break;
  2884. default: {
  2885. } break;
  2886. }
  2887. if (get_node != nullptr) {
  2888. const Object *node = p_context.base->call("get_node_or_null", NodePath(get_node->full_path));
  2889. if (node != nullptr) {
  2890. GDScriptParser::DataType assigned_type = _type_from_variant(node, p_context).type;
  2891. GDScriptParser::DataType base_type = p_subscript->base->datatype;
  2892. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER && base_type.type_source == GDScriptParser::DataType::ANNOTATED_EXPLICIT && (assigned_type.kind != base_type.kind || assigned_type.script_path != base_type.script_path || assigned_type.native_type != base_type.native_type)) {
  2893. // Annotated type takes precedence.
  2894. return false;
  2895. }
  2896. if (r_base != nullptr) {
  2897. *r_base = node;
  2898. }
  2899. r_base_type.type_source = GDScriptParser::DataType::INFERRED;
  2900. r_base_type.builtin_type = Variant::OBJECT;
  2901. r_base_type.native_type = node->get_class_name();
  2902. Ref<Script> scr = node->get_script();
  2903. if (scr.is_null()) {
  2904. r_base_type.kind = GDScriptParser::DataType::NATIVE;
  2905. } else {
  2906. r_base_type.kind = GDScriptParser::DataType::SCRIPT;
  2907. r_base_type.script_type = scr;
  2908. }
  2909. return true;
  2910. }
  2911. }
  2912. return false;
  2913. }
  2914. static void _find_call_arguments(GDScriptParser::CompletionContext &p_context, const GDScriptParser::Node *p_call, int p_argidx, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, bool &r_forced, String &r_arghint) {
  2915. if (p_call->type == GDScriptParser::Node::PRELOAD) {
  2916. if (p_argidx == 0 && bool(EDITOR_GET("text_editor/completion/complete_file_paths"))) {
  2917. _get_directory_contents(EditorFileSystem::get_singleton()->get_filesystem(), r_result);
  2918. }
  2919. MethodInfo mi(PropertyInfo(Variant::OBJECT, "resource", PROPERTY_HINT_RESOURCE_TYPE, "Resource"), "preload", PropertyInfo(Variant::STRING, "path"));
  2920. r_arghint = _make_arguments_hint(mi, p_argidx);
  2921. return;
  2922. } else if (p_call->type != GDScriptParser::Node::CALL) {
  2923. return;
  2924. }
  2925. Variant base;
  2926. GDScriptParser::DataType base_type;
  2927. bool _static = false;
  2928. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(p_call);
  2929. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  2930. if (callee_type == GDScriptParser::Node::SUBSCRIPT) {
  2931. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(call->callee);
  2932. if (subscript->base != nullptr && subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  2933. const GDScriptParser::IdentifierNode *base_identifier = static_cast<const GDScriptParser::IdentifierNode *>(subscript->base);
  2934. Variant::Type method_type = GDScriptParser::get_builtin_type(base_identifier->name);
  2935. if (method_type < Variant::VARIANT_MAX) {
  2936. Variant v;
  2937. Callable::CallError err;
  2938. Variant::construct(method_type, v, nullptr, 0, err);
  2939. if (err.error != Callable::CallError::CALL_OK) {
  2940. return;
  2941. }
  2942. List<MethodInfo> methods;
  2943. v.get_method_list(&methods);
  2944. for (MethodInfo &E : methods) {
  2945. if (p_argidx >= E.arguments.size()) {
  2946. continue;
  2947. }
  2948. if (E.name == call->function_name) {
  2949. r_arghint += _make_arguments_hint(E, p_argidx);
  2950. return;
  2951. }
  2952. }
  2953. }
  2954. }
  2955. if (subscript->is_attribute) {
  2956. bool found_type = _get_subscript_type(p_context, subscript, base_type, &base);
  2957. if (!found_type) {
  2958. GDScriptCompletionIdentifier ci;
  2959. if (_guess_expression_type(p_context, subscript->base, ci)) {
  2960. base_type = ci.type;
  2961. base = ci.value;
  2962. } else {
  2963. return;
  2964. }
  2965. }
  2966. _static = base_type.is_meta_type;
  2967. }
  2968. } else if (Variant::has_utility_function(call->function_name)) {
  2969. MethodInfo info = Variant::get_utility_function_info(call->function_name);
  2970. r_arghint = _make_arguments_hint(info, p_argidx);
  2971. return;
  2972. } else if (GDScriptUtilityFunctions::function_exists(call->function_name)) {
  2973. MethodInfo info = GDScriptUtilityFunctions::get_function_info(call->function_name);
  2974. r_arghint = _make_arguments_hint(info, p_argidx);
  2975. return;
  2976. } else if (GDScriptParser::get_builtin_type(call->function_name) < Variant::VARIANT_MAX) {
  2977. // Complete constructor.
  2978. List<MethodInfo> constructors;
  2979. Variant::get_constructor_list(GDScriptParser::get_builtin_type(call->function_name), &constructors);
  2980. int i = 0;
  2981. for (const MethodInfo &E : constructors) {
  2982. if (p_argidx >= E.arguments.size()) {
  2983. continue;
  2984. }
  2985. if (i > 0) {
  2986. r_arghint += "\n";
  2987. }
  2988. r_arghint += _make_arguments_hint(E, p_argidx);
  2989. i++;
  2990. }
  2991. return;
  2992. } else if (call->is_super || callee_type == GDScriptParser::Node::IDENTIFIER) {
  2993. base = p_context.base;
  2994. if (p_context.current_class) {
  2995. base_type = p_context.current_class->get_datatype();
  2996. _static = !p_context.current_function || p_context.current_function->is_static;
  2997. }
  2998. } else {
  2999. return;
  3000. }
  3001. GDScriptCompletionIdentifier ci;
  3002. ci.type = base_type;
  3003. ci.value = base;
  3004. _find_call_arguments(p_context, ci, call->function_name, p_argidx, _static, r_result, r_arghint);
  3005. r_forced = r_result.size() > 0;
  3006. }
  3007. ::Error GDScriptLanguage::complete_code(const String &p_code, const String &p_path, Object *p_owner, List<ScriptLanguage::CodeCompletionOption> *r_options, bool &r_forced, String &r_call_hint) {
  3008. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  3009. GDScriptParser parser;
  3010. GDScriptAnalyzer analyzer(&parser);
  3011. parser.parse(p_code, p_path, true);
  3012. analyzer.analyze();
  3013. r_forced = false;
  3014. HashMap<String, ScriptLanguage::CodeCompletionOption> options;
  3015. GDScriptParser::CompletionContext completion_context = parser.get_completion_context();
  3016. if (completion_context.current_class != nullptr && completion_context.current_class->outer == nullptr) {
  3017. completion_context.base = p_owner;
  3018. }
  3019. bool is_function = false;
  3020. switch (completion_context.type) {
  3021. case GDScriptParser::COMPLETION_NONE:
  3022. break;
  3023. case GDScriptParser::COMPLETION_ANNOTATION: {
  3024. List<MethodInfo> annotations;
  3025. parser.get_annotation_list(&annotations);
  3026. for (const MethodInfo &E : annotations) {
  3027. ScriptLanguage::CodeCompletionOption option(E.name.substr(1), ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3028. if (E.arguments.size() > 0) {
  3029. option.insert_text += "(";
  3030. }
  3031. options.insert(option.display, option);
  3032. }
  3033. r_forced = true;
  3034. } break;
  3035. case GDScriptParser::COMPLETION_ANNOTATION_ARGUMENTS: {
  3036. if (completion_context.node == nullptr || completion_context.node->type != GDScriptParser::Node::ANNOTATION) {
  3037. break;
  3038. }
  3039. const GDScriptParser::AnnotationNode *annotation = static_cast<const GDScriptParser::AnnotationNode *>(completion_context.node);
  3040. _find_annotation_arguments(annotation, completion_context.current_argument, quote_style, options, r_call_hint);
  3041. r_forced = true;
  3042. } break;
  3043. case GDScriptParser::COMPLETION_BUILT_IN_TYPE_CONSTANT_OR_STATIC_METHOD: {
  3044. // Constants.
  3045. {
  3046. List<StringName> constants;
  3047. Variant::get_constants_for_type(completion_context.builtin_type, &constants);
  3048. for (const StringName &E : constants) {
  3049. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  3050. bool valid = false;
  3051. Variant default_value = Variant::get_constant_value(completion_context.builtin_type, E, &valid);
  3052. if (valid) {
  3053. option.default_value = default_value;
  3054. }
  3055. options.insert(option.display, option);
  3056. }
  3057. }
  3058. // Methods.
  3059. {
  3060. List<StringName> methods;
  3061. Variant::get_builtin_method_list(completion_context.builtin_type, &methods);
  3062. for (const StringName &E : methods) {
  3063. if (Variant::is_builtin_method_static(completion_context.builtin_type, E)) {
  3064. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  3065. if (!_guess_expecting_callable(completion_context)) {
  3066. if (Variant::get_builtin_method_argument_count(completion_context.builtin_type, E) > 0 || Variant::is_builtin_method_vararg(completion_context.builtin_type, E)) {
  3067. option.insert_text += "(";
  3068. } else {
  3069. option.insert_text += "()";
  3070. }
  3071. }
  3072. options.insert(option.display, option);
  3073. }
  3074. }
  3075. }
  3076. } break;
  3077. case GDScriptParser::COMPLETION_INHERIT_TYPE: {
  3078. _list_available_types(true, completion_context, options);
  3079. r_forced = true;
  3080. } break;
  3081. case GDScriptParser::COMPLETION_TYPE_NAME_OR_VOID: {
  3082. ScriptLanguage::CodeCompletionOption option("void", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3083. options.insert(option.display, option);
  3084. }
  3085. [[fallthrough]];
  3086. case GDScriptParser::COMPLETION_TYPE_NAME: {
  3087. _list_available_types(false, completion_context, options);
  3088. r_forced = true;
  3089. } break;
  3090. case GDScriptParser::COMPLETION_PROPERTY_DECLARATION_OR_TYPE: {
  3091. _list_available_types(false, completion_context, options);
  3092. ScriptLanguage::CodeCompletionOption get("get", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3093. options.insert(get.display, get);
  3094. ScriptLanguage::CodeCompletionOption set("set", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3095. options.insert(set.display, set);
  3096. r_forced = true;
  3097. } break;
  3098. case GDScriptParser::COMPLETION_PROPERTY_DECLARATION: {
  3099. ScriptLanguage::CodeCompletionOption get("get", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3100. options.insert(get.display, get);
  3101. ScriptLanguage::CodeCompletionOption set("set", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3102. options.insert(set.display, set);
  3103. r_forced = true;
  3104. } break;
  3105. case GDScriptParser::COMPLETION_PROPERTY_METHOD: {
  3106. if (!completion_context.current_class) {
  3107. break;
  3108. }
  3109. for (int i = 0; i < completion_context.current_class->members.size(); i++) {
  3110. const GDScriptParser::ClassNode::Member &member = completion_context.current_class->members[i];
  3111. if (member.type != GDScriptParser::ClassNode::Member::FUNCTION) {
  3112. continue;
  3113. }
  3114. if (member.function->is_static) {
  3115. continue;
  3116. }
  3117. ScriptLanguage::CodeCompletionOption option(member.function->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  3118. options.insert(option.display, option);
  3119. }
  3120. r_forced = true;
  3121. } break;
  3122. case GDScriptParser::COMPLETION_ASSIGN: {
  3123. GDScriptCompletionIdentifier type;
  3124. if (!completion_context.node || completion_context.node->type != GDScriptParser::Node::ASSIGNMENT) {
  3125. break;
  3126. }
  3127. if (!_guess_expression_type(completion_context, static_cast<const GDScriptParser::AssignmentNode *>(completion_context.node)->assignee, type)) {
  3128. _find_identifiers(completion_context, false, true, options, 0);
  3129. r_forced = true;
  3130. break;
  3131. }
  3132. if (!type.enumeration.is_empty()) {
  3133. _find_enumeration_candidates(completion_context, type.enumeration, options);
  3134. r_forced = options.size() > 0;
  3135. } else {
  3136. _find_identifiers(completion_context, false, true, options, 0);
  3137. r_forced = true;
  3138. }
  3139. } break;
  3140. case GDScriptParser::COMPLETION_METHOD:
  3141. is_function = true;
  3142. [[fallthrough]];
  3143. case GDScriptParser::COMPLETION_IDENTIFIER: {
  3144. _find_identifiers(completion_context, is_function, !_guess_expecting_callable(completion_context), options, 0);
  3145. } break;
  3146. case GDScriptParser::COMPLETION_ATTRIBUTE_METHOD:
  3147. is_function = true;
  3148. [[fallthrough]];
  3149. case GDScriptParser::COMPLETION_ATTRIBUTE: {
  3150. r_forced = true;
  3151. const GDScriptParser::SubscriptNode *attr = static_cast<const GDScriptParser::SubscriptNode *>(completion_context.node);
  3152. if (attr->base) {
  3153. GDScriptCompletionIdentifier base;
  3154. bool found_type = _get_subscript_type(completion_context, attr, base.type);
  3155. if (!found_type && !_guess_expression_type(completion_context, attr->base, base)) {
  3156. break;
  3157. }
  3158. _find_identifiers_in_base(base, is_function, false, !_guess_expecting_callable(completion_context), options, 0);
  3159. }
  3160. } break;
  3161. case GDScriptParser::COMPLETION_SUBSCRIPT: {
  3162. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(completion_context.node);
  3163. GDScriptCompletionIdentifier base;
  3164. const bool res = _guess_expression_type(completion_context, subscript->base, base);
  3165. // If the type is not known, we assume it is BUILTIN, since indices on arrays is the most common use case.
  3166. if (!subscript->is_attribute && (!res || base.type.kind == GDScriptParser::DataType::BUILTIN || base.type.is_variant())) {
  3167. if (base.value.get_type() == Variant::DICTIONARY) {
  3168. List<PropertyInfo> members;
  3169. base.value.get_property_list(&members);
  3170. for (const PropertyInfo &E : members) {
  3171. ScriptLanguage::CodeCompletionOption option(E.name.quote(quote_style), ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, ScriptLanguage::LOCATION_LOCAL);
  3172. options.insert(option.display, option);
  3173. }
  3174. }
  3175. if (!subscript->index || subscript->index->type != GDScriptParser::Node::LITERAL) {
  3176. _find_identifiers(completion_context, false, !_guess_expecting_callable(completion_context), options, 0);
  3177. }
  3178. } else if (res) {
  3179. if (!subscript->is_attribute) {
  3180. // Quote the options if they are not accessed as attribute.
  3181. HashMap<String, ScriptLanguage::CodeCompletionOption> opt;
  3182. _find_identifiers_in_base(base, false, false, false, opt, 0);
  3183. for (const KeyValue<String, CodeCompletionOption> &E : opt) {
  3184. ScriptLanguage::CodeCompletionOption option(E.value.insert_text.quote(quote_style), E.value.kind, E.value.location);
  3185. options.insert(option.display, option);
  3186. }
  3187. } else {
  3188. _find_identifiers_in_base(base, false, false, !_guess_expecting_callable(completion_context), options, 0);
  3189. }
  3190. }
  3191. } break;
  3192. case GDScriptParser::COMPLETION_TYPE_ATTRIBUTE: {
  3193. if (!completion_context.current_class) {
  3194. break;
  3195. }
  3196. const GDScriptParser::TypeNode *type = static_cast<const GDScriptParser::TypeNode *>(completion_context.node);
  3197. ERR_FAIL_INDEX_V_MSG(completion_context.type_chain_index - 1, type->type_chain.size(), Error::ERR_BUG, "Could not complete type argument with out of bounds type chain index.");
  3198. GDScriptCompletionIdentifier base;
  3199. if (_guess_identifier_type(completion_context, type->type_chain[0], base)) {
  3200. bool found = true;
  3201. for (int i = 1; i < completion_context.type_chain_index; i++) {
  3202. GDScriptCompletionIdentifier ci;
  3203. found = _guess_identifier_type_from_base(completion_context, base, type->type_chain[i]->name, ci);
  3204. base = ci;
  3205. if (!found) {
  3206. break;
  3207. }
  3208. }
  3209. if (found) {
  3210. _find_identifiers_in_base(base, false, true, true, options, 0);
  3211. }
  3212. }
  3213. r_forced = true;
  3214. } break;
  3215. case GDScriptParser::COMPLETION_RESOURCE_PATH: {
  3216. if (EDITOR_GET("text_editor/completion/complete_file_paths")) {
  3217. _get_directory_contents(EditorFileSystem::get_singleton()->get_filesystem(), options);
  3218. r_forced = true;
  3219. }
  3220. } break;
  3221. case GDScriptParser::COMPLETION_CALL_ARGUMENTS: {
  3222. if (!completion_context.node) {
  3223. break;
  3224. }
  3225. _find_call_arguments(completion_context, completion_context.node, completion_context.current_argument, options, r_forced, r_call_hint);
  3226. } break;
  3227. case GDScriptParser::COMPLETION_OVERRIDE_METHOD: {
  3228. GDScriptParser::DataType native_type = completion_context.current_class->base_type;
  3229. GDScriptParser::FunctionNode *function_node = static_cast<GDScriptParser::FunctionNode *>(completion_context.node);
  3230. bool is_static = function_node != nullptr && function_node->is_static;
  3231. while (native_type.is_set() && native_type.kind != GDScriptParser::DataType::NATIVE) {
  3232. switch (native_type.kind) {
  3233. case GDScriptParser::DataType::CLASS: {
  3234. for (const GDScriptParser::ClassNode::Member &member : native_type.class_type->members) {
  3235. if (member.type != GDScriptParser::ClassNode::Member::FUNCTION) {
  3236. continue;
  3237. }
  3238. if (options.has(member.function->identifier->name)) {
  3239. continue;
  3240. }
  3241. if (completion_context.current_class->has_function(member.get_name()) && completion_context.current_class->get_member(member.get_name()).function != function_node) {
  3242. continue;
  3243. }
  3244. if (is_static != member.function->is_static) {
  3245. continue;
  3246. }
  3247. String display_name = member.function->identifier->name;
  3248. display_name += member.function->signature + ":";
  3249. ScriptLanguage::CodeCompletionOption option(display_name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  3250. options.insert(member.function->identifier->name, option); // Insert name instead of display to track duplicates.
  3251. }
  3252. native_type = native_type.class_type->base_type;
  3253. } break;
  3254. default: {
  3255. native_type.kind = GDScriptParser::DataType::UNRESOLVED;
  3256. } break;
  3257. }
  3258. }
  3259. if (!native_type.is_set()) {
  3260. break;
  3261. }
  3262. StringName class_name = native_type.native_type;
  3263. if (!ClassDB::class_exists(class_name)) {
  3264. break;
  3265. }
  3266. const bool type_hints = EditorSettings::get_singleton()->get_setting("text_editor/completion/add_type_hints");
  3267. List<MethodInfo> virtual_methods;
  3268. if (is_static) {
  3269. // Not truly a virtual method, but can also be "overridden".
  3270. MethodInfo static_init("_static_init");
  3271. static_init.return_val.type = Variant::NIL;
  3272. static_init.flags |= METHOD_FLAG_STATIC | METHOD_FLAG_VIRTUAL;
  3273. virtual_methods.push_back(static_init);
  3274. } else {
  3275. ClassDB::get_virtual_methods(class_name, &virtual_methods);
  3276. }
  3277. for (const MethodInfo &mi : virtual_methods) {
  3278. if (options.has(mi.name)) {
  3279. continue;
  3280. }
  3281. if (completion_context.current_class->has_function(mi.name) && completion_context.current_class->get_member(mi.name).function != function_node) {
  3282. continue;
  3283. }
  3284. String method_hint = mi.name;
  3285. if (method_hint.contains_char(':')) {
  3286. method_hint = method_hint.get_slicec(':', 0);
  3287. }
  3288. method_hint += "(";
  3289. for (int64_t i = 0; i < mi.arguments.size(); ++i) {
  3290. if (i > 0) {
  3291. method_hint += ", ";
  3292. }
  3293. String arg = mi.arguments[i].name;
  3294. if (arg.contains_char(':')) {
  3295. arg = arg.substr(0, arg.find_char(':'));
  3296. }
  3297. method_hint += arg;
  3298. if (type_hints) {
  3299. method_hint += ": " + _get_visual_datatype(mi.arguments[i], true, class_name);
  3300. }
  3301. }
  3302. if (mi.flags & METHOD_FLAG_VARARG) {
  3303. if (!mi.arguments.is_empty()) {
  3304. method_hint += ", ";
  3305. }
  3306. method_hint += "...args"; // `MethodInfo` does not support the rest parameter name.
  3307. if (type_hints) {
  3308. method_hint += ": Array";
  3309. }
  3310. }
  3311. method_hint += ")";
  3312. if (type_hints) {
  3313. method_hint += " -> " + _get_visual_datatype(mi.return_val, false, class_name);
  3314. }
  3315. method_hint += ":";
  3316. ScriptLanguage::CodeCompletionOption option(method_hint, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  3317. options.insert(option.display, option);
  3318. }
  3319. } break;
  3320. case GDScriptParser::COMPLETION_GET_NODE: {
  3321. // Handles the `$Node/Path` or `$"Some NodePath"` syntax specifically.
  3322. if (p_owner) {
  3323. List<String> opts;
  3324. p_owner->get_argument_options("get_node", 0, &opts);
  3325. bool for_unique_name = false;
  3326. if (completion_context.node != nullptr && completion_context.node->type == GDScriptParser::Node::GET_NODE && !static_cast<GDScriptParser::GetNodeNode *>(completion_context.node)->use_dollar) {
  3327. for_unique_name = true;
  3328. }
  3329. for (const String &E : opts) {
  3330. r_forced = true;
  3331. String opt = E.strip_edges();
  3332. if (opt.is_quoted()) {
  3333. // Remove quotes so that we can handle user preferred quote style,
  3334. // or handle NodePaths which are valid identifiers and don't need quotes.
  3335. opt = opt.unquote();
  3336. }
  3337. if (for_unique_name) {
  3338. if (!opt.begins_with("%")) {
  3339. continue;
  3340. }
  3341. opt = opt.substr(1);
  3342. }
  3343. // The path needs quotes if at least one of its components (excluding `%` prefix and `/` separations)
  3344. // is not a valid identifier.
  3345. bool path_needs_quote = false;
  3346. for (const String &part : opt.trim_prefix("%").split("/")) {
  3347. if (!part.is_valid_ascii_identifier()) {
  3348. path_needs_quote = true;
  3349. break;
  3350. }
  3351. }
  3352. if (path_needs_quote) {
  3353. // Ignore quote_style and just use double quotes for paths with apostrophes.
  3354. // Double quotes don't need to be checked because they're not valid in node and property names.
  3355. opt = opt.quote(opt.contains_char('\'') ? "\"" : quote_style); // Handle user preference.
  3356. }
  3357. ScriptLanguage::CodeCompletionOption option(opt, ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH);
  3358. options.insert(option.display, option);
  3359. }
  3360. if (!for_unique_name) {
  3361. // Get autoloads.
  3362. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : ProjectSettings::get_singleton()->get_autoload_list()) {
  3363. String path = "/root/" + E.key;
  3364. ScriptLanguage::CodeCompletionOption option(path.quote(quote_style), ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH);
  3365. options.insert(option.display, option);
  3366. }
  3367. }
  3368. }
  3369. } break;
  3370. case GDScriptParser::COMPLETION_SUPER_METHOD: {
  3371. if (!completion_context.current_class) {
  3372. break;
  3373. }
  3374. _find_identifiers_in_class(completion_context.current_class, true, false, false, true, !_guess_expecting_callable(completion_context), options, 0);
  3375. } break;
  3376. }
  3377. for (const KeyValue<String, ScriptLanguage::CodeCompletionOption> &E : options) {
  3378. r_options->push_back(E.value);
  3379. }
  3380. return OK;
  3381. }
  3382. #else // !TOOLS_ENABLED
  3383. Error GDScriptLanguage::complete_code(const String &p_code, const String &p_path, Object *p_owner, List<ScriptLanguage::CodeCompletionOption> *r_options, bool &r_forced, String &r_call_hint) {
  3384. return OK;
  3385. }
  3386. #endif // TOOLS_ENABLED
  3387. //////// END COMPLETION //////////
  3388. String GDScriptLanguage::_get_indentation() const {
  3389. #ifdef TOOLS_ENABLED
  3390. if (Engine::get_singleton()->is_editor_hint()) {
  3391. bool use_space_indentation = EDITOR_GET("text_editor/behavior/indent/type");
  3392. if (use_space_indentation) {
  3393. int indent_size = EDITOR_GET("text_editor/behavior/indent/size");
  3394. return String(" ").repeat(indent_size);
  3395. }
  3396. }
  3397. #endif
  3398. return "\t";
  3399. }
  3400. void GDScriptLanguage::auto_indent_code(String &p_code, int p_from_line, int p_to_line) const {
  3401. String indent = _get_indentation();
  3402. Vector<String> lines = p_code.split("\n");
  3403. List<int> indent_stack;
  3404. for (int i = 0; i < lines.size(); i++) {
  3405. String l = lines[i];
  3406. int tc = 0;
  3407. for (int j = 0; j < l.length(); j++) {
  3408. if (l[j] == ' ' || l[j] == '\t') {
  3409. tc++;
  3410. } else {
  3411. break;
  3412. }
  3413. }
  3414. String st = l.substr(tc).strip_edges();
  3415. if (st.is_empty() || st.begins_with("#")) {
  3416. continue; //ignore!
  3417. }
  3418. int ilevel = 0;
  3419. if (indent_stack.size()) {
  3420. ilevel = indent_stack.back()->get();
  3421. }
  3422. if (tc > ilevel) {
  3423. indent_stack.push_back(tc);
  3424. } else if (tc < ilevel) {
  3425. while (indent_stack.size() && indent_stack.back()->get() > tc) {
  3426. indent_stack.pop_back();
  3427. }
  3428. if (indent_stack.size() && indent_stack.back()->get() != tc) {
  3429. indent_stack.push_back(tc); // this is not right but gets the job done
  3430. }
  3431. }
  3432. if (i >= p_from_line) {
  3433. l = indent.repeat(indent_stack.size()) + st;
  3434. } else if (i > p_to_line) {
  3435. break;
  3436. }
  3437. lines.write[i] = l;
  3438. }
  3439. p_code = "";
  3440. for (int i = 0; i < lines.size(); i++) {
  3441. if (i > 0) {
  3442. p_code += "\n";
  3443. }
  3444. p_code += lines[i];
  3445. }
  3446. }
  3447. #ifdef TOOLS_ENABLED
  3448. static Error _lookup_symbol_from_base(const GDScriptParser::DataType &p_base, const String &p_symbol, GDScriptLanguage::LookupResult &r_result) {
  3449. GDScriptParser::DataType base_type = p_base;
  3450. while (true) {
  3451. switch (base_type.kind) {
  3452. case GDScriptParser::DataType::CLASS: {
  3453. ERR_FAIL_NULL_V(base_type.class_type, ERR_BUG);
  3454. String name = p_symbol;
  3455. if (name == "new") {
  3456. name = "_init";
  3457. }
  3458. if (!base_type.class_type->has_member(name)) {
  3459. base_type = base_type.class_type->base_type;
  3460. break;
  3461. }
  3462. const GDScriptParser::ClassNode::Member &member = base_type.class_type->get_member(name);
  3463. switch (member.type) {
  3464. case GDScriptParser::ClassNode::Member::UNDEFINED:
  3465. case GDScriptParser::ClassNode::Member::GROUP:
  3466. return ERR_BUG;
  3467. case GDScriptParser::ClassNode::Member::CLASS: {
  3468. String doc_type_name;
  3469. String doc_enum_name;
  3470. GDScriptDocGen::doctype_from_gdtype(GDScriptAnalyzer::type_from_metatype(member.get_datatype()), doc_type_name, doc_enum_name);
  3471. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3472. r_result.class_name = doc_type_name;
  3473. } break;
  3474. case GDScriptParser::ClassNode::Member::CONSTANT:
  3475. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3476. break;
  3477. case GDScriptParser::ClassNode::Member::FUNCTION:
  3478. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3479. break;
  3480. case GDScriptParser::ClassNode::Member::SIGNAL:
  3481. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_SIGNAL;
  3482. break;
  3483. case GDScriptParser::ClassNode::Member::VARIABLE:
  3484. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  3485. break;
  3486. case GDScriptParser::ClassNode::Member::ENUM:
  3487. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3488. break;
  3489. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  3490. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3491. break;
  3492. }
  3493. if (member.type != GDScriptParser::ClassNode::Member::CLASS) {
  3494. String doc_type_name;
  3495. String doc_enum_name;
  3496. GDScriptDocGen::doctype_from_gdtype(GDScriptAnalyzer::type_from_metatype(base_type), doc_type_name, doc_enum_name);
  3497. r_result.class_name = doc_type_name;
  3498. r_result.class_member = name;
  3499. }
  3500. Error err = OK;
  3501. r_result.script = GDScriptCache::get_shallow_script(base_type.script_path, err);
  3502. r_result.script_path = base_type.script_path;
  3503. r_result.location = member.get_line();
  3504. return err;
  3505. } break;
  3506. case GDScriptParser::DataType::SCRIPT: {
  3507. const Ref<Script> scr = base_type.script_type;
  3508. if (scr.is_null()) {
  3509. return ERR_CANT_RESOLVE;
  3510. }
  3511. String name = p_symbol;
  3512. if (name == "new") {
  3513. name = "_init";
  3514. }
  3515. const int line = scr->get_member_line(name);
  3516. if (line >= 0) {
  3517. bool found_type = false;
  3518. r_result.type = ScriptLanguage::LOOKUP_RESULT_SCRIPT_LOCATION;
  3519. {
  3520. List<PropertyInfo> properties;
  3521. scr->get_script_property_list(&properties);
  3522. for (const PropertyInfo &property : properties) {
  3523. if (property.name == name && (property.usage & PROPERTY_USAGE_SCRIPT_VARIABLE)) {
  3524. found_type = true;
  3525. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  3526. r_result.class_name = scr->get_doc_class_name();
  3527. r_result.class_member = name;
  3528. break;
  3529. }
  3530. }
  3531. }
  3532. if (!found_type) {
  3533. List<MethodInfo> methods;
  3534. scr->get_script_method_list(&methods);
  3535. for (const MethodInfo &method : methods) {
  3536. if (method.name == name) {
  3537. found_type = true;
  3538. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3539. r_result.class_name = scr->get_doc_class_name();
  3540. r_result.class_member = name;
  3541. break;
  3542. }
  3543. }
  3544. }
  3545. if (!found_type) {
  3546. List<MethodInfo> signals;
  3547. scr->get_script_method_list(&signals);
  3548. for (const MethodInfo &signal : signals) {
  3549. if (signal.name == name) {
  3550. found_type = true;
  3551. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_SIGNAL;
  3552. r_result.class_name = scr->get_doc_class_name();
  3553. r_result.class_member = name;
  3554. break;
  3555. }
  3556. }
  3557. }
  3558. if (!found_type) {
  3559. const Ref<GDScript> gds = scr;
  3560. if (gds.is_valid()) {
  3561. const Ref<GDScript> *subclass = gds->get_subclasses().getptr(name);
  3562. if (subclass != nullptr) {
  3563. found_type = true;
  3564. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3565. r_result.class_name = subclass->ptr()->get_doc_class_name();
  3566. }
  3567. // TODO: enums.
  3568. }
  3569. }
  3570. if (!found_type) {
  3571. HashMap<StringName, Variant> constants;
  3572. scr->get_constants(&constants);
  3573. if (constants.has(name)) {
  3574. found_type = true;
  3575. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3576. r_result.class_name = scr->get_doc_class_name();
  3577. r_result.class_member = name;
  3578. }
  3579. }
  3580. r_result.script = scr;
  3581. r_result.script_path = base_type.script_path;
  3582. r_result.location = line;
  3583. return OK;
  3584. }
  3585. const Ref<Script> base_script = scr->get_base_script();
  3586. if (base_script.is_valid()) {
  3587. base_type.script_type = base_script;
  3588. } else {
  3589. base_type.kind = GDScriptParser::DataType::NATIVE;
  3590. base_type.builtin_type = Variant::OBJECT;
  3591. base_type.native_type = scr->get_instance_base_type();
  3592. }
  3593. } break;
  3594. case GDScriptParser::DataType::NATIVE: {
  3595. const StringName &class_name = base_type.native_type;
  3596. ERR_FAIL_COND_V(!ClassDB::class_exists(class_name), ERR_BUG);
  3597. if (ClassDB::has_method(class_name, p_symbol, true)) {
  3598. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3599. r_result.class_name = class_name;
  3600. r_result.class_member = p_symbol;
  3601. return OK;
  3602. }
  3603. List<MethodInfo> virtual_methods;
  3604. ClassDB::get_virtual_methods(class_name, &virtual_methods, true);
  3605. for (const MethodInfo &E : virtual_methods) {
  3606. if (E.name == p_symbol) {
  3607. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3608. r_result.class_name = class_name;
  3609. r_result.class_member = p_symbol;
  3610. return OK;
  3611. }
  3612. }
  3613. if (ClassDB::has_signal(class_name, p_symbol, true)) {
  3614. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_SIGNAL;
  3615. r_result.class_name = class_name;
  3616. r_result.class_member = p_symbol;
  3617. return OK;
  3618. }
  3619. List<StringName> enums;
  3620. ClassDB::get_enum_list(class_name, &enums);
  3621. for (const StringName &E : enums) {
  3622. if (E == p_symbol) {
  3623. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3624. r_result.class_name = class_name;
  3625. r_result.class_member = p_symbol;
  3626. return OK;
  3627. }
  3628. }
  3629. if (!String(ClassDB::get_integer_constant_enum(class_name, p_symbol, true)).is_empty()) {
  3630. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3631. r_result.class_name = class_name;
  3632. r_result.class_member = p_symbol;
  3633. return OK;
  3634. }
  3635. List<String> constants;
  3636. ClassDB::get_integer_constant_list(class_name, &constants, true);
  3637. for (const String &E : constants) {
  3638. if (E == p_symbol) {
  3639. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3640. r_result.class_name = class_name;
  3641. r_result.class_member = p_symbol;
  3642. return OK;
  3643. }
  3644. }
  3645. if (ClassDB::has_property(class_name, p_symbol, true)) {
  3646. PropertyInfo prop_info;
  3647. ClassDB::get_property_info(class_name, p_symbol, &prop_info, true);
  3648. if (prop_info.usage & PROPERTY_USAGE_INTERNAL) {
  3649. return ERR_CANT_RESOLVE;
  3650. }
  3651. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  3652. r_result.class_name = class_name;
  3653. r_result.class_member = p_symbol;
  3654. return OK;
  3655. }
  3656. const StringName parent_class = ClassDB::get_parent_class(class_name);
  3657. if (parent_class != StringName()) {
  3658. base_type.native_type = parent_class;
  3659. } else {
  3660. return ERR_CANT_RESOLVE;
  3661. }
  3662. } break;
  3663. case GDScriptParser::DataType::BUILTIN: {
  3664. if (base_type.is_meta_type) {
  3665. if (Variant::has_enum(base_type.builtin_type, p_symbol)) {
  3666. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3667. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  3668. r_result.class_member = p_symbol;
  3669. return OK;
  3670. }
  3671. if (Variant::has_constant(base_type.builtin_type, p_symbol)) {
  3672. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3673. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  3674. r_result.class_member = p_symbol;
  3675. return OK;
  3676. }
  3677. } else {
  3678. if (Variant::has_member(base_type.builtin_type, p_symbol)) {
  3679. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  3680. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  3681. r_result.class_member = p_symbol;
  3682. return OK;
  3683. }
  3684. }
  3685. if (Variant::has_builtin_method(base_type.builtin_type, p_symbol)) {
  3686. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3687. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  3688. r_result.class_member = p_symbol;
  3689. return OK;
  3690. }
  3691. return ERR_CANT_RESOLVE;
  3692. } break;
  3693. case GDScriptParser::DataType::ENUM: {
  3694. if (base_type.is_meta_type) {
  3695. if (base_type.enum_values.has(p_symbol)) {
  3696. String doc_type_name;
  3697. String doc_enum_name;
  3698. GDScriptDocGen::doctype_from_gdtype(GDScriptAnalyzer::type_from_metatype(base_type), doc_type_name, doc_enum_name);
  3699. if (CoreConstants::is_global_enum(doc_enum_name)) {
  3700. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3701. r_result.class_name = "@GlobalScope";
  3702. r_result.class_member = p_symbol;
  3703. return OK;
  3704. } else {
  3705. const int dot_pos = doc_enum_name.rfind_char('.');
  3706. if (dot_pos >= 0) {
  3707. Error err = OK;
  3708. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3709. if (base_type.class_type != nullptr) {
  3710. // For script enums the value isn't accessible as class constant so we need the full enum name.
  3711. r_result.class_name = doc_enum_name;
  3712. r_result.class_member = p_symbol;
  3713. r_result.script = GDScriptCache::get_shallow_script(base_type.script_path, err);
  3714. r_result.script_path = base_type.script_path;
  3715. const String enum_name = doc_enum_name.substr(dot_pos + 1);
  3716. if (base_type.class_type->has_member(enum_name)) {
  3717. const GDScriptParser::ClassNode::Member member = base_type.class_type->get_member(enum_name);
  3718. if (member.type == GDScriptParser::ClassNode::Member::ENUM) {
  3719. for (const GDScriptParser::EnumNode::Value &value : member.m_enum->values) {
  3720. if (value.identifier->name == p_symbol) {
  3721. r_result.location = value.line;
  3722. break;
  3723. }
  3724. }
  3725. }
  3726. }
  3727. } else if (base_type.script_type.is_valid()) {
  3728. // For script enums the value isn't accessible as class constant so we need the full enum name.
  3729. r_result.class_name = doc_enum_name;
  3730. r_result.class_member = p_symbol;
  3731. r_result.script = base_type.script_type;
  3732. r_result.script_path = base_type.script_path;
  3733. // TODO: Find a way to obtain enum value location for a script
  3734. r_result.location = base_type.script_type->get_member_line(doc_enum_name.substr(dot_pos + 1));
  3735. } else {
  3736. r_result.class_name = doc_enum_name.left(dot_pos);
  3737. r_result.class_member = p_symbol;
  3738. }
  3739. return err;
  3740. }
  3741. }
  3742. } else if (Variant::has_builtin_method(Variant::DICTIONARY, p_symbol)) {
  3743. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3744. r_result.class_name = "Dictionary";
  3745. r_result.class_member = p_symbol;
  3746. return OK;
  3747. }
  3748. }
  3749. return ERR_CANT_RESOLVE;
  3750. } break;
  3751. case GDScriptParser::DataType::VARIANT: {
  3752. if (base_type.is_meta_type) {
  3753. const String enum_name = "Variant." + p_symbol;
  3754. if (CoreConstants::is_global_enum(enum_name)) {
  3755. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3756. r_result.class_name = "@GlobalScope";
  3757. r_result.class_member = enum_name;
  3758. return OK;
  3759. }
  3760. }
  3761. return ERR_CANT_RESOLVE;
  3762. } break;
  3763. case GDScriptParser::DataType::RESOLVING:
  3764. case GDScriptParser::DataType::UNRESOLVED: {
  3765. return ERR_CANT_RESOLVE;
  3766. } break;
  3767. }
  3768. }
  3769. return ERR_CANT_RESOLVE;
  3770. }
  3771. ::Error GDScriptLanguage::lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result) {
  3772. // Before parsing, try the usual stuff.
  3773. if (ClassDB::class_exists(p_symbol)) {
  3774. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3775. r_result.class_name = p_symbol;
  3776. return OK;
  3777. }
  3778. if (Variant::get_type_by_name(p_symbol) < Variant::VARIANT_MAX) {
  3779. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3780. r_result.class_name = p_symbol;
  3781. return OK;
  3782. }
  3783. if (p_symbol == "Variant") {
  3784. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3785. r_result.class_name = "Variant";
  3786. return OK;
  3787. }
  3788. if (p_symbol == "PI" || p_symbol == "TAU" || p_symbol == "INF" || p_symbol == "NAN") {
  3789. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3790. r_result.class_name = "@GDScript";
  3791. r_result.class_member = p_symbol;
  3792. return OK;
  3793. }
  3794. GDScriptParser parser;
  3795. parser.parse(p_code, p_path, true);
  3796. GDScriptParser::CompletionContext context = parser.get_completion_context();
  3797. context.base = p_owner;
  3798. // Allows class functions with the names like built-ins to be handled properly.
  3799. if (context.type != GDScriptParser::COMPLETION_ATTRIBUTE) {
  3800. // Need special checks for `assert` and `preload` as they are technically
  3801. // keywords, so are not registered in `GDScriptUtilityFunctions`.
  3802. if (GDScriptUtilityFunctions::function_exists(p_symbol) || p_symbol == "assert" || p_symbol == "preload") {
  3803. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3804. r_result.class_name = "@GDScript";
  3805. r_result.class_member = p_symbol;
  3806. return OK;
  3807. }
  3808. }
  3809. GDScriptAnalyzer analyzer(&parser);
  3810. analyzer.analyze();
  3811. if (context.current_class && context.current_class->extends.size() > 0) {
  3812. StringName class_name = context.current_class->extends[0]->name;
  3813. bool success = false;
  3814. ClassDB::get_integer_constant(class_name, p_symbol, &success);
  3815. if (success) {
  3816. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3817. r_result.class_name = class_name;
  3818. r_result.class_member = p_symbol;
  3819. return OK;
  3820. }
  3821. do {
  3822. List<StringName> enums;
  3823. ClassDB::get_enum_list(class_name, &enums, true);
  3824. for (const StringName &enum_name : enums) {
  3825. if (enum_name == p_symbol) {
  3826. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3827. r_result.class_name = class_name;
  3828. r_result.class_member = p_symbol;
  3829. return OK;
  3830. }
  3831. }
  3832. class_name = ClassDB::get_parent_class_nocheck(class_name);
  3833. } while (class_name != StringName());
  3834. }
  3835. const GDScriptParser::TypeNode *type_node = dynamic_cast<const GDScriptParser::TypeNode *>(context.node);
  3836. if (type_node != nullptr && !type_node->type_chain.is_empty()) {
  3837. StringName class_name = type_node->type_chain[0]->name;
  3838. if (ScriptServer::is_global_class(class_name)) {
  3839. class_name = ScriptServer::get_global_class_native_base(class_name);
  3840. }
  3841. do {
  3842. List<StringName> enums;
  3843. ClassDB::get_enum_list(class_name, &enums, true);
  3844. for (const StringName &enum_name : enums) {
  3845. if (enum_name == p_symbol) {
  3846. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3847. r_result.class_name = class_name;
  3848. r_result.class_member = p_symbol;
  3849. return OK;
  3850. }
  3851. }
  3852. class_name = ClassDB::get_parent_class_nocheck(class_name);
  3853. } while (class_name != StringName());
  3854. }
  3855. bool is_function = false;
  3856. switch (context.type) {
  3857. case GDScriptParser::COMPLETION_BUILT_IN_TYPE_CONSTANT_OR_STATIC_METHOD: {
  3858. GDScriptParser::DataType base_type;
  3859. base_type.kind = GDScriptParser::DataType::BUILTIN;
  3860. base_type.builtin_type = context.builtin_type;
  3861. base_type.is_meta_type = true;
  3862. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  3863. return OK;
  3864. }
  3865. } break;
  3866. case GDScriptParser::COMPLETION_SUPER_METHOD:
  3867. case GDScriptParser::COMPLETION_METHOD:
  3868. case GDScriptParser::COMPLETION_ASSIGN:
  3869. case GDScriptParser::COMPLETION_CALL_ARGUMENTS:
  3870. case GDScriptParser::COMPLETION_IDENTIFIER:
  3871. case GDScriptParser::COMPLETION_PROPERTY_METHOD:
  3872. case GDScriptParser::COMPLETION_SUBSCRIPT: {
  3873. GDScriptParser::DataType base_type;
  3874. if (context.current_class) {
  3875. if (context.type != GDScriptParser::COMPLETION_SUPER_METHOD) {
  3876. base_type = context.current_class->get_datatype();
  3877. } else {
  3878. base_type = context.current_class->base_type;
  3879. }
  3880. } else {
  3881. break;
  3882. }
  3883. if (!is_function && context.current_suite) {
  3884. // Lookup local variables.
  3885. const GDScriptParser::SuiteNode *suite = context.current_suite;
  3886. while (suite) {
  3887. if (suite->has_local(p_symbol)) {
  3888. const GDScriptParser::SuiteNode::Local &local = suite->get_local(p_symbol);
  3889. switch (local.type) {
  3890. case GDScriptParser::SuiteNode::Local::UNDEFINED:
  3891. return ERR_BUG;
  3892. case GDScriptParser::SuiteNode::Local::CONSTANT:
  3893. r_result.type = ScriptLanguage::LOOKUP_RESULT_LOCAL_CONSTANT;
  3894. r_result.description = local.constant->doc_data.description;
  3895. r_result.is_deprecated = local.constant->doc_data.is_deprecated;
  3896. r_result.deprecated_message = local.constant->doc_data.deprecated_message;
  3897. r_result.is_experimental = local.constant->doc_data.is_experimental;
  3898. r_result.experimental_message = local.constant->doc_data.experimental_message;
  3899. if (local.constant->initializer != nullptr) {
  3900. r_result.value = GDScriptDocGen::docvalue_from_expression(local.constant->initializer);
  3901. }
  3902. break;
  3903. case GDScriptParser::SuiteNode::Local::VARIABLE:
  3904. r_result.type = ScriptLanguage::LOOKUP_RESULT_LOCAL_VARIABLE;
  3905. r_result.description = local.variable->doc_data.description;
  3906. r_result.is_deprecated = local.variable->doc_data.is_deprecated;
  3907. r_result.deprecated_message = local.variable->doc_data.deprecated_message;
  3908. r_result.is_experimental = local.variable->doc_data.is_experimental;
  3909. r_result.experimental_message = local.variable->doc_data.experimental_message;
  3910. if (local.variable->initializer != nullptr) {
  3911. r_result.value = GDScriptDocGen::docvalue_from_expression(local.variable->initializer);
  3912. }
  3913. break;
  3914. case GDScriptParser::SuiteNode::Local::PARAMETER:
  3915. case GDScriptParser::SuiteNode::Local::FOR_VARIABLE:
  3916. case GDScriptParser::SuiteNode::Local::PATTERN_BIND:
  3917. r_result.type = ScriptLanguage::LOOKUP_RESULT_LOCAL_VARIABLE;
  3918. break;
  3919. }
  3920. GDScriptDocGen::doctype_from_gdtype(local.get_datatype(), r_result.doc_type, r_result.enumeration);
  3921. Error err = OK;
  3922. r_result.script = GDScriptCache::get_shallow_script(base_type.script_path, err);
  3923. r_result.script_path = base_type.script_path;
  3924. r_result.location = local.start_line;
  3925. return err;
  3926. }
  3927. suite = suite->parent_block;
  3928. }
  3929. }
  3930. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  3931. return OK;
  3932. }
  3933. if (!is_function) {
  3934. if (ProjectSettings::get_singleton()->has_autoload(p_symbol)) {
  3935. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(p_symbol);
  3936. if (autoload.is_singleton) {
  3937. String scr_path = autoload.path;
  3938. if (!scr_path.ends_with(".gd")) {
  3939. // Not a script, try find the script anyway, may have some success.
  3940. scr_path = scr_path.get_basename() + ".gd";
  3941. }
  3942. if (FileAccess::exists(scr_path)) {
  3943. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3944. r_result.class_name = p_symbol;
  3945. r_result.script = ResourceLoader::load(scr_path);
  3946. r_result.script_path = scr_path;
  3947. r_result.location = 0;
  3948. return OK;
  3949. }
  3950. }
  3951. }
  3952. if (ScriptServer::is_global_class(p_symbol)) {
  3953. const String scr_path = ScriptServer::get_global_class_path(p_symbol);
  3954. const Ref<Script> scr = ResourceLoader::load(scr_path);
  3955. if (scr.is_null()) {
  3956. return ERR_BUG;
  3957. }
  3958. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3959. r_result.class_name = scr->get_doc_class_name();
  3960. r_result.script = scr;
  3961. r_result.script_path = scr_path;
  3962. r_result.location = 0;
  3963. return OK;
  3964. }
  3965. const HashMap<StringName, int> &global_map = GDScriptLanguage::get_singleton()->get_global_map();
  3966. if (global_map.has(p_symbol)) {
  3967. Variant value = GDScriptLanguage::get_singleton()->get_global_array()[global_map[p_symbol]];
  3968. if (value.get_type() == Variant::OBJECT) {
  3969. const Object *obj = value;
  3970. if (obj) {
  3971. if (Object::cast_to<GDScriptNativeClass>(obj)) {
  3972. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3973. r_result.class_name = Object::cast_to<GDScriptNativeClass>(obj)->get_name();
  3974. } else {
  3975. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3976. r_result.class_name = obj->get_class();
  3977. }
  3978. return OK;
  3979. }
  3980. }
  3981. }
  3982. if (CoreConstants::is_global_enum(p_symbol)) {
  3983. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3984. r_result.class_name = "@GlobalScope";
  3985. r_result.class_member = p_symbol;
  3986. return OK;
  3987. }
  3988. if (CoreConstants::is_global_constant(p_symbol)) {
  3989. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3990. r_result.class_name = "@GlobalScope";
  3991. r_result.class_member = p_symbol;
  3992. return OK;
  3993. }
  3994. if (Variant::has_utility_function(p_symbol)) {
  3995. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3996. r_result.class_name = "@GlobalScope";
  3997. r_result.class_member = p_symbol;
  3998. return OK;
  3999. }
  4000. }
  4001. } break;
  4002. case GDScriptParser::COMPLETION_ATTRIBUTE_METHOD:
  4003. case GDScriptParser::COMPLETION_ATTRIBUTE: {
  4004. if (context.node->type != GDScriptParser::Node::SUBSCRIPT) {
  4005. break;
  4006. }
  4007. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(context.node);
  4008. if (!subscript->is_attribute) {
  4009. break;
  4010. }
  4011. GDScriptCompletionIdentifier base;
  4012. bool found_type = _get_subscript_type(context, subscript, base.type);
  4013. if (!found_type && !_guess_expression_type(context, subscript->base, base)) {
  4014. break;
  4015. }
  4016. if (_lookup_symbol_from_base(base.type, p_symbol, r_result) == OK) {
  4017. return OK;
  4018. }
  4019. } break;
  4020. case GDScriptParser::COMPLETION_TYPE_ATTRIBUTE: {
  4021. if (context.node == nullptr || context.node->type != GDScriptParser::Node::TYPE) {
  4022. break;
  4023. }
  4024. const GDScriptParser::TypeNode *type = static_cast<const GDScriptParser::TypeNode *>(context.node);
  4025. GDScriptParser::DataType base_type;
  4026. const GDScriptParser::IdentifierNode *prev = nullptr;
  4027. for (const GDScriptParser::IdentifierNode *E : type->type_chain) {
  4028. if (E->name == p_symbol && prev != nullptr) {
  4029. base_type = prev->get_datatype();
  4030. break;
  4031. }
  4032. prev = E;
  4033. }
  4034. if (base_type.kind != GDScriptParser::DataType::CLASS) {
  4035. GDScriptCompletionIdentifier base;
  4036. if (!_guess_expression_type(context, prev, base)) {
  4037. break;
  4038. }
  4039. base_type = base.type;
  4040. }
  4041. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  4042. return OK;
  4043. }
  4044. } break;
  4045. case GDScriptParser::COMPLETION_OVERRIDE_METHOD: {
  4046. GDScriptParser::DataType base_type = context.current_class->base_type;
  4047. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  4048. return OK;
  4049. }
  4050. } break;
  4051. case GDScriptParser::COMPLETION_PROPERTY_DECLARATION_OR_TYPE:
  4052. case GDScriptParser::COMPLETION_TYPE_NAME_OR_VOID:
  4053. case GDScriptParser::COMPLETION_TYPE_NAME: {
  4054. GDScriptParser::DataType base_type = context.current_class->get_datatype();
  4055. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  4056. return OK;
  4057. }
  4058. } break;
  4059. case GDScriptParser::COMPLETION_ANNOTATION: {
  4060. const String annotation_symbol = "@" + p_symbol;
  4061. if (parser.annotation_exists(annotation_symbol)) {
  4062. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ANNOTATION;
  4063. r_result.class_name = "@GDScript";
  4064. r_result.class_member = annotation_symbol;
  4065. return OK;
  4066. }
  4067. } break;
  4068. default: {
  4069. }
  4070. }
  4071. return ERR_CANT_RESOLVE;
  4072. }
  4073. #endif // TOOLS_ENABLED