gdscript_editor.cpp 134 KB

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