gdscript_workspace.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804
  1. /*************************************************************************/
  2. /* gdscript_workspace.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 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_workspace.h"
  31. #include "../gdscript.h"
  32. #include "../gdscript_parser.h"
  33. #include "core/project_settings.h"
  34. #include "core/script_language.h"
  35. #include "editor/editor_file_system.h"
  36. #include "editor/editor_help.h"
  37. #include "editor/editor_node.h"
  38. #include "gdscript_language_protocol.h"
  39. #include "scene/resources/packed_scene.h"
  40. void GDScriptWorkspace::_bind_methods() {
  41. ClassDB::bind_method(D_METHOD("didDeleteFiles"), &GDScriptWorkspace::did_delete_files);
  42. ClassDB::bind_method(D_METHOD("symbol"), &GDScriptWorkspace::symbol);
  43. ClassDB::bind_method(D_METHOD("parse_script", "path", "content"), &GDScriptWorkspace::parse_script);
  44. ClassDB::bind_method(D_METHOD("parse_local_script", "path"), &GDScriptWorkspace::parse_local_script);
  45. ClassDB::bind_method(D_METHOD("get_file_path", "uri"), &GDScriptWorkspace::get_file_path);
  46. ClassDB::bind_method(D_METHOD("get_file_uri", "path"), &GDScriptWorkspace::get_file_uri);
  47. ClassDB::bind_method(D_METHOD("publish_diagnostics", "path"), &GDScriptWorkspace::publish_diagnostics);
  48. ClassDB::bind_method(D_METHOD("generate_script_api", "path"), &GDScriptWorkspace::generate_script_api);
  49. ClassDB::bind_method(D_METHOD("apply_new_signal", "obj", "function", "args"), &GDScriptWorkspace::apply_new_signal);
  50. }
  51. void GDScriptWorkspace::apply_new_signal(Object *obj, String function, PoolStringArray args) {
  52. Ref<Script> script = obj->get_script();
  53. if (script->get_language()->get_name() != "GDScript") {
  54. return;
  55. }
  56. String function_signature = "func " + function;
  57. String source = script->get_source_code();
  58. if (source.find(function_signature) != -1) {
  59. return;
  60. }
  61. int first_class = source.find("\nclass ");
  62. int start_line = 0;
  63. if (first_class != -1) {
  64. start_line = source.substr(0, first_class).split("\n").size();
  65. } else {
  66. start_line = source.split("\n").size();
  67. }
  68. String function_body = "\n\n" + function_signature + "(";
  69. for (int i = 0; i < args.size(); ++i) {
  70. function_body += args[i];
  71. if (i < args.size() - 1) {
  72. function_body += ", ";
  73. }
  74. }
  75. function_body += ")";
  76. if (EditorSettings::get_singleton()->get_setting("text_editor/completion/add_type_hints")) {
  77. function_body += " -> void";
  78. }
  79. function_body += ":\n\tpass # Replace with function body.\n";
  80. lsp::TextEdit text_edit;
  81. if (first_class != -1) {
  82. function_body += "\n\n";
  83. }
  84. text_edit.range.end.line = text_edit.range.start.line = start_line;
  85. text_edit.newText = function_body;
  86. String uri = get_file_uri(script->get_path());
  87. lsp::ApplyWorkspaceEditParams params;
  88. params.edit.add_edit(uri, text_edit);
  89. GDScriptLanguageProtocol::get_singleton()->request_client("workspace/applyEdit", params.to_json());
  90. }
  91. void GDScriptWorkspace::did_delete_files(const Dictionary &p_params) {
  92. Array files = p_params["files"];
  93. for (int i = 0; i < files.size(); ++i) {
  94. Dictionary file = files[i];
  95. String uri = file["uri"];
  96. String path = get_file_path(uri);
  97. parse_script(path, "");
  98. }
  99. }
  100. void GDScriptWorkspace::remove_cache_parser(const String &p_path) {
  101. Map<String, ExtendGDScriptParser *>::Element *parser = parse_results.find(p_path);
  102. Map<String, ExtendGDScriptParser *>::Element *script = scripts.find(p_path);
  103. if (parser && script) {
  104. if (script->get() && script->get() == parser->get()) {
  105. memdelete(script->get());
  106. } else {
  107. memdelete(script->get());
  108. memdelete(parser->get());
  109. }
  110. parse_results.erase(p_path);
  111. scripts.erase(p_path);
  112. } else if (parser) {
  113. memdelete(parser->get());
  114. parse_results.erase(p_path);
  115. } else if (script) {
  116. memdelete(script->get());
  117. scripts.erase(p_path);
  118. }
  119. }
  120. const lsp::DocumentSymbol *GDScriptWorkspace::get_native_symbol(const String &p_class, const String &p_member) const {
  121. StringName class_name = p_class;
  122. StringName empty;
  123. while (class_name != empty) {
  124. if (const Map<StringName, lsp::DocumentSymbol>::Element *E = native_symbols.find(class_name)) {
  125. const lsp::DocumentSymbol &class_symbol = E->value();
  126. if (p_member.empty()) {
  127. return &class_symbol;
  128. } else {
  129. for (int i = 0; i < class_symbol.children.size(); i++) {
  130. const lsp::DocumentSymbol &symbol = class_symbol.children[i];
  131. if (symbol.name == p_member) {
  132. return &symbol;
  133. }
  134. }
  135. }
  136. }
  137. class_name = ClassDB::get_parent_class(class_name);
  138. }
  139. return nullptr;
  140. }
  141. const lsp::DocumentSymbol *GDScriptWorkspace::get_script_symbol(const String &p_path) const {
  142. const Map<String, ExtendGDScriptParser *>::Element *S = scripts.find(p_path);
  143. if (S) {
  144. return &(S->get()->get_symbols());
  145. }
  146. return nullptr;
  147. }
  148. const lsp::DocumentSymbol *GDScriptWorkspace::get_parameter_symbol(const lsp::DocumentSymbol *p_parent, const String &symbol_identifier) {
  149. for (int i = 0; i < p_parent->children.size(); ++i) {
  150. const lsp::DocumentSymbol *parameter_symbol = &p_parent->children[i];
  151. if (!parameter_symbol->detail.empty() && parameter_symbol->name == symbol_identifier) {
  152. return parameter_symbol;
  153. }
  154. }
  155. return nullptr;
  156. }
  157. const lsp::DocumentSymbol *GDScriptWorkspace::get_local_symbol(const ExtendGDScriptParser *p_parser, const String &p_symbol_identifier) {
  158. const lsp::DocumentSymbol *class_symbol = &p_parser->get_symbols();
  159. for (int i = 0; i < class_symbol->children.size(); ++i) {
  160. if (class_symbol->children[i].kind == lsp::SymbolKind::Function || class_symbol->children[i].kind == lsp::SymbolKind::Class) {
  161. const lsp::DocumentSymbol *function_symbol = &class_symbol->children[i];
  162. for (int l = 0; l < function_symbol->children.size(); ++l) {
  163. const lsp::DocumentSymbol *local = &function_symbol->children[l];
  164. if (!local->detail.empty() && local->name == p_symbol_identifier) {
  165. return local;
  166. }
  167. }
  168. }
  169. }
  170. return nullptr;
  171. }
  172. void GDScriptWorkspace::reload_all_workspace_scripts() {
  173. List<String> paths;
  174. list_script_files("res://", paths);
  175. for (List<String>::Element *E = paths.front(); E; E = E->next()) {
  176. const String &path = E->get();
  177. Error err;
  178. String content = FileAccess::get_file_as_string(path, &err);
  179. ERR_CONTINUE(err != OK);
  180. err = parse_script(path, content);
  181. if (err != OK) {
  182. Map<String, ExtendGDScriptParser *>::Element *S = parse_results.find(path);
  183. String err_msg = "Failed parse script " + path;
  184. if (S) {
  185. err_msg += "\n" + S->get()->get_error();
  186. }
  187. ERR_CONTINUE_MSG(err != OK, err_msg);
  188. }
  189. }
  190. }
  191. void GDScriptWorkspace::list_script_files(const String &p_root_dir, List<String> &r_files) {
  192. Error err;
  193. DirAccessRef dir = DirAccess::open(p_root_dir, &err);
  194. if (OK == err) {
  195. dir->list_dir_begin();
  196. String file_name = dir->get_next();
  197. while (file_name.length()) {
  198. if (dir->current_is_dir() && file_name != "." && file_name != ".." && file_name != "./") {
  199. list_script_files(p_root_dir.plus_file(file_name), r_files);
  200. } else if (file_name.ends_with(".gd")) {
  201. String script_file = p_root_dir.plus_file(file_name);
  202. r_files.push_back(script_file);
  203. }
  204. file_name = dir->get_next();
  205. }
  206. }
  207. }
  208. ExtendGDScriptParser *GDScriptWorkspace::get_parse_successed_script(const String &p_path) {
  209. const Map<String, ExtendGDScriptParser *>::Element *S = scripts.find(p_path);
  210. if (!S) {
  211. parse_local_script(p_path);
  212. S = scripts.find(p_path);
  213. }
  214. if (S) {
  215. return S->get();
  216. }
  217. return nullptr;
  218. }
  219. ExtendGDScriptParser *GDScriptWorkspace::get_parse_result(const String &p_path) {
  220. const Map<String, ExtendGDScriptParser *>::Element *S = parse_results.find(p_path);
  221. if (!S) {
  222. parse_local_script(p_path);
  223. S = parse_results.find(p_path);
  224. }
  225. if (S) {
  226. return S->get();
  227. }
  228. return nullptr;
  229. }
  230. Array GDScriptWorkspace::symbol(const Dictionary &p_params) {
  231. String query = p_params["query"];
  232. Array arr;
  233. if (!query.empty()) {
  234. for (Map<String, ExtendGDScriptParser *>::Element *E = scripts.front(); E; E = E->next()) {
  235. Vector<lsp::DocumentedSymbolInformation> script_symbols;
  236. E->get()->get_symbols().symbol_tree_as_list(E->key(), script_symbols);
  237. for (int i = 0; i < script_symbols.size(); ++i) {
  238. if (query.is_subsequence_ofi(script_symbols[i].name)) {
  239. lsp::DocumentedSymbolInformation symbol = script_symbols[i];
  240. symbol.location.uri = get_file_uri(symbol.location.uri);
  241. arr.push_back(symbol.to_json());
  242. }
  243. }
  244. }
  245. }
  246. return arr;
  247. }
  248. Error GDScriptWorkspace::initialize() {
  249. if (initialized) {
  250. return OK;
  251. }
  252. DocData *doc = EditorHelp::get_doc_data();
  253. for (Map<String, DocData::ClassDoc>::Element *E = doc->class_list.front(); E; E = E->next()) {
  254. const DocData::ClassDoc &class_data = E->value();
  255. lsp::DocumentSymbol class_symbol;
  256. String class_name = E->key();
  257. class_symbol.name = class_name;
  258. class_symbol.native_class = class_name;
  259. class_symbol.kind = lsp::SymbolKind::Class;
  260. class_symbol.detail = String("<Native> class ") + class_name;
  261. if (!class_data.inherits.empty()) {
  262. class_symbol.detail += " extends " + class_data.inherits;
  263. }
  264. class_symbol.documentation = class_data.brief_description + "\n" + class_data.description;
  265. for (int i = 0; i < class_data.constants.size(); i++) {
  266. const DocData::ConstantDoc &const_data = class_data.constants[i];
  267. lsp::DocumentSymbol symbol;
  268. symbol.name = const_data.name;
  269. symbol.native_class = class_name;
  270. symbol.kind = lsp::SymbolKind::Constant;
  271. symbol.detail = "const " + class_name + "." + const_data.name;
  272. if (const_data.enumeration.length()) {
  273. symbol.detail += ": " + const_data.enumeration;
  274. }
  275. symbol.detail += " = " + const_data.value;
  276. symbol.documentation = const_data.description;
  277. class_symbol.children.push_back(symbol);
  278. }
  279. for (int i = 0; i < class_data.properties.size(); i++) {
  280. const DocData::PropertyDoc &data = class_data.properties[i];
  281. lsp::DocumentSymbol symbol;
  282. symbol.name = data.name;
  283. symbol.native_class = class_name;
  284. symbol.kind = lsp::SymbolKind::Property;
  285. symbol.detail = "var " + class_name + "." + data.name;
  286. if (data.enumeration.length()) {
  287. symbol.detail += ": " + data.enumeration;
  288. } else {
  289. symbol.detail += ": " + data.type;
  290. }
  291. symbol.documentation = data.description;
  292. class_symbol.children.push_back(symbol);
  293. }
  294. for (int i = 0; i < class_data.theme_properties.size(); i++) {
  295. const DocData::ThemeItemDoc &data = class_data.theme_properties[i];
  296. lsp::DocumentSymbol symbol;
  297. symbol.name = data.name;
  298. symbol.native_class = class_name;
  299. symbol.kind = lsp::SymbolKind::Property;
  300. symbol.detail = "<Theme> var " + class_name + "." + data.name + ": " + data.type;
  301. symbol.documentation = data.description;
  302. class_symbol.children.push_back(symbol);
  303. }
  304. Vector<DocData::MethodDoc> methods_signals;
  305. methods_signals.append_array(class_data.methods);
  306. const int signal_start_idx = methods_signals.size();
  307. methods_signals.append_array(class_data.signals);
  308. for (int i = 0; i < methods_signals.size(); i++) {
  309. const DocData::MethodDoc &data = methods_signals[i];
  310. lsp::DocumentSymbol symbol;
  311. symbol.name = data.name;
  312. symbol.native_class = class_name;
  313. symbol.kind = i >= signal_start_idx ? lsp::SymbolKind::Event : lsp::SymbolKind::Method;
  314. String params = "";
  315. bool arg_default_value_started = false;
  316. for (int j = 0; j < data.arguments.size(); j++) {
  317. const DocData::ArgumentDoc &arg = data.arguments[j];
  318. lsp::DocumentSymbol symbol_arg;
  319. symbol_arg.name = arg.name;
  320. symbol_arg.kind = lsp::SymbolKind::Variable;
  321. symbol_arg.detail = arg.type;
  322. if (!arg_default_value_started && !arg.default_value.empty()) {
  323. arg_default_value_started = true;
  324. }
  325. String arg_str = arg.name + ": " + arg.type;
  326. if (arg_default_value_started) {
  327. arg_str += " = " + arg.default_value;
  328. }
  329. if (j < data.arguments.size() - 1) {
  330. arg_str += ", ";
  331. }
  332. params += arg_str;
  333. symbol.children.push_back(symbol_arg);
  334. }
  335. if (data.qualifiers.find("vararg") != -1) {
  336. params += params.empty() ? "..." : ", ...";
  337. }
  338. String return_type = data.return_type;
  339. if (return_type.empty()) {
  340. return_type = "void";
  341. }
  342. symbol.detail = "func " + class_name + "." + data.name + "(" + params + ") -> " + return_type;
  343. symbol.documentation = data.description;
  344. class_symbol.children.push_back(symbol);
  345. }
  346. native_symbols.insert(class_name, class_symbol);
  347. }
  348. reload_all_workspace_scripts();
  349. if (GDScriptLanguageProtocol::get_singleton()->is_smart_resolve_enabled()) {
  350. for (Map<StringName, lsp::DocumentSymbol>::Element *E = native_symbols.front(); E; E = E->next()) {
  351. ClassMembers members;
  352. const lsp::DocumentSymbol &class_symbol = E->get();
  353. for (int i = 0; i < class_symbol.children.size(); i++) {
  354. const lsp::DocumentSymbol &symbol = class_symbol.children[i];
  355. members.set(symbol.name, &symbol);
  356. }
  357. native_members.set(E->key(), members);
  358. }
  359. // cache member completions
  360. for (Map<String, ExtendGDScriptParser *>::Element *S = scripts.front(); S; S = S->next()) {
  361. S->get()->get_member_completions();
  362. }
  363. }
  364. EditorNode *editor_node = EditorNode::get_singleton();
  365. editor_node->connect("script_add_function_request", this, "apply_new_signal");
  366. return OK;
  367. }
  368. Error GDScriptWorkspace::parse_script(const String &p_path, const String &p_content) {
  369. ExtendGDScriptParser *parser = memnew(ExtendGDScriptParser);
  370. Error err = parser->parse(p_content, p_path);
  371. Map<String, ExtendGDScriptParser *>::Element *last_parser = parse_results.find(p_path);
  372. Map<String, ExtendGDScriptParser *>::Element *last_script = scripts.find(p_path);
  373. if (err == OK) {
  374. remove_cache_parser(p_path);
  375. parse_results[p_path] = parser;
  376. scripts[p_path] = parser;
  377. } else {
  378. if (last_parser && last_script && last_parser->get() != last_script->get()) {
  379. memdelete(last_parser->get());
  380. }
  381. parse_results[p_path] = parser;
  382. }
  383. publish_diagnostics(p_path);
  384. return err;
  385. }
  386. Dictionary GDScriptWorkspace::rename(const lsp::TextDocumentPositionParams &p_doc_pos, const String &new_name) {
  387. Error err;
  388. String path = get_file_path(p_doc_pos.textDocument.uri);
  389. lsp::WorkspaceEdit edit;
  390. List<String> paths;
  391. list_script_files("res://", paths);
  392. const lsp::DocumentSymbol *reference_symbol = resolve_symbol(p_doc_pos);
  393. if (reference_symbol) {
  394. String identifier = reference_symbol->name;
  395. for (List<String>::Element *PE = paths.front(); PE; PE = PE->next()) {
  396. Vector<String> content = FileAccess::get_file_as_string(PE->get(), &err).split("\n");
  397. for (int i = 0; i < content.size(); ++i) {
  398. String line = content[i];
  399. int character = line.find(identifier);
  400. while (character > -1) {
  401. lsp::TextDocumentPositionParams params;
  402. lsp::TextDocumentIdentifier text_doc;
  403. text_doc.uri = get_file_uri(PE->get());
  404. params.textDocument = text_doc;
  405. params.position.line = i;
  406. params.position.character = character;
  407. const lsp::DocumentSymbol *other_symbol = resolve_symbol(params);
  408. if (other_symbol == reference_symbol) {
  409. edit.add_change(text_doc.uri, i, character, character + identifier.length(), new_name);
  410. }
  411. character = line.find(identifier, character + 1);
  412. }
  413. }
  414. }
  415. }
  416. return edit.to_json();
  417. }
  418. Error GDScriptWorkspace::parse_local_script(const String &p_path) {
  419. Error err;
  420. String content = FileAccess::get_file_as_string(p_path, &err);
  421. if (err == OK) {
  422. err = parse_script(p_path, content);
  423. }
  424. return err;
  425. }
  426. String GDScriptWorkspace::get_file_path(const String &p_uri) const {
  427. String path = p_uri;
  428. path = path.replace(root_uri + "/", "res://");
  429. path = path.http_unescape();
  430. return path;
  431. }
  432. String GDScriptWorkspace::get_file_uri(const String &p_path) const {
  433. String uri = p_path;
  434. uri = uri.replace("res://", root_uri + "/");
  435. return uri;
  436. }
  437. void GDScriptWorkspace::publish_diagnostics(const String &p_path) {
  438. Dictionary params;
  439. Array errors;
  440. const Map<String, ExtendGDScriptParser *>::Element *ele = parse_results.find(p_path);
  441. if (ele) {
  442. const Vector<lsp::Diagnostic> &list = ele->get()->get_diagnostics();
  443. errors.resize(list.size());
  444. for (int i = 0; i < list.size(); ++i) {
  445. errors[i] = list[i].to_json();
  446. }
  447. }
  448. params["diagnostics"] = errors;
  449. params["uri"] = get_file_uri(p_path);
  450. GDScriptLanguageProtocol::get_singleton()->notify_client("textDocument/publishDiagnostics", params);
  451. }
  452. void GDScriptWorkspace::_get_owners(EditorFileSystemDirectory *efsd, String p_path, List<String> &owners) {
  453. if (!efsd) {
  454. return;
  455. }
  456. for (int i = 0; i < efsd->get_subdir_count(); i++) {
  457. _get_owners(efsd->get_subdir(i), p_path, owners);
  458. }
  459. for (int i = 0; i < efsd->get_file_count(); i++) {
  460. Vector<String> deps = efsd->get_file_deps(i);
  461. bool found = false;
  462. for (int j = 0; j < deps.size(); j++) {
  463. if (deps[j] == p_path) {
  464. found = true;
  465. break;
  466. }
  467. }
  468. if (!found) {
  469. continue;
  470. }
  471. owners.push_back(efsd->get_file_path(i));
  472. }
  473. }
  474. Node *GDScriptWorkspace::_get_owner_scene_node(String p_path) {
  475. Node *owner_scene_node = nullptr;
  476. List<String> owners;
  477. _get_owners(EditorFileSystem::get_singleton()->get_filesystem(), p_path, owners);
  478. for (int i = 0; i < owners.size(); i++) {
  479. NodePath owner_path = owners[i];
  480. RES owner_res = ResourceLoader::load(owner_path);
  481. if (Object::cast_to<PackedScene>(owner_res.ptr())) {
  482. Ref<PackedScene> owner_packed_scene = Ref<PackedScene>(Object::cast_to<PackedScene>(*owner_res));
  483. owner_scene_node = owner_packed_scene->instance();
  484. break;
  485. }
  486. }
  487. return owner_scene_node;
  488. }
  489. void GDScriptWorkspace::completion(const lsp::CompletionParams &p_params, List<ScriptCodeCompletionOption> *r_options) {
  490. String path = get_file_path(p_params.textDocument.uri);
  491. String call_hint;
  492. bool forced = false;
  493. if (const ExtendGDScriptParser *parser = get_parse_result(path)) {
  494. Node *owner_scene_node = _get_owner_scene_node(path);
  495. Array stack;
  496. Node *current = nullptr;
  497. if (owner_scene_node) {
  498. stack.push_back(owner_scene_node);
  499. while (!stack.empty()) {
  500. current = stack.pop_back();
  501. Ref<GDScript> script = current->get_script();
  502. if (script.is_valid() && script->get_path() == path) {
  503. break;
  504. }
  505. for (int i = 0; i < current->get_child_count(); ++i) {
  506. stack.push_back(current->get_child(i));
  507. }
  508. }
  509. Ref<GDScript> script = current->get_script();
  510. if (!script.is_valid() || script->get_path() != path) {
  511. current = owner_scene_node;
  512. }
  513. }
  514. String code = parser->get_text_for_completion(p_params.position);
  515. GDScriptLanguage::get_singleton()->complete_code(code, path, current, r_options, forced, call_hint);
  516. if (owner_scene_node) {
  517. memdelete(owner_scene_node);
  518. }
  519. }
  520. }
  521. const lsp::DocumentSymbol *GDScriptWorkspace::resolve_symbol(const lsp::TextDocumentPositionParams &p_doc_pos, const String &p_symbol_name, bool p_func_required) {
  522. const lsp::DocumentSymbol *symbol = nullptr;
  523. String path = get_file_path(p_doc_pos.textDocument.uri);
  524. if (const ExtendGDScriptParser *parser = get_parse_result(path)) {
  525. String symbol_identifier = p_symbol_name;
  526. Vector<String> identifier_parts = symbol_identifier.split("(");
  527. if (identifier_parts.size()) {
  528. symbol_identifier = identifier_parts[0];
  529. }
  530. lsp::Position pos = p_doc_pos.position;
  531. if (symbol_identifier.empty()) {
  532. Vector2i offset;
  533. symbol_identifier = parser->get_identifier_under_position(p_doc_pos.position, offset);
  534. pos.character += offset.y;
  535. }
  536. if (!symbol_identifier.empty()) {
  537. if (ScriptServer::is_global_class(symbol_identifier)) {
  538. String class_path = ScriptServer::get_global_class_path(symbol_identifier);
  539. symbol = get_script_symbol(class_path);
  540. } else {
  541. ScriptLanguage::LookupResult ret;
  542. if (symbol_identifier == "new" && parser->get_lines()[p_doc_pos.position.line].replace(" ", "").replace("\t", "").find("new(") > -1) {
  543. symbol_identifier = "_init";
  544. }
  545. if (OK == GDScriptLanguage::get_singleton()->lookup_code(parser->get_text_for_lookup_symbol(pos, symbol_identifier, p_func_required), symbol_identifier, path, nullptr, ret)) {
  546. if (ret.type == ScriptLanguage::LookupResult::RESULT_SCRIPT_LOCATION) {
  547. String target_script_path = path;
  548. if (!ret.script.is_null()) {
  549. target_script_path = ret.script->get_path();
  550. }
  551. if (const ExtendGDScriptParser *target_parser = get_parse_result(target_script_path)) {
  552. symbol = target_parser->get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(ret.location));
  553. if (symbol && symbol->kind == lsp::SymbolKind::Function && symbol->name != symbol_identifier) {
  554. symbol = get_parameter_symbol(symbol, symbol_identifier);
  555. }
  556. }
  557. } else {
  558. String member = ret.class_member;
  559. if (member.empty() && symbol_identifier != ret.class_name) {
  560. member = symbol_identifier;
  561. }
  562. symbol = get_native_symbol(ret.class_name, member);
  563. }
  564. } else {
  565. symbol = parser->get_member_symbol(symbol_identifier);
  566. if (!symbol) {
  567. symbol = get_local_symbol(parser, symbol_identifier);
  568. }
  569. }
  570. }
  571. }
  572. }
  573. return symbol;
  574. }
  575. void GDScriptWorkspace::resolve_related_symbols(const lsp::TextDocumentPositionParams &p_doc_pos, List<const lsp::DocumentSymbol *> &r_list) {
  576. String path = get_file_path(p_doc_pos.textDocument.uri);
  577. if (const ExtendGDScriptParser *parser = get_parse_result(path)) {
  578. String symbol_identifier;
  579. Vector2i offset;
  580. symbol_identifier = parser->get_identifier_under_position(p_doc_pos.position, offset);
  581. const StringName *class_ptr = native_members.next(nullptr);
  582. while (class_ptr) {
  583. const ClassMembers &members = native_members.get(*class_ptr);
  584. if (const lsp::DocumentSymbol *const *symbol = members.getptr(symbol_identifier)) {
  585. r_list.push_back(*symbol);
  586. }
  587. class_ptr = native_members.next(class_ptr);
  588. }
  589. for (Map<String, ExtendGDScriptParser *>::Element *E = scripts.front(); E; E = E->next()) {
  590. const ExtendGDScriptParser *script = E->get();
  591. const ClassMembers &members = script->get_members();
  592. if (const lsp::DocumentSymbol *const *symbol = members.getptr(symbol_identifier)) {
  593. r_list.push_back(*symbol);
  594. }
  595. const HashMap<String, ClassMembers> &inner_classes = script->get_inner_classes();
  596. const String *_class = inner_classes.next(nullptr);
  597. while (_class) {
  598. const ClassMembers *inner_class = inner_classes.getptr(*_class);
  599. if (const lsp::DocumentSymbol *const *symbol = inner_class->getptr(symbol_identifier)) {
  600. r_list.push_back(*symbol);
  601. }
  602. _class = inner_classes.next(_class);
  603. }
  604. }
  605. }
  606. }
  607. const lsp::DocumentSymbol *GDScriptWorkspace::resolve_native_symbol(const lsp::NativeSymbolInspectParams &p_params) {
  608. if (Map<StringName, lsp::DocumentSymbol>::Element *E = native_symbols.find(p_params.native_class)) {
  609. const lsp::DocumentSymbol &symbol = E->get();
  610. if (p_params.symbol_name.empty() || p_params.symbol_name == symbol.name) {
  611. return &symbol;
  612. }
  613. for (int i = 0; i < symbol.children.size(); ++i) {
  614. if (symbol.children[i].name == p_params.symbol_name) {
  615. return &(symbol.children[i]);
  616. }
  617. }
  618. }
  619. return nullptr;
  620. }
  621. void GDScriptWorkspace::resolve_document_links(const String &p_uri, List<lsp::DocumentLink> &r_list) {
  622. if (const ExtendGDScriptParser *parser = get_parse_successed_script(get_file_path(p_uri))) {
  623. const List<lsp::DocumentLink> &links = parser->get_document_links();
  624. for (const List<lsp::DocumentLink>::Element *E = links.front(); E; E = E->next()) {
  625. r_list.push_back(E->get());
  626. }
  627. }
  628. }
  629. Dictionary GDScriptWorkspace::generate_script_api(const String &p_path) {
  630. Dictionary api;
  631. if (const ExtendGDScriptParser *parser = get_parse_successed_script(p_path)) {
  632. api = parser->generate_api();
  633. }
  634. return api;
  635. }
  636. Error GDScriptWorkspace::resolve_signature(const lsp::TextDocumentPositionParams &p_doc_pos, lsp::SignatureHelp &r_signature) {
  637. if (const ExtendGDScriptParser *parser = get_parse_result(get_file_path(p_doc_pos.textDocument.uri))) {
  638. lsp::TextDocumentPositionParams text_pos;
  639. text_pos.textDocument = p_doc_pos.textDocument;
  640. if (parser->get_left_function_call(p_doc_pos.position, text_pos.position, r_signature.activeParameter) == OK) {
  641. List<const lsp::DocumentSymbol *> symbols;
  642. if (const lsp::DocumentSymbol *symbol = resolve_symbol(text_pos)) {
  643. symbols.push_back(symbol);
  644. } else if (GDScriptLanguageProtocol::get_singleton()->is_smart_resolve_enabled()) {
  645. GDScriptLanguageProtocol::get_singleton()->get_workspace()->resolve_related_symbols(text_pos, symbols);
  646. }
  647. for (List<const lsp::DocumentSymbol *>::Element *E = symbols.front(); E; E = E->next()) {
  648. const lsp::DocumentSymbol *symbol = E->get();
  649. if (symbol->kind == lsp::SymbolKind::Method || symbol->kind == lsp::SymbolKind::Function) {
  650. lsp::SignatureInformation signature_info;
  651. signature_info.label = symbol->detail;
  652. signature_info.documentation = symbol->render();
  653. for (int i = 0; i < symbol->children.size(); i++) {
  654. const lsp::DocumentSymbol &arg = symbol->children[i];
  655. lsp::ParameterInformation arg_info;
  656. arg_info.label = arg.name;
  657. signature_info.parameters.push_back(arg_info);
  658. }
  659. r_signature.signatures.push_back(signature_info);
  660. break;
  661. }
  662. }
  663. if (r_signature.signatures.size()) {
  664. return OK;
  665. }
  666. }
  667. }
  668. return ERR_METHOD_NOT_FOUND;
  669. }
  670. GDScriptWorkspace::GDScriptWorkspace() {
  671. ProjectSettings::get_singleton()->get_resource_path();
  672. }
  673. GDScriptWorkspace::~GDScriptWorkspace() {
  674. Set<String> cached_parsers;
  675. for (Map<String, ExtendGDScriptParser *>::Element *E = parse_results.front(); E; E = E->next()) {
  676. cached_parsers.insert(E->key());
  677. }
  678. for (Map<String, ExtendGDScriptParser *>::Element *E = scripts.front(); E; E = E->next()) {
  679. cached_parsers.insert(E->key());
  680. }
  681. for (Set<String>::Element *E = cached_parsers.front(); E; E = E->next()) {
  682. remove_cache_parser(E->get());
  683. }
  684. }