gdscript_editor.cpp 159 KB

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