gdscript_editor.cpp 140 KB

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