gdscript_editor.cpp 118 KB

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