gdscript_editor.cpp 124 KB

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