gdscript_workspace.cpp 24 KB

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