1/**************************************************************************/
2/* gdscript_workspace.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef GDSCRIPT_WORKSPACE_H
32#define GDSCRIPT_WORKSPACE_H
33
34#include "../gdscript_parser.h"
35#include "gdscript_extend_parser.h"
36#include "godot_lsp.h"
37
38#include "core/variant/variant.h"
39#include "editor/editor_file_system.h"
40
41class GDScriptWorkspace : public RefCounted {
42 GDCLASS(GDScriptWorkspace, RefCounted);
43
44private:
45 void _get_owners(EditorFileSystemDirectory *efsd, String p_path, List<String> &owners);
46 Node *_get_owner_scene_node(String p_path);
47
48protected:
49 static void _bind_methods();
50 void remove_cache_parser(const String &p_path);
51 bool initialized = false;
52 HashMap<StringName, lsp::DocumentSymbol> native_symbols;
53
54 const lsp::DocumentSymbol *get_native_symbol(const String &p_class, const String &p_member = "") const;
55 const lsp::DocumentSymbol *get_script_symbol(const String &p_path) const;
56 const lsp::DocumentSymbol *get_parameter_symbol(const lsp::DocumentSymbol *p_parent, const String &symbol_identifier);
57 const lsp::DocumentSymbol *get_local_symbol_at(const ExtendGDScriptParser *p_parser, const String &p_symbol_identifier, const lsp::Position p_position);
58
59 void reload_all_workspace_scripts();
60
61 ExtendGDScriptParser *get_parse_successed_script(const String &p_path);
62 ExtendGDScriptParser *get_parse_result(const String &p_path);
63
64 void list_script_files(const String &p_root_dir, List<String> &r_files);
65
66 void apply_new_signal(Object *obj, String function, PackedStringArray args);
67
68public:
69 String root;
70 String root_uri;
71
72 HashMap<String, ExtendGDScriptParser *> scripts;
73 HashMap<String, ExtendGDScriptParser *> parse_results;
74 HashMap<StringName, ClassMembers> native_members;
75
76public:
77 Error initialize();
78
79 Error parse_script(const String &p_path, const String &p_content);
80 Error parse_local_script(const String &p_path);
81
82 String get_file_path(const String &p_uri) const;
83 String get_file_uri(const String &p_path) const;
84
85 void publish_diagnostics(const String &p_path);
86 void completion(const lsp::CompletionParams &p_params, List<ScriptLanguage::CodeCompletionOption> *r_options);
87
88 const lsp::DocumentSymbol *resolve_symbol(const lsp::TextDocumentPositionParams &p_doc_pos, const String &p_symbol_name = "", bool p_func_required = false);
89 void resolve_related_symbols(const lsp::TextDocumentPositionParams &p_doc_pos, List<const lsp::DocumentSymbol *> &r_list);
90 const lsp::DocumentSymbol *resolve_native_symbol(const lsp::NativeSymbolInspectParams &p_params);
91 void resolve_document_links(const String &p_uri, List<lsp::DocumentLink> &r_list);
92 Dictionary generate_script_api(const String &p_path);
93 Error resolve_signature(const lsp::TextDocumentPositionParams &p_doc_pos, lsp::SignatureHelp &r_signature);
94 void did_delete_files(const Dictionary &p_params);
95 Dictionary rename(const lsp::TextDocumentPositionParams &p_doc_pos, const String &new_name);
96 bool can_rename(const lsp::TextDocumentPositionParams &p_doc_pos, lsp::DocumentSymbol &r_symbol, lsp::Range &r_range);
97 Vector<lsp::Location> find_usages_in_file(const lsp::DocumentSymbol &p_symbol, const String &p_file_path);
98 Vector<lsp::Location> find_all_usages(const lsp::DocumentSymbol &p_symbol);
99
100 GDScriptWorkspace();
101 ~GDScriptWorkspace();
102};
103
104#endif // GDSCRIPT_WORKSPACE_H
105