2
0

gdscript_editor.cpp 109 KB

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