gdscript_editor.cpp 123 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506
  1. /*************************************************************************/
  2. /* gdscript_editor.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "gdscript.h"
  31. #include "core/config/engine.h"
  32. #include "core/core_constants.h"
  33. #include "core/io/file_access.h"
  34. #include "gdscript_analyzer.h"
  35. #include "gdscript_compiler.h"
  36. #include "gdscript_parser.h"
  37. #include "gdscript_tokenizer.h"
  38. #include "gdscript_utility_functions.h"
  39. #ifdef TOOLS_ENABLED
  40. #include "core/config/project_settings.h"
  41. #include "editor/editor_file_system.h"
  42. #include "editor/editor_settings.h"
  43. #include "editor/script_templates/templates.gen.h"
  44. #endif
  45. void GDScriptLanguage::get_comment_delimiters(List<String> *p_delimiters) const {
  46. p_delimiters->push_back("#");
  47. }
  48. void GDScriptLanguage::get_string_delimiters(List<String> *p_delimiters) const {
  49. p_delimiters->push_back("\" \"");
  50. p_delimiters->push_back("' '");
  51. p_delimiters->push_back("\"\"\" \"\"\"");
  52. }
  53. bool GDScriptLanguage::is_using_templates() {
  54. return true;
  55. }
  56. Ref<Script> GDScriptLanguage::make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const {
  57. Ref<GDScript> scr;
  58. scr.instantiate();
  59. String processed_template = p_template;
  60. bool type_hints = false;
  61. #ifdef TOOLS_ENABLED
  62. type_hints = EDITOR_GET("text_editor/completion/add_type_hints");
  63. #endif
  64. if (!type_hints) {
  65. processed_template = processed_template.replace(": int", "")
  66. .replace(": String", "")
  67. .replace(": Array[String]", "")
  68. .replace(": float", "")
  69. .replace(":=", "=")
  70. .replace(" -> String", "")
  71. .replace(" -> int", "")
  72. .replace(" -> void", "");
  73. }
  74. processed_template = processed_template.replace("_BASE_", p_base_class_name)
  75. .replace("_CLASS_", p_class_name)
  76. .replace("_TS_", _get_indentation());
  77. scr->set_source_code(processed_template);
  78. return scr;
  79. }
  80. Vector<ScriptLanguage::ScriptTemplate> GDScriptLanguage::get_built_in_templates(StringName p_object) {
  81. Vector<ScriptLanguage::ScriptTemplate> templates;
  82. #ifdef TOOLS_ENABLED
  83. for (int i = 0; i < TEMPLATES_ARRAY_SIZE; i++) {
  84. if (TEMPLATES[i].inherit == p_object) {
  85. templates.append(TEMPLATES[i]);
  86. }
  87. }
  88. #endif
  89. return templates;
  90. }
  91. static void get_function_names_recursively(const GDScriptParser::ClassNode *p_class, const String &p_prefix, HashMap<int, String> &r_funcs) {
  92. for (int i = 0; i < p_class->members.size(); i++) {
  93. if (p_class->members[i].type == GDScriptParser::ClassNode::Member::FUNCTION) {
  94. const GDScriptParser::FunctionNode *function = p_class->members[i].function;
  95. r_funcs[function->start_line] = p_prefix.is_empty() ? String(function->identifier->name) : p_prefix + "." + String(function->identifier->name);
  96. } else if (p_class->members[i].type == GDScriptParser::ClassNode::Member::CLASS) {
  97. String new_prefix = p_class->members[i].m_class->identifier->name;
  98. get_function_names_recursively(p_class->members[i].m_class, p_prefix.is_empty() ? new_prefix : p_prefix + "." + new_prefix, r_funcs);
  99. }
  100. }
  101. }
  102. 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 {
  103. GDScriptParser parser;
  104. GDScriptAnalyzer analyzer(&parser);
  105. Error err = parser.parse(p_script, p_path, false);
  106. if (err == OK) {
  107. err = analyzer.analyze();
  108. }
  109. #ifdef DEBUG_ENABLED
  110. if (r_warnings) {
  111. for (const GDScriptWarning &E : parser.get_warnings()) {
  112. const GDScriptWarning &warn = E;
  113. ScriptLanguage::Warning w;
  114. w.start_line = warn.start_line;
  115. w.end_line = warn.end_line;
  116. w.leftmost_column = warn.leftmost_column;
  117. w.rightmost_column = warn.rightmost_column;
  118. w.code = (int)warn.code;
  119. w.string_code = GDScriptWarning::get_name_from_code(warn.code);
  120. w.message = warn.get_message();
  121. r_warnings->push_back(w);
  122. }
  123. }
  124. #endif
  125. if (err) {
  126. if (r_errors) {
  127. for (const GDScriptParser::ParserError &E : parser.get_errors()) {
  128. const GDScriptParser::ParserError &pe = E;
  129. ScriptLanguage::ScriptError e;
  130. e.line = pe.line;
  131. e.column = pe.column;
  132. e.message = pe.message;
  133. r_errors->push_back(e);
  134. }
  135. }
  136. return false;
  137. } else {
  138. const GDScriptParser::ClassNode *cl = parser.get_tree();
  139. HashMap<int, String> funcs;
  140. get_function_names_recursively(cl, "", funcs);
  141. for (const KeyValue<int, String> &E : funcs) {
  142. r_functions->push_back(E.value + ":" + itos(E.key));
  143. }
  144. }
  145. #ifdef DEBUG_ENABLED
  146. if (r_safe_lines) {
  147. const HashSet<int> &unsafe_lines = parser.get_unsafe_lines();
  148. for (int i = 1; i <= parser.get_last_line_number(); i++) {
  149. if (!unsafe_lines.has(i)) {
  150. r_safe_lines->insert(i);
  151. }
  152. }
  153. }
  154. #endif
  155. return true;
  156. }
  157. bool GDScriptLanguage::has_named_classes() const {
  158. return false;
  159. }
  160. bool GDScriptLanguage::supports_builtin_mode() const {
  161. return true;
  162. }
  163. bool GDScriptLanguage::supports_documentation() const {
  164. return true;
  165. }
  166. int GDScriptLanguage::find_function(const String &p_function, const String &p_code) const {
  167. GDScriptTokenizer tokenizer;
  168. tokenizer.set_source_code(p_code);
  169. int indent = 0;
  170. GDScriptTokenizer::Token current = tokenizer.scan();
  171. while (current.type != GDScriptTokenizer::Token::TK_EOF && current.type != GDScriptTokenizer::Token::ERROR) {
  172. if (current.type == GDScriptTokenizer::Token::INDENT) {
  173. indent++;
  174. } else if (current.type == GDScriptTokenizer::Token::DEDENT) {
  175. indent--;
  176. }
  177. if (indent == 0 && current.type == GDScriptTokenizer::Token::FUNC) {
  178. current = tokenizer.scan();
  179. if (current.is_identifier()) {
  180. String identifier = current.get_identifier();
  181. if (identifier == p_function) {
  182. return current.start_line;
  183. }
  184. }
  185. }
  186. current = tokenizer.scan();
  187. }
  188. return -1;
  189. }
  190. Script *GDScriptLanguage::create_script() const {
  191. return memnew(GDScript);
  192. }
  193. /* DEBUGGER FUNCTIONS */
  194. bool GDScriptLanguage::debug_break_parse(const String &p_file, int p_line, const String &p_error) {
  195. // break because of parse error
  196. if (EngineDebugger::is_active() && Thread::get_caller_id() == Thread::get_main_id()) {
  197. _debug_parse_err_line = p_line;
  198. _debug_parse_err_file = p_file;
  199. _debug_error = p_error;
  200. EngineDebugger::get_script_debugger()->debug(this, false, true);
  201. return true;
  202. } else {
  203. return false;
  204. }
  205. }
  206. bool GDScriptLanguage::debug_break(const String &p_error, bool p_allow_continue) {
  207. if (EngineDebugger::is_active() && Thread::get_caller_id() == Thread::get_main_id()) {
  208. _debug_parse_err_line = -1;
  209. _debug_parse_err_file = "";
  210. _debug_error = p_error;
  211. bool is_error_breakpoint = p_error != "Breakpoint";
  212. EngineDebugger::get_script_debugger()->debug(this, p_allow_continue, is_error_breakpoint);
  213. return true;
  214. } else {
  215. return false;
  216. }
  217. }
  218. String GDScriptLanguage::debug_get_error() const {
  219. return _debug_error;
  220. }
  221. int GDScriptLanguage::debug_get_stack_level_count() const {
  222. if (_debug_parse_err_line >= 0) {
  223. return 1;
  224. }
  225. return _debug_call_stack_pos;
  226. }
  227. int GDScriptLanguage::debug_get_stack_level_line(int p_level) const {
  228. if (_debug_parse_err_line >= 0) {
  229. return _debug_parse_err_line;
  230. }
  231. ERR_FAIL_INDEX_V(p_level, _debug_call_stack_pos, -1);
  232. int l = _debug_call_stack_pos - p_level - 1;
  233. return *(_call_stack[l].line);
  234. }
  235. String GDScriptLanguage::debug_get_stack_level_function(int p_level) const {
  236. if (_debug_parse_err_line >= 0) {
  237. return "";
  238. }
  239. ERR_FAIL_INDEX_V(p_level, _debug_call_stack_pos, "");
  240. int l = _debug_call_stack_pos - p_level - 1;
  241. return _call_stack[l].function->get_name();
  242. }
  243. String GDScriptLanguage::debug_get_stack_level_source(int p_level) const {
  244. if (_debug_parse_err_line >= 0) {
  245. return _debug_parse_err_file;
  246. }
  247. ERR_FAIL_INDEX_V(p_level, _debug_call_stack_pos, "");
  248. int l = _debug_call_stack_pos - p_level - 1;
  249. return _call_stack[l].function->get_source();
  250. }
  251. 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) {
  252. if (_debug_parse_err_line >= 0) {
  253. return;
  254. }
  255. ERR_FAIL_INDEX(p_level, _debug_call_stack_pos);
  256. int l = _debug_call_stack_pos - p_level - 1;
  257. GDScriptFunction *f = _call_stack[l].function;
  258. List<Pair<StringName, int>> locals;
  259. f->debug_get_stack_member_state(*_call_stack[l].line, &locals);
  260. for (const Pair<StringName, int> &E : locals) {
  261. p_locals->push_back(E.first);
  262. p_values->push_back(_call_stack[l].stack[E.second]);
  263. }
  264. }
  265. 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) {
  266. if (_debug_parse_err_line >= 0) {
  267. return;
  268. }
  269. ERR_FAIL_INDEX(p_level, _debug_call_stack_pos);
  270. int l = _debug_call_stack_pos - p_level - 1;
  271. GDScriptInstance *instance = _call_stack[l].instance;
  272. if (!instance) {
  273. return;
  274. }
  275. Ref<GDScript> scr = instance->get_script();
  276. ERR_FAIL_COND(scr.is_null());
  277. const HashMap<StringName, GDScript::MemberInfo> &mi = scr->debug_get_member_indices();
  278. for (const KeyValue<StringName, GDScript::MemberInfo> &E : mi) {
  279. p_members->push_back(E.key);
  280. p_values->push_back(instance->debug_get_member_by_index(E.value.index));
  281. }
  282. }
  283. ScriptInstance *GDScriptLanguage::debug_get_stack_level_instance(int p_level) {
  284. if (_debug_parse_err_line >= 0) {
  285. return nullptr;
  286. }
  287. ERR_FAIL_INDEX_V(p_level, _debug_call_stack_pos, nullptr);
  288. int l = _debug_call_stack_pos - p_level - 1;
  289. ScriptInstance *instance = _call_stack[l].instance;
  290. return instance;
  291. }
  292. void GDScriptLanguage::debug_get_globals(List<String> *p_globals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  293. const HashMap<StringName, int> &name_idx = GDScriptLanguage::get_singleton()->get_global_map();
  294. const Variant *gl_array = GDScriptLanguage::get_singleton()->get_global_array();
  295. List<Pair<String, Variant>> cinfo;
  296. get_public_constants(&cinfo);
  297. for (const KeyValue<StringName, int> &E : name_idx) {
  298. if (ClassDB::class_exists(E.key) || Engine::get_singleton()->has_singleton(E.key)) {
  299. continue;
  300. }
  301. bool is_script_constant = false;
  302. for (List<Pair<String, Variant>>::Element *CE = cinfo.front(); CE; CE = CE->next()) {
  303. if (CE->get().first == E.key) {
  304. is_script_constant = true;
  305. break;
  306. }
  307. }
  308. if (is_script_constant) {
  309. continue;
  310. }
  311. const Variant &var = gl_array[E.value];
  312. if (Object *obj = var) {
  313. if (Object::cast_to<GDScriptNativeClass>(obj)) {
  314. continue;
  315. }
  316. }
  317. bool skip = false;
  318. for (int i = 0; i < CoreConstants::get_global_constant_count(); i++) {
  319. if (E.key == CoreConstants::get_global_constant_name(i)) {
  320. skip = true;
  321. break;
  322. }
  323. }
  324. if (skip) {
  325. continue;
  326. }
  327. p_globals->push_back(E.key);
  328. p_values->push_back(var);
  329. }
  330. }
  331. String GDScriptLanguage::debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems, int p_max_depth) {
  332. return "";
  333. }
  334. void GDScriptLanguage::get_recognized_extensions(List<String> *p_extensions) const {
  335. p_extensions->push_back("gd");
  336. }
  337. void GDScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const {
  338. List<StringName> functions;
  339. GDScriptUtilityFunctions::get_function_list(&functions);
  340. for (const StringName &E : functions) {
  341. p_functions->push_back(GDScriptUtilityFunctions::get_function_info(E));
  342. }
  343. // Not really "functions", but show in documentation.
  344. {
  345. MethodInfo mi;
  346. mi.name = "preload";
  347. mi.arguments.push_back(PropertyInfo(Variant::STRING, "path"));
  348. mi.return_val = PropertyInfo(Variant::OBJECT, "", PROPERTY_HINT_RESOURCE_TYPE, "Resource");
  349. p_functions->push_back(mi);
  350. }
  351. {
  352. MethodInfo mi;
  353. mi.name = "assert";
  354. mi.return_val.type = Variant::NIL;
  355. mi.arguments.push_back(PropertyInfo(Variant::BOOL, "condition"));
  356. mi.arguments.push_back(PropertyInfo(Variant::STRING, "message"));
  357. mi.default_arguments.push_back(String());
  358. p_functions->push_back(mi);
  359. }
  360. }
  361. void GDScriptLanguage::get_public_constants(List<Pair<String, Variant>> *p_constants) const {
  362. Pair<String, Variant> pi;
  363. pi.first = "PI";
  364. pi.second = Math_PI;
  365. p_constants->push_back(pi);
  366. Pair<String, Variant> tau;
  367. tau.first = "TAU";
  368. tau.second = Math_TAU;
  369. p_constants->push_back(tau);
  370. Pair<String, Variant> infinity;
  371. infinity.first = "INF";
  372. infinity.second = INFINITY;
  373. p_constants->push_back(infinity);
  374. Pair<String, Variant> nan;
  375. nan.first = "NAN";
  376. nan.second = NAN;
  377. p_constants->push_back(nan);
  378. }
  379. void GDScriptLanguage::get_public_annotations(List<MethodInfo> *p_annotations) const {
  380. GDScriptParser parser;
  381. List<MethodInfo> annotations;
  382. parser.get_annotation_list(&annotations);
  383. for (const MethodInfo &E : annotations) {
  384. p_annotations->push_back(E);
  385. }
  386. }
  387. String GDScriptLanguage::make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const {
  388. #ifdef TOOLS_ENABLED
  389. bool th = EditorSettings::get_singleton()->get_setting("text_editor/completion/add_type_hints");
  390. #else
  391. bool th = false;
  392. #endif
  393. String s = "func " + p_name + "(";
  394. if (p_args.size()) {
  395. for (int i = 0; i < p_args.size(); i++) {
  396. if (i > 0) {
  397. s += ", ";
  398. }
  399. s += p_args[i].get_slice(":", 0);
  400. if (th) {
  401. String type = p_args[i].get_slice(":", 1);
  402. if (!type.is_empty() && type != "var") {
  403. s += ": " + type;
  404. }
  405. }
  406. }
  407. }
  408. s += String(")") + (th ? " -> void" : "") + ":\n" + _get_indentation() + "pass # Replace with function body.\n";
  409. return s;
  410. }
  411. //////// COMPLETION //////////
  412. #ifdef TOOLS_ENABLED
  413. #define COMPLETION_RECURSION_LIMIT 200
  414. struct GDScriptCompletionIdentifier {
  415. GDScriptParser::DataType type;
  416. String enumeration;
  417. Variant value;
  418. const GDScriptParser::ExpressionNode *assigned_expression = nullptr;
  419. };
  420. // LOCATION METHODS
  421. // These methods are used to populate the `CodeCompletionOption::location` integer.
  422. // For these methods, the location is based on the depth in the inheritance chain that the property
  423. // appears. For example, if you are completing code in a class that inherits Node2D, a property found on Node2D
  424. // will have a "better" (lower) location "score" than a property that is found on CanvasItem.
  425. static int _get_property_location(StringName p_class, StringName p_property) {
  426. if (!ClassDB::has_property(p_class, p_property)) {
  427. return ScriptLanguage::LOCATION_OTHER;
  428. }
  429. int depth = 0;
  430. StringName class_test = p_class;
  431. while (class_test && !ClassDB::has_property(class_test, p_property, true)) {
  432. class_test = ClassDB::get_parent_class(class_test);
  433. depth++;
  434. }
  435. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  436. }
  437. static int _get_constant_location(StringName p_class, StringName p_constant) {
  438. if (!ClassDB::has_integer_constant(p_class, p_constant)) {
  439. return ScriptLanguage::LOCATION_OTHER;
  440. }
  441. int depth = 0;
  442. StringName class_test = p_class;
  443. while (class_test && !ClassDB::has_integer_constant(class_test, p_constant, true)) {
  444. class_test = ClassDB::get_parent_class(class_test);
  445. depth++;
  446. }
  447. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  448. }
  449. static int _get_signal_location(StringName p_class, StringName p_signal) {
  450. if (!ClassDB::has_signal(p_class, p_signal)) {
  451. return ScriptLanguage::LOCATION_OTHER;
  452. }
  453. int depth = 0;
  454. StringName class_test = p_class;
  455. while (class_test && !ClassDB::has_signal(class_test, p_signal, true)) {
  456. class_test = ClassDB::get_parent_class(class_test);
  457. depth++;
  458. }
  459. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  460. }
  461. static int _get_method_location(StringName p_class, StringName p_method) {
  462. if (!ClassDB::has_method(p_class, p_method)) {
  463. return ScriptLanguage::LOCATION_OTHER;
  464. }
  465. int depth = 0;
  466. StringName class_test = p_class;
  467. while (class_test && !ClassDB::has_method(class_test, p_method, true)) {
  468. class_test = ClassDB::get_parent_class(class_test);
  469. depth++;
  470. }
  471. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  472. }
  473. static int _get_enum_constant_location(StringName p_class, StringName p_enum_constant) {
  474. if (!ClassDB::get_integer_constant_enum(p_class, p_enum_constant)) {
  475. return ScriptLanguage::LOCATION_OTHER;
  476. }
  477. int depth = 0;
  478. StringName class_test = p_class;
  479. while (class_test && !ClassDB::get_integer_constant_enum(class_test, p_enum_constant, true)) {
  480. class_test = ClassDB::get_parent_class(class_test);
  481. depth++;
  482. }
  483. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  484. }
  485. // END LOCATION METHODS
  486. static String _get_visual_datatype(const PropertyInfo &p_info, bool p_is_arg = true) {
  487. if (p_info.usage & (PROPERTY_USAGE_CLASS_IS_ENUM | PROPERTY_USAGE_CLASS_IS_BITFIELD)) {
  488. String enum_name = p_info.class_name;
  489. if (!enum_name.contains(".")) {
  490. return enum_name;
  491. }
  492. return enum_name.get_slice(".", 1);
  493. }
  494. String n = p_info.name;
  495. int idx = n.find(":");
  496. if (idx != -1) {
  497. return n.substr(idx + 1, n.length());
  498. }
  499. if (p_info.type == Variant::OBJECT) {
  500. if (p_info.hint == PROPERTY_HINT_RESOURCE_TYPE) {
  501. return p_info.hint_string;
  502. } else {
  503. return p_info.class_name.operator String();
  504. }
  505. }
  506. if (p_info.type == Variant::NIL) {
  507. if (p_is_arg || (p_info.usage & PROPERTY_USAGE_NIL_IS_VARIANT)) {
  508. return "Variant";
  509. } else {
  510. return "void";
  511. }
  512. }
  513. return Variant::get_type_name(p_info.type);
  514. }
  515. static String _make_arguments_hint(const MethodInfo &p_info, int p_arg_idx, bool p_is_annotation = false) {
  516. String arghint;
  517. if (!p_is_annotation) {
  518. arghint += _get_visual_datatype(p_info.return_val, false) + " ";
  519. }
  520. arghint += p_info.name + "(";
  521. int def_args = p_info.arguments.size() - p_info.default_arguments.size();
  522. int i = 0;
  523. for (const PropertyInfo &E : p_info.arguments) {
  524. if (i > 0) {
  525. arghint += ", ";
  526. }
  527. if (i == p_arg_idx) {
  528. arghint += String::chr(0xFFFF);
  529. }
  530. arghint += E.name + ": " + _get_visual_datatype(E, true);
  531. if (i - def_args >= 0) {
  532. arghint += String(" = ") + p_info.default_arguments[i - def_args].get_construct_string();
  533. }
  534. if (i == p_arg_idx) {
  535. arghint += String::chr(0xFFFF);
  536. }
  537. i++;
  538. }
  539. if (p_info.flags & METHOD_FLAG_VARARG) {
  540. if (p_info.arguments.size() > 0) {
  541. arghint += ", ";
  542. }
  543. if (p_arg_idx >= p_info.arguments.size()) {
  544. arghint += String::chr(0xFFFF);
  545. }
  546. arghint += "...";
  547. if (p_arg_idx >= p_info.arguments.size()) {
  548. arghint += String::chr(0xFFFF);
  549. }
  550. }
  551. arghint += ")";
  552. return arghint;
  553. }
  554. static String _make_arguments_hint(const GDScriptParser::FunctionNode *p_function, int p_arg_idx) {
  555. String arghint;
  556. if (p_function->get_datatype().builtin_type == Variant::NIL) {
  557. arghint = "void " + p_function->identifier->name.operator String() + "(";
  558. } else {
  559. arghint = p_function->get_datatype().to_string() + " " + p_function->identifier->name.operator String() + "(";
  560. }
  561. for (int i = 0; i < p_function->parameters.size(); i++) {
  562. if (i > 0) {
  563. arghint += ", ";
  564. }
  565. if (i == p_arg_idx) {
  566. arghint += String::chr(0xFFFF);
  567. }
  568. const GDScriptParser::ParameterNode *par = p_function->parameters[i];
  569. if (!par->get_datatype().is_hard_type()) {
  570. arghint += par->identifier->name.operator String() + ": Variant";
  571. } else {
  572. arghint += par->identifier->name.operator String() + ": " + par->get_datatype().to_string();
  573. }
  574. if (par->default_value) {
  575. String def_val = "<unknown>";
  576. switch (par->default_value->type) {
  577. case GDScriptParser::Node::LITERAL: {
  578. const GDScriptParser::LiteralNode *literal = static_cast<const GDScriptParser::LiteralNode *>(par->default_value);
  579. def_val = literal->value.get_construct_string();
  580. } break;
  581. case GDScriptParser::Node::IDENTIFIER: {
  582. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(par->default_value);
  583. def_val = id->name.operator String();
  584. } break;
  585. case GDScriptParser::Node::CALL: {
  586. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(par->default_value);
  587. if (call->is_constant && call->reduced) {
  588. def_val = call->function_name.operator String() + call->reduced_value.operator String();
  589. }
  590. } break;
  591. case GDScriptParser::Node::ARRAY: {
  592. const GDScriptParser::ArrayNode *arr = static_cast<const GDScriptParser::ArrayNode *>(par->default_value);
  593. if (arr->is_constant && arr->reduced) {
  594. def_val = arr->reduced_value.operator String();
  595. }
  596. } break;
  597. case GDScriptParser::Node::DICTIONARY: {
  598. const GDScriptParser::DictionaryNode *dict = static_cast<const GDScriptParser::DictionaryNode *>(par->default_value);
  599. if (dict->is_constant && dict->reduced) {
  600. def_val = dict->reduced_value.operator String();
  601. }
  602. } break;
  603. case GDScriptParser::Node::SUBSCRIPT: {
  604. const GDScriptParser::SubscriptNode *sub = static_cast<const GDScriptParser::SubscriptNode *>(par->default_value);
  605. if (sub->is_constant) {
  606. if (sub->datatype.kind == GDScriptParser::DataType::ENUM) {
  607. def_val = sub->get_datatype().to_string();
  608. } else if (sub->reduced) {
  609. const Variant::Type vt = sub->reduced_value.get_type();
  610. if (vt == Variant::Type::NIL || vt == Variant::Type::FLOAT || vt == Variant::Type::INT || vt == Variant::Type::STRING || vt == Variant::Type::STRING_NAME || vt == Variant::Type::BOOL || vt == Variant::Type::NODE_PATH) {
  611. def_val = sub->reduced_value.operator String();
  612. } else {
  613. def_val = sub->get_datatype().to_string() + sub->reduced_value.operator String();
  614. }
  615. }
  616. }
  617. } break;
  618. default:
  619. break;
  620. }
  621. arghint += " = " + def_val;
  622. }
  623. if (i == p_arg_idx) {
  624. arghint += String::chr(0xFFFF);
  625. }
  626. }
  627. arghint += ")";
  628. return arghint;
  629. }
  630. static void _get_directory_contents(EditorFileSystemDirectory *p_dir, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_list) {
  631. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  632. for (int i = 0; i < p_dir->get_file_count(); i++) {
  633. ScriptLanguage::CodeCompletionOption option(p_dir->get_file_path(i), ScriptLanguage::CODE_COMPLETION_KIND_FILE_PATH);
  634. option.insert_text = option.display.quote(quote_style);
  635. r_list.insert(option.display, option);
  636. }
  637. for (int i = 0; i < p_dir->get_subdir_count(); i++) {
  638. _get_directory_contents(p_dir->get_subdir(i), r_list);
  639. }
  640. }
  641. static void _find_annotation_arguments(const GDScriptParser::AnnotationNode *p_annotation, int p_argument, const String p_quote_style, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result) {
  642. if (p_annotation->name == SNAME("@export_range")) {
  643. if (p_argument == 3 || p_argument == 4 || p_argument == 5) {
  644. // Slider hint.
  645. ScriptLanguage::CodeCompletionOption slider1("or_greater", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  646. slider1.insert_text = slider1.display.quote(p_quote_style);
  647. r_result.insert(slider1.display, slider1);
  648. ScriptLanguage::CodeCompletionOption slider2("or_less", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  649. slider2.insert_text = slider2.display.quote(p_quote_style);
  650. r_result.insert(slider2.display, slider2);
  651. ScriptLanguage::CodeCompletionOption slider3("hide_slider", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  652. slider3.insert_text = slider3.display.quote(p_quote_style);
  653. r_result.insert(slider3.display, slider3);
  654. }
  655. } else if (p_annotation->name == SNAME("@export_exp_easing")) {
  656. if (p_argument == 0 || p_argument == 1) {
  657. // Easing hint.
  658. ScriptLanguage::CodeCompletionOption hint1("attenuation", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  659. hint1.insert_text = hint1.display.quote(p_quote_style);
  660. r_result.insert(hint1.display, hint1);
  661. ScriptLanguage::CodeCompletionOption hint2("inout", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  662. hint2.insert_text = hint2.display.quote(p_quote_style);
  663. r_result.insert(hint2.display, hint2);
  664. }
  665. } else if (p_annotation->name == SNAME("@export_node_path")) {
  666. ScriptLanguage::CodeCompletionOption node("Node", ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  667. r_result.insert(node.display, node);
  668. List<StringName> node_types;
  669. ClassDB::get_inheriters_from_class("Node", &node_types);
  670. for (const StringName &E : node_types) {
  671. if (!ClassDB::is_class_exposed(E)) {
  672. continue;
  673. }
  674. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  675. r_result.insert(option.display, option);
  676. }
  677. } else if (p_annotation->name == SNAME("@warning_ignore")) {
  678. for (int warning_code = 0; warning_code < GDScriptWarning::WARNING_MAX; warning_code++) {
  679. ScriptLanguage::CodeCompletionOption warning(GDScriptWarning::get_name_from_code((GDScriptWarning::Code)warning_code).to_lower(), ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  680. r_result.insert(warning.display, warning);
  681. }
  682. }
  683. }
  684. static void _find_built_in_variants(HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, bool exclude_nil = false) {
  685. for (int i = 0; i < Variant::VARIANT_MAX; i++) {
  686. if (!exclude_nil && Variant::Type(i) == Variant::Type::NIL) {
  687. ScriptLanguage::CodeCompletionOption option("null", ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  688. r_result.insert(option.display, option);
  689. } else {
  690. ScriptLanguage::CodeCompletionOption option(Variant::get_type_name(Variant::Type(i)), ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  691. r_result.insert(option.display, option);
  692. }
  693. }
  694. }
  695. static void _list_available_types(bool p_inherit_only, GDScriptParser::CompletionContext &p_context, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result) {
  696. // Built-in Variant Types
  697. _find_built_in_variants(r_result, true);
  698. List<StringName> native_types;
  699. ClassDB::get_class_list(&native_types);
  700. for (const StringName &E : native_types) {
  701. if (ClassDB::is_class_exposed(E) && !Engine::get_singleton()->has_singleton(E)) {
  702. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  703. r_result.insert(option.display, option);
  704. }
  705. }
  706. if (p_context.current_class) {
  707. if (!p_inherit_only && p_context.current_class->base_type.is_set()) {
  708. // Native enums from base class
  709. List<StringName> enums;
  710. ClassDB::get_enum_list(p_context.current_class->base_type.native_type, &enums);
  711. for (const StringName &E : enums) {
  712. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_ENUM);
  713. r_result.insert(option.display, option);
  714. }
  715. }
  716. // Check current class for potential types
  717. const GDScriptParser::ClassNode *current = p_context.current_class;
  718. while (current) {
  719. for (int i = 0; i < current->members.size(); i++) {
  720. const GDScriptParser::ClassNode::Member &member = current->members[i];
  721. switch (member.type) {
  722. case GDScriptParser::ClassNode::Member::CLASS: {
  723. ScriptLanguage::CodeCompletionOption option(member.m_class->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_LOCAL);
  724. r_result.insert(option.display, option);
  725. } break;
  726. case GDScriptParser::ClassNode::Member::ENUM: {
  727. if (!p_inherit_only) {
  728. ScriptLanguage::CodeCompletionOption option(member.m_enum->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, ScriptLanguage::LOCATION_LOCAL);
  729. r_result.insert(option.display, option);
  730. }
  731. } break;
  732. case GDScriptParser::ClassNode::Member::CONSTANT: {
  733. if (member.constant->get_datatype().is_meta_type && p_context.current_class->outer != nullptr) {
  734. ScriptLanguage::CodeCompletionOption option(member.constant->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_LOCAL);
  735. r_result.insert(option.display, option);
  736. }
  737. } break;
  738. default:
  739. break;
  740. }
  741. }
  742. current = current->outer;
  743. }
  744. }
  745. // Global scripts
  746. List<StringName> global_classes;
  747. ScriptServer::get_global_class_list(&global_classes);
  748. for (const StringName &E : global_classes) {
  749. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_OTHER_USER_CODE);
  750. r_result.insert(option.display, option);
  751. }
  752. // Autoload singletons
  753. HashMap<StringName, ProjectSettings::AutoloadInfo> autoloads = ProjectSettings::get_singleton()->get_autoload_list();
  754. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : autoloads) {
  755. const ProjectSettings::AutoloadInfo &info = E.value;
  756. if (!info.is_singleton || info.path.get_extension().to_lower() != "gd") {
  757. continue;
  758. }
  759. ScriptLanguage::CodeCompletionOption option(info.name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_OTHER_USER_CODE);
  760. r_result.insert(option.display, option);
  761. }
  762. }
  763. static void _find_identifiers_in_suite(const GDScriptParser::SuiteNode *p_suite, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result) {
  764. for (int i = 0; i < p_suite->locals.size(); i++) {
  765. ScriptLanguage::CodeCompletionOption option;
  766. if (p_suite->locals[i].type == GDScriptParser::SuiteNode::Local::CONSTANT) {
  767. option = ScriptLanguage::CodeCompletionOption(p_suite->locals[i].name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, ScriptLanguage::LOCATION_LOCAL);
  768. option.default_value = p_suite->locals[i].constant->initializer->reduced_value;
  769. } else {
  770. option = ScriptLanguage::CodeCompletionOption(p_suite->locals[i].name, ScriptLanguage::CODE_COMPLETION_KIND_VARIABLE, ScriptLanguage::LOCATION_LOCAL);
  771. }
  772. r_result.insert(option.display, option);
  773. }
  774. if (p_suite->parent_block) {
  775. _find_identifiers_in_suite(p_suite->parent_block, r_result);
  776. }
  777. }
  778. static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base, bool p_only_functions, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth);
  779. static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class, bool p_only_functions, bool p_static, bool p_parent_only, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth) {
  780. ERR_FAIL_COND(p_recursion_depth > COMPLETION_RECURSION_LIMIT);
  781. if (!p_parent_only) {
  782. bool outer = false;
  783. const GDScriptParser::ClassNode *clss = p_class;
  784. int classes_processed = 0;
  785. while (clss) {
  786. for (int i = 0; i < clss->members.size(); i++) {
  787. const int location = (classes_processed + p_recursion_depth) | ScriptLanguage::LOCATION_PARENT_MASK;
  788. const GDScriptParser::ClassNode::Member &member = clss->members[i];
  789. ScriptLanguage::CodeCompletionOption option;
  790. switch (member.type) {
  791. case GDScriptParser::ClassNode::Member::VARIABLE:
  792. if (p_only_functions || outer || (p_static)) {
  793. continue;
  794. }
  795. option = ScriptLanguage::CodeCompletionOption(member.variable->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  796. break;
  797. case GDScriptParser::ClassNode::Member::CONSTANT:
  798. if (p_only_functions) {
  799. continue;
  800. }
  801. if (r_result.has(member.constant->identifier->name)) {
  802. continue;
  803. }
  804. option = ScriptLanguage::CodeCompletionOption(member.constant->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  805. if (member.constant->initializer) {
  806. option.default_value = member.constant->initializer->reduced_value;
  807. }
  808. break;
  809. case GDScriptParser::ClassNode::Member::CLASS:
  810. if (p_only_functions) {
  811. continue;
  812. }
  813. option = ScriptLanguage::CodeCompletionOption(member.m_class->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, location);
  814. break;
  815. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  816. if (p_only_functions) {
  817. continue;
  818. }
  819. option = ScriptLanguage::CodeCompletionOption(member.enum_value.identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  820. break;
  821. case GDScriptParser::ClassNode::Member::ENUM:
  822. if (p_only_functions) {
  823. continue;
  824. }
  825. option = ScriptLanguage::CodeCompletionOption(member.m_enum->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, location);
  826. break;
  827. case GDScriptParser::ClassNode::Member::FUNCTION:
  828. if (outer || (p_static && !member.function->is_static) || member.function->identifier->name.operator String().begins_with("@")) {
  829. continue;
  830. }
  831. option = ScriptLanguage::CodeCompletionOption(member.function->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  832. if (member.function->parameters.size() > 0) {
  833. option.insert_text += "(";
  834. } else {
  835. option.insert_text += "()";
  836. }
  837. break;
  838. case GDScriptParser::ClassNode::Member::SIGNAL:
  839. if (p_only_functions || outer) {
  840. continue;
  841. }
  842. option = ScriptLanguage::CodeCompletionOption(member.signal->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL, location);
  843. break;
  844. case GDScriptParser::ClassNode::Member::GROUP:
  845. break; // No-op, but silences warnings.
  846. case GDScriptParser::ClassNode::Member::UNDEFINED:
  847. break;
  848. }
  849. r_result.insert(option.display, option);
  850. }
  851. outer = true;
  852. clss = clss->outer;
  853. classes_processed++;
  854. }
  855. }
  856. // Parents.
  857. GDScriptCompletionIdentifier base_type;
  858. base_type.type = p_class->base_type;
  859. base_type.type.is_meta_type = p_static;
  860. _find_identifiers_in_base(base_type, p_only_functions, r_result, p_recursion_depth + 1);
  861. }
  862. static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base, bool p_only_functions, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth) {
  863. ERR_FAIL_COND(p_recursion_depth > COMPLETION_RECURSION_LIMIT);
  864. GDScriptParser::DataType base_type = p_base.type;
  865. bool _static = base_type.is_meta_type;
  866. if (_static && base_type.kind != GDScriptParser::DataType::BUILTIN) {
  867. ScriptLanguage::CodeCompletionOption option("new", ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, ScriptLanguage::LOCATION_LOCAL);
  868. option.insert_text += "(";
  869. r_result.insert(option.display, option);
  870. }
  871. while (!base_type.has_no_type()) {
  872. switch (base_type.kind) {
  873. case GDScriptParser::DataType::CLASS: {
  874. _find_identifiers_in_class(base_type.class_type, p_only_functions, _static, false, r_result, p_recursion_depth + 1);
  875. // This already finds all parent identifiers, so we are done.
  876. base_type = GDScriptParser::DataType();
  877. } break;
  878. case GDScriptParser::DataType::SCRIPT: {
  879. Ref<Script> scr = base_type.script_type;
  880. if (scr.is_valid()) {
  881. if (!p_only_functions) {
  882. if (!_static) {
  883. List<PropertyInfo> members;
  884. scr->get_script_property_list(&members);
  885. for (const PropertyInfo &E : members) {
  886. int location = p_recursion_depth + _get_property_location(scr->get_class_name(), E.class_name);
  887. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  888. r_result.insert(option.display, option);
  889. }
  890. }
  891. HashMap<StringName, Variant> constants;
  892. scr->get_constants(&constants);
  893. for (const KeyValue<StringName, Variant> &E : constants) {
  894. int location = p_recursion_depth + _get_constant_location(scr->get_class_name(), E.key);
  895. ScriptLanguage::CodeCompletionOption option(E.key.operator String(), ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  896. r_result.insert(option.display, option);
  897. }
  898. List<MethodInfo> signals;
  899. scr->get_script_signal_list(&signals);
  900. for (const MethodInfo &E : signals) {
  901. int location = p_recursion_depth + _get_signal_location(scr->get_class_name(), E.name);
  902. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL, location);
  903. r_result.insert(option.display, option);
  904. }
  905. }
  906. List<MethodInfo> methods;
  907. scr->get_script_method_list(&methods);
  908. for (const MethodInfo &E : methods) {
  909. if (E.name.begins_with("@")) {
  910. continue;
  911. }
  912. int location = p_recursion_depth + _get_method_location(scr->get_class_name(), E.name);
  913. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  914. if (E.arguments.size()) {
  915. option.insert_text += "(";
  916. } else {
  917. option.insert_text += "()";
  918. }
  919. r_result.insert(option.display, option);
  920. }
  921. Ref<Script> base_script = scr->get_base_script();
  922. if (base_script.is_valid()) {
  923. base_type.script_type = base_script;
  924. } else {
  925. base_type.kind = GDScriptParser::DataType::NATIVE;
  926. base_type.native_type = scr->get_instance_base_type();
  927. }
  928. } else {
  929. return;
  930. }
  931. } break;
  932. case GDScriptParser::DataType::NATIVE: {
  933. StringName type = base_type.native_type;
  934. if (!ClassDB::class_exists(type)) {
  935. return;
  936. }
  937. if (!p_only_functions) {
  938. List<String> constants;
  939. ClassDB::get_integer_constant_list(type, &constants);
  940. for (const String &E : constants) {
  941. int location = p_recursion_depth + _get_constant_location(type, StringName(E));
  942. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  943. r_result.insert(option.display, option);
  944. }
  945. List<MethodInfo> signals;
  946. ClassDB::get_signal_list(type, &signals);
  947. for (const MethodInfo &E : signals) {
  948. int location = p_recursion_depth + _get_signal_location(type, StringName(E.name));
  949. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL, location);
  950. r_result.insert(option.display, option);
  951. }
  952. if (!_static || Engine::get_singleton()->has_singleton(type)) {
  953. List<PropertyInfo> pinfo;
  954. ClassDB::get_property_list(type, &pinfo);
  955. for (const PropertyInfo &E : pinfo) {
  956. if (E.usage & (PROPERTY_USAGE_GROUP | PROPERTY_USAGE_CATEGORY)) {
  957. continue;
  958. }
  959. if (E.name.contains("/")) {
  960. continue;
  961. }
  962. int location = p_recursion_depth + _get_property_location(type, E.class_name);
  963. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  964. r_result.insert(option.display, option);
  965. }
  966. }
  967. }
  968. bool only_static = _static && !Engine::get_singleton()->has_singleton(type);
  969. List<MethodInfo> methods;
  970. ClassDB::get_method_list(type, &methods, false, true);
  971. for (const MethodInfo &E : methods) {
  972. if (only_static && (E.flags & METHOD_FLAG_STATIC) == 0) {
  973. continue;
  974. }
  975. if (E.name.begins_with("_")) {
  976. continue;
  977. }
  978. int location = p_recursion_depth + _get_method_location(type, E.name);
  979. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  980. if (E.arguments.size()) {
  981. option.insert_text += "(";
  982. } else {
  983. option.insert_text += "()";
  984. }
  985. r_result.insert(option.display, option);
  986. }
  987. return;
  988. } break;
  989. case GDScriptParser::DataType::BUILTIN: {
  990. Callable::CallError err;
  991. Variant tmp;
  992. Variant::construct(base_type.builtin_type, tmp, nullptr, 0, err);
  993. if (err.error != Callable::CallError::CALL_OK) {
  994. return;
  995. }
  996. if (!p_only_functions) {
  997. List<PropertyInfo> members;
  998. if (p_base.value.get_type() != Variant::NIL) {
  999. p_base.value.get_property_list(&members);
  1000. } else {
  1001. tmp.get_property_list(&members);
  1002. }
  1003. for (const PropertyInfo &E : members) {
  1004. if (!String(E.name).contains("/")) {
  1005. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER);
  1006. r_result.insert(option.display, option);
  1007. }
  1008. }
  1009. }
  1010. List<MethodInfo> methods;
  1011. tmp.get_method_list(&methods);
  1012. for (const MethodInfo &E : methods) {
  1013. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1014. if (E.arguments.size()) {
  1015. option.insert_text += "(";
  1016. } else {
  1017. option.insert_text += "()";
  1018. }
  1019. r_result.insert(option.display, option);
  1020. }
  1021. return;
  1022. } break;
  1023. default: {
  1024. return;
  1025. } break;
  1026. }
  1027. }
  1028. }
  1029. static void _find_identifiers(const GDScriptParser::CompletionContext &p_context, bool p_only_functions, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth) {
  1030. if (!p_only_functions && p_context.current_suite) {
  1031. // This includes function parameters, since they are also locals.
  1032. _find_identifiers_in_suite(p_context.current_suite, r_result);
  1033. }
  1034. if (p_context.current_class) {
  1035. _find_identifiers_in_class(p_context.current_class, p_only_functions, (!p_context.current_function || p_context.current_function->is_static), false, r_result, p_recursion_depth + 1);
  1036. }
  1037. List<StringName> functions;
  1038. GDScriptUtilityFunctions::get_function_list(&functions);
  1039. for (const StringName &E : functions) {
  1040. MethodInfo function = GDScriptUtilityFunctions::get_function_info(E);
  1041. ScriptLanguage::CodeCompletionOption option(String(E), ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1042. if (function.arguments.size() || (function.flags & METHOD_FLAG_VARARG)) {
  1043. option.insert_text += "(";
  1044. } else {
  1045. option.insert_text += "()";
  1046. }
  1047. r_result.insert(option.display, option);
  1048. }
  1049. if (p_only_functions) {
  1050. return;
  1051. }
  1052. _find_built_in_variants(r_result);
  1053. static const char *_keywords[] = {
  1054. "true", "false", "PI", "TAU", "INF", "NAN", "null", "self", "super",
  1055. "break", "breakpoint", "continue", "pass", "return",
  1056. nullptr
  1057. };
  1058. const char **kw = _keywords;
  1059. while (*kw) {
  1060. ScriptLanguage::CodeCompletionOption option(*kw, ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  1061. r_result.insert(option.display, option);
  1062. kw++;
  1063. }
  1064. static const char *_keywords_with_space[] = {
  1065. "and", "not", "or", "in", "as", "class", "class_name", "extends", "is", "func", "signal", "await",
  1066. "const", "enum", "static", "var", "if", "elif", "else", "for", "match", "while",
  1067. nullptr
  1068. };
  1069. const char **kws = _keywords_with_space;
  1070. while (*kws) {
  1071. ScriptLanguage::CodeCompletionOption option(*kws, ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  1072. option.insert_text += " ";
  1073. r_result.insert(option.display, option);
  1074. kws++;
  1075. }
  1076. static const char *_keywords_with_args[] = {
  1077. "assert", "preload",
  1078. nullptr
  1079. };
  1080. const char **kwa = _keywords_with_args;
  1081. while (*kwa) {
  1082. ScriptLanguage::CodeCompletionOption option(*kwa, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1083. option.insert_text += "(";
  1084. r_result.insert(option.display, option);
  1085. kwa++;
  1086. }
  1087. List<StringName> utility_func_names;
  1088. Variant::get_utility_function_list(&utility_func_names);
  1089. for (List<StringName>::Element *E = utility_func_names.front(); E; E = E->next()) {
  1090. ScriptLanguage::CodeCompletionOption option(E->get(), ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1091. option.insert_text += "(";
  1092. r_result.insert(option.display, option);
  1093. }
  1094. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : ProjectSettings::get_singleton()->get_autoload_list()) {
  1095. if (!E.value.is_singleton) {
  1096. continue;
  1097. }
  1098. ScriptLanguage::CodeCompletionOption option(E.key, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  1099. r_result.insert(option.display, option);
  1100. }
  1101. // Native classes and global constants.
  1102. for (const KeyValue<StringName, int> &E : GDScriptLanguage::get_singleton()->get_global_map()) {
  1103. ScriptLanguage::CodeCompletionOption option;
  1104. if (ClassDB::class_exists(E.key) || Engine::get_singleton()->has_singleton(E.key)) {
  1105. option = ScriptLanguage::CodeCompletionOption(E.key.operator String(), ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  1106. } else {
  1107. option = ScriptLanguage::CodeCompletionOption(E.key.operator String(), ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  1108. }
  1109. r_result.insert(option.display, option);
  1110. }
  1111. }
  1112. static GDScriptCompletionIdentifier _type_from_variant(const Variant &p_value) {
  1113. GDScriptCompletionIdentifier ci;
  1114. ci.value = p_value;
  1115. ci.type.is_constant = true;
  1116. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1117. ci.type.kind = GDScriptParser::DataType::BUILTIN;
  1118. ci.type.builtin_type = p_value.get_type();
  1119. if (ci.type.builtin_type == Variant::OBJECT) {
  1120. Object *obj = p_value.operator Object *();
  1121. if (!obj) {
  1122. return ci;
  1123. }
  1124. ci.type.native_type = obj->get_class_name();
  1125. Ref<Script> scr = p_value;
  1126. if (scr.is_valid()) {
  1127. ci.type.is_meta_type = true;
  1128. } else {
  1129. ci.type.is_meta_type = false;
  1130. scr = obj->get_script();
  1131. }
  1132. if (scr.is_valid()) {
  1133. ci.type.script_type = scr;
  1134. ci.type.kind = GDScriptParser::DataType::SCRIPT;
  1135. ci.type.native_type = scr->get_instance_base_type();
  1136. } else {
  1137. ci.type.kind = GDScriptParser::DataType::NATIVE;
  1138. }
  1139. }
  1140. return ci;
  1141. }
  1142. static GDScriptCompletionIdentifier _type_from_property(const PropertyInfo &p_property) {
  1143. GDScriptCompletionIdentifier ci;
  1144. if (p_property.type == Variant::NIL) {
  1145. // Variant
  1146. return ci;
  1147. }
  1148. if (p_property.usage & (PROPERTY_USAGE_CLASS_IS_ENUM | PROPERTY_USAGE_CLASS_IS_BITFIELD)) {
  1149. ci.enumeration = p_property.class_name;
  1150. }
  1151. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1152. ci.type.builtin_type = p_property.type;
  1153. if (p_property.type == Variant::OBJECT) {
  1154. ci.type.kind = GDScriptParser::DataType::NATIVE;
  1155. ci.type.native_type = p_property.class_name == StringName() ? "Object" : p_property.class_name;
  1156. } else {
  1157. ci.type.kind = GDScriptParser::DataType::BUILTIN;
  1158. }
  1159. return ci;
  1160. }
  1161. static bool _guess_identifier_type(GDScriptParser::CompletionContext &p_context, const StringName &p_identifier, GDScriptCompletionIdentifier &r_type);
  1162. static bool _guess_identifier_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_identifier, GDScriptCompletionIdentifier &r_type);
  1163. static bool _guess_method_return_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_method, GDScriptCompletionIdentifier &r_type);
  1164. static bool _is_expression_named_identifier(const GDScriptParser::ExpressionNode *p_expression, const StringName &p_name) {
  1165. if (p_expression) {
  1166. switch (p_expression->type) {
  1167. case GDScriptParser::Node::IDENTIFIER: {
  1168. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(p_expression);
  1169. if (id->name == p_name) {
  1170. return true;
  1171. }
  1172. } break;
  1173. case GDScriptParser::Node::CAST: {
  1174. const GDScriptParser::CastNode *cn = static_cast<const GDScriptParser::CastNode *>(p_expression);
  1175. return _is_expression_named_identifier(cn->operand, p_name);
  1176. } break;
  1177. default:
  1178. break;
  1179. }
  1180. }
  1181. return false;
  1182. }
  1183. static bool _guess_expression_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::ExpressionNode *p_expression, GDScriptCompletionIdentifier &r_type) {
  1184. bool found = false;
  1185. if (p_expression == nullptr) {
  1186. return false;
  1187. }
  1188. if (p_expression->is_constant) {
  1189. // Already has a value, so just use that.
  1190. r_type = _type_from_variant(p_expression->reduced_value);
  1191. found = true;
  1192. } else {
  1193. switch (p_expression->type) {
  1194. case GDScriptParser::Node::LITERAL: {
  1195. const GDScriptParser::LiteralNode *literal = static_cast<const GDScriptParser::LiteralNode *>(p_expression);
  1196. r_type = _type_from_variant(literal->value);
  1197. found = true;
  1198. } break;
  1199. case GDScriptParser::Node::SELF: {
  1200. if (p_context.current_class) {
  1201. r_type.type.kind = GDScriptParser::DataType::CLASS;
  1202. r_type.type.type_source = GDScriptParser::DataType::INFERRED;
  1203. r_type.type.is_constant = true;
  1204. r_type.type.class_type = p_context.current_class;
  1205. r_type.value = p_context.base;
  1206. found = true;
  1207. }
  1208. } break;
  1209. case GDScriptParser::Node::IDENTIFIER: {
  1210. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(p_expression);
  1211. found = _guess_identifier_type(p_context, id->name, r_type);
  1212. } break;
  1213. case GDScriptParser::Node::DICTIONARY: {
  1214. // Try to recreate the dictionary.
  1215. const GDScriptParser::DictionaryNode *dn = static_cast<const GDScriptParser::DictionaryNode *>(p_expression);
  1216. Dictionary d;
  1217. bool full = true;
  1218. for (int i = 0; i < dn->elements.size(); i++) {
  1219. GDScriptCompletionIdentifier key;
  1220. if (_guess_expression_type(p_context, dn->elements[i].key, key)) {
  1221. if (!key.type.is_constant) {
  1222. full = false;
  1223. break;
  1224. }
  1225. GDScriptCompletionIdentifier value;
  1226. if (_guess_expression_type(p_context, dn->elements[i].value, value)) {
  1227. if (!value.type.is_constant) {
  1228. full = false;
  1229. break;
  1230. }
  1231. d[key.value] = value.value;
  1232. } else {
  1233. full = false;
  1234. break;
  1235. }
  1236. } else {
  1237. full = false;
  1238. break;
  1239. }
  1240. }
  1241. if (full) {
  1242. r_type.value = d;
  1243. r_type.type.is_constant = true;
  1244. }
  1245. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1246. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1247. r_type.type.builtin_type = Variant::DICTIONARY;
  1248. found = true;
  1249. } break;
  1250. case GDScriptParser::Node::ARRAY: {
  1251. // Try to recreate the array
  1252. const GDScriptParser::ArrayNode *an = static_cast<const GDScriptParser::ArrayNode *>(p_expression);
  1253. Array a;
  1254. bool full = true;
  1255. a.resize(an->elements.size());
  1256. for (int i = 0; i < an->elements.size(); i++) {
  1257. GDScriptCompletionIdentifier value;
  1258. if (_guess_expression_type(p_context, an->elements[i], value)) {
  1259. if (value.type.is_constant) {
  1260. a[i] = value.value;
  1261. } else {
  1262. full = false;
  1263. break;
  1264. }
  1265. } else {
  1266. full = false;
  1267. break;
  1268. }
  1269. }
  1270. if (full) {
  1271. // If not fully constant, setting this value is detrimental to the inference.
  1272. r_type.value = a;
  1273. }
  1274. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1275. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1276. r_type.type.builtin_type = Variant::ARRAY;
  1277. found = true;
  1278. } break;
  1279. case GDScriptParser::Node::CAST: {
  1280. const GDScriptParser::CastNode *cn = static_cast<const GDScriptParser::CastNode *>(p_expression);
  1281. GDScriptCompletionIdentifier value;
  1282. if (_guess_expression_type(p_context, cn->operand, r_type)) {
  1283. r_type.type = cn->get_datatype();
  1284. found = true;
  1285. }
  1286. } break;
  1287. case GDScriptParser::Node::CALL: {
  1288. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(p_expression);
  1289. if (GDScriptParser::get_builtin_type(call->function_name) < Variant::VARIANT_MAX) {
  1290. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1291. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1292. r_type.type.builtin_type = GDScriptParser::get_builtin_type(call->function_name);
  1293. found = true;
  1294. break;
  1295. } else if (GDScriptUtilityFunctions::function_exists(call->function_name)) {
  1296. MethodInfo mi = GDScriptUtilityFunctions::get_function_info(call->function_name);
  1297. r_type = _type_from_property(mi.return_val);
  1298. found = true;
  1299. break;
  1300. } else {
  1301. GDScriptParser::CompletionContext c = p_context;
  1302. c.current_line = call->start_line;
  1303. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  1304. GDScriptCompletionIdentifier base;
  1305. if (callee_type == GDScriptParser::Node::IDENTIFIER || call->is_super) {
  1306. // Simple call, so base is 'self'.
  1307. if (p_context.current_class) {
  1308. if (call->is_super) {
  1309. base.type = p_context.current_class->base_type;
  1310. base.value = p_context.base;
  1311. } else {
  1312. base.type.kind = GDScriptParser::DataType::CLASS;
  1313. base.type.type_source = GDScriptParser::DataType::INFERRED;
  1314. base.type.is_constant = true;
  1315. base.type.class_type = p_context.current_class;
  1316. base.value = p_context.base;
  1317. }
  1318. } else {
  1319. break;
  1320. }
  1321. } else if (callee_type == GDScriptParser::Node::SUBSCRIPT && static_cast<const GDScriptParser::SubscriptNode *>(call->callee)->is_attribute) {
  1322. if (!_guess_expression_type(c, static_cast<const GDScriptParser::SubscriptNode *>(call->callee)->base, base)) {
  1323. found = false;
  1324. break;
  1325. }
  1326. } else {
  1327. break;
  1328. }
  1329. // Try call if constant methods with constant arguments
  1330. if (base.type.is_constant && base.value.get_type() == Variant::OBJECT) {
  1331. GDScriptParser::DataType native_type = base.type;
  1332. while (native_type.kind == GDScriptParser::DataType::CLASS) {
  1333. native_type = native_type.class_type->base_type;
  1334. }
  1335. while (native_type.kind == GDScriptParser::DataType::SCRIPT) {
  1336. if (native_type.script_type.is_valid()) {
  1337. Ref<Script> parent = native_type.script_type->get_base_script();
  1338. if (parent.is_valid()) {
  1339. native_type.script_type = parent;
  1340. } else {
  1341. native_type.kind = GDScriptParser::DataType::NATIVE;
  1342. native_type.native_type = native_type.script_type->get_instance_base_type();
  1343. if (!ClassDB::class_exists(native_type.native_type)) {
  1344. native_type.kind = GDScriptParser::DataType::UNRESOLVED;
  1345. }
  1346. }
  1347. }
  1348. }
  1349. if (native_type.kind == GDScriptParser::DataType::NATIVE) {
  1350. MethodBind *mb = ClassDB::get_method(native_type.native_type, call->function_name);
  1351. if (mb && mb->is_const()) {
  1352. bool all_is_const = true;
  1353. Vector<Variant> args;
  1354. GDScriptParser::CompletionContext c2 = p_context;
  1355. c2.current_line = call->start_line;
  1356. for (int i = 0; all_is_const && i < call->arguments.size(); i++) {
  1357. GDScriptCompletionIdentifier arg;
  1358. if (!call->arguments[i]->is_constant) {
  1359. all_is_const = false;
  1360. }
  1361. }
  1362. Object *baseptr = base.value;
  1363. if (all_is_const && call->function_name == SNAME("get_node") && ClassDB::is_parent_class(native_type.native_type, SNAME("Node")) && args.size()) {
  1364. String arg1 = args[0];
  1365. if (arg1.begins_with("/root/")) {
  1366. String which = arg1.get_slice("/", 2);
  1367. if (!which.is_empty()) {
  1368. // Try singletons first
  1369. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(which)) {
  1370. r_type = _type_from_variant(GDScriptLanguage::get_singleton()->get_named_globals_map()[which]);
  1371. found = true;
  1372. } else {
  1373. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : ProjectSettings::get_singleton()->get_autoload_list()) {
  1374. String name = E.key;
  1375. if (name == which) {
  1376. String script = E.value.path;
  1377. if (!script.begins_with("res://")) {
  1378. script = "res://" + script;
  1379. }
  1380. if (!script.ends_with(".gd")) {
  1381. // not a script, try find the script anyway,
  1382. // may have some success
  1383. script = script.get_basename() + ".gd";
  1384. }
  1385. if (FileAccess::exists(script)) {
  1386. Error err = OK;
  1387. Ref<GDScriptParserRef> parser = GDScriptCache::get_parser(script, GDScriptParserRef::INTERFACE_SOLVED, err);
  1388. if (err == OK) {
  1389. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1390. r_type.type.script_path = script;
  1391. r_type.type.class_type = parser->get_parser()->get_tree();
  1392. r_type.type.is_constant = false;
  1393. r_type.type.kind = GDScriptParser::DataType::CLASS;
  1394. r_type.value = Variant();
  1395. p_context.dependent_parsers.push_back(parser);
  1396. found = true;
  1397. }
  1398. }
  1399. break;
  1400. }
  1401. }
  1402. }
  1403. }
  1404. }
  1405. }
  1406. if (!found && all_is_const && baseptr) {
  1407. Vector<const Variant *> argptr;
  1408. for (int i = 0; i < args.size(); i++) {
  1409. argptr.push_back(&args[i]);
  1410. }
  1411. Callable::CallError ce;
  1412. Variant ret = mb->call(baseptr, (const Variant **)argptr.ptr(), argptr.size(), ce);
  1413. if (ce.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1414. if (ret.get_type() != Variant::OBJECT || ret.operator Object *() != nullptr) {
  1415. r_type = _type_from_variant(ret);
  1416. found = true;
  1417. }
  1418. }
  1419. }
  1420. }
  1421. }
  1422. }
  1423. if (!found && base.value.get_type() != Variant::NIL) {
  1424. found = _guess_method_return_type_from_base(c, base, call->function_name, r_type);
  1425. }
  1426. }
  1427. } break;
  1428. case GDScriptParser::Node::SUBSCRIPT: {
  1429. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(p_expression);
  1430. if (subscript->is_attribute) {
  1431. GDScriptParser::CompletionContext c = p_context;
  1432. c.current_line = subscript->start_line;
  1433. GDScriptCompletionIdentifier base;
  1434. if (!_guess_expression_type(c, subscript->base, base)) {
  1435. found = false;
  1436. break;
  1437. }
  1438. if (base.value.get_type() == Variant::DICTIONARY && base.value.operator Dictionary().has(String(subscript->attribute->name))) {
  1439. Variant value = base.value.operator Dictionary()[String(subscript->attribute->name)];
  1440. r_type = _type_from_variant(value);
  1441. found = true;
  1442. break;
  1443. }
  1444. const GDScriptParser::DictionaryNode *dn = nullptr;
  1445. if (subscript->base->type == GDScriptParser::Node::DICTIONARY) {
  1446. dn = static_cast<const GDScriptParser::DictionaryNode *>(subscript->base);
  1447. } else if (base.assigned_expression && base.assigned_expression->type == GDScriptParser::Node::DICTIONARY) {
  1448. dn = static_cast<const GDScriptParser::DictionaryNode *>(base.assigned_expression);
  1449. }
  1450. if (dn) {
  1451. for (int i = 0; i < dn->elements.size(); i++) {
  1452. GDScriptCompletionIdentifier key;
  1453. if (!_guess_expression_type(c, dn->elements[i].key, key)) {
  1454. continue;
  1455. }
  1456. if (key.value == String(subscript->attribute->name)) {
  1457. r_type.assigned_expression = dn->elements[i].value;
  1458. found = _guess_expression_type(c, dn->elements[i].value, r_type);
  1459. break;
  1460. }
  1461. }
  1462. }
  1463. if (!found) {
  1464. found = _guess_identifier_type_from_base(c, base, subscript->attribute->name, r_type);
  1465. }
  1466. } else {
  1467. if (subscript->index == nullptr) {
  1468. found = false;
  1469. break;
  1470. }
  1471. GDScriptParser::CompletionContext c = p_context;
  1472. c.current_line = subscript->start_line;
  1473. GDScriptCompletionIdentifier base;
  1474. if (!_guess_expression_type(c, subscript->base, base)) {
  1475. found = false;
  1476. break;
  1477. }
  1478. GDScriptCompletionIdentifier index;
  1479. if (!_guess_expression_type(c, subscript->index, index)) {
  1480. found = false;
  1481. break;
  1482. }
  1483. if (base.value.in(index.value)) {
  1484. Variant value = base.value.get(index.value);
  1485. r_type = _type_from_variant(value);
  1486. found = true;
  1487. break;
  1488. }
  1489. // Look if it is a dictionary node.
  1490. const GDScriptParser::DictionaryNode *dn = nullptr;
  1491. if (subscript->base->type == GDScriptParser::Node::DICTIONARY) {
  1492. dn = static_cast<const GDScriptParser::DictionaryNode *>(subscript->base);
  1493. } else if (base.assigned_expression && base.assigned_expression->type == GDScriptParser::Node::DICTIONARY) {
  1494. dn = static_cast<const GDScriptParser::DictionaryNode *>(base.assigned_expression);
  1495. }
  1496. if (dn) {
  1497. for (int i = 0; i < dn->elements.size(); i++) {
  1498. GDScriptCompletionIdentifier key;
  1499. if (!_guess_expression_type(c, dn->elements[i].key, key)) {
  1500. continue;
  1501. }
  1502. if (key.value == index.value) {
  1503. r_type.assigned_expression = dn->elements[i].value;
  1504. found = _guess_expression_type(p_context, dn->elements[i].value, r_type);
  1505. break;
  1506. }
  1507. }
  1508. }
  1509. // Look if it is an array node.
  1510. if (!found && index.value.is_num()) {
  1511. int idx = index.value;
  1512. const GDScriptParser::ArrayNode *an = nullptr;
  1513. if (subscript->base->type == GDScriptParser::Node::ARRAY) {
  1514. an = static_cast<const GDScriptParser::ArrayNode *>(subscript->base);
  1515. } else if (base.assigned_expression && base.assigned_expression->type == GDScriptParser::Node::ARRAY) {
  1516. an = static_cast<const GDScriptParser::ArrayNode *>(base.assigned_expression);
  1517. }
  1518. if (an && idx >= 0 && an->elements.size() > idx) {
  1519. r_type.assigned_expression = an->elements[idx];
  1520. found = _guess_expression_type(c, an->elements[idx], r_type);
  1521. break;
  1522. }
  1523. }
  1524. // Look for valid indexing in other types
  1525. if (!found && (index.value.get_type() == Variant::STRING || index.value.get_type() == Variant::NODE_PATH)) {
  1526. StringName id = index.value;
  1527. found = _guess_identifier_type_from_base(c, base, id, r_type);
  1528. } else if (!found && index.type.kind == GDScriptParser::DataType::BUILTIN) {
  1529. Callable::CallError err;
  1530. Variant base_val;
  1531. Variant::construct(base.type.builtin_type, base_val, nullptr, 0, err);
  1532. bool valid = false;
  1533. Variant res = base_val.get(index.value, &valid);
  1534. if (valid) {
  1535. r_type = _type_from_variant(res);
  1536. r_type.value = Variant();
  1537. r_type.type.is_constant = false;
  1538. found = true;
  1539. }
  1540. }
  1541. }
  1542. } break;
  1543. case GDScriptParser::Node::BINARY_OPERATOR: {
  1544. const GDScriptParser::BinaryOpNode *op = static_cast<const GDScriptParser::BinaryOpNode *>(p_expression);
  1545. if (op->variant_op == Variant::OP_MAX) {
  1546. break;
  1547. }
  1548. GDScriptParser::CompletionContext context = p_context;
  1549. context.current_line = op->start_line;
  1550. GDScriptCompletionIdentifier p1;
  1551. GDScriptCompletionIdentifier p2;
  1552. if (!_guess_expression_type(context, op->left_operand, p1)) {
  1553. found = false;
  1554. break;
  1555. }
  1556. if (!_guess_expression_type(context, op->right_operand, p2)) {
  1557. found = false;
  1558. break;
  1559. }
  1560. Callable::CallError ce;
  1561. bool v1_use_value = p1.value.get_type() != Variant::NIL && p1.value.get_type() != Variant::OBJECT;
  1562. Variant d1;
  1563. Variant::construct(p1.type.builtin_type, d1, nullptr, 0, ce);
  1564. Variant d2;
  1565. Variant::construct(p2.type.builtin_type, d2, nullptr, 0, ce);
  1566. Variant v1 = (v1_use_value) ? p1.value : d1;
  1567. bool v2_use_value = p2.value.get_type() != Variant::NIL && p2.value.get_type() != Variant::OBJECT;
  1568. Variant v2 = (v2_use_value) ? p2.value : d2;
  1569. // avoid potential invalid ops
  1570. if ((op->variant_op == Variant::OP_DIVIDE || op->variant_op == Variant::OP_MODULE) && v2.get_type() == Variant::INT) {
  1571. v2 = 1;
  1572. v2_use_value = false;
  1573. }
  1574. if (op->variant_op == Variant::OP_DIVIDE && v2.get_type() == Variant::FLOAT) {
  1575. v2 = 1.0;
  1576. v2_use_value = false;
  1577. }
  1578. Variant res;
  1579. bool valid;
  1580. Variant::evaluate(op->variant_op, v1, v2, res, valid);
  1581. if (!valid) {
  1582. found = false;
  1583. break;
  1584. }
  1585. r_type = _type_from_variant(res);
  1586. if (!v1_use_value || !v2_use_value) {
  1587. r_type.value = Variant();
  1588. r_type.type.is_constant = false;
  1589. }
  1590. found = true;
  1591. } break;
  1592. default:
  1593. break;
  1594. }
  1595. }
  1596. // It may have found a null, but that's never useful
  1597. if (found && r_type.type.kind == GDScriptParser::DataType::BUILTIN && r_type.type.builtin_type == Variant::NIL) {
  1598. found = false;
  1599. }
  1600. // Check type hint last. For collections we want chance to get the actual value first
  1601. // This way we can detect types from the content of dictionaries and arrays
  1602. if (!found && p_expression->get_datatype().is_hard_type()) {
  1603. r_type.type = p_expression->get_datatype();
  1604. if (!r_type.assigned_expression) {
  1605. r_type.assigned_expression = p_expression;
  1606. }
  1607. found = true;
  1608. }
  1609. return found;
  1610. }
  1611. static bool _guess_identifier_type(GDScriptParser::CompletionContext &p_context, const StringName &p_identifier, GDScriptCompletionIdentifier &r_type) {
  1612. // Look in blocks first.
  1613. int last_assign_line = -1;
  1614. const GDScriptParser::ExpressionNode *last_assigned_expression = nullptr;
  1615. GDScriptParser::DataType id_type;
  1616. GDScriptParser::SuiteNode *suite = p_context.current_suite;
  1617. bool is_function_parameter = false;
  1618. if (suite) {
  1619. if (suite->has_local(p_identifier)) {
  1620. const GDScriptParser::SuiteNode::Local &local = suite->get_local(p_identifier);
  1621. id_type = local.get_datatype();
  1622. // Check initializer as the first assignment.
  1623. switch (local.type) {
  1624. case GDScriptParser::SuiteNode::Local::VARIABLE:
  1625. if (local.variable->initializer) {
  1626. last_assign_line = local.variable->initializer->end_line;
  1627. last_assigned_expression = local.variable->initializer;
  1628. }
  1629. break;
  1630. case GDScriptParser::SuiteNode::Local::CONSTANT:
  1631. if (local.constant->initializer) {
  1632. last_assign_line = local.constant->initializer->end_line;
  1633. last_assigned_expression = local.constant->initializer;
  1634. }
  1635. break;
  1636. case GDScriptParser::SuiteNode::Local::PARAMETER:
  1637. if (local.parameter->default_value) {
  1638. last_assign_line = local.parameter->default_value->end_line;
  1639. last_assigned_expression = local.parameter->default_value;
  1640. }
  1641. is_function_parameter = true;
  1642. break;
  1643. default:
  1644. break;
  1645. }
  1646. }
  1647. }
  1648. while (suite) {
  1649. for (int i = 0; i < suite->statements.size(); i++) {
  1650. if (suite->statements[i]->end_line >= p_context.current_line) {
  1651. break;
  1652. }
  1653. switch (suite->statements[i]->type) {
  1654. case GDScriptParser::Node::ASSIGNMENT: {
  1655. const GDScriptParser::AssignmentNode *assign = static_cast<const GDScriptParser::AssignmentNode *>(suite->statements[i]);
  1656. if (assign->end_line > last_assign_line && assign->assignee && assign->assigned_value && assign->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  1657. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(assign->assignee);
  1658. if (id->name == p_identifier) {
  1659. last_assign_line = assign->assigned_value->end_line;
  1660. last_assigned_expression = assign->assigned_value;
  1661. }
  1662. }
  1663. } break;
  1664. default:
  1665. // TODO: Check sub blocks (control flow statements) as they might also reassign stuff.
  1666. break;
  1667. }
  1668. }
  1669. if (suite->parent_if && suite->parent_if->condition && suite->parent_if->condition->type == GDScriptParser::Node::BINARY_OPERATOR && static_cast<const GDScriptParser::BinaryOpNode *>(suite->parent_if->condition)->operation == GDScriptParser::BinaryOpNode::OP_TYPE_TEST) {
  1670. // Operator `is` used, check if identifier is in there! this helps resolve in blocks that are (if (identifier is value)): which are very common..
  1671. // Super dirty hack, but very useful.
  1672. // Credit: Zylann.
  1673. // TODO: this could be hacked to detect ANDed conditions too...
  1674. const GDScriptParser::BinaryOpNode *op = static_cast<const GDScriptParser::BinaryOpNode *>(suite->parent_if->condition);
  1675. if (op->left_operand && op->right_operand && op->left_operand->type == GDScriptParser::Node::IDENTIFIER && static_cast<const GDScriptParser::IdentifierNode *>(op->left_operand)->name == p_identifier) {
  1676. // Bingo.
  1677. GDScriptParser::CompletionContext c = p_context;
  1678. c.current_line = op->left_operand->start_line;
  1679. c.current_suite = suite;
  1680. GDScriptCompletionIdentifier is_type;
  1681. if (_guess_expression_type(c, op->right_operand, is_type)) {
  1682. id_type = is_type.type;
  1683. id_type.is_meta_type = false;
  1684. if (last_assign_line < c.current_line) {
  1685. // Override last assignment.
  1686. last_assign_line = c.current_line;
  1687. last_assigned_expression = nullptr;
  1688. }
  1689. }
  1690. }
  1691. }
  1692. suite = suite->parent_block;
  1693. }
  1694. if (last_assigned_expression && last_assign_line < p_context.current_line) {
  1695. GDScriptParser::CompletionContext c = p_context;
  1696. c.current_line = last_assign_line;
  1697. r_type.assigned_expression = last_assigned_expression;
  1698. if (_guess_expression_type(c, last_assigned_expression, r_type)) {
  1699. return true;
  1700. }
  1701. }
  1702. if (is_function_parameter && p_context.current_function && p_context.current_function->source_lambda == nullptr && p_context.current_class) {
  1703. // Check if it's override of native function, then we can assume the type from the signature.
  1704. GDScriptParser::DataType base_type = p_context.current_class->base_type;
  1705. while (base_type.is_set()) {
  1706. switch (base_type.kind) {
  1707. case GDScriptParser::DataType::CLASS:
  1708. if (base_type.class_type->has_function(p_context.current_function->identifier->name)) {
  1709. GDScriptParser::FunctionNode *parent_function = base_type.class_type->get_member(p_context.current_function->identifier->name).function;
  1710. const GDScriptParser::ParameterNode *parameter = parent_function->parameters[parent_function->parameters_indices[p_identifier]];
  1711. if ((!id_type.is_set() || id_type.is_variant()) && parameter->get_datatype().is_hard_type()) {
  1712. id_type = parameter->get_datatype();
  1713. }
  1714. if (parameter->default_value) {
  1715. GDScriptParser::CompletionContext c = p_context;
  1716. c.current_function = parent_function;
  1717. c.current_class = base_type.class_type;
  1718. c.base = nullptr;
  1719. if (_guess_expression_type(c, parameter->default_value, r_type)) {
  1720. return true;
  1721. }
  1722. }
  1723. }
  1724. base_type = base_type.class_type->base_type;
  1725. break;
  1726. case GDScriptParser::DataType::NATIVE: {
  1727. if (id_type.is_set() && !id_type.is_variant()) {
  1728. base_type = GDScriptParser::DataType();
  1729. break;
  1730. }
  1731. MethodInfo info;
  1732. if (ClassDB::get_method_info(base_type.native_type, p_context.current_function->identifier->name, &info)) {
  1733. for (const PropertyInfo &E : info.arguments) {
  1734. if (E.name == p_identifier) {
  1735. r_type = _type_from_property(E);
  1736. return true;
  1737. }
  1738. }
  1739. }
  1740. base_type = GDScriptParser::DataType();
  1741. } break;
  1742. default:
  1743. break;
  1744. }
  1745. }
  1746. }
  1747. if (id_type.is_set() && !id_type.is_variant()) {
  1748. r_type.type = id_type;
  1749. return true;
  1750. }
  1751. // Check current class (including inheritance).
  1752. if (p_context.current_class) {
  1753. GDScriptCompletionIdentifier base;
  1754. base.value = p_context.base;
  1755. base.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1756. base.type.kind = GDScriptParser::DataType::CLASS;
  1757. base.type.class_type = p_context.current_class;
  1758. base.type.is_meta_type = p_context.current_function && p_context.current_function->is_static;
  1759. if (_guess_identifier_type_from_base(p_context, base, p_identifier, r_type)) {
  1760. return true;
  1761. }
  1762. }
  1763. // Check global scripts.
  1764. if (ScriptServer::is_global_class(p_identifier)) {
  1765. String script = ScriptServer::get_global_class_path(p_identifier);
  1766. if (script.to_lower().ends_with(".gd")) {
  1767. Error err = OK;
  1768. Ref<GDScriptParserRef> parser = GDScriptCache::get_parser(script, GDScriptParserRef::INTERFACE_SOLVED, err);
  1769. if (err == OK) {
  1770. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1771. r_type.type.script_path = script;
  1772. r_type.type.class_type = parser->get_parser()->get_tree();
  1773. r_type.type.is_constant = false;
  1774. r_type.type.kind = GDScriptParser::DataType::CLASS;
  1775. r_type.value = Variant();
  1776. p_context.dependent_parsers.push_back(parser);
  1777. return true;
  1778. }
  1779. } else {
  1780. Ref<Script> scr = ResourceLoader::load(ScriptServer::get_global_class_path(p_identifier));
  1781. if (scr.is_valid()) {
  1782. r_type = _type_from_variant(scr);
  1783. r_type.type.is_meta_type = true;
  1784. return true;
  1785. }
  1786. }
  1787. return false;
  1788. }
  1789. // Check global variables (including autoloads).
  1790. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(p_identifier)) {
  1791. r_type = _type_from_variant(GDScriptLanguage::get_singleton()->get_named_globals_map()[p_identifier]);
  1792. return true;
  1793. }
  1794. // Check ClassDB.
  1795. if (ClassDB::class_exists(p_identifier) && ClassDB::is_class_exposed(p_identifier)) {
  1796. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1797. r_type.type.kind = GDScriptParser::DataType::NATIVE;
  1798. r_type.type.native_type = p_identifier;
  1799. r_type.type.is_constant = true;
  1800. if (Engine::get_singleton()->has_singleton(p_identifier)) {
  1801. r_type.type.is_meta_type = false;
  1802. r_type.value = Engine::get_singleton()->get_singleton_object(p_identifier);
  1803. } else {
  1804. r_type.type.is_meta_type = true;
  1805. r_type.value = Variant();
  1806. }
  1807. }
  1808. return false;
  1809. }
  1810. static bool _guess_identifier_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_identifier, GDScriptCompletionIdentifier &r_type) {
  1811. GDScriptParser::DataType base_type = p_base.type;
  1812. bool is_static = base_type.is_meta_type;
  1813. while (base_type.is_set()) {
  1814. switch (base_type.kind) {
  1815. case GDScriptParser::DataType::CLASS:
  1816. if (base_type.class_type->has_member(p_identifier)) {
  1817. const GDScriptParser::ClassNode::Member &member = base_type.class_type->get_member(p_identifier);
  1818. switch (member.type) {
  1819. case GDScriptParser::ClassNode::Member::CONSTANT:
  1820. r_type.type = member.constant->get_datatype();
  1821. if (member.constant->initializer && member.constant->initializer->is_constant) {
  1822. r_type.value = member.constant->initializer->reduced_value;
  1823. }
  1824. return true;
  1825. case GDScriptParser::ClassNode::Member::VARIABLE:
  1826. if (!is_static) {
  1827. if (member.variable->get_datatype().is_set() && !member.variable->get_datatype().is_variant()) {
  1828. r_type.type = member.variable->get_datatype();
  1829. return true;
  1830. } else if (member.variable->initializer) {
  1831. const GDScriptParser::ExpressionNode *init = member.variable->initializer;
  1832. if (init->is_constant) {
  1833. r_type.value = init->reduced_value;
  1834. r_type = _type_from_variant(init->reduced_value);
  1835. return true;
  1836. } else if (init->start_line == p_context.current_line) {
  1837. return false;
  1838. // Detects if variable is assigned to itself
  1839. } else if (_is_expression_named_identifier(init, member.variable->identifier->name)) {
  1840. if (member.variable->initializer->get_datatype().is_set()) {
  1841. r_type.type = member.variable->initializer->get_datatype();
  1842. } else if (member.variable->get_datatype().is_set() && !member.variable->get_datatype().is_variant()) {
  1843. r_type.type = member.variable->get_datatype();
  1844. }
  1845. return true;
  1846. } else if (_guess_expression_type(p_context, init, r_type)) {
  1847. return true;
  1848. } else if (init->get_datatype().is_set() && !init->get_datatype().is_variant()) {
  1849. r_type.type = init->get_datatype();
  1850. return true;
  1851. }
  1852. }
  1853. }
  1854. // TODO: Check assignments in constructor.
  1855. return false;
  1856. case GDScriptParser::ClassNode::Member::ENUM:
  1857. r_type.type = member.m_enum->get_datatype();
  1858. r_type.enumeration = member.m_enum->identifier->name;
  1859. return true;
  1860. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  1861. r_type = _type_from_variant(member.enum_value.value);
  1862. return true;
  1863. case GDScriptParser::ClassNode::Member::SIGNAL:
  1864. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1865. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1866. r_type.type.builtin_type = Variant::SIGNAL;
  1867. return true;
  1868. case GDScriptParser::ClassNode::Member::FUNCTION:
  1869. if (is_static && !member.function->is_static) {
  1870. return false;
  1871. }
  1872. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1873. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1874. r_type.type.builtin_type = Variant::CALLABLE;
  1875. return true;
  1876. case GDScriptParser::ClassNode::Member::CLASS:
  1877. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1878. r_type.type.kind = GDScriptParser::DataType::CLASS;
  1879. r_type.type.class_type = member.m_class;
  1880. return true;
  1881. case GDScriptParser::ClassNode::Member::GROUP:
  1882. return false; // No-op, but silences warnings.
  1883. case GDScriptParser::ClassNode::Member::UNDEFINED:
  1884. return false; // Unreachable.
  1885. }
  1886. return false;
  1887. }
  1888. base_type = base_type.class_type->base_type;
  1889. break;
  1890. case GDScriptParser::DataType::SCRIPT: {
  1891. Ref<Script> scr = base_type.script_type;
  1892. if (scr.is_valid()) {
  1893. HashMap<StringName, Variant> constants;
  1894. scr->get_constants(&constants);
  1895. if (constants.has(p_identifier)) {
  1896. r_type = _type_from_variant(constants[p_identifier]);
  1897. return true;
  1898. }
  1899. if (!is_static) {
  1900. List<PropertyInfo> members;
  1901. scr->get_script_property_list(&members);
  1902. for (const PropertyInfo &prop : members) {
  1903. if (prop.name == p_identifier) {
  1904. r_type = _type_from_property(prop);
  1905. return true;
  1906. }
  1907. }
  1908. }
  1909. Ref<Script> parent = scr->get_base_script();
  1910. if (parent.is_valid()) {
  1911. base_type.script_type = parent;
  1912. } else {
  1913. base_type.kind = GDScriptParser::DataType::NATIVE;
  1914. base_type.native_type = scr->get_instance_base_type();
  1915. }
  1916. } else {
  1917. return false;
  1918. }
  1919. } break;
  1920. case GDScriptParser::DataType::NATIVE: {
  1921. StringName class_name = base_type.native_type;
  1922. if (!ClassDB::class_exists(class_name)) {
  1923. return false;
  1924. }
  1925. // Skip constants since they're all integers. Type does not matter because int has no members.
  1926. PropertyInfo prop;
  1927. if (ClassDB::get_property_info(class_name, p_identifier, &prop)) {
  1928. StringName getter = ClassDB::get_property_getter(class_name, p_identifier);
  1929. if (getter != StringName()) {
  1930. MethodBind *g = ClassDB::get_method(class_name, getter);
  1931. if (g) {
  1932. r_type = _type_from_property(g->get_return_info());
  1933. return true;
  1934. }
  1935. } else {
  1936. r_type = _type_from_property(prop);
  1937. return true;
  1938. }
  1939. }
  1940. return false;
  1941. } break;
  1942. case GDScriptParser::DataType::BUILTIN: {
  1943. Callable::CallError err;
  1944. Variant tmp;
  1945. Variant::construct(base_type.builtin_type, tmp, nullptr, 0, err);
  1946. if (err.error != Callable::CallError::CALL_OK) {
  1947. return false;
  1948. }
  1949. bool valid = false;
  1950. Variant res = tmp.get(p_identifier, &valid);
  1951. if (valid) {
  1952. r_type = _type_from_variant(res);
  1953. r_type.value = Variant();
  1954. r_type.type.is_constant = false;
  1955. return true;
  1956. }
  1957. return false;
  1958. } break;
  1959. default: {
  1960. return false;
  1961. } break;
  1962. }
  1963. }
  1964. return false;
  1965. }
  1966. static void _find_last_return_in_block(GDScriptParser::CompletionContext &p_context, int &r_last_return_line, const GDScriptParser::ExpressionNode **r_last_returned_value) {
  1967. if (!p_context.current_suite) {
  1968. return;
  1969. }
  1970. for (int i = 0; i < p_context.current_suite->statements.size(); i++) {
  1971. if (p_context.current_suite->statements[i]->start_line < r_last_return_line) {
  1972. break;
  1973. }
  1974. GDScriptParser::CompletionContext c = p_context;
  1975. switch (p_context.current_suite->statements[i]->type) {
  1976. case GDScriptParser::Node::FOR:
  1977. c.current_suite = static_cast<const GDScriptParser::ForNode *>(p_context.current_suite->statements[i])->loop;
  1978. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  1979. break;
  1980. case GDScriptParser::Node::WHILE:
  1981. c.current_suite = static_cast<const GDScriptParser::WhileNode *>(p_context.current_suite->statements[i])->loop;
  1982. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  1983. break;
  1984. case GDScriptParser::Node::IF: {
  1985. const GDScriptParser::IfNode *_if = static_cast<const GDScriptParser::IfNode *>(p_context.current_suite->statements[i]);
  1986. c.current_suite = _if->true_block;
  1987. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  1988. if (_if->false_block) {
  1989. c.current_suite = _if->false_block;
  1990. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  1991. }
  1992. } break;
  1993. case GDScriptParser::Node::MATCH: {
  1994. const GDScriptParser::MatchNode *match = static_cast<const GDScriptParser::MatchNode *>(p_context.current_suite->statements[i]);
  1995. for (int j = 0; j < match->branches.size(); j++) {
  1996. c.current_suite = match->branches[j]->block;
  1997. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  1998. }
  1999. } break;
  2000. case GDScriptParser::Node::RETURN: {
  2001. const GDScriptParser::ReturnNode *ret = static_cast<const GDScriptParser::ReturnNode *>(p_context.current_suite->statements[i]);
  2002. if (ret->return_value) {
  2003. if (ret->start_line > r_last_return_line) {
  2004. r_last_return_line = ret->start_line;
  2005. *r_last_returned_value = ret->return_value;
  2006. }
  2007. }
  2008. } break;
  2009. default:
  2010. break;
  2011. }
  2012. }
  2013. }
  2014. static bool _guess_method_return_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_method, GDScriptCompletionIdentifier &r_type) {
  2015. GDScriptParser::DataType base_type = p_base.type;
  2016. bool is_static = base_type.is_meta_type;
  2017. if (is_static && p_method == SNAME("new")) {
  2018. r_type.type = base_type;
  2019. r_type.type.is_meta_type = false;
  2020. r_type.type.is_constant = false;
  2021. return true;
  2022. }
  2023. while (base_type.is_set() && !base_type.is_variant()) {
  2024. switch (base_type.kind) {
  2025. case GDScriptParser::DataType::CLASS:
  2026. if (base_type.class_type->has_function(p_method)) {
  2027. const GDScriptParser::FunctionNode *method = base_type.class_type->get_member(p_method).function;
  2028. if (!is_static || method->is_static) {
  2029. if (method->get_datatype().is_set() && !method->get_datatype().is_variant()) {
  2030. r_type.type = method->get_datatype();
  2031. return true;
  2032. }
  2033. int last_return_line = -1;
  2034. const GDScriptParser::ExpressionNode *last_returned_value = nullptr;
  2035. GDScriptParser::CompletionContext c = p_context;
  2036. c.current_class = base_type.class_type;
  2037. c.current_function = const_cast<GDScriptParser::FunctionNode *>(method);
  2038. c.current_suite = method->body;
  2039. _find_last_return_in_block(c, last_return_line, &last_returned_value);
  2040. if (last_returned_value) {
  2041. c.current_line = c.current_suite->end_line;
  2042. if (_guess_expression_type(c, last_returned_value, r_type)) {
  2043. return true;
  2044. }
  2045. }
  2046. }
  2047. }
  2048. base_type = base_type.class_type->base_type;
  2049. break;
  2050. case GDScriptParser::DataType::SCRIPT: {
  2051. Ref<Script> scr = base_type.script_type;
  2052. if (scr.is_valid()) {
  2053. List<MethodInfo> methods;
  2054. scr->get_script_method_list(&methods);
  2055. for (const MethodInfo &mi : methods) {
  2056. if (mi.name == p_method) {
  2057. r_type = _type_from_property(mi.return_val);
  2058. return true;
  2059. }
  2060. }
  2061. Ref<Script> base_script = scr->get_base_script();
  2062. if (base_script.is_valid()) {
  2063. base_type.script_type = base_script;
  2064. } else {
  2065. base_type.kind = GDScriptParser::DataType::NATIVE;
  2066. base_type.native_type = scr->get_instance_base_type();
  2067. }
  2068. } else {
  2069. return false;
  2070. }
  2071. } break;
  2072. case GDScriptParser::DataType::NATIVE: {
  2073. if (!ClassDB::class_exists(base_type.native_type)) {
  2074. return false;
  2075. }
  2076. MethodBind *mb = ClassDB::get_method(base_type.native_type, p_method);
  2077. if (mb) {
  2078. r_type = _type_from_property(mb->get_return_info());
  2079. return true;
  2080. }
  2081. return false;
  2082. } break;
  2083. case GDScriptParser::DataType::BUILTIN: {
  2084. Callable::CallError err;
  2085. Variant tmp;
  2086. Variant::construct(base_type.builtin_type, tmp, nullptr, 0, err);
  2087. if (err.error != Callable::CallError::CALL_OK) {
  2088. return false;
  2089. }
  2090. List<MethodInfo> methods;
  2091. tmp.get_method_list(&methods);
  2092. for (const MethodInfo &mi : methods) {
  2093. if (mi.name == p_method) {
  2094. r_type = _type_from_property(mi.return_val);
  2095. return true;
  2096. }
  2097. }
  2098. return false;
  2099. } break;
  2100. default: {
  2101. return false;
  2102. }
  2103. }
  2104. }
  2105. return false;
  2106. }
  2107. static void _find_enumeration_candidates(GDScriptParser::CompletionContext &p_context, const String &p_enum_hint, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result) {
  2108. if (!p_enum_hint.contains(".")) {
  2109. // Global constant or in the current class.
  2110. StringName current_enum = p_enum_hint;
  2111. 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) {
  2112. const GDScriptParser::EnumNode *_enum = p_context.current_class->get_member(current_enum).m_enum;
  2113. for (int i = 0; i < _enum->values.size(); i++) {
  2114. ScriptLanguage::CodeCompletionOption option(_enum->values[i].identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM);
  2115. r_result.insert(option.display, option);
  2116. }
  2117. } else {
  2118. for (int i = 0; i < CoreConstants::get_global_constant_count(); i++) {
  2119. if (CoreConstants::get_global_constant_enum(i) == current_enum) {
  2120. ScriptLanguage::CodeCompletionOption option(CoreConstants::get_global_constant_name(i), ScriptLanguage::CODE_COMPLETION_KIND_ENUM);
  2121. r_result.insert(option.display, option);
  2122. }
  2123. }
  2124. }
  2125. } else {
  2126. String class_name = p_enum_hint.get_slice(".", 0);
  2127. String enum_name = p_enum_hint.get_slice(".", 1);
  2128. if (!ClassDB::class_exists(class_name)) {
  2129. return;
  2130. }
  2131. List<StringName> enum_constants;
  2132. ClassDB::get_enum_constants(class_name, enum_name, &enum_constants);
  2133. for (const StringName &E : enum_constants) {
  2134. String candidate = class_name + "." + E;
  2135. int location = _get_enum_constant_location(class_name, E);
  2136. ScriptLanguage::CodeCompletionOption option(candidate, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, location);
  2137. r_result.insert(option.display, option);
  2138. }
  2139. }
  2140. }
  2141. 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) {
  2142. Variant base = p_base.value;
  2143. GDScriptParser::DataType base_type = p_base.type;
  2144. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  2145. while (base_type.is_set() && !base_type.is_variant()) {
  2146. switch (base_type.kind) {
  2147. case GDScriptParser::DataType::CLASS: {
  2148. if (base_type.class_type->has_member(p_method)) {
  2149. const GDScriptParser::ClassNode::Member &member = base_type.class_type->get_member(p_method);
  2150. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION) {
  2151. r_arghint = _make_arguments_hint(member.function, p_argidx);
  2152. return;
  2153. }
  2154. }
  2155. base_type = base_type.class_type->base_type;
  2156. } break;
  2157. case GDScriptParser::DataType::NATIVE: {
  2158. StringName class_name = base_type.native_type;
  2159. if (!ClassDB::class_exists(class_name)) {
  2160. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2161. break;
  2162. }
  2163. MethodInfo info;
  2164. int method_args = 0;
  2165. if (ClassDB::get_method_info(class_name, p_method, &info)) {
  2166. method_args = info.arguments.size();
  2167. if (base.get_type() == Variant::OBJECT) {
  2168. Object *obj = base.operator Object *();
  2169. if (obj) {
  2170. List<String> options;
  2171. obj->get_argument_options(p_method, p_argidx, &options);
  2172. for (String &opt : options) {
  2173. if (opt.is_quoted()) {
  2174. opt = opt.unquote().quote(quote_style); // Handle user preference.
  2175. }
  2176. ScriptLanguage::CodeCompletionOption option(opt, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  2177. r_result.insert(option.display, option);
  2178. }
  2179. }
  2180. }
  2181. if (p_argidx < method_args) {
  2182. PropertyInfo arg_info = info.arguments[p_argidx];
  2183. if (arg_info.usage & (PROPERTY_USAGE_CLASS_IS_ENUM | PROPERTY_USAGE_CLASS_IS_BITFIELD)) {
  2184. _find_enumeration_candidates(p_context, arg_info.class_name, r_result);
  2185. }
  2186. }
  2187. r_arghint = _make_arguments_hint(info, p_argidx);
  2188. }
  2189. if (p_argidx == 0 && ClassDB::is_parent_class(class_name, SNAME("Node")) && (p_method == SNAME("get_node") || p_method == SNAME("has_node"))) {
  2190. // Get autoloads
  2191. List<PropertyInfo> props;
  2192. ProjectSettings::get_singleton()->get_property_list(&props);
  2193. for (const PropertyInfo &E : props) {
  2194. String s = E.name;
  2195. if (!s.begins_with("autoload/")) {
  2196. continue;
  2197. }
  2198. String name = s.get_slice("/", 1);
  2199. ScriptLanguage::CodeCompletionOption option("/root/" + name, ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH);
  2200. option.insert_text = option.display.quote(quote_style);
  2201. r_result.insert(option.display, option);
  2202. }
  2203. }
  2204. if (p_argidx == 0 && method_args > 0 && ClassDB::is_parent_class(class_name, SNAME("InputEvent")) && p_method.operator String().contains("action")) {
  2205. // Get input actions
  2206. List<PropertyInfo> props;
  2207. ProjectSettings::get_singleton()->get_property_list(&props);
  2208. for (const PropertyInfo &E : props) {
  2209. String s = E.name;
  2210. if (!s.begins_with("input/")) {
  2211. continue;
  2212. }
  2213. String name = s.get_slice("/", 1);
  2214. ScriptLanguage::CodeCompletionOption option(name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  2215. option.insert_text = option.display.quote(quote_style);
  2216. r_result.insert(option.display, option);
  2217. }
  2218. }
  2219. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2220. } break;
  2221. case GDScriptParser::DataType::BUILTIN: {
  2222. if (base.get_type() == Variant::NIL) {
  2223. Callable::CallError err;
  2224. Variant::construct(base_type.builtin_type, base, nullptr, 0, err);
  2225. if (err.error != Callable::CallError::CALL_OK) {
  2226. return;
  2227. }
  2228. }
  2229. List<MethodInfo> methods;
  2230. base.get_method_list(&methods);
  2231. for (const MethodInfo &E : methods) {
  2232. if (E.name == p_method) {
  2233. r_arghint = _make_arguments_hint(E, p_argidx);
  2234. return;
  2235. }
  2236. }
  2237. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2238. } break;
  2239. default: {
  2240. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2241. } break;
  2242. }
  2243. }
  2244. }
  2245. static bool _get_subscript_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::SubscriptNode *p_subscript, GDScriptParser::DataType &r_base_type, Variant *r_base = nullptr) {
  2246. if (p_context.base == nullptr) {
  2247. return false;
  2248. }
  2249. const GDScriptParser::GetNodeNode *get_node = nullptr;
  2250. switch (p_subscript->base->type) {
  2251. case GDScriptParser::Node::GET_NODE: {
  2252. get_node = static_cast<GDScriptParser::GetNodeNode *>(p_subscript->base);
  2253. } break;
  2254. case GDScriptParser::Node::IDENTIFIER: {
  2255. const GDScriptParser::IdentifierNode *identifier_node = static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base);
  2256. switch (identifier_node->source) {
  2257. case GDScriptParser::IdentifierNode::Source::MEMBER_VARIABLE: {
  2258. if (p_context.current_class != nullptr) {
  2259. const StringName &member_name = identifier_node->name;
  2260. const GDScriptParser::ClassNode *current_class = p_context.current_class;
  2261. if (current_class->has_member(member_name)) {
  2262. const GDScriptParser::ClassNode::Member &member = current_class->get_member(member_name);
  2263. if (member.type == GDScriptParser::ClassNode::Member::VARIABLE) {
  2264. const GDScriptParser::VariableNode *variable = static_cast<GDScriptParser::VariableNode *>(member.variable);
  2265. if (variable->initializer && variable->initializer->type == GDScriptParser::Node::GET_NODE) {
  2266. get_node = static_cast<GDScriptParser::GetNodeNode *>(variable->initializer);
  2267. }
  2268. }
  2269. }
  2270. }
  2271. } break;
  2272. case GDScriptParser::IdentifierNode::Source::LOCAL_VARIABLE: {
  2273. if (identifier_node->next != nullptr && identifier_node->next->type == GDScriptParser::ClassNode::Node::GET_NODE) {
  2274. get_node = static_cast<GDScriptParser::GetNodeNode *>(identifier_node->next);
  2275. }
  2276. } break;
  2277. default: {
  2278. } break;
  2279. }
  2280. } break;
  2281. default: {
  2282. } break;
  2283. }
  2284. if (get_node != nullptr) {
  2285. const Object *node = p_context.base->call("get_node_or_null", NodePath(get_node->full_path));
  2286. if (node != nullptr) {
  2287. if (r_base != nullptr) {
  2288. *r_base = node;
  2289. }
  2290. r_base_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2291. r_base_type.kind = GDScriptParser::DataType::NATIVE;
  2292. r_base_type.native_type = node->get_class_name();
  2293. r_base_type.builtin_type = Variant::OBJECT;
  2294. return true;
  2295. }
  2296. }
  2297. return false;
  2298. }
  2299. 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) {
  2300. if (p_call->type == GDScriptParser::Node::PRELOAD) {
  2301. if (p_argidx == 0 && bool(EDITOR_GET("text_editor/completion/complete_file_paths"))) {
  2302. _get_directory_contents(EditorFileSystem::get_singleton()->get_filesystem(), r_result);
  2303. }
  2304. MethodInfo mi(PropertyInfo(Variant::OBJECT, "resource", PROPERTY_HINT_RESOURCE_TYPE, "Resource"), "preload", PropertyInfo(Variant::STRING, "path"));
  2305. r_arghint = _make_arguments_hint(mi, p_argidx);
  2306. return;
  2307. } else if (p_call->type != GDScriptParser::Node::CALL) {
  2308. return;
  2309. }
  2310. Variant base;
  2311. GDScriptParser::DataType base_type;
  2312. bool _static = false;
  2313. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(p_call);
  2314. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  2315. GDScriptCompletionIdentifier connect_base;
  2316. if (callee_type == GDScriptParser::Node::SUBSCRIPT) {
  2317. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(call->callee);
  2318. if (subscript->base != nullptr && subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  2319. const GDScriptParser::IdentifierNode *base_identifier = static_cast<const GDScriptParser::IdentifierNode *>(subscript->base);
  2320. Variant::Type method_type = GDScriptParser::get_builtin_type(base_identifier->name);
  2321. if (method_type < Variant::VARIANT_MAX) {
  2322. Variant v;
  2323. Callable::CallError err;
  2324. Variant::construct(method_type, v, nullptr, 0, err);
  2325. if (err.error != Callable::CallError::CALL_OK) {
  2326. return;
  2327. }
  2328. List<MethodInfo> methods;
  2329. v.get_method_list(&methods);
  2330. for (MethodInfo &E : methods) {
  2331. if (p_argidx >= E.arguments.size()) {
  2332. continue;
  2333. }
  2334. if (E.name == call->function_name) {
  2335. r_arghint += _make_arguments_hint(E, p_argidx);
  2336. return;
  2337. }
  2338. }
  2339. }
  2340. }
  2341. if (subscript->is_attribute) {
  2342. bool found_type = _get_subscript_type(p_context, subscript, base_type, &base);
  2343. if (!found_type) {
  2344. GDScriptCompletionIdentifier ci;
  2345. if (_guess_expression_type(p_context, subscript->base, ci)) {
  2346. base_type = ci.type;
  2347. base = ci.value;
  2348. } else {
  2349. return;
  2350. }
  2351. }
  2352. _static = base_type.is_meta_type;
  2353. }
  2354. } else if (Variant::has_utility_function(call->function_name)) {
  2355. MethodInfo info = Variant::get_utility_function_info(call->function_name);
  2356. r_arghint = _make_arguments_hint(info, p_argidx);
  2357. return;
  2358. } else if (GDScriptUtilityFunctions::function_exists(call->function_name)) {
  2359. MethodInfo info = GDScriptUtilityFunctions::get_function_info(call->function_name);
  2360. r_arghint = _make_arguments_hint(info, p_argidx);
  2361. return;
  2362. } else if (GDScriptParser::get_builtin_type(call->function_name) < Variant::VARIANT_MAX) {
  2363. // Complete constructor.
  2364. List<MethodInfo> constructors;
  2365. Variant::get_constructor_list(GDScriptParser::get_builtin_type(call->function_name), &constructors);
  2366. int i = 0;
  2367. for (const MethodInfo &E : constructors) {
  2368. if (p_argidx >= E.arguments.size()) {
  2369. continue;
  2370. }
  2371. if (i > 0) {
  2372. r_arghint += "\n";
  2373. }
  2374. r_arghint += _make_arguments_hint(E, p_argidx);
  2375. i++;
  2376. }
  2377. return;
  2378. } else if (call->is_super || callee_type == GDScriptParser::Node::IDENTIFIER) {
  2379. base = p_context.base;
  2380. if (p_context.current_class) {
  2381. base_type = p_context.current_class->get_datatype();
  2382. _static = !p_context.current_function || p_context.current_function->is_static;
  2383. }
  2384. } else {
  2385. return;
  2386. }
  2387. GDScriptCompletionIdentifier ci;
  2388. ci.type = base_type;
  2389. ci.value = base;
  2390. _find_call_arguments(p_context, ci, call->function_name, p_argidx, _static, r_result, r_arghint);
  2391. r_forced = r_result.size() > 0;
  2392. }
  2393. ::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) {
  2394. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  2395. GDScriptParser parser;
  2396. GDScriptAnalyzer analyzer(&parser);
  2397. parser.parse(p_code, p_path, true);
  2398. analyzer.analyze();
  2399. r_forced = false;
  2400. HashMap<String, ScriptLanguage::CodeCompletionOption> options;
  2401. GDScriptParser::CompletionContext completion_context = parser.get_completion_context();
  2402. completion_context.base = p_owner;
  2403. bool is_function = false;
  2404. switch (completion_context.type) {
  2405. case GDScriptParser::COMPLETION_NONE:
  2406. break;
  2407. case GDScriptParser::COMPLETION_ANNOTATION: {
  2408. List<MethodInfo> annotations;
  2409. parser.get_annotation_list(&annotations);
  2410. for (const MethodInfo &E : annotations) {
  2411. ScriptLanguage::CodeCompletionOption option(E.name.substr(1), ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  2412. if (E.arguments.size() > 0) {
  2413. option.insert_text += "(";
  2414. }
  2415. options.insert(option.display, option);
  2416. }
  2417. r_forced = true;
  2418. } break;
  2419. case GDScriptParser::COMPLETION_ANNOTATION_ARGUMENTS: {
  2420. if (completion_context.node == nullptr || completion_context.node->type != GDScriptParser::Node::ANNOTATION) {
  2421. break;
  2422. }
  2423. const GDScriptParser::AnnotationNode *annotation = static_cast<const GDScriptParser::AnnotationNode *>(completion_context.node);
  2424. _find_annotation_arguments(annotation, completion_context.current_argument, quote_style, options);
  2425. r_forced = true;
  2426. } break;
  2427. case GDScriptParser::COMPLETION_BUILT_IN_TYPE_CONSTANT_OR_STATIC_METHOD: {
  2428. // Constants.
  2429. {
  2430. List<StringName> constants;
  2431. Variant::get_constants_for_type(completion_context.builtin_type, &constants);
  2432. for (const StringName &E : constants) {
  2433. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  2434. bool valid = false;
  2435. Variant default_value = Variant::get_constant_value(completion_context.builtin_type, E, &valid);
  2436. if (valid) {
  2437. option.default_value = default_value;
  2438. }
  2439. options.insert(option.display, option);
  2440. }
  2441. }
  2442. // Methods.
  2443. {
  2444. List<StringName> methods;
  2445. Variant::get_builtin_method_list(completion_context.builtin_type, &methods);
  2446. for (const StringName &E : methods) {
  2447. if (Variant::is_builtin_method_static(completion_context.builtin_type, E)) {
  2448. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  2449. if (Variant::get_builtin_method_argument_count(completion_context.builtin_type, E) > 0 || Variant::is_builtin_method_vararg(completion_context.builtin_type, E)) {
  2450. option.insert_text += "(";
  2451. } else {
  2452. option.insert_text += "()";
  2453. }
  2454. options.insert(option.display, option);
  2455. }
  2456. }
  2457. }
  2458. } break;
  2459. case GDScriptParser::COMPLETION_INHERIT_TYPE: {
  2460. _list_available_types(true, completion_context, options);
  2461. r_forced = true;
  2462. } break;
  2463. case GDScriptParser::COMPLETION_TYPE_NAME_OR_VOID: {
  2464. ScriptLanguage::CodeCompletionOption option("void", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  2465. options.insert(option.display, option);
  2466. }
  2467. [[fallthrough]];
  2468. case GDScriptParser::COMPLETION_TYPE_NAME: {
  2469. _list_available_types(false, completion_context, options);
  2470. r_forced = true;
  2471. } break;
  2472. case GDScriptParser::COMPLETION_PROPERTY_DECLARATION_OR_TYPE: {
  2473. _list_available_types(false, completion_context, options);
  2474. ScriptLanguage::CodeCompletionOption get("get", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  2475. options.insert(get.display, get);
  2476. ScriptLanguage::CodeCompletionOption set("set", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  2477. options.insert(set.display, set);
  2478. r_forced = true;
  2479. } break;
  2480. case GDScriptParser::COMPLETION_PROPERTY_DECLARATION: {
  2481. ScriptLanguage::CodeCompletionOption get("get", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  2482. options.insert(get.display, get);
  2483. ScriptLanguage::CodeCompletionOption set("set", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  2484. options.insert(set.display, set);
  2485. r_forced = true;
  2486. } break;
  2487. case GDScriptParser::COMPLETION_PROPERTY_METHOD: {
  2488. if (!completion_context.current_class) {
  2489. break;
  2490. }
  2491. for (int i = 0; i < completion_context.current_class->members.size(); i++) {
  2492. const GDScriptParser::ClassNode::Member &member = completion_context.current_class->members[i];
  2493. if (member.type != GDScriptParser::ClassNode::Member::FUNCTION) {
  2494. continue;
  2495. }
  2496. if (member.function->is_static) {
  2497. continue;
  2498. }
  2499. ScriptLanguage::CodeCompletionOption option(member.function->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  2500. options.insert(option.display, option);
  2501. }
  2502. r_forced = true;
  2503. } break;
  2504. case GDScriptParser::COMPLETION_ASSIGN: {
  2505. GDScriptCompletionIdentifier type;
  2506. if (!completion_context.node || completion_context.node->type != GDScriptParser::Node::ASSIGNMENT) {
  2507. break;
  2508. }
  2509. if (!_guess_expression_type(completion_context, static_cast<const GDScriptParser::AssignmentNode *>(completion_context.node)->assignee, type)) {
  2510. _find_identifiers(completion_context, false, options, 0);
  2511. r_forced = true;
  2512. break;
  2513. }
  2514. if (!type.enumeration.is_empty()) {
  2515. _find_enumeration_candidates(completion_context, type.enumeration, options);
  2516. r_forced = options.size() > 0;
  2517. } else {
  2518. _find_identifiers(completion_context, false, options, 0);
  2519. r_forced = true;
  2520. }
  2521. } break;
  2522. case GDScriptParser::COMPLETION_METHOD:
  2523. is_function = true;
  2524. [[fallthrough]];
  2525. case GDScriptParser::COMPLETION_IDENTIFIER: {
  2526. _find_identifiers(completion_context, is_function, options, 0);
  2527. } break;
  2528. case GDScriptParser::COMPLETION_ATTRIBUTE_METHOD:
  2529. is_function = true;
  2530. [[fallthrough]];
  2531. case GDScriptParser::COMPLETION_ATTRIBUTE: {
  2532. r_forced = true;
  2533. const GDScriptParser::SubscriptNode *attr = static_cast<const GDScriptParser::SubscriptNode *>(completion_context.node);
  2534. if (attr->base) {
  2535. GDScriptCompletionIdentifier base;
  2536. bool found_type = _get_subscript_type(completion_context, attr, base.type);
  2537. if (!found_type && !_guess_expression_type(completion_context, attr->base, base)) {
  2538. break;
  2539. }
  2540. _find_identifiers_in_base(base, is_function, options, 0);
  2541. }
  2542. } break;
  2543. case GDScriptParser::COMPLETION_SUBSCRIPT: {
  2544. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(completion_context.node);
  2545. GDScriptCompletionIdentifier base;
  2546. if (!_guess_expression_type(completion_context, subscript->base, base)) {
  2547. break;
  2548. }
  2549. GDScriptParser::CompletionContext c = completion_context;
  2550. c.current_function = nullptr;
  2551. c.current_suite = nullptr;
  2552. c.base = base.value.get_type() == Variant::OBJECT ? base.value.operator Object *() : nullptr;
  2553. if (base.type.kind == GDScriptParser::DataType::CLASS) {
  2554. c.current_class = base.type.class_type;
  2555. } else {
  2556. c.current_class = nullptr;
  2557. }
  2558. _find_identifiers_in_base(base, false, options, 0);
  2559. } break;
  2560. case GDScriptParser::COMPLETION_TYPE_ATTRIBUTE: {
  2561. if (!completion_context.current_class) {
  2562. break;
  2563. }
  2564. const GDScriptParser::TypeNode *type = static_cast<const GDScriptParser::TypeNode *>(completion_context.node);
  2565. bool found = true;
  2566. GDScriptCompletionIdentifier base;
  2567. base.type.kind = GDScriptParser::DataType::CLASS;
  2568. base.type.type_source = GDScriptParser::DataType::INFERRED;
  2569. base.type.is_constant = true;
  2570. base.type.class_type = completion_context.current_class;
  2571. base.value = completion_context.base;
  2572. for (int i = 0; i < completion_context.current_argument; i++) {
  2573. GDScriptCompletionIdentifier ci;
  2574. if (!_guess_identifier_type_from_base(completion_context, base, type->type_chain[i]->name, ci)) {
  2575. found = false;
  2576. break;
  2577. }
  2578. base = ci;
  2579. }
  2580. // TODO: Improve this to only list types.
  2581. if (found) {
  2582. _find_identifiers_in_base(base, false, options, 0);
  2583. }
  2584. r_forced = true;
  2585. } break;
  2586. case GDScriptParser::COMPLETION_RESOURCE_PATH: {
  2587. if (EDITOR_GET("text_editor/completion/complete_file_paths")) {
  2588. _get_directory_contents(EditorFileSystem::get_singleton()->get_filesystem(), options);
  2589. r_forced = true;
  2590. }
  2591. } break;
  2592. case GDScriptParser::COMPLETION_CALL_ARGUMENTS: {
  2593. if (!completion_context.node) {
  2594. break;
  2595. }
  2596. _find_call_arguments(completion_context, completion_context.node, completion_context.current_argument, options, r_forced, r_call_hint);
  2597. } break;
  2598. case GDScriptParser::COMPLETION_OVERRIDE_METHOD: {
  2599. GDScriptParser::DataType native_type = completion_context.current_class->base_type;
  2600. while (native_type.is_set() && native_type.kind != GDScriptParser::DataType::NATIVE) {
  2601. switch (native_type.kind) {
  2602. case GDScriptParser::DataType::CLASS: {
  2603. native_type = native_type.class_type->base_type;
  2604. } break;
  2605. default: {
  2606. native_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2607. } break;
  2608. }
  2609. }
  2610. if (!native_type.is_set()) {
  2611. break;
  2612. }
  2613. StringName class_name = native_type.native_type;
  2614. if (!ClassDB::class_exists(class_name)) {
  2615. break;
  2616. }
  2617. bool use_type_hint = EditorSettings::get_singleton()->get_setting("text_editor/completion/add_type_hints").operator bool();
  2618. List<MethodInfo> virtual_methods;
  2619. ClassDB::get_virtual_methods(class_name, &virtual_methods);
  2620. for (const MethodInfo &mi : virtual_methods) {
  2621. String method_hint = mi.name;
  2622. if (method_hint.contains(":")) {
  2623. method_hint = method_hint.get_slice(":", 0);
  2624. }
  2625. method_hint += "(";
  2626. if (mi.arguments.size()) {
  2627. for (int i = 0; i < mi.arguments.size(); i++) {
  2628. if (i > 0) {
  2629. method_hint += ", ";
  2630. }
  2631. String arg = mi.arguments[i].name;
  2632. if (arg.contains(":")) {
  2633. arg = arg.substr(0, arg.find(":"));
  2634. }
  2635. method_hint += arg;
  2636. if (use_type_hint && mi.arguments[i].type != Variant::NIL) {
  2637. method_hint += ": ";
  2638. if (mi.arguments[i].type == Variant::OBJECT && mi.arguments[i].class_name != StringName()) {
  2639. method_hint += mi.arguments[i].class_name.operator String();
  2640. } else {
  2641. method_hint += Variant::get_type_name(mi.arguments[i].type);
  2642. }
  2643. }
  2644. }
  2645. }
  2646. method_hint += ")";
  2647. if (use_type_hint && (mi.return_val.type != Variant::NIL || !(mi.return_val.usage & PROPERTY_USAGE_NIL_IS_VARIANT))) {
  2648. method_hint += " -> ";
  2649. if (mi.return_val.type == Variant::NIL) {
  2650. method_hint += "void";
  2651. } else if (mi.return_val.type == Variant::OBJECT && mi.return_val.class_name != StringName()) {
  2652. method_hint += mi.return_val.class_name.operator String();
  2653. } else {
  2654. method_hint += Variant::get_type_name(mi.return_val.type);
  2655. }
  2656. }
  2657. method_hint += ":";
  2658. ScriptLanguage::CodeCompletionOption option(method_hint, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  2659. options.insert(option.display, option);
  2660. }
  2661. } break;
  2662. case GDScriptParser::COMPLETION_GET_NODE: {
  2663. // Handles the `$Node/Path` or `$"Some NodePath"` syntax specifically.
  2664. if (p_owner) {
  2665. List<String> opts;
  2666. p_owner->get_argument_options("get_node", 0, &opts);
  2667. for (const String &E : opts) {
  2668. r_forced = true;
  2669. String opt = E.strip_edges();
  2670. if (opt.is_quoted()) {
  2671. // Remove quotes so that we can handle user preferred quote style,
  2672. // or handle NodePaths which are valid identifiers and don't need quotes.
  2673. opt = opt.unquote();
  2674. }
  2675. // The path needs quotes if it's not a valid identifier (with an exception
  2676. // for "/" as path separator, which also doesn't require quotes).
  2677. if (!opt.replace("/", "_").is_valid_identifier()) {
  2678. opt = opt.quote(quote_style); // Handle user preference.
  2679. }
  2680. ScriptLanguage::CodeCompletionOption option(opt, ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH);
  2681. options.insert(option.display, option);
  2682. }
  2683. // Get autoloads.
  2684. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : ProjectSettings::get_singleton()->get_autoload_list()) {
  2685. String path = "/root/" + E.key;
  2686. ScriptLanguage::CodeCompletionOption option(path.quote(quote_style), ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH);
  2687. options.insert(option.display, option);
  2688. }
  2689. }
  2690. } break;
  2691. case GDScriptParser::COMPLETION_SUPER_METHOD: {
  2692. if (!completion_context.current_class) {
  2693. break;
  2694. }
  2695. _find_identifiers_in_class(completion_context.current_class, true, false, true, options, 0);
  2696. } break;
  2697. }
  2698. for (const KeyValue<String, ScriptLanguage::CodeCompletionOption> &E : options) {
  2699. r_options->push_back(E.value);
  2700. }
  2701. return OK;
  2702. }
  2703. #else
  2704. 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) {
  2705. return OK;
  2706. }
  2707. #endif
  2708. //////// END COMPLETION //////////
  2709. String GDScriptLanguage::_get_indentation() const {
  2710. #ifdef TOOLS_ENABLED
  2711. if (Engine::get_singleton()->is_editor_hint()) {
  2712. bool use_space_indentation = EDITOR_GET("text_editor/behavior/indent/type");
  2713. if (use_space_indentation) {
  2714. int indent_size = EDITOR_GET("text_editor/behavior/indent/size");
  2715. String space_indent = "";
  2716. for (int i = 0; i < indent_size; i++) {
  2717. space_indent += " ";
  2718. }
  2719. return space_indent;
  2720. }
  2721. }
  2722. #endif
  2723. return "\t";
  2724. }
  2725. void GDScriptLanguage::auto_indent_code(String &p_code, int p_from_line, int p_to_line) const {
  2726. String indent = _get_indentation();
  2727. Vector<String> lines = p_code.split("\n");
  2728. List<int> indent_stack;
  2729. for (int i = 0; i < lines.size(); i++) {
  2730. String l = lines[i];
  2731. int tc = 0;
  2732. for (int j = 0; j < l.length(); j++) {
  2733. if (l[j] == ' ' || l[j] == '\t') {
  2734. tc++;
  2735. } else {
  2736. break;
  2737. }
  2738. }
  2739. String st = l.substr(tc, l.length()).strip_edges();
  2740. if (st.is_empty() || st.begins_with("#")) {
  2741. continue; //ignore!
  2742. }
  2743. int ilevel = 0;
  2744. if (indent_stack.size()) {
  2745. ilevel = indent_stack.back()->get();
  2746. }
  2747. if (tc > ilevel) {
  2748. indent_stack.push_back(tc);
  2749. } else if (tc < ilevel) {
  2750. while (indent_stack.size() && indent_stack.back()->get() > tc) {
  2751. indent_stack.pop_back();
  2752. }
  2753. if (indent_stack.size() && indent_stack.back()->get() != tc) {
  2754. indent_stack.push_back(tc); // this is not right but gets the job done
  2755. }
  2756. }
  2757. if (i >= p_from_line) {
  2758. l = "";
  2759. for (int j = 0; j < indent_stack.size(); j++) {
  2760. l += indent;
  2761. }
  2762. l += st;
  2763. } else if (i > p_to_line) {
  2764. break;
  2765. }
  2766. lines.write[i] = l;
  2767. }
  2768. p_code = "";
  2769. for (int i = 0; i < lines.size(); i++) {
  2770. if (i > 0) {
  2771. p_code += "\n";
  2772. }
  2773. p_code += lines[i];
  2774. }
  2775. }
  2776. #ifdef TOOLS_ENABLED
  2777. static Error _lookup_symbol_from_base(const GDScriptParser::DataType &p_base, const String &p_symbol, bool p_is_function, GDScriptLanguage::LookupResult &r_result) {
  2778. GDScriptParser::DataType base_type = p_base;
  2779. while (base_type.is_set()) {
  2780. switch (base_type.kind) {
  2781. case GDScriptParser::DataType::CLASS: {
  2782. if (base_type.class_type) {
  2783. if (base_type.class_type->has_member(p_symbol)) {
  2784. r_result.type = ScriptLanguage::LOOKUP_RESULT_SCRIPT_LOCATION;
  2785. r_result.location = base_type.class_type->get_member(p_symbol).get_line();
  2786. r_result.class_path = base_type.script_path;
  2787. Error err = OK;
  2788. r_result.script = GDScriptCache::get_shallow_script(r_result.class_path, err);
  2789. return err;
  2790. }
  2791. base_type = base_type.class_type->base_type;
  2792. }
  2793. } break;
  2794. case GDScriptParser::DataType::SCRIPT: {
  2795. Ref<Script> scr = base_type.script_type;
  2796. if (scr.is_valid()) {
  2797. int line = scr->get_member_line(p_symbol);
  2798. if (line >= 0) {
  2799. r_result.type = ScriptLanguage::LOOKUP_RESULT_SCRIPT_LOCATION;
  2800. r_result.location = line;
  2801. r_result.script = scr;
  2802. return OK;
  2803. }
  2804. Ref<Script> base_script = scr->get_base_script();
  2805. if (base_script.is_valid()) {
  2806. base_type.script_type = base_script;
  2807. } else {
  2808. base_type.kind = GDScriptParser::DataType::NATIVE;
  2809. base_type.native_type = scr->get_instance_base_type();
  2810. }
  2811. } else {
  2812. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2813. }
  2814. } break;
  2815. case GDScriptParser::DataType::NATIVE: {
  2816. StringName class_name = base_type.native_type;
  2817. if (!ClassDB::class_exists(class_name)) {
  2818. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2819. break;
  2820. }
  2821. if (ClassDB::has_method(class_name, p_symbol, true)) {
  2822. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  2823. r_result.class_name = base_type.native_type;
  2824. r_result.class_member = p_symbol;
  2825. return OK;
  2826. }
  2827. List<MethodInfo> virtual_methods;
  2828. ClassDB::get_virtual_methods(class_name, &virtual_methods, true);
  2829. for (const MethodInfo &E : virtual_methods) {
  2830. if (E.name == p_symbol) {
  2831. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  2832. r_result.class_name = base_type.native_type;
  2833. r_result.class_member = p_symbol;
  2834. return OK;
  2835. }
  2836. }
  2837. if (ClassDB::has_signal(class_name, p_symbol, true)) {
  2838. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_SIGNAL;
  2839. r_result.class_name = base_type.native_type;
  2840. r_result.class_member = p_symbol;
  2841. return OK;
  2842. }
  2843. StringName enum_name = ClassDB::get_integer_constant_enum(class_name, p_symbol, true);
  2844. if (enum_name != StringName()) {
  2845. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  2846. r_result.class_name = base_type.native_type;
  2847. r_result.class_member = enum_name;
  2848. return OK;
  2849. }
  2850. List<String> constants;
  2851. ClassDB::get_integer_constant_list(class_name, &constants, true);
  2852. for (const String &E : constants) {
  2853. if (E == p_symbol) {
  2854. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  2855. r_result.class_name = base_type.native_type;
  2856. r_result.class_member = p_symbol;
  2857. return OK;
  2858. }
  2859. }
  2860. if (ClassDB::has_property(class_name, p_symbol, true)) {
  2861. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  2862. r_result.class_name = base_type.native_type;
  2863. r_result.class_member = p_symbol;
  2864. return OK;
  2865. }
  2866. StringName parent = ClassDB::get_parent_class(class_name);
  2867. if (parent != StringName()) {
  2868. base_type.native_type = parent;
  2869. } else {
  2870. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2871. }
  2872. } break;
  2873. case GDScriptParser::DataType::BUILTIN: {
  2874. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2875. if (Variant::has_constant(base_type.builtin_type, p_symbol)) {
  2876. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  2877. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  2878. r_result.class_member = p_symbol;
  2879. return OK;
  2880. }
  2881. Variant v;
  2882. Ref<RefCounted> v_ref;
  2883. if (base_type.builtin_type == Variant::OBJECT) {
  2884. v_ref.instantiate();
  2885. v = v_ref;
  2886. } else {
  2887. Callable::CallError err;
  2888. Variant::construct(base_type.builtin_type, v, nullptr, 0, err);
  2889. if (err.error != Callable::CallError::CALL_OK) {
  2890. break;
  2891. }
  2892. }
  2893. if (v.has_method(p_symbol)) {
  2894. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  2895. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  2896. r_result.class_member = p_symbol;
  2897. return OK;
  2898. }
  2899. bool valid = false;
  2900. v.get(p_symbol, &valid);
  2901. if (valid) {
  2902. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  2903. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  2904. r_result.class_member = p_symbol;
  2905. return OK;
  2906. }
  2907. } break;
  2908. default: {
  2909. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2910. } break;
  2911. }
  2912. }
  2913. return ERR_CANT_RESOLVE;
  2914. }
  2915. ::Error GDScriptLanguage::lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result) {
  2916. // Before parsing, try the usual stuff.
  2917. if (ClassDB::class_exists(p_symbol)) {
  2918. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  2919. r_result.class_name = p_symbol;
  2920. return OK;
  2921. }
  2922. for (int i = 0; i < Variant::VARIANT_MAX; i++) {
  2923. Variant::Type t = Variant::Type(i);
  2924. if (Variant::get_type_name(t) == p_symbol) {
  2925. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  2926. r_result.class_name = Variant::get_type_name(t);
  2927. return OK;
  2928. }
  2929. }
  2930. if ("PI" == p_symbol || "TAU" == p_symbol || "INF" == p_symbol || "NAN" == p_symbol) {
  2931. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  2932. r_result.class_name = "@GDScript";
  2933. r_result.class_member = p_symbol;
  2934. return OK;
  2935. }
  2936. GDScriptParser parser;
  2937. parser.parse(p_code, p_path, true);
  2938. GDScriptParser::CompletionContext context = parser.get_completion_context();
  2939. context.base = p_owner;
  2940. // Allows class functions with the names like built-ins to be handled properly.
  2941. if (context.type != GDScriptParser::COMPLETION_ATTRIBUTE) {
  2942. // Need special checks for assert and preload as they are technically
  2943. // keywords, so are not registered in GDScriptUtilityFunctions.
  2944. if (GDScriptUtilityFunctions::function_exists(p_symbol) || "assert" == p_symbol || "preload" == p_symbol) {
  2945. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  2946. r_result.class_name = "@GDScript";
  2947. r_result.class_member = p_symbol;
  2948. return OK;
  2949. }
  2950. }
  2951. GDScriptAnalyzer analyzer(&parser);
  2952. analyzer.analyze();
  2953. if (context.current_class && context.current_class->extends.size() > 0) {
  2954. bool success = false;
  2955. ClassDB::get_integer_constant(context.current_class->extends[0], p_symbol, &success);
  2956. if (success) {
  2957. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  2958. r_result.class_name = context.current_class->extends[0];
  2959. r_result.class_member = p_symbol;
  2960. return OK;
  2961. }
  2962. }
  2963. bool is_function = false;
  2964. switch (context.type) {
  2965. case GDScriptParser::COMPLETION_BUILT_IN_TYPE_CONSTANT_OR_STATIC_METHOD: {
  2966. if (!Variant::has_builtin_method(context.builtin_type, StringName(p_symbol))) {
  2967. // A constant.
  2968. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  2969. r_result.class_name = Variant::get_type_name(context.builtin_type);
  2970. r_result.class_member = p_symbol;
  2971. return OK;
  2972. }
  2973. // A method.
  2974. GDScriptParser::DataType base_type;
  2975. base_type.kind = GDScriptParser::DataType::BUILTIN;
  2976. base_type.builtin_type = context.builtin_type;
  2977. if (_lookup_symbol_from_base(base_type, p_symbol, true, r_result) == OK) {
  2978. return OK;
  2979. }
  2980. } break;
  2981. case GDScriptParser::COMPLETION_SUPER_METHOD:
  2982. case GDScriptParser::COMPLETION_METHOD: {
  2983. is_function = true;
  2984. [[fallthrough]];
  2985. }
  2986. case GDScriptParser::COMPLETION_ASSIGN:
  2987. case GDScriptParser::COMPLETION_CALL_ARGUMENTS:
  2988. case GDScriptParser::COMPLETION_IDENTIFIER: {
  2989. GDScriptParser::DataType base_type;
  2990. if (context.current_class) {
  2991. if (context.type != GDScriptParser::COMPLETION_SUPER_METHOD) {
  2992. base_type = context.current_class->get_datatype();
  2993. } else {
  2994. base_type = context.current_class->base_type;
  2995. }
  2996. } else {
  2997. break;
  2998. }
  2999. if (!is_function && context.current_suite) {
  3000. // Lookup local variables.
  3001. const GDScriptParser::SuiteNode *suite = context.current_suite;
  3002. while (suite) {
  3003. if (suite->has_local(p_symbol)) {
  3004. r_result.type = ScriptLanguage::LOOKUP_RESULT_SCRIPT_LOCATION;
  3005. r_result.location = suite->get_local(p_symbol).start_line;
  3006. return OK;
  3007. }
  3008. suite = suite->parent_block;
  3009. }
  3010. }
  3011. if (_lookup_symbol_from_base(base_type, p_symbol, is_function, r_result) == OK) {
  3012. return OK;
  3013. }
  3014. if (!is_function) {
  3015. // Guess in autoloads as singletons.
  3016. if (ProjectSettings::get_singleton()->has_autoload(p_symbol)) {
  3017. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(p_symbol);
  3018. if (autoload.is_singleton) {
  3019. String scr_path = autoload.path;
  3020. if (!scr_path.ends_with(".gd")) {
  3021. // Not a script, try find the script anyway,
  3022. // may have some success.
  3023. scr_path = scr_path.get_basename() + ".gd";
  3024. }
  3025. if (FileAccess::exists(scr_path)) {
  3026. r_result.type = ScriptLanguage::LOOKUP_RESULT_SCRIPT_LOCATION;
  3027. r_result.location = 0;
  3028. r_result.script = ResourceLoader::load(scr_path);
  3029. return OK;
  3030. }
  3031. }
  3032. }
  3033. // Global.
  3034. HashMap<StringName, int> classes = GDScriptLanguage::get_singleton()->get_global_map();
  3035. if (classes.has(p_symbol)) {
  3036. Variant value = GDScriptLanguage::get_singleton()->get_global_array()[classes[p_symbol]];
  3037. if (value.get_type() == Variant::OBJECT) {
  3038. Object *obj = value;
  3039. if (obj) {
  3040. if (Object::cast_to<GDScriptNativeClass>(obj)) {
  3041. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3042. r_result.class_name = Object::cast_to<GDScriptNativeClass>(obj)->get_name();
  3043. } else {
  3044. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3045. r_result.class_name = obj->get_class();
  3046. }
  3047. // proxy class remove the underscore.
  3048. if (r_result.class_name.begins_with("_")) {
  3049. r_result.class_name = r_result.class_name.substr(1);
  3050. }
  3051. return OK;
  3052. }
  3053. } else {
  3054. /*
  3055. // Because get_integer_constant_enum and get_integer_constant don't work on @GlobalScope
  3056. // We cannot determine the exact nature of the identifier here
  3057. // Otherwise these codes would work
  3058. StringName enumName = ClassDB::get_integer_constant_enum("@GlobalScope", p_symbol, true);
  3059. if (enumName != nullptr) {
  3060. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3061. r_result.class_name = "@GlobalScope";
  3062. r_result.class_member = enumName;
  3063. return OK;
  3064. }
  3065. else {
  3066. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3067. r_result.class_name = "@GlobalScope";
  3068. r_result.class_member = p_symbol;
  3069. return OK;
  3070. }*/
  3071. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_TBD_GLOBALSCOPE;
  3072. r_result.class_name = "@GlobalScope";
  3073. r_result.class_member = p_symbol;
  3074. return OK;
  3075. }
  3076. } else {
  3077. List<StringName> utility_functions;
  3078. Variant::get_utility_function_list(&utility_functions);
  3079. if (utility_functions.find(p_symbol) != nullptr) {
  3080. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_TBD_GLOBALSCOPE;
  3081. r_result.class_name = "@GlobalScope";
  3082. r_result.class_member = p_symbol;
  3083. return OK;
  3084. }
  3085. }
  3086. }
  3087. } break;
  3088. case GDScriptParser::COMPLETION_ATTRIBUTE_METHOD: {
  3089. is_function = true;
  3090. [[fallthrough]];
  3091. }
  3092. case GDScriptParser::COMPLETION_ATTRIBUTE: {
  3093. if (context.node->type != GDScriptParser::Node::SUBSCRIPT) {
  3094. break;
  3095. }
  3096. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(context.node);
  3097. if (!subscript->is_attribute) {
  3098. break;
  3099. }
  3100. GDScriptCompletionIdentifier base;
  3101. bool found_type = _get_subscript_type(context, subscript, base.type);
  3102. if (!found_type && !_guess_expression_type(context, subscript->base, base)) {
  3103. break;
  3104. }
  3105. if (_lookup_symbol_from_base(base.type, p_symbol, is_function, r_result) == OK) {
  3106. return OK;
  3107. }
  3108. } break;
  3109. case GDScriptParser::COMPLETION_OVERRIDE_METHOD: {
  3110. GDScriptParser::DataType base_type = context.current_class->base_type;
  3111. if (_lookup_symbol_from_base(base_type, p_symbol, true, r_result) == OK) {
  3112. return OK;
  3113. }
  3114. } break;
  3115. case GDScriptParser::COMPLETION_TYPE_NAME_OR_VOID:
  3116. case GDScriptParser::COMPLETION_TYPE_NAME: {
  3117. GDScriptParser::DataType base_type = context.current_class->get_datatype();
  3118. if (_lookup_symbol_from_base(base_type, p_symbol, false, r_result) == OK) {
  3119. return OK;
  3120. }
  3121. } break;
  3122. case GDScriptParser::COMPLETION_ANNOTATION: {
  3123. const String annotation_symbol = "@" + p_symbol;
  3124. if (parser.annotation_exists(annotation_symbol)) {
  3125. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ANNOTATION;
  3126. r_result.class_name = "@GDScript";
  3127. r_result.class_member = annotation_symbol;
  3128. return OK;
  3129. }
  3130. } break;
  3131. default: {
  3132. }
  3133. }
  3134. return ERR_CANT_RESOLVE;
  3135. }
  3136. #endif