gdscript_editor.cpp 118 KB

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