gdscript_editor.cpp 139 KB

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