gdscript_editor.cpp 157 KB

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