summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBooksBaum <15612932+Booksbaum@users.noreply.github.com>2023-07-28 17:06:08 +0200
committerryanabx <ryanbrue@hotmail.com>2023-09-11 09:46:34 -0500
commit0202a36a7a0eb76dec9814728e30e00074dc7bb2 (patch)
tree1628450e38be206c3b951652a7934f5a740c2888
parent221884e6bc260c38f16422081b7d4efd49a71375 (diff)
downloadredot-engine-0202a36a7a0eb76dec9814728e30e00074dc7bb2.tar.gz
Language Server: Improve hovered symbol resolution, fix renaming bugs, implement reference lookup
Co-Authored-By: Ryan Brue <56272643+ryanabx@users.noreply.github.com> Co-Authored-By: BooksBaum <15612932+booksbaum@users.noreply.github.com>
-rw-r--r--modules/gdscript/gdscript_editor.cpp9
-rw-r--r--modules/gdscript/language_server/gdscript_extend_parser.cpp462
-rw-r--r--modules/gdscript/language_server/gdscript_extend_parser.h78
-rw-r--r--modules/gdscript/language_server/gdscript_language_protocol.cpp10
-rw-r--r--modules/gdscript/language_server/gdscript_text_document.cpp55
-rw-r--r--modules/gdscript/language_server/gdscript_text_document.h2
-rw-r--r--modules/gdscript/language_server/gdscript_workspace.cpp199
-rw-r--r--modules/gdscript/language_server/gdscript_workspace.h8
-rw-r--r--modules/gdscript/language_server/godot_lsp.h173
-rw-r--r--modules/gdscript/tests/scripts/lsp/class.notest.gd132
-rw-r--r--modules/gdscript/tests/scripts/lsp/enums.notest.gd26
-rw-r--r--modules/gdscript/tests/scripts/lsp/indentation.notest.gd28
-rw-r--r--modules/gdscript/tests/scripts/lsp/lambdas.notest.gd91
-rw-r--r--modules/gdscript/tests/scripts/lsp/local_variables.notest.gd25
-rw-r--r--modules/gdscript/tests/scripts/lsp/properties.notest.gd65
-rw-r--r--modules/gdscript/tests/scripts/lsp/scopes.notest.gd106
-rw-r--r--modules/gdscript/tests/scripts/lsp/shadowing_initializer.notest.gd56
-rw-r--r--modules/gdscript/tests/test_lsp.h480
18 files changed, 1653 insertions, 352 deletions
diff --git a/modules/gdscript/gdscript_editor.cpp b/modules/gdscript/gdscript_editor.cpp
index 6cad3b2b90..5e626f0520 100644
--- a/modules/gdscript/gdscript_editor.cpp
+++ b/modules/gdscript/gdscript_editor.cpp
@@ -1459,8 +1459,13 @@ static bool _guess_expression_type(GDScriptParser::CompletionContext &p_context,
if (p_expression->is_constant) {
// Already has a value, so just use that.
r_type = _type_from_variant(p_expression->reduced_value);
- if (p_expression->get_datatype().kind == GDScriptParser::DataType::ENUM) {
- r_type.type = p_expression->get_datatype();
+ switch (p_expression->get_datatype().kind) {
+ case GDScriptParser::DataType::ENUM:
+ case GDScriptParser::DataType::CLASS:
+ r_type.type = p_expression->get_datatype();
+ break;
+ default:
+ break;
}
found = true;
} else {
diff --git a/modules/gdscript/language_server/gdscript_extend_parser.cpp b/modules/gdscript/language_server/gdscript_extend_parser.cpp
index 3a5a54e275..362f253a99 100644
--- a/modules/gdscript/language_server/gdscript_extend_parser.cpp
+++ b/modules/gdscript/language_server/gdscript_extend_parser.cpp
@@ -32,9 +32,94 @@
#include "../gdscript.h"
#include "../gdscript_analyzer.h"
+#include "editor/editor_settings.h"
#include "gdscript_language_protocol.h"
#include "gdscript_workspace.h"
+int get_indent_size() {
+ if (EditorSettings::get_singleton()) {
+ return EditorSettings::get_singleton()->get_setting("text_editor/behavior/indent/size");
+ } else {
+ return 4;
+ }
+}
+
+lsp::Position GodotPosition::to_lsp(const Vector<String> &p_lines) const {
+ lsp::Position res;
+
+ // Special case: `line = 0` -> root class (range covers everything).
+ if (this->line <= 0) {
+ return res;
+ }
+ // Special case: `line = p_lines.size() + 1` -> root class (range covers everything).
+ if (this->line >= p_lines.size() + 1) {
+ res.line = p_lines.size();
+ return res;
+ }
+ res.line = this->line - 1;
+ // Note: character outside of `pos_line.length()-1` is valid.
+ res.character = this->column - 1;
+
+ String pos_line = p_lines[res.line];
+ if (pos_line.contains("\t")) {
+ int tab_size = get_indent_size();
+
+ int in_col = 1;
+ int res_char = 0;
+
+ while (res_char < pos_line.size() && in_col < this->column) {
+ if (pos_line[res_char] == '\t') {
+ in_col += tab_size;
+ res_char++;
+ } else {
+ in_col++;
+ res_char++;
+ }
+ }
+
+ res.character = res_char;
+ }
+
+ return res;
+}
+
+GodotPosition GodotPosition::from_lsp(const lsp::Position p_pos, const Vector<String> &p_lines) {
+ GodotPosition res(p_pos.line + 1, p_pos.character + 1);
+
+ // Line outside of actual text is valid (-> pos/cursor at end of text).
+ if (res.line > p_lines.size()) {
+ return res;
+ }
+
+ String line = p_lines[p_pos.line];
+ int tabs_before_char = 0;
+ for (int i = 0; i < p_pos.character && i < line.length(); i++) {
+ if (line[i] == '\t') {
+ tabs_before_char++;
+ }
+ }
+
+ if (tabs_before_char > 0) {
+ int tab_size = get_indent_size();
+ res.column += tabs_before_char * (tab_size - 1);
+ }
+
+ return res;
+}
+
+lsp::Range GodotRange::to_lsp(const Vector<String> &p_lines) const {
+ lsp::Range res;
+ res.start = start.to_lsp(p_lines);
+ res.end = end.to_lsp(p_lines);
+ return res;
+}
+
+GodotRange GodotRange::from_lsp(const lsp::Range &p_range, const Vector<String> &p_lines) {
+ GodotPosition start = GodotPosition::from_lsp(p_range.start, p_lines);
+ GodotPosition end = GodotPosition::from_lsp(p_range.end, p_lines);
+ return GodotRange(start, end);
+}
+
void ExtendGDScriptParser::update_diagnostics() {
diagnostics.clear();
@@ -90,7 +175,7 @@ void ExtendGDScriptParser::update_symbols() {
const lsp::DocumentSymbol &symbol = class_symbol.children[i];
members.insert(symbol.name, &symbol);
- // cache level one inner classes
+ // Cache level one inner classes.
if (symbol.kind == lsp::SymbolKind::Class) {
ClassMembers inner_class;
for (int j = 0; j < symbol.children.size(); j++) {
@@ -126,10 +211,7 @@ void ExtendGDScriptParser::update_document_links(const String &p_code) {
String value = const_val;
lsp::DocumentLink link;
link.target = GDScriptLanguageProtocol::get_singleton()->get_workspace()->get_file_uri(scr_path);
- link.range.start.line = LINE_NUMBER_TO_INDEX(token.start_line);
- link.range.end.line = LINE_NUMBER_TO_INDEX(token.end_line);
- link.range.start.character = LINE_NUMBER_TO_INDEX(token.start_column);
- link.range.end.character = LINE_NUMBER_TO_INDEX(token.end_column);
+ link.range = GodotRange(GodotPosition(token.start_line, token.start_column), GodotPosition(token.end_line, token.end_column)).to_lsp(this->lines);
document_links.push_back(link);
}
}
@@ -137,6 +219,12 @@ void ExtendGDScriptParser::update_document_links(const String &p_code) {
}
}
+lsp::Range ExtendGDScriptParser::range_of_node(const GDScriptParser::Node *p_node) const {
+ GodotPosition start(p_node->start_line, p_node->start_column);
+ GodotPosition end(p_node->end_line, p_node->end_column);
+ return GodotRange(start, end).to_lsp(this->lines);
+}
+
void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p_class, lsp::DocumentSymbol &r_symbol) {
const String uri = get_uri();
@@ -149,13 +237,30 @@ void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p
}
r_symbol.kind = lsp::SymbolKind::Class;
r_symbol.deprecated = false;
- r_symbol.range.start.line = p_class->start_line;
- r_symbol.range.start.character = p_class->start_column;
- r_symbol.range.end.line = lines.size();
- r_symbol.selectionRange.start.line = r_symbol.range.start.line;
+ r_symbol.range = range_of_node(p_class);
+ r_symbol.range.start.line = MAX(r_symbol.range.start.line, 0);
+ if (p_class->identifier) {
+ r_symbol.selectionRange = range_of_node(p_class->identifier);
+ }
r_symbol.detail = "class " + r_symbol.name;
- bool is_root_class = &r_symbol == &class_symbol;
- r_symbol.documentation = parse_documentation(is_root_class ? 0 : LINE_NUMBER_TO_INDEX(p_class->start_line), is_root_class);
+ {
+ String doc = p_class->doc_data.description;
+ if (!p_class->doc_data.description.is_empty()) {
+ doc += "\n\n" + p_class->doc_data.description;
+ }
+
+ if (!p_class->doc_data.tutorials.is_empty()) {
+ doc += "\n";
+ for (const Pair<String, String> &tutorial : p_class->doc_data.tutorials) {
+ if (tutorial.first.is_empty()) {
+ doc += vformat("\n@tutorial: %s", tutorial.second);
+ } else {
+ doc += vformat("\n@tutorial(%s): %s", tutorial.first, tutorial.second);
+ }
+ }
+ }
+ r_symbol.documentation = doc;
+ }
for (int i = 0; i < p_class->members.size(); i++) {
const ClassNode::Member &m = p_class->members[i];
@@ -166,11 +271,8 @@ void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p
symbol.name = m.variable->identifier->name;
symbol.kind = m.variable->property == VariableNode::PROP_NONE ? lsp::SymbolKind::Variable : lsp::SymbolKind::Property;
symbol.deprecated = false;
- symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.variable->start_line);
- symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.variable->start_column);
- symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.variable->end_line);
- symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.variable->end_column);
- symbol.selectionRange.start.line = symbol.range.start.line;
+ symbol.range = range_of_node(m.variable);
+ symbol.selectionRange = range_of_node(m.variable->identifier);
if (m.variable->exported) {
symbol.detail += "@export ";
}
@@ -182,10 +284,31 @@ void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p
symbol.detail += " = " + m.variable->initializer->reduced_value.to_json_string();
}
- symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.variable->start_line));
+ symbol.documentation = m.variable->doc_data.description;
symbol.uri = uri;
symbol.script_path = path;
+ if (m.variable->initializer && m.variable->initializer->type == GDScriptParser::Node::LAMBDA) {
+ GDScriptParser::LambdaNode *lambda_node = (GDScriptParser::LambdaNode *)m.variable->initializer;
+ lsp::DocumentSymbol lambda;
+ parse_function_symbol(lambda_node->function, lambda);
+ // Merge lambda into current variable.
+ symbol.children.append_array(lambda.children);
+ }
+
+ if (m.variable->getter && m.variable->getter->type == GDScriptParser::Node::FUNCTION) {
+ lsp::DocumentSymbol get_symbol;
+ parse_function_symbol(m.variable->getter, get_symbol);
+ get_symbol.local = true;
+ symbol.children.push_back(get_symbol);
+ }
+ if (m.variable->setter && m.variable->setter->type == GDScriptParser::Node::FUNCTION) {
+ lsp::DocumentSymbol set_symbol;
+ parse_function_symbol(m.variable->setter, set_symbol);
+ set_symbol.local = true;
+ symbol.children.push_back(set_symbol);
+ }
+
r_symbol.children.push_back(symbol);
} break;
case ClassNode::Member::CONSTANT: {
@@ -194,12 +317,9 @@ void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p
symbol.name = m.constant->identifier->name;
symbol.kind = lsp::SymbolKind::Constant;
symbol.deprecated = false;
- symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.constant->start_line);
- symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.constant->start_column);
- symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.constant->end_line);
- symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.constant->start_column);
- symbol.selectionRange.start.line = LINE_NUMBER_TO_INDEX(m.constant->start_line);
- symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.constant->start_line));
+ symbol.range = range_of_node(m.constant);
+ symbol.selectionRange = range_of_node(m.constant->identifier);
+ symbol.documentation = m.constant->doc_data.description;
symbol.uri = uri;
symbol.script_path = path;
@@ -231,36 +351,14 @@ void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p
r_symbol.children.push_back(symbol);
} break;
- case ClassNode::Member::ENUM_VALUE: {
- lsp::DocumentSymbol symbol;
-
- symbol.name = m.enum_value.identifier->name;
- symbol.kind = lsp::SymbolKind::EnumMember;
- symbol.deprecated = false;
- symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.enum_value.line);
- symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.enum_value.leftmost_column);
- symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.enum_value.line);
- symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.enum_value.rightmost_column);
- symbol.selectionRange.start.line = LINE_NUMBER_TO_INDEX(m.enum_value.line);
- symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.enum_value.line));
- symbol.uri = uri;
- symbol.script_path = path;
-
- symbol.detail = symbol.name + " = " + itos(m.enum_value.value);
-
- r_symbol.children.push_back(symbol);
- } break;
case ClassNode::Member::SIGNAL: {
lsp::DocumentSymbol symbol;
symbol.name = m.signal->identifier->name;
symbol.kind = lsp::SymbolKind::Event;
symbol.deprecated = false;
- symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.signal->start_line);
- symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.signal->start_column);
- symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.signal->end_line);
- symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.signal->end_column);
- symbol.selectionRange.start.line = symbol.range.start.line;
- symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.signal->start_line));
+ symbol.range = range_of_node(m.signal);
+ symbol.selectionRange = range_of_node(m.signal->identifier);
+ symbol.documentation = m.signal->doc_data.description;
symbol.uri = uri;
symbol.script_path = path;
symbol.detail = "signal " + String(m.signal->identifier->name) + "(";
@@ -272,17 +370,48 @@ void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p
}
symbol.detail += ")";
+ for (GDScriptParser::ParameterNode *param : m.signal->parameters) {
+ lsp::DocumentSymbol param_symbol;
+ param_symbol.name = param->identifier->name;
+ param_symbol.kind = lsp::SymbolKind::Variable;
+ param_symbol.deprecated = false;
+ param_symbol.local = true;
+ param_symbol.range = range_of_node(param);
+ param_symbol.selectionRange = range_of_node(param->identifier);
+ param_symbol.uri = uri;
+ param_symbol.script_path = path;
+ param_symbol.detail = "var " + param_symbol.name;
+ if (param->get_datatype().is_hard_type()) {
+ param_symbol.detail += ": " + param->get_datatype().to_string();
+ }
+ symbol.children.push_back(param_symbol);
+ }
+ r_symbol.children.push_back(symbol);
+ } break;
+ case ClassNode::Member::ENUM_VALUE: {
+ lsp::DocumentSymbol symbol;
+
+ symbol.name = m.enum_value.identifier->name;
+ symbol.kind = lsp::SymbolKind::EnumMember;
+ symbol.deprecated = false;
+ symbol.range.start = GodotPosition(m.enum_value.line, m.enum_value.leftmost_column).to_lsp(this->lines);
+ symbol.range.end = GodotPosition(m.enum_value.line, m.enum_value.rightmost_column).to_lsp(this->lines);
+ symbol.selectionRange = range_of_node(m.enum_value.identifier);
+ symbol.documentation = m.enum_value.doc_data.description;
+ symbol.uri = uri;
+ symbol.script_path = path;
+
+ symbol.detail = symbol.name + " = " + itos(m.enum_value.value);
+
r_symbol.children.push_back(symbol);
} break;
case ClassNode::Member::ENUM: {
lsp::DocumentSymbol symbol;
+ symbol.name = m.m_enum->identifier->name;
symbol.kind = lsp::SymbolKind::Enum;
- symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.m_enum->start_line);
- symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.m_enum->start_column);
- symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.m_enum->end_line);
- symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.m_enum->end_column);
- symbol.selectionRange.start.line = symbol.range.start.line;
- symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.m_enum->start_line));
+ symbol.range = range_of_node(m.m_enum);
+ symbol.selectionRange = range_of_node(m.m_enum->identifier);
+ symbol.documentation = m.m_enum->doc_data.description;
symbol.uri = uri;
symbol.script_path = path;
@@ -294,6 +423,25 @@ void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p
symbol.detail += String(m.m_enum->values[j].identifier->name) + " = " + itos(m.m_enum->values[j].value);
}
symbol.detail += "}";
+
+ for (GDScriptParser::EnumNode::Value value : m.m_enum->values) {
+ lsp::DocumentSymbol child;
+
+ child.name = value.identifier->name;
+ child.kind = lsp::SymbolKind::EnumMember;
+ child.deprecated = false;
+ child.range.start = GodotPosition(value.line, value.leftmost_column).to_lsp(this->lines);
+ child.range.end = GodotPosition(value.line, value.rightmost_column).to_lsp(this->lines);
+ child.selectionRange = range_of_node(value.identifier);
+ child.documentation = value.doc_data.description;
+ child.uri = uri;
+ child.script_path = path;
+
+ child.detail = child.name + " = " + itos(value.value);
+
+ symbol.children.push_back(child);
+ }
+
r_symbol.children.push_back(symbol);
} break;
case ClassNode::Member::FUNCTION: {
@@ -317,32 +465,29 @@ void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p
void ExtendGDScriptParser::parse_function_symbol(const GDScriptParser::FunctionNode *p_func, lsp::DocumentSymbol &r_symbol) {
const String uri = get_uri();
- r_symbol.name = p_func->identifier->name;
- r_symbol.kind = p_func->is_static ? lsp::SymbolKind::Function : lsp::SymbolKind::Method;
- r_symbol.detail = "func " + String(p_func->identifier->name) + "(";
+ bool is_named = p_func->identifier != nullptr;
+
+ r_symbol.name = is_named ? p_func->identifier->name : "";
+ r_symbol.kind = (p_func->is_static || p_func->source_lambda != nullptr) ? lsp::SymbolKind::Function : lsp::SymbolKind::Method;
+ r_symbol.detail = "func";
+ if (is_named) {
+ r_symbol.detail += " " + String(p_func->identifier->name);
+ }
+ r_symbol.detail += "(";
r_symbol.deprecated = false;
- r_symbol.range.start.line = LINE_NUMBER_TO_INDEX(p_func->start_line);
- r_symbol.range.start.character = LINE_NUMBER_TO_INDEX(p_func->start_column);
- r_symbol.range.end.line = LINE_NUMBER_TO_INDEX(p_func->start_line);
- r_symbol.range.end.character = LINE_NUMBER_TO_INDEX(p_func->end_column);
- r_symbol.selectionRange.start.line = r_symbol.range.start.line;
- r_symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(p_func->start_line));
+ r_symbol.range = range_of_node(p_func);
+ if (is_named) {
+ r_symbol.selectionRange = range_of_node(p_func->identifier);
+ } else {
+ r_symbol.selectionRange.start = r_symbol.selectionRange.end = r_symbol.range.start;
+ }
+ r_symbol.documentation = p_func->doc_data.description;
r_symbol.uri = uri;
r_symbol.script_path = path;
String parameters;
for (int i = 0; i < p_func->parameters.size(); i++) {
const ParameterNode *parameter = p_func->parameters[i];
- lsp::DocumentSymbol symbol;
- symbol.kind = lsp::SymbolKind::Variable;
- symbol.name = parameter->identifier->name;
- symbol.range.start.line = LINE_NUMBER_TO_INDEX(parameter->start_line);
- symbol.range.start.character = LINE_NUMBER_TO_INDEX(parameter->start_column);
- symbol.range.end.line = LINE_NUMBER_TO_INDEX(parameter->end_line);
- symbol.range.end.character = LINE_NUMBER_TO_INDEX(parameter->end_column);
- symbol.uri = uri;
- symbol.script_path = path;
- r_symbol.children.push_back(symbol);
if (i > 0) {
parameters += ", ";
}
@@ -387,6 +532,13 @@ void ExtendGDScriptParser::parse_function_symbol(const GDScriptParser::FunctionN
node_stack.push_back(while_node->loop);
} break;
+ case GDScriptParser::TypeNode::MATCH: {
+ GDScriptParser::MatchNode *match_node = (GDScriptParser::MatchNode *)node;
+ for (GDScriptParser::MatchBranchNode *branch_node : match_node->branches) {
+ node_stack.push_back(branch_node);
+ }
+ } break;
+
case GDScriptParser::TypeNode::MATCH_BRANCH: {
GDScriptParser::MatchBranchNode *match_node = (GDScriptParser::MatchBranchNode *)node;
node_stack.push_back(match_node->block);
@@ -400,20 +552,6 @@ void ExtendGDScriptParser::parse_function_symbol(const GDScriptParser::FunctionN
}
} break;
- case GDScriptParser::TypeNode::VARIABLE: {
- GDScriptParser::VariableNode *variable_node = (GDScriptParser::VariableNode *)(node);
- lsp::DocumentSymbol symbol;
- symbol.kind = lsp::SymbolKind::Variable;
- symbol.name = variable_node->identifier->name;
- symbol.range.start.line = LINE_NUMBER_TO_INDEX(variable_node->start_line);
- symbol.range.start.character = LINE_NUMBER_TO_INDEX(variable_node->start_column);
- symbol.range.end.line = LINE_NUMBER_TO_INDEX(variable_node->end_line);
- symbol.range.end.character = LINE_NUMBER_TO_INDEX(variable_node->end_column);
- symbol.uri = uri;
- symbol.script_path = path;
- r_symbol.children.push_back(symbol);
- } break;
-
default:
continue;
}
@@ -426,10 +564,40 @@ void ExtendGDScriptParser::parse_function_symbol(const GDScriptParser::FunctionN
lsp::DocumentSymbol symbol;
symbol.name = local.name;
symbol.kind = local.type == SuiteNode::Local::CONSTANT ? lsp::SymbolKind::Constant : lsp::SymbolKind::Variable;
- symbol.range.start.line = LINE_NUMBER_TO_INDEX(local.start_line);
- symbol.range.start.character = LINE_NUMBER_TO_INDEX(local.start_column);
- symbol.range.end.line = LINE_NUMBER_TO_INDEX(local.end_line);
- symbol.range.end.character = LINE_NUMBER_TO_INDEX(local.end_column);
+ switch (local.type) {
+ case SuiteNode::Local::CONSTANT:
+ symbol.range = range_of_node(local.constant);
+ symbol.selectionRange = range_of_node(local.constant->identifier);
+ break;
+ case SuiteNode::Local::VARIABLE:
+ symbol.range = range_of_node(local.variable);
+ symbol.selectionRange = range_of_node(local.variable->identifier);
+ if (local.variable->initializer && local.variable->initializer->type == GDScriptParser::Node::LAMBDA) {
+ GDScriptParser::LambdaNode *lambda_node = (GDScriptParser::LambdaNode *)local.variable->initializer;
+ lsp::DocumentSymbol lambda;
+ parse_function_symbol(lambda_node->function, lambda);
+ // Merge lambda into current variable.
+ // -> Only interested in new variables, not lambda itself.
+ symbol.children.append_array(lambda.children);
+ }
+ break;
+ case SuiteNode::Local::PARAMETER:
+ symbol.range = range_of_node(local.parameter);
+ symbol.selectionRange = range_of_node(local.parameter->identifier);
+ break;
+ case SuiteNode::Local::FOR_VARIABLE:
+ case SuiteNode::Local::PATTERN_BIND:
+ symbol.range = range_of_node(local.bind);
+ symbol.selectionRange = range_of_node(local.bind);
+ break;
+ default:
+ // Fallback.
+ symbol.range.start = GodotPosition(local.start_line, local.start_column).to_lsp(get_lines());
+ symbol.range.end = GodotPosition(local.end_line, local.end_column).to_lsp(get_lines());
+ symbol.selectionRange = symbol.range;
+ break;
+ }
+ symbol.local = true;
symbol.uri = uri;
symbol.script_path = path;
symbol.detail = local.type == SuiteNode::Local::CONSTANT ? "const " : "var ";
@@ -437,53 +605,19 @@ void ExtendGDScriptParser::parse_function_symbol(const GDScriptParser::FunctionN
if (local.get_datatype().is_hard_type()) {
symbol.detail += ": " + local.get_datatype().to_string();
}
- symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(local.start_line));
- r_symbol.children.push_back(symbol);
- }
- }
-}
-
-String ExtendGDScriptParser::parse_documentation(int p_line, bool p_docs_down) {
- ERR_FAIL_INDEX_V(p_line, lines.size(), String());
-
- List<String> doc_lines;
-
- if (!p_docs_down) { // inline comment
- String inline_comment = lines[p_line];
- int comment_start = inline_comment.find("##");
- if (comment_start != -1) {
- inline_comment = inline_comment.substr(comment_start, inline_comment.length()).strip_edges();
- if (inline_comment.length() > 1) {
- doc_lines.push_back(inline_comment.substr(2, inline_comment.length()));
+ switch (local.type) {
+ case SuiteNode::Local::CONSTANT:
+ symbol.documentation = local.constant->doc_data.description;
+ break;
+ case SuiteNode::Local::VARIABLE:
+ symbol.documentation = local.variable->doc_data.description;
+ break;
+ default:
+ break;
}
+ r_symbol.children.push_back(symbol);
}
}
-
- int step = p_docs_down ? 1 : -1;
- int start_line = p_docs_down ? p_line : p_line - 1;
- for (int i = start_line; true; i += step) {
- if (i < 0 || i >= lines.size()) {
- break;
- }
-
- String line_comment = lines[i].strip_edges(true, false);
- if (line_comment.begins_with("##")) {
- line_comment = line_comment.substr(2, line_comment.length());
- if (p_docs_down) {
- doc_lines.push_back(line_comment);
- } else {
- doc_lines.push_front(line_comment);
- }
- } else {
- break;
- }
- }
-
- String doc;
- for (const String &E : doc_lines) {
- doc += E + "\n";
- }
- return doc;
}
String ExtendGDScriptParser::get_text_for_completion(const lsp::Position &p_cursor) const {
@@ -492,7 +626,7 @@ String ExtendGDScriptParser::get_text_for_completion(const lsp::Position &p_curs
for (int i = 0; i < len; i++) {
if (i == p_cursor.line) {
longthing += lines[i].substr(0, p_cursor.character);
- longthing += String::chr(0xFFFF); //not unicode, represents the cursor
+ longthing += String::chr(0xFFFF); // Not unicode, represents the cursor.
longthing += lines[i].substr(p_cursor.character, lines[i].size());
} else {
longthing += lines[i];
@@ -513,7 +647,7 @@ String ExtendGDScriptParser::get_text_for_lookup_symbol(const lsp::Position &p_c
if (i == p_cursor.line) {
String line = lines[i];
String first_part = line.substr(0, p_cursor.character);
- String last_part = line.substr(p_cursor.character + 1, lines[i].length());
+ String last_part = line.substr(p_cursor.character, lines[i].length());
if (!p_symbol.is_empty()) {
String left_cursor_text;
for (int c = p_cursor.character - 1; c >= 0; c--) {
@@ -527,9 +661,9 @@ String ExtendGDScriptParser::get_text_for_lookup_symbol(const lsp::Position &p_c
}
longthing += first_part;
- longthing += String::chr(0xFFFF); //not unicode, represents the cursor
+ longthing += String::chr(0xFFFF); // Not unicode, represents the cursor.
if (p_func_required) {
- longthing += "("; // tell the parser this is a function call
+ longthing += "("; // Tell the parser this is a function call.
}
longthing += last_part;
} else {
@@ -544,7 +678,7 @@ String ExtendGDScriptParser::get_text_for_lookup_symbol(const lsp::Position &p_c
return longthing;
}
-String ExtendGDScriptParser::get_identifier_under_position(const lsp::Position &p_position, Vector2i &p_offset) const {
+String ExtendGDScriptParser::get_identifier_under_position(const lsp::Position &p_position, lsp::Range &r_range) const {
ERR_FAIL_INDEX_V(p_position.line, lines.size(), "");
String line = lines[p_position.line];
if (line.is_empty()) {
@@ -552,8 +686,32 @@ String ExtendGDScriptParser::get_identifier_under_position(const lsp::Position &
}
ERR_FAIL_INDEX_V(p_position.character, line.size(), "");
- int start_pos = p_position.character;
- for (int c = p_position.character; c >= 0; c--) {
+ // `p_position` cursor is BETWEEN chars, not ON chars.
+ // ->
+ // ```gdscript
+ // var member| := some_func|(some_variable|)
+ // ^ ^ ^
+ // | | | cursor on `some_variable, position on `)`
+ // | |
+ // | | cursor on `some_func`, pos on `(`
+ // |
+ // | cursor on `member`, pos on ` ` (space)
+ // ```
+ // -> Move position to previous character if:
+ // * Position not on valid identifier char.
+ // * Prev position is valid identifier char.
+ lsp::Position pos = p_position;
+ if (
+ pos.character >= line.length() // Cursor at end of line.
+ || (!is_ascii_identifier_char(line[pos.character]) // Not on valid identifier char.
+ && (pos.character > 0 // Not line start -> there is a prev char.
+ && is_ascii_identifier_char(line[pos.character - 1]) // Prev is valid identifier char.
+ ))) {
+ pos.character--;
+ }
+
+ int start_pos = pos.character;
+ for (int c = pos.character; c >= 0; c--) {
start_pos = c;
char32_t ch = line[c];
bool valid_char = is_ascii_identifier_char(ch);
@@ -562,8 +720,8 @@ String ExtendGDScriptParser::get_identifier_under_position(const lsp::Position &
}
}
- int end_pos = p_position.character;
- for (int c = p_position.character; c < line.length(); c++) {
+ int end_pos = pos.character;
+ for (int c = pos.character; c < line.length(); c++) {
char32_t ch = line[c];
bool valid_char = is_ascii_identifier_char(ch);
if (!valid_char) {
@@ -571,9 +729,11 @@ String ExtendGDScriptParser::get_identifier_under_position(const lsp::Position &
}
end_pos = c;
}
+
if (start_pos < end_pos) {
- p_offset.x = start_pos - p_position.character;
- p_offset.y = end_pos - p_position.character;
+ r_range.start.line = r_range.end.line = pos.line;
+ r_range.start.character = start_pos + 1;
+ r_range.end.character = end_pos + 1;
return line.substr(start_pos + 1, end_pos - start_pos);
}
@@ -584,15 +744,15 @@ String ExtendGDScriptParser::get_uri() const {
return GDScriptLanguageProtocol::get_singleton()->get_workspace()->get_file_uri(path);
}
-const lsp::DocumentSymbol *ExtendGDScriptParser::search_symbol_defined_at_line(int p_line, const lsp::DocumentSymbol &p_parent) const {
+const lsp::DocumentSymbol *ExtendGDScriptParser::search_symbol_defined_at_line(int p_line, const lsp::DocumentSymbol &p_parent, const String &p_symbol_name) const {
const lsp::DocumentSymbol *ret = nullptr;
if (p_line < p_parent.range.start.line) {
return ret;
- } else if (p_parent.range.start.line == p_line) {
+ } else if (p_parent.range.start.line == p_line && (p_symbol_name.is_empty() || p_parent.name == p_symbol_name)) {
return &p_parent;
} else {
for (int i = 0; i < p_parent.children.size(); i++) {
- ret = search_symbol_defined_at_line(p_line, p_parent.children[i]);
+ ret = search_symbol_defined_at_line(p_line, p_parent.children[i], p_symbol_name);
if (ret) {
break;
}
@@ -645,11 +805,11 @@ Error ExtendGDScriptParser::get_left_function_call(const lsp::Position &p_positi
return ERR_METHOD_NOT_FOUND;
}
-const lsp::DocumentSymbol *ExtendGDScriptParser::get_symbol_defined_at_line(int p_line) const {
+const lsp::DocumentSymbol *ExtendGDScriptParser::get_symbol_defined_at_line(int p_line, const String &p_symbol_name) const {
if (p_line <= 0) {
return &class_symbol;
}
- return search_symbol_defined_at_line(p_line, class_symbol);
+ return search_symbol_defined_at_line(p_line, class_symbol, p_symbol_name);
}
const lsp::DocumentSymbol *ExtendGDScriptParser::get_member_symbol(const String &p_name, const String &p_subclass) const {
diff --git a/modules/gdscript/language_server/gdscript_extend_parser.h b/modules/gdscript/language_server/gdscript_extend_parser.h
index 4fd27de081..a808f19e5b 100644
--- a/modules/gdscript/language_server/gdscript_extend_parser.h
+++ b/modules/gdscript/language_server/gdscript_extend_parser.h
@@ -39,6 +39,9 @@
#ifndef LINE_NUMBER_TO_INDEX
#define LINE_NUMBER_TO_INDEX(p_line) ((p_line)-1)
#endif
+#ifndef COLUMN_NUMBER_TO_INDEX
+#define COLUMN_NUMBER_TO_INDEX(p_column) ((p_column)-1)
+#endif
#ifndef SYMBOL_SEPERATOR
#define SYMBOL_SEPERATOR "::"
@@ -50,6 +53,64 @@
typedef HashMap<String, const lsp::DocumentSymbol *> ClassMembers;
+/**
+ * Represents a Position as used by GDScript Parser. Used for conversion to and from `lsp::Position`.
+ *
+ * Difference to `lsp::Position`:
+ * * Line & Char/column: 1-based
+ * * LSP: both 0-based
+ * * Tabs are expanded to columns using tab size (`text_editor/behavior/indent/size`).
+ * * LSP: tab is single char
+ *
+ * Example:
+ * ```gdscript
+ * β†’β†’var my_value = 42
+ * ```
+ * `_` is at:
+ * * Godot: `column=12`
+ * * using `indent/size=4`
+ * * Note: counting starts at `1`
+ * * LSP: `character=8`
+ * * Note: counting starts at `0`
+ */
+struct GodotPosition {
+ int line;
+ int column;
+
+ GodotPosition(int p_line, int p_column) :
+ line(p_line), column(p_column) {}
+
+ lsp::Position to_lsp(const Vector<String> &p_lines) const;
+ static GodotPosition from_lsp(const lsp::Position p_pos, const Vector<String> &p_lines);
+
+ bool operator==(const GodotPosition &p_other) const {
+ return line == p_other.line && column == p_other.column;
+ }
+
+ String to_string() const {
+ return vformat("(%d,%d)", line, column);
+ }
+};
+
+struct GodotRange {
+ GodotPosition start;
+ GodotPosition end;
+
+ GodotRange(GodotPosition p_start, GodotPosition p_end) :
+ start(p_start), end(p_end) {}
+
+ lsp::Range to_lsp(const Vector<String> &p_lines) const;
+ static GodotRange from_lsp(const lsp::Range &p_range, const Vector<String> &p_lines);
+
+ bool operator==(const GodotRange &p_other) const {
+ return start == p_other.start && end == p_other.end;
+ }
+
+ String to_string() const {
+ return vformat("[%s:%s]", start.to_string(), end.to_string());
+ }
+};
+
class ExtendGDScriptParser : public GDScriptParser {
String path;
Vector<String> lines;
@@ -60,6 +121,8 @@ class ExtendGDScriptParser : public GDScriptParser {
ClassMembers members;
HashMap<String, ClassMembers> inner_classes;
+ lsp::Range range_of_node(const GDScriptParser::Node *p_node) const;
+
void update_diagnostics();
void update_symbols();
@@ -70,8 +133,7 @@ class ExtendGDScriptParser : public GDScriptParser {
Dictionary dump_function_api(const GDScriptParser::FunctionNode *p_func) const;
Dictionary dump_class_api(const GDScriptParser::ClassNode *p_class) const;
- String parse_documentation(int p_line, bool p_docs_down = false);
- const lsp::DocumentSymbol *search_symbol_defined_at_line(int p_line, const lsp::DocumentSymbol &p_parent) const;
+ const lsp::DocumentSymbol *search_symbol_defined_at_line(int p_line, const lsp::DocumentSymbol &p_parent, const String &p_symbol_name = "") const;
Array member_completions;
@@ -87,10 +149,18 @@ public:
String get_text_for_completion(const lsp::Position &p_cursor) const;
String get_text_for_lookup_symbol(const lsp::Position &p_cursor, const String &p_symbol = "", bool p_func_required = false) const;
- String get_identifier_under_position(const lsp::Position &p_position, Vector2i &p_offset) const;
+ String get_identifier_under_position(const lsp::Position &p_position, lsp::Range &r_range) const;
String get_uri() const;
- const lsp::DocumentSymbol *get_symbol_defined_at_line(int p_line) const;
+ /**
+ * `p_symbol_name` gets ignored if empty. Otherwise symbol must match passed in named.
+ *
+ * Necessary when multiple symbols at same line for example with `func`:
+ * `func handle_arg(arg: int):`
+ * -> Without `p_symbol_name`: returns `handle_arg`. Even if parameter (`arg`) is wanted.
+ * With `p_symbol_name`: symbol name MUST match `p_symbol_name`: returns `arg`.
+ */
+ const lsp::DocumentSymbol *get_symbol_defined_at_line(int p_line, const String &p_symbol_name = "") const;
const lsp::DocumentSymbol *get_member_symbol(const String &p_name, const String &p_subclass = "") const;
const List<lsp::DocumentLink> &get_document_links() const;
diff --git a/modules/gdscript/language_server/gdscript_language_protocol.cpp b/modules/gdscript/language_server/gdscript_language_protocol.cpp
index 112db4df3a..14fc21d7dc 100644
--- a/modules/gdscript/language_server/gdscript_language_protocol.cpp
+++ b/modules/gdscript/language_server/gdscript_language_protocol.cpp
@@ -278,6 +278,11 @@ void GDScriptLanguageProtocol::stop() {
}
void GDScriptLanguageProtocol::notify_client(const String &p_method, const Variant &p_params, int p_client_id) {
+#ifdef TESTS_ENABLED
+ if (clients.is_empty()) {
+ return;
+ }
+#endif
if (p_client_id == -1) {
ERR_FAIL_COND_MSG(latest_client_id == -1,
"GDScript LSP: Can't notify client as none was connected.");
@@ -294,6 +299,11 @@ void GDScriptLanguageProtocol::notify_client(const String &p_method, const Varia
}
void GDScriptLanguageProtocol::request_client(const String &p_method, const Variant &p_params, int p_client_id) {
+#ifdef TESTS_ENABLED
+ if (clients.is_empty()) {
+ return;
+ }
+#endif
if (p_client_id == -1) {
ERR_FAIL_COND_MSG(latest_client_id == -1,
"GDScript LSP: Can't notify client as none was connected.");
diff --git a/modules/gdscript/language_server/gdscript_text_document.cpp b/modules/gdscript/language_server/gdscript_text_document.cpp
index 92a5f55978..1e927f9f6e 100644
--- a/modules/gdscript/language_server/gdscript_text_document.cpp
+++ b/modules/gdscript/language_server/gdscript_text_document.cpp
@@ -50,6 +50,8 @@ void GDScriptTextDocument::_bind_methods() {
ClassDB::bind_method(D_METHOD("completion"), &GDScriptTextDocument::completion);
ClassDB::bind_method(D_METHOD("resolve"), &GDScriptTextDocument::resolve);
ClassDB::bind_method(D_METHOD("rename"), &GDScriptTextDocument::rename);
+ ClassDB::bind_method(D_METHOD("prepareRename"), &GDScriptTextDocument::prepareRename);
+ ClassDB::bind_method(D_METHOD("references"), &GDScriptTextDocument::references);
ClassDB::bind_method(D_METHOD("foldingRange"), &GDScriptTextDocument::foldingRange);
ClassDB::bind_method(D_METHOD("codeLens"), &GDScriptTextDocument::codeLens);
ClassDB::bind_method(D_METHOD("documentLink"), &GDScriptTextDocument::documentLink);
@@ -161,11 +163,8 @@ Array GDScriptTextDocument::documentSymbol(const Dictionary &p_params) {
String path = GDScriptLanguageProtocol::get_singleton()->get_workspace()->get_file_path(uri);
Array arr;
if (HashMap<String, ExtendGDScriptParser *>::ConstIterator parser = GDScriptLanguageProtocol::get_singleton()->get_workspace()->scripts.find(path)) {
- Vector<lsp::DocumentedSymbolInformation> list;
- parser->value->get_symbols().symbol_tree_as_list(uri, list);
- for (int i = 0; i < list.size(); i++) {
- arr.push_back(list[i].to_json());
- }
+ lsp::DocumentSymbol symbol = parser->value->get_symbols();
+ arr.push_back(symbol.to_json(true));
}
return arr;
}
@@ -253,6 +252,48 @@ Dictionary GDScriptTextDocument::rename(const Dictionary &p_params) {
return GDScriptLanguageProtocol::get_singleton()->get_workspace()->rename(params, new_name);
}
+Variant GDScriptTextDocument::prepareRename(const Dictionary &p_params) {
+ lsp::TextDocumentPositionParams params;
+ params.load(p_params);
+
+ lsp::DocumentSymbol symbol;
+ lsp::Range range;
+ if (GDScriptLanguageProtocol::get_singleton()->get_workspace()->can_rename(params, symbol, range)) {
+ return Variant(range.to_json());
+ }
+
+ // `null` -> rename not valid at current location.
+ return Variant();
+}
+
+Array GDScriptTextDocument::references(const Dictionary &p_params) {
+ Array res;
+
+ lsp::ReferenceParams params;
+ params.load(p_params);
+
+ const lsp::DocumentSymbol *symbol = GDScriptLanguageProtocol::get_singleton()->get_workspace()->resolve_symbol(params);
+ if (symbol) {
+ Vector<lsp::Location> usages = GDScriptLanguageProtocol::get_singleton()->get_workspace()->find_all_usages(*symbol);
+ res.resize(usages.size());
+ int declaration_adjustment = 0;
+ for (int i = 0; i < usages.size(); i++) {
+ lsp::Location usage = usages[i];
+ if (!params.context.includeDeclaration && usage.range == symbol->range) {
+ declaration_adjustment++;
+ continue;
+ }
+ res[i - declaration_adjustment] = usages[i].to_json();
+ }
+
+ if (declaration_adjustment > 0) {
+ res.resize(res.size() - declaration_adjustment);
+ }
+ }
+
+ return res;
+}
+
Dictionary GDScriptTextDocument::resolve(const Dictionary &p_params) {
lsp::CompletionItem item;
item.load(p_params);
@@ -450,7 +491,7 @@ Array GDScriptTextDocument::find_symbols(const lsp::TextDocumentPositionParams &
if (symbol) {
lsp::Location location;
location.uri = symbol->uri;
- location.range = symbol->range;
+ location.range = symbol->selectionRange;
const String &path = GDScriptLanguageProtocol::get_singleton()->get_workspace()->get_file_path(symbol->uri);
if (file_checker->file_exists(path)) {
arr.push_back(location.to_json());
@@ -464,7 +505,7 @@ Array GDScriptTextDocument::find_symbols(const lsp::TextDocumentPositionParams &
if (!s->uri.is_empty()) {
lsp::Location location;
location.uri = s->uri;
- location.range = s->range;
+ location.range = s->selectionRange;
arr.push_back(location.to_json());
r_list.push_back(s);
}
diff --git a/modules/gdscript/language_server/gdscript_text_document.h b/modules/gdscript/language_server/gdscript_text_document.h
index 0121101db2..cfd0490f0a 100644
--- a/modules/gdscript/language_server/gdscript_text_document.h
+++ b/modules/gdscript/language_server/gdscript_text_document.h
@@ -65,6 +65,8 @@ public:
Array completion(const Dictionary &p_params);
Dictionary resolve(const Dictionary &p_params);
Dictionary rename(const Dictionary &p_params);
+ Variant prepareRename(const Dictionary &p_params);
+ Array references(const Dictionary &p_params);
Array foldingRange(const Dictionary &p_params);
Array codeLens(const Dictionary &p_params);
Array documentLink(const Dictionary &p_params);
diff --git a/modules/gdscript/language_server/gdscript_workspace.cpp b/modules/gdscript/language_server/gdscript_workspace.cpp
index 9f848b02f5..81933c8c87 100644
--- a/modules/gdscript/language_server/gdscript_workspace.cpp
+++ b/modules/gdscript/language_server/gdscript_workspace.cpp
@@ -46,7 +46,6 @@
void GDScriptWorkspace::_bind_methods() {
ClassDB::bind_method(D_METHOD("apply_new_signal"), &GDScriptWorkspace::apply_new_signal);
ClassDB::bind_method(D_METHOD("didDeleteFiles"), &GDScriptWorkspace::did_delete_files);
- ClassDB::bind_method(D_METHOD("symbol"), &GDScriptWorkspace::symbol);
ClassDB::bind_method(D_METHOD("parse_script", "path", "content"), &GDScriptWorkspace::parse_script);
ClassDB::bind_method(D_METHOD("parse_local_script", "path"), &GDScriptWorkspace::parse_local_script);
ClassDB::bind_method(D_METHOD("get_file_path", "uri"), &GDScriptWorkspace::get_file_path);
@@ -182,35 +181,33 @@ const lsp::DocumentSymbol *GDScriptWorkspace::get_parameter_symbol(const lsp::Do
return nullptr;
}
-const lsp::DocumentSymbol *GDScriptWorkspace::get_local_symbol(const ExtendGDScriptParser *p_parser, const String &p_symbol_identifier) {
- const lsp::DocumentSymbol *class_symbol = &p_parser->get_symbols();
+const lsp::DocumentSymbol *GDScriptWorkspace::get_local_symbol_at(const ExtendGDScriptParser *p_parser, const String &p_symbol_identifier, const lsp::Position p_position) {
+ // Go down and pick closest `DocumentSymbol` with `p_symbol_identifier`.
- for (int i = 0; i < class_symbol->children.size(); ++i) {
- int kind = class_symbol->children[i].kind;
- switch (kind) {
- case lsp::SymbolKind::Function:
- case lsp::SymbolKind::Method:
- case lsp::SymbolKind::Class: {
- const lsp::DocumentSymbol *function_symbol = &class_symbol->children[i];
+ const lsp::DocumentSymbol *current = &p_parser->get_symbols();
+ const lsp::DocumentSymbol *best_match = nullptr;
- for (int l = 0; l < function_symbol->children.size(); ++l) {
- const lsp::DocumentSymbol *local = &function_symbol->children[l];
- if (!local->detail.is_empty() && local->name == p_symbol_identifier) {
- return local;
- }
- }
- } break;
+ while (current) {
+ if (current->name == p_symbol_identifier) {
+ if (current->selectionRange.contains(p_position)) {
+ // Exact match: pos is ON symbol decl identifier.
+ return current;
+ }
- case lsp::SymbolKind::Variable: {
- const lsp::DocumentSymbol *variable_symbol = &class_symbol->children[i];
- if (variable_symbol->name == p_symbol_identifier) {
- return variable_symbol;
- }
- } break;
+ best_match = current;
+ }
+
+ const lsp::DocumentSymbol *parent = current;
+ current = nullptr;
+ for (const lsp::DocumentSymbol &child : parent->children) {
+ if (child.range.contains(p_position)) {
+ current = &child;
+ break;
+ }
}
}
- return nullptr;
+ return best_match;
}
void GDScriptWorkspace::reload_all_workspace_scripts() {
@@ -275,25 +272,6 @@ ExtendGDScriptParser *GDScriptWorkspace::get_parse_result(const String &p_path)
return nullptr;
}
-Array GDScriptWorkspace::symbol(const Dictionary &p_params) {
- String query = p_params["query"];
- Array arr;
- if (!query.is_empty()) {
- for (const KeyValue<String, ExtendGDScriptParser *> &E : scripts) {
- Vector<lsp::DocumentedSymbolInformation> script_symbols;
- E.value->get_symbols().symbol_tree_as_list(E.key, script_symbols);
- for (int i = 0; i < script_symbols.size(); ++i) {
- if (query.is_subsequence_ofn(script_symbols[i].name)) {
- lsp::DocumentedSymbolInformation symbol = script_symbols[i];
- symbol.location.uri = get_file_uri(symbol.location.uri);
- arr.push_back(symbol.to_json());
- }
- }
- }
- }
- return arr;
-}
-
Error GDScriptWorkspace::initialize() {
if (initialized) {
return OK;
@@ -423,7 +401,7 @@ Error GDScriptWorkspace::initialize() {
native_members.insert(E.key, members);
}
- // cache member completions
+ // Cache member completions.
for (const KeyValue<String, ExtendGDScriptParser *> &S : scripts) {
S.value->get_member_completions();
}
@@ -458,48 +436,110 @@ Error GDScriptWorkspace::parse_script(const String &p_path, const String &p_cont
return err;
}
-Dictionary GDScriptWorkspace::rename(const lsp::TextDocumentPositionParams &p_doc_pos, const String &new_name) {
- Error err;
- String path = get_file_path(p_doc_pos.textDocument.uri);
+static bool is_valid_rename_target(const lsp::DocumentSymbol *p_symbol) {
+ // Must be valid symbol.
+ if (!p_symbol) {
+ return false;
+ }
+
+ // Cannot rename builtin.
+ if (!p_symbol->native_class.is_empty()) {
+ return false;
+ }
+
+ // Source must be available.
+ if (p_symbol->script_path.is_empty()) {
+ return false;
+ }
+ return true;
+}
+
+Dictionary GDScriptWorkspace::rename(const lsp::TextDocumentPositionParams &p_doc_pos, const String &new_name) {
lsp::WorkspaceEdit edit;
- List<String> paths;
- list_script_files("res://", paths);
+ const lsp::DocumentSymbol *reference_symbol = resolve_symbol(p_doc_pos);
+ if (is_valid_rename_target(reference_symbol)) {
+ Vector<lsp::Location> usages = find_all_usages(*reference_symbol);
+ for (int i = 0; i < usages.size(); ++i) {
+ lsp::Location loc = usages[i];
+
+ edit.add_change(loc.uri, loc.range.start.line, loc.range.start.character, loc.range.end.character, new_name);
+ }
+ }
+
+ return edit.to_json();
+}
+bool GDScriptWorkspace::can_rename(const lsp::TextDocumentPositionParams &p_doc_pos, lsp::DocumentSymbol &r_symbol, lsp::Range &r_range) {
const lsp::DocumentSymbol *reference_symbol = resolve_symbol(p_doc_pos);
- if (reference_symbol) {
- String identifier = reference_symbol->name;
+ if (!is_valid_rename_target(reference_symbol)) {
+ return false;
+ }
- for (List<String>::Element *PE = paths.front(); PE; PE = PE->next()) {
- PackedStringArray content = FileAccess::get_file_as_string(PE->get(), &err).split("\n");
- for (int i = 0; i < content.size(); ++i) {
- String line = content[i];
+ String path = get_file_path(p_doc_pos.textDocument.uri);
+ if (const ExtendGDScriptParser *parser = get_parse_result(path)) {
+ parser->get_identifier_under_position(p_doc_pos.position, r_range);
+ r_symbol = *reference_symbol;
+ return true;
+ }
- int character = line.find(identifier);
- while (character > -1) {
- lsp::TextDocumentPositionParams params;
+ return false;
+}
- lsp::TextDocumentIdentifier text_doc;
- text_doc.uri = get_file_uri(PE->get());
+Vector<lsp::Location> GDScriptWorkspace::find_usages_in_file(const lsp::DocumentSymbol &p_symbol, const String &p_file_path) {
+ Vector<lsp::Location> usages;
- params.textDocument = text_doc;
- params.position.line = i;
- params.position.character = character;
+ String identifier = p_symbol.name;
+ if (const ExtendGDScriptParser *parser = get_parse_result(p_file_path)) {
+ const PackedStringArray &content = parser->get_lines();
+ for (int i = 0; i < content.size(); ++i) {
+ String line = content[i];
- const lsp::DocumentSymbol *other_symbol = resolve_symbol(params);
+ int character = line.find(identifier);
+ while (character > -1) {
+ lsp::TextDocumentPositionParams params;
- if (other_symbol == reference_symbol) {
- edit.add_change(text_doc.uri, i, character, character + identifier.length(), new_name);
- }
+ lsp::TextDocumentIdentifier text_doc;
+ text_doc.uri = get_file_uri(p_file_path);
- character = line.find(identifier, character + 1);
+ params.textDocument = text_doc;
+ params.position.line = i;
+ params.position.character = character;
+
+ const lsp::DocumentSymbol *other_symbol = resolve_symbol(params);
+
+ if (other_symbol == &p_symbol) {
+ lsp::Location loc;
+ loc.uri = text_doc.uri;
+ loc.range.start = params.position;
+ loc.range.end.line = params.position.line;
+ loc.range.end.character = params.position.character + identifier.length();
+ usages.append(loc);
}
+
+ character = line.find(identifier, character + 1);
}
}
}
- return edit.to_json();
+ return usages;
+}
+
+Vector<lsp::Location> GDScriptWorkspace::find_all_usages(const lsp::DocumentSymbol &p_symbol) {
+ if (p_symbol.local) {
+ // Only search in current document.
+ return find_usages_in_file(p_symbol, p_symbol.script_path);
+ }
+ // Search in all documents.
+ List<String> paths;
+ list_script_files("res://", paths);
+
+ Vector<lsp::Location> usages;
+ for (List<String>::Element *PE = paths.front(); PE; PE = PE->next()) {
+ usages.append_array(find_usages_in_file(p_symbol, PE->get()));
+ }
+ return usages;
}
Error GDScriptWorkspace::parse_local_script(const String &p_path) {
@@ -636,9 +676,9 @@ const lsp::DocumentSymbol *GDScriptWorkspace::resolve_symbol(const lsp::TextDocu
lsp::Position pos = p_doc_pos.position;
if (symbol_identifier.is_empty()) {
- Vector2i offset;
- symbol_identifier = parser->get_identifier_under_position(p_doc_pos.position, offset);
- pos.character += offset.y;
+ lsp::Range range;
+ symbol_identifier = parser->get_identifier_under_position(p_doc_pos.position, range);
+ pos.character = range.end.character;
}
if (!symbol_identifier.is_empty()) {
@@ -661,7 +701,7 @@ const lsp::DocumentSymbol *GDScriptWorkspace::resolve_symbol(const lsp::TextDocu
}
if (const ExtendGDScriptParser *target_parser = get_parse_result(target_script_path)) {
- symbol = target_parser->get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(ret.location));
+ symbol = target_parser->get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(ret.location), symbol_identifier);
if (symbol) {
switch (symbol->kind) {
@@ -670,10 +710,6 @@ const lsp::DocumentSymbol *GDScriptWorkspace::resolve_symbol(const lsp::TextDocu
symbol = get_parameter_symbol(symbol, symbol_identifier);
}
} break;
-
- case lsp::SymbolKind::Variable: {
- symbol = get_local_symbol(parser, symbol_identifier);
- } break;
}
}
}
@@ -686,10 +722,9 @@ const lsp::DocumentSymbol *GDScriptWorkspace::resolve_symbol(const lsp::TextDocu
symbol = get_native_symbol(ret.class_name, member);
}
} else {
- symbol = parser->get_member_symbol(symbol_identifier);
-
+ symbol = get_local_symbol_at(parser, symbol_identifier, p_doc_pos.position);
if (!symbol) {
- symbol = get_local_symbol(parser, symbol_identifier);
+ symbol = parser->get_member_symbol(symbol_identifier);
}
}
}
@@ -703,8 +738,8 @@ void GDScriptWorkspace::resolve_related_symbols(const lsp::TextDocumentPositionP
String path = get_file_path(p_doc_pos.textDocument.uri);
if (const ExtendGDScriptParser *parser = get_parse_result(path)) {
String symbol_identifier;
- Vector2i offset;
- symbol_identifier = parser->get_identifier_under_position(p_doc_pos.position, offset);
+ lsp::Range range;
+ symbol_identifier = parser->get_identifier_under_position(p_doc_pos.position, range);
for (const KeyValue<StringName, ClassMembers> &E : native_members) {
const ClassMembers &members = native_members.get(E.key);
diff --git a/modules/gdscript/language_server/gdscript_workspace.h b/modules/gdscript/language_server/gdscript_workspace.h
index 80653778fb..0b2d43b817 100644
--- a/modules/gdscript/language_server/gdscript_workspace.h
+++ b/modules/gdscript/language_server/gdscript_workspace.h
@@ -54,7 +54,7 @@ protected:
const lsp::DocumentSymbol *get_native_symbol(const String &p_class, const String &p_member = "") const;
const lsp::DocumentSymbol *get_script_symbol(const String &p_path) const;
const lsp::DocumentSymbol *get_parameter_symbol(const lsp::DocumentSymbol *p_parent, const String &symbol_identifier);
- const lsp::DocumentSymbol *get_local_symbol(const ExtendGDScriptParser *p_parser, const String &p_symbol_identifier);
+ const lsp::DocumentSymbol *get_local_symbol_at(const ExtendGDScriptParser *p_parser, const String &p_symbol_identifier, const lsp::Position p_position);
void reload_all_workspace_scripts();
@@ -74,9 +74,6 @@ public:
HashMap<StringName, ClassMembers> native_members;
public:
- Array symbol(const Dictionary &p_params);
-
-public:
Error initialize();
Error parse_script(const String &p_path, const String &p_content);
@@ -96,6 +93,9 @@ public:
Error resolve_signature(const lsp::TextDocumentPositionParams &p_doc_pos, lsp::SignatureHelp &r_signature);
void did_delete_files(const Dictionary &p_params);
Dictionary rename(const lsp::TextDocumentPositionParams &p_doc_pos, const String &new_name);
+ bool can_rename(const lsp::TextDocumentPositionParams &p_doc_pos, lsp::DocumentSymbol &r_symbol, lsp::Range &r_range);
+ Vector<lsp::Location> find_usages_in_file(const lsp::DocumentSymbol &p_symbol, const String &p_file_path);
+ Vector<lsp::Location> find_all_usages(const lsp::DocumentSymbol &p_symbol);
GDScriptWorkspace();
~GDScriptWorkspace();
diff --git a/modules/gdscript/language_server/godot_lsp.h b/modules/gdscript/language_server/godot_lsp.h
index 3782945e07..1ac4267c7b 100644
--- a/modules/gdscript/language_server/godot_lsp.h
+++ b/modules/gdscript/language_server/godot_lsp.h
@@ -83,6 +83,14 @@ struct Position {
*/
int character = 0;
+ _FORCE_INLINE_ bool operator==(const Position &p_other) const {
+ return line == p_other.line && character == p_other.character;
+ }
+
+ String to_string() const {
+ return vformat("(%d,%d)", line, character);
+ }
+
_FORCE_INLINE_ void load(const Dictionary &p_params) {
line = p_params["line"];
character = p_params["character"];
@@ -112,6 +120,27 @@ struct Range {
*/
Position end;
+ _FORCE_INLINE_ bool operator==(const Range &p_other) const {
+ return start == p_other.start && end == p_other.end;
+ }
+
+ bool contains(const Position &p_pos) const {
+ // Inside line range.
+ if (start.line <= p_pos.line && p_pos.line <= end.line) {
+ // If on start line: must come after start char.
+ bool start_ok = p_pos.line == start.line ? start.character <= p_pos.character : true;
+ // If on end line: must come before end char.
+ bool end_ok = p_pos.line == end.line ? p_pos.character <= end.character : true;
+ return start_ok && end_ok;
+ } else {
+ return false;
+ }
+ }
+
+ String to_string() const {
+ return vformat("[%s:%s]", start.to_string(), end.to_string());
+ }
+
_FORCE_INLINE_ void load(const Dictionary &p_params) {
start.load(p_params["start"]);
end.load(p_params["end"]);
@@ -203,6 +232,17 @@ struct TextDocumentPositionParams {
}
};
+struct ReferenceContext {
+ /**
+ * Include the declaration of the current symbol.
+ */
+ bool includeDeclaration;
+};
+
+struct ReferenceParams : TextDocumentPositionParams {
+ ReferenceContext context;
+};
+
struct DocumentLinkParams {
/**
* The document to provide document links for.
@@ -343,8 +383,8 @@ struct Command {
}
};
-// Use namespace instead of enumeration to follow the LSP specifications
-// lsp::EnumName::EnumValue is OK but lsp::EnumValue is not
+// Use namespace instead of enumeration to follow the LSP specifications.
+// `lsp::EnumName::EnumValue` is OK but `lsp::EnumValue` is not.
namespace TextDocumentSyncKind {
/**
@@ -436,7 +476,7 @@ struct RenameOptions {
/**
* Renames should be checked and tested before being executed.
*/
- bool prepareProvider = false;
+ bool prepareProvider = true;
Dictionary to_json() {
Dictionary dict;
@@ -794,12 +834,12 @@ static const String Markdown = "markdown";
*/
struct MarkupContent {
/**
- * The type of the Markup
+ * The type of the Markup.
*/
String kind;
/**
- * The content itself
+ * The content itself.
*/
String value;
@@ -821,8 +861,8 @@ struct MarkupContent {
};
// Use namespace instead of enumeration to follow the LSP specifications
-// lsp::EnumName::EnumValue is OK but lsp::EnumValue is not
-// And here C++ compilers are unhappy with our enumeration name like Color, File, RefCounted etc.
+// `lsp::EnumName::EnumValue` is OK but `lsp::EnumValue` is not.
+// And here C++ compilers are unhappy with our enumeration name like `Color`, `File`, `RefCounted` etc.
/**
* The kind of a completion entry.
*/
@@ -854,7 +894,7 @@ static const int Operator = 24;
static const int TypeParameter = 25;
}; // namespace CompletionItemKind
-// Use namespace instead of enumeration to follow the LSP specifications
+// Use namespace instead of enumeration to follow the LSP specifications.
/**
* Defines whether the insert text in a completion item should be interpreted as
* plain text or a snippet.
@@ -1070,8 +1110,8 @@ struct CompletionList {
};
// Use namespace instead of enumeration to follow the LSP specifications
-// lsp::EnumName::EnumValue is OK but lsp::EnumValue is not
-// And here C++ compilers are unhappy with our enumeration name like String, Array, Object etc
+// `lsp::EnumName::EnumValue` is OK but `lsp::EnumValue` is not
+// And here C++ compilers are unhappy with our enumeration name like `String`, `Array`, `Object` etc
/**
* A symbol kind.
*/
@@ -1105,70 +1145,6 @@ static const int TypeParameter = 26;
}; // namespace SymbolKind
/**
- * Represents information about programming constructs like variables, classes,
- * interfaces etc.
- */
-struct SymbolInformation {
- /**
- * The name of this symbol.
- */
- String name;
-
- /**
- * The kind of this symbol.
- */
- int kind = SymbolKind::File;
-
- /**
- * Indicates if this symbol is deprecated.
- */
- bool deprecated = false;
-
- /**
- * The location of this symbol. The location's range is used by a tool
- * to reveal the location in the editor. If the symbol is selected in the
- * tool the range's start information is used to position the cursor. So
- * the range usually spans more then the actual symbol's name and does
- * normally include things like visibility modifiers.
- *
- * The range doesn't have to denote a node range in the sense of a abstract
- * syntax tree. It can therefore not be used to re-construct a hierarchy of
- * the symbols.
- */
- Location location;
-
- /**
- * The name of the symbol containing this symbol. This information is for
- * user interface purposes (e.g. to render a qualifier in the user interface
- * if necessary). It can't be used to re-infer a hierarchy for the document
- * symbols.
- */
- String containerName;
-
- _FORCE_INLINE_ Dictionary to_json() const {
- Dictionary dict;
- dict["name"] = name;
- dict["kind"] = kind;
- dict["deprecated"] = deprecated;
- dict["location"] = location.to_json();
- dict["containerName"] = containerName;
- return dict;
- }
-};
-
-struct DocumentedSymbolInformation : public SymbolInformation {
- /**
- * A human-readable string with additional information
- */
- String detail;
-
- /**
- * A human-readable string that represents a doc-comment.
- */
- String documentation;
-};
-
-/**
* Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be
* hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range,
* e.g. the range of an identifier.
@@ -1186,12 +1162,12 @@ struct DocumentSymbol {
String detail;
/**
- * Documentation for this symbol
+ * Documentation for this symbol.
*/
String documentation;
/**
- * Class name for the native symbols
+ * Class name for the native symbols.
*/
String native_class;
@@ -1206,6 +1182,13 @@ struct DocumentSymbol {
bool deprecated = false;
/**
+ * If `true`: Symbol is local to script and cannot be accessed somewhere else.
+ *
+ * For example: local variable inside a `func`.
+ */
+ bool local = false;
+
+ /**
* The range enclosing this symbol not including leading/trailing whitespace but everything else
* like comments. This information is typically used to determine if the clients cursor is
* inside the symbol to reveal in the symbol in the UI.
@@ -1238,35 +1221,21 @@ struct DocumentSymbol {
dict["documentation"] = documentation;
dict["native_class"] = native_class;
}
- Array arr;
- arr.resize(children.size());
- for (int i = 0; i < children.size(); i++) {
- arr[i] = children[i].to_json(with_doc);
+ if (!children.is_empty()) {
+ Array arr;
+ for (int i = 0; i < children.size(); i++) {
+ if (children[i].local) {
+ continue;
+ }
+ arr.push_back(children[i].to_json(with_doc));
+ }
+ if (!children.is_empty()) {
+ dict["children"] = arr;
+ }
}
- dict["children"] = arr;
return dict;
}
- void symbol_tree_as_list(const String &p_uri, Vector<DocumentedSymbolInformation> &r_list, const String &p_container = "", bool p_join_name = false) const {
- DocumentedSymbolInformation si;
- if (p_join_name && !p_container.is_empty()) {
- si.name = p_container + ">" + name;
- } else {
- si.name = name;
- }
- si.kind = kind;
- si.containerName = p_container;
- si.deprecated = deprecated;
- si.location.uri = p_uri;
- si.location.range = range;
- si.detail = detail;
- si.documentation = documentation;
- r_list.push_back(si);
- for (int i = 0; i < children.size(); i++) {
- children[i].symbol_tree_as_list(p_uri, r_list, si.name, p_join_name);
- }
- }
-
_FORCE_INLINE_ MarkupContent render() const {
MarkupContent markdown;
if (detail.length()) {
@@ -1750,7 +1719,7 @@ struct ServerCapabilities {
/**
* The server provides find references support.
*/
- bool referencesProvider = false;
+ bool referencesProvider = true;
/**
* The server provides document highlight support.
diff --git a/modules/gdscript/tests/scripts/lsp/class.notest.gd b/modules/gdscript/tests/scripts/lsp/class.notest.gd
new file mode 100644
index 0000000000..53d0b14d72
--- /dev/null
+++ b/modules/gdscript/tests/scripts/lsp/class.notest.gd
@@ -0,0 +1,132 @@
+extends Node
+
+class Inner1 extends Node:
+# ^^^^^^ class1 -> class1
+ var member1 := 42
+ # ^^^^^^^ class1:member1 -> class1:member1
+ var member2 : int = 13
+ # ^^^^^^^ class1:member2 -> class1:member2
+ var member3 = 1337
+ # ^^^^^^^ class1:member3 -> class1:member3
+
+ signal changed(old, new)
+ # ^^^^^^^ class1:signal -> class1:signal
+ func my_func(arg1: int, arg2: String, arg3):
+ # | | | | | | ^^^^ class1:func:arg3 -> class1:func:arg3
+ # | | | | ^^^^ class1:func:arg2 -> class1:func:arg2
+ # | | ^^^^ class1:func:arg1 -> class1:func:arg1
+ # ^^^^^^^ class1:func -> class1:func
+ print(arg1, arg2, arg3)
+ # | | | | ^^^^ -> class1:func:arg3
+ # | | ^^^^ -> class1:func:arg2
+ # ^^^^ -> class1:func:arg1
+ changed.emit(arg1, arg3)
+ # | | | ^^^^ -> class1:func:arg3
+ # | ^^^^ -> class1:func:arg1
+ #<^^^^^ -> class1:signal
+ return arg1 + arg2.length() + arg3
+ # | | | | ^^^^ -> class1:func:arg3
+ # | | ^^^^ -> class1:func:arg2
+ # ^^^^ -> class1:func:arg1
+
+class Inner2:
+# ^^^^^^ class2 -> class2
+ var member1 := 42
+ # ^^^^^^^ class2:member1 -> class2:member1
+ var member2 : int = 13
+ # ^^^^^^^ class2:member2 -> class2:member2
+ var member3 = 1337
+ # ^^^^^^^ class2:member3 -> class2:member3
+
+ signal changed(old, new)
+ # ^^^^^^^ class2:signal -> class2:signal
+ func my_func(arg1: int, arg2: String, arg3):
+ # | | | | | | ^^^^ class2:func:arg3 -> class2:func:arg3
+ # | | | | ^^^^ class2:func:arg2 -> class2:func:arg2
+ # | | ^^^^ class2:func:arg1 -> class2:func:arg1
+ # ^^^^^^^ class2:func -> class2:func
+ print(arg1, arg2, arg3)
+ # | | | | ^^^^ -> class2:func:arg3
+ # | | ^^^^ -> class2:func:arg2
+ # ^^^^ -> class2:func:arg1
+ changed.emit(arg1, arg3)
+ # | | | ^^^^ -> class2:func:arg3
+ # | ^^^^ -> class2:func:arg1
+ #<^^^^^ -> class2:signal
+ return arg1 + arg2.length() + arg3
+ # | | | | ^^^^ -> class2:func:arg3
+ # | | ^^^^ -> class2:func:arg2
+ # ^^^^ -> class2:func:arg1
+
+class Inner3 extends Inner2:
+# | | ^^^^^^ -> class2
+# ^^^^^^ class3 -> class3
+ var whatever = "foo"
+ # ^^^^^^^^ class3:whatever -> class3:whatever
+
+ func _init():
+ # ^^^^^ class3:init
+ # Note: no self-ref check here: resolves to `Object._init`.
+ # usages of `Inner3.new()` DO resolve to this `_init`
+ pass
+
+ class NestedInInner3:
+ # ^^^^^^^^^^^^^^ class3:nested1 -> class3:nested1
+ var some_value := 42
+ # ^^^^^^^^^^ class3:nested1:some_value -> class3:nested1:some_value
+
+ class AnotherNestedInInner3 extends NestedInInner3:
+ #! | | ^^^^^^^^^^^^^^ -> class3:nested1
+ # ^^^^^^^^^^^^^^^^^^^^^ class3:nested2 -> class3:nested2
+ var another_value := 13
+ # ^^^^^^^^^^^^^ class3:nested2:another_value -> class3:nested2:another_value
+
+func _ready():
+ var inner1 = Inner1.new()
+ # | | ^^^^^^ -> class1
+ # ^^^^^^ func:class1 -> func:class1
+ var value1 = inner1.my_func(1,"",3)
+ # | | | | ^^^^^^^ -> class1:func
+ # | | ^^^^^^ -> func:class1
+ # ^^^^^^ func:class1:value1 -> func:class1:value1
+ var value2 = inner1.member3
+ # | | | | ^^^^^^^ -> class1:member3
+ # | | ^^^^^^ -> func:class1
+ # ^^^^^^ func:class1:value2 -> func:class1:value2
+ print(value1, value2)
+ # | | ^^^^^^ -> func:class1:value2
+ # ^^^^^^ -> func:class1:value1
+
+ var inner3 = Inner3.new()
+ # | | | | ^^^ -> class3:init
+ # | | ^^^^^^ -> class3
+ # ^^^^^^ func:class3 -> func:class3
+ print(inner3)
+ # ^^^^^^ -> func:class3
+
+ var nested1 = Inner3.NestedInInner3.new()
+ # | | | | ^^^^^^^^^^^^^^ -> class3:nested1
+ # | | ^^^^^^ -> class3
+ # ^^^^^^^ func:class3:nested1 -> func:class3:nested1
+ var value_nested1 = nested1.some_value
+ # | | | | ^^^^^^^^^^ -> class3:nested1:some_value
+ # | | ^^^^^^^ -> func:class3:nested1
+ # ^^^^^^^^^^^^^ func:class3:nested1:value
+ print(value_nested1)
+ # ^^^^^^^^^^^^^ -> func:class3:nested1:value
+
+ var nested2 = Inner3.AnotherNestedInInner3.new()
+ # | | | | ^^^^^^^^^^^^^^^^^^^^^ -> class3:nested2
+ # | | ^^^^^^ -> class3
+ # ^^^^^^^ func:class3:nested2 -> func:class3:nested2
+ var value_nested2 = nested2.some_value
+ # | | | | ^^^^^^^^^^ -> class3:nested1:some_value
+ # | | ^^^^^^^ -> func:class3:nested2
+ # ^^^^^^^^^^^^^ func:class3:nested2:value
+ var another_value_nested2 = nested2.another_value
+ # | | | | ^^^^^^^^^^^^^ -> class3:nested2:another_value
+ # | | ^^^^^^^ -> func:class3:nested2
+ # ^^^^^^^^^^^^^^^^^^^^^ func:class3:nested2:another_value_nested
+ print(value_nested2, another_value_nested2)
+ # | | ^^^^^^^^^^^^^^^^^^^^^ -> func:class3:nested2:another_value_nested
+ # ^^^^^^^^^^^^^ -> func:class3:nested2:value
diff --git a/modules/gdscript/tests/scripts/lsp/enums.notest.gd b/modules/gdscript/tests/scripts/lsp/enums.notest.gd
new file mode 100644
index 0000000000..38b9ec110a
--- /dev/null
+++ b/modules/gdscript/tests/scripts/lsp/enums.notest.gd
@@ -0,0 +1,26 @@
+extends Node
+
+enum {UNIT_NEUTRAL, UNIT_ENEMY, UNIT_ALLY}
+# | | | | ^^^^^^^^^ enum:unnamed:ally -> enum:unnamed:ally
+# | | ^^^^^^^^^^ enum:unnamed:enemy -> enum:unnamed:enemy
+# ^^^^^^^^^^^^ enum:unnamed:neutral -> enum:unnamed:neutral
+enum Named {THING_1, THING_2, ANOTHER_THING = -1}
+# | | | | | | ^^^^^^^^^^^^^ enum:named:thing3 -> enum:named:thing3
+# | | | | ^^^^^^^ enum:named:thing2 -> enum:named:thing2
+# | | ^^^^^^^ enum:named:thing1 -> enum:named:thing1
+# ^^^^^ enum:named -> enum:named
+
+func f(arg):
+ match arg:
+ UNIT_ENEMY: print(UNIT_ENEMY)
+ # | ^^^^^^^^^^ -> enum:unnamed:enemy
+ #<^^^^^^^^ -> enum:unnamed:enemy
+ Named.THING_2: print(Named.THING_2)
+ #! | | | | | ^^^^^^^ -> enum:named:thing2
+ # | | | ^^^^^ -> enum:named
+ #! | ^^^^^^^ -> enum:named:thing2
+ #<^^^ -> enum:named
+ _: print(UNIT_ENEMY, Named.ANOTHER_THING)
+ #! | | | | ^^^^^^^^^^^^^ -> enum:named:thing3
+ # | | ^^^^^ -> enum:named
+ # ^^^^^^^^^^ -> enum:unnamed:enemy
diff --git a/modules/gdscript/tests/scripts/lsp/indentation.notest.gd b/modules/gdscript/tests/scripts/lsp/indentation.notest.gd
new file mode 100644
index 0000000000..c25d73a719
--- /dev/null
+++ b/modules/gdscript/tests/scripts/lsp/indentation.notest.gd
@@ -0,0 +1,28 @@
+extends Node
+
+var root = 0
+# ^^^^ 0_indent -> 0_indent
+
+func a():
+ var alpha: int = root + 42
+ # | | ^^^^ -> 0_indent
+ # ^^^^^ 1_indent -> 1_indent
+ if alpha > 42:
+ # ^^^^^ -> 1_indent
+ var beta := alpha + 13
+ # | | ^^^^ -> 1_indent
+ # ^^^^ 2_indent -> 2_indent
+ if beta > alpha:
+ # | | ^^^^^ -> 1_indent
+ # ^^^^ -> 2_indent
+ var gamma = beta + 1
+ # | | ^^^^ -> 2_indent
+ # ^^^^^ 3_indent -> 3_indent
+ print(gamma)
+ # ^^^^^ -> 3_indent
+ print(beta)
+ # ^^^^ -> 2_indent
+ print(alpha)
+ # ^^^^^ -> 1_indent
+ print(root)
+ # ^^^^ -> 0_indent
diff --git a/modules/gdscript/tests/scripts/lsp/lambdas.notest.gd b/modules/gdscript/tests/scripts/lsp/lambdas.notest.gd
new file mode 100644
index 0000000000..6f5d468eea
--- /dev/null
+++ b/modules/gdscript/tests/scripts/lsp/lambdas.notest.gd
@@ -0,0 +1,91 @@
+extends Node
+
+var lambda_member1 := func(alpha: int, beta): return alpha + beta
+# | | | | | | | | ^^^^ -> \1:beta
+# | | | | | | ^^^^^ -> \1:alpha
+# | | | | ^^^^ \1:beta -> \1:beta
+# | | ^^^^^ \1:alpha -> \1:alpha
+# ^^^^^^^^^^^^^^ \1 -> \1
+
+var lambda_member2 := func(alpha, beta: int) -> int:
+# | | | | | |
+# | | | | | |
+# | | | | ^^^^ \2:beta -> \2:beta
+# | | ^^^^^ \2:alpha -> \2:alpha
+# ^^^^^^^^^^^^^^ \2 -> \2
+ return alpha + beta
+ # | | ^^^^ -> \2:beta
+ # ^^^^^ -> \2:alpha
+
+var lambda_member3 := func add_values(alpha, beta): return alpha + beta
+# | | | | | | | | ^^^^ -> \3:beta
+# | | | | | | ^^^^^ -> \3:alpha
+# | | | | ^^^^ \3:beta -> \3:beta
+# | | ^^^^^ \3:alpha -> \3:alpha
+# ^^^^^^^^^^^^^^ \3 -> \3
+
+var lambda_multiline = func(alpha: int, beta: int) -> int:
+# | | | | | |
+# | | | | | |
+# | | | | ^^^^ \multi:beta -> \multi:beta
+# | | ^^^^^ \multi:alpha -> \multi:alpha
+# ^^^^^^^^^^^^^^^^ \multi -> \multi
+ print(alpha + beta)
+ # | | ^^^^ -> \multi:beta
+ # ^^^^^ -> \multi:alpha
+ var tmp = alpha + beta + 42
+ # | | | | ^^^^ -> \multi:beta
+ # | | ^^^^^ -> \multi:alpha
+ # ^^^ \multi:tmp -> \multi:tmp
+ print(tmp)
+ # ^^^ -> \multi:tmp
+ if tmp > 50:
+ # ^^^ -> \multi:tmp
+ tmp += alpha
+ # | ^^^^^ -> \multi:alpha
+ #<^ -> \multi:tmp
+ else:
+ tmp -= beta
+ # | ^^^^ -> \multi:beta
+ #<^ -> \multi:tmp
+ print(tmp)
+ # ^^^ -> \multi:tmp
+ return beta + tmp + alpha
+ # | | | | ^^^^^ -> \multi:alpha
+ # | | ^^^ -> \multi:tmp
+ # ^^^^ -> \multi:beta
+
+
+var some_name := "foo bar"
+# ^^^^^^^^^ member:some_name -> member:some_name
+
+func _ready() -> void:
+ var a = lambda_member1.call(1,2)
+ # ^^^^^^^^^^^^^^ -> \1
+ var b = lambda_member2.call(1,2)
+ # ^^^^^^^^^^^^^^ -> \2
+ var c = lambda_member3.call(1,2)
+ # ^^^^^^^^^^^^^^ -> \3
+ var d = lambda_multiline.call(1,2)
+ # ^^^^^^^^^^^^^^^^ -> \multi
+ print(a,b,c,d)
+
+ var lambda_local = func(alpha, beta): return alpha + beta
+ # | | | | | | | | ^^^^ -> \local:beta
+ # | | | | | | ^^^^^ -> \local:alpha
+ # | | | | ^^^^ \local:beta -> \local:beta
+ # | | ^^^^^ \local:alpha -> \local:alpha
+ # ^^^^^^^^^^^^ \local -> \local
+
+ var value := 42
+ # ^^^^^ local:value -> local:value
+ var lambda_capture = func(): return value + some_name.length()
+ # | | | | ^^^^^^^^^ -> member:some_name
+ # | | ^^^^^ -> local:value
+ # ^^^^^^^^^^^^^^ \capture -> \capture
+
+ var z = lambda_local.call(1,2)
+ # ^^^^^^^^^^^^ -> \local
+ var x = lambda_capture.call()
+ # ^^^^^^^^^^^^^^ -> \capture
+ print(z,x)
diff --git a/modules/gdscript/tests/scripts/lsp/local_variables.notest.gd b/modules/gdscript/tests/scripts/lsp/local_variables.notest.gd
new file mode 100644
index 0000000000..b6cc46f7da
--- /dev/null
+++ b/modules/gdscript/tests/scripts/lsp/local_variables.notest.gd
@@ -0,0 +1,25 @@
+extends Node
+
+var member := 2
+# ^^^^^^ member -> member
+
+func test_member() -> void:
+ var test := member + 42
+ # | | ^^^^^^ -> member
+ # ^^^^ test -> test
+ test += 3
+ #<^^ -> test
+ member += 5
+ #<^^^^ -> member
+ test = return_arg(test)
+ # | ^^^^ -> test
+ #<^^ -> test
+ print(test)
+ # ^^^^ -> test
+
+func return_arg(arg: int) -> int:
+# ^^^ arg -> arg
+ arg += 2
+ #<^ -> arg
+ return arg
+ # ^^^ -> arg \ No newline at end of file
diff --git a/modules/gdscript/tests/scripts/lsp/properties.notest.gd b/modules/gdscript/tests/scripts/lsp/properties.notest.gd
new file mode 100644
index 0000000000..8dfaee2e5b
--- /dev/null
+++ b/modules/gdscript/tests/scripts/lsp/properties.notest.gd
@@ -0,0 +1,65 @@
+extends Node
+
+var prop1 := 42
+# ^^^^^ prop1 -> prop1
+var prop2 : int = 42
+# ^^^^^ prop2 -> prop2
+var prop3 := 42:
+# ^^^^^ prop3 -> prop3
+ get:
+ return prop3 + 13
+ # ^^^^^ -> prop3
+ set(value):
+ # ^^^^^ prop3:value -> prop3:value
+ prop3 = value - 13
+ # | ^^^^^ -> prop3:value
+ #<^^^ -> prop3
+var prop4: int:
+# ^^^^^ prop4 -> prop4
+ get:
+ return 42
+var prop5 := 42:
+# ^^^^^ prop5 -> prop5
+ set(value):
+ # ^^^^^ prop5:value -> prop5:value
+ prop5 = value - 13
+ # | ^^^^^ -> prop5:value
+ #<^^^ -> prop5
+
+var prop6:
+# ^^^^^ prop6 -> prop6
+ get = get_prop6,
+ # ^^^^^^^^^ -> get_prop6
+ set = set_prop6
+ # ^^^^^^^^^ -> set_prop6
+func get_prop6():
+# ^^^^^^^^^ get_prop6 -> get_prop6
+ return 42
+func set_prop6(value):
+# | | ^^^^^ set_prop6:value -> set_prop6:value
+# ^^^^^^^^^ set_prop6 -> set_prop6
+ print(value)
+ # ^^^^^ -> set_prop6:value
+
+var prop7:
+# ^^^^^ prop7 -> prop7
+ get = get_prop7
+ # ^^^^^^^^^ -> get_prop7
+func get_prop7():
+# ^^^^^^^^^ get_prop7 -> get_prop7
+ return 42
+
+var prop8:
+# ^^^^^ prop8 -> prop8
+ set = set_prop8
+ # ^^^^^^^^^ -> set_prop8
+func set_prop8(value):
+# | | ^^^^^ set_prop8:value -> set_prop8:value
+# ^^^^^^^^^ set_prop8 -> set_prop8
+ print(value)
+ # ^^^^^ -> set_prop8:value
+
+const const_var := 42
+# ^^^^^^^^^ const_var -> const_var
+static var static_var := 42
+# ^^^^^^^^^^ static_var -> static_var
diff --git a/modules/gdscript/tests/scripts/lsp/scopes.notest.gd b/modules/gdscript/tests/scripts/lsp/scopes.notest.gd
new file mode 100644
index 0000000000..20b8fb9bd7
--- /dev/null
+++ b/modules/gdscript/tests/scripts/lsp/scopes.notest.gd
@@ -0,0 +1,106 @@
+extends Node
+
+var member := 2
+# ^^^^^^ public -> public
+
+signal some_changed(new_value)
+# | | ^^^^^^^^^ signal:parameter -> signal:parameter
+# ^^^^^^^^^^^^ signal -> signal
+var some_value := 42:
+# ^^^^^^^^^^ property -> property
+ get:
+ return some_value
+ # ^^^^^^^^^^ -> property
+ set(value):
+ # ^^^^^ property:set:value -> property:set:value
+ some_changed.emit(value)
+ # | ^^^^^ -> property:set:value
+ #<^^^^^^^^^^ -> signal
+ some_value = value
+ # | ^^^^^ -> property:set:value
+ #<^^^^^^^^ -> property
+
+func v():
+ var value := member + 2
+ # | | ^^^^^^ -> public
+ # ^^^^^ v:value -> v:value
+ print(value)
+ # ^^^^^ -> v:value
+ if value > 0:
+ # ^^^^^ -> v:value
+ var beta := value + 2
+ # | | ^^^^^ -> v:value
+ # ^^^^ v:if:beta -> v:if:beta
+ print(beta)
+ # ^^^^ -> v:if:beta
+
+ for counter in beta:
+ # | | ^^^^ -> v:if:beta
+ # ^^^^^^^ v:if:counter -> v:if:counter
+ print (counter)
+ # ^^^^^^^ -> v:if:counter
+
+ else:
+ for counter in value:
+ # | | ^^^^^ -> v:value
+ # ^^^^^^^ v:else:counter -> v:else:counter
+ print(counter)
+ # ^^^^^^^ -> v:else:counter
+
+func f():
+ var func1 = func(value): print(value + 13)
+ # | | | | ^^^^^ -> f:func1:value
+ # | | ^^^^^ f:func1:value -> f:func1:value
+ # ^^^^^ f:func1 -> f:func1
+ var func2 = func(value): print(value + 42)
+ # | | | | ^^^^^ -> f:func2:value
+ # | | ^^^^^ f:func2:value -> f:func2:value
+ # ^^^^^ f:func2 -> f:func2
+
+ func1.call(1)
+ #<^^^ -> f:func1
+ func2.call(2)
+ #<^^^ -> f:func2
+
+func m():
+ var value = 42
+ # ^^^^^ m:value -> m:value
+
+ match value:
+ # ^^^^^ -> m:value
+ 13:
+ print(value)
+ # ^^^^^ -> m:value
+ [var start, _, var end]:
+ # | | ^^^ m:match:array:end -> m:match:array:end
+ # ^^^^^ m:match:array:start -> m:match:array:start
+ print(start + end)
+ # | | ^^^ -> m:match:array:end
+ # ^^^^^ -> m:match:array:start
+ { "name": var name }:
+ # ^^^^ m:match:dict:var -> m:match:dict:var
+ print(name)
+ # ^^^^ -> m:match:dict:var
+ var whatever:
+ # ^^^^^^^^ m:match:var -> m:match:var
+ print(whatever)
+ # ^^^^^^^^ -> m:match:var
+
+func m2():
+ var value = 42
+ # ^^^^^ m2:value -> m2:value
+
+ match value:
+ # ^^^^^ -> m2:value
+ { "name": var name }:
+ # ^^^^ m2:match:dict:var -> m2:match:dict:var
+ print(name)
+ # ^^^^ -> m2:match:dict:var
+ [var name, ..]:
+ # ^^^^ m2:match:array:var -> m2:match:array:var
+ print(name)
+ # ^^^^ -> m2:match:array:var
+ var name:
+ # ^^^^ m2:match:var -> m2:match:var
+ print(name)
+ # ^^^^ -> m2:match:var
diff --git a/modules/gdscript/tests/scripts/lsp/shadowing_initializer.notest.gd b/modules/gdscript/tests/scripts/lsp/shadowing_initializer.notest.gd
new file mode 100644
index 0000000000..338000fa0e
--- /dev/null
+++ b/modules/gdscript/tests/scripts/lsp/shadowing_initializer.notest.gd
@@ -0,0 +1,56 @@
+extends Node
+
+var value := 42
+# ^^^^^ member:value -> member:value
+
+func variable():
+ var value = value + 42
+ #! | | ^^^^^ -> member:value
+ # ^^^^^ variable:value -> variable:value
+ print(value)
+ # ^^^^^ -> variable:value
+
+func array():
+ var value = [1,value,3,value+4]
+ #! | | | | ^^^^^ -> member:value
+ #! | | ^^^^^ -> member:value
+ # ^^^^^ array:value -> array:value
+ print(value)
+ # ^^^^^ -> array:value
+
+func dictionary():
+ var value = {
+ # ^^^^^ dictionary:value -> dictionary:value
+ "key1": value,
+ #! ^^^^^ -> member:value
+ "key2": 1 + value + 3,
+ #! ^^^^^ -> member:value
+ }
+ print(value)
+ # ^^^^^ -> dictionary:value
+
+func for_loop():
+ for value in value:
+ # | | ^^^^^ -> member:value
+ # ^^^^^ for:value -> for:value
+ print(value)
+ # ^^^^^ -> for:value
+
+func for_range():
+ for value in range(5, value):
+ # | | ^^^^^ -> member:value
+ # ^^^^^ for:range:value -> for:range:value
+ print(value)
+ # ^^^^^ -> for:range:value
+
+func matching():
+ match value:
+ # ^^^^^ -> member:value
+ 42: print(value)
+ # ^^^^^ -> member:value
+ [var value, ..]: print(value)
+ # | | ^^^^^ -> match:array:value
+ # ^^^^^ match:array:value -> match:array:value
+ var value: print(value)
+ # | | ^^^^^ -> match:var:value
+ # ^^^^^ match:var:value -> match:var:value
diff --git a/modules/gdscript/tests/test_lsp.h b/modules/gdscript/tests/test_lsp.h
new file mode 100644
index 0000000000..e57df00e2d
--- /dev/null
+++ b/modules/gdscript/tests/test_lsp.h
@@ -0,0 +1,480 @@
+/**************************************************************************/
+/* test_lsp.h */
+/**************************************************************************/
+/* This file is part of: */
+/* GODOT ENGINE */
+/* https://godotengine.org */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
+/* */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the */
+/* "Software"), to deal in the Software without restriction, including */
+/* without limitation the rights to use, copy, modify, merge, publish, */
+/* distribute, sublicense, and/or sell copies of the Software, and to */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions: */
+/* */
+/* The above copyright notice and this permission notice shall be */
+/* included in all copies or substantial portions of the Software. */
+/* */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
+/**************************************************************************/
+
+#ifndef TEST_LSP_H
+#define TEST_LSP_H
+
+#ifdef TOOLS_ENABLED
+
+#include "tests/test_macros.h"
+
+#include "../language_server/gdscript_extend_parser.h"
+#include "../language_server/gdscript_language_protocol.h"
+#include "../language_server/gdscript_workspace.h"
+#include "../language_server/godot_lsp.h"
+
+#include "core/io/dir_access.h"
+#include "core/io/file_access_pack.h"
+#include "core/os/os.h"
+#include "editor/editor_help.h"
+#include "editor/editor_node.h"
+#include "modules/gdscript/gdscript_analyzer.h"
+#include "modules/regex/regex.h"
+
+#include "thirdparty/doctest/doctest.h"
+
+template <>
+struct doctest::StringMaker<lsp::Position> {
+ static doctest::String convert(const lsp::Position &p_val) {
+ return p_val.to_string().utf8().get_data();
+ }
+};
+
+template <>
+struct doctest::StringMaker<lsp::Range> {
+ static doctest::String convert(const lsp::Range &p_val) {
+ return p_val.to_string().utf8().get_data();
+ }
+};
+
+template <>
+struct doctest::StringMaker<GodotPosition> {
+ static doctest::String convert(const GodotPosition &p_val) {
+ return p_val.to_string().utf8().get_data();
+ }
+};
+
+namespace GDScriptTests {
+
+// LSP GDScript test scripts are located inside project of other GDScript tests:
+// Cannot reset `ProjectSettings` (singleton) -> Cannot load another workspace and resources in there.
+// -> Reuse GDScript test project. LSP specific scripts are then placed inside `lsp` folder.
+// Access via `res://lsp/my_script.notest.gd`.
+const String root = "modules/gdscript/tests/scripts/";
+
+/*
+ * After use:
+ * * `memdelete` returned `GDScriptLanguageProtocol`.
+ * * Call `GDScriptTests::::finish_language`.
+ */
+GDScriptLanguageProtocol *initialize(const String &p_root) {
+ Error err = OK;
+ Ref<DirAccess> dir(DirAccess::open(p_root, &err));
+ REQUIRE_MESSAGE(err == OK, "Could not open specified root directory");
+ String absolute_root = dir->get_current_dir();
+ init_language(absolute_root);
+
+ GDScriptLanguageProtocol *proto = memnew(GDScriptLanguageProtocol);
+
+ Ref<GDScriptWorkspace> workspace = GDScriptLanguageProtocol::get_singleton()->get_workspace();
+ workspace->root = absolute_root;
+ // On windows: `C:/...` -> `C%3A/...`.
+ workspace->root_uri = "file:///" + absolute_root.lstrip("/").replace_first(":", "%3A");
+
+ return proto;
+}
+
+lsp::Position pos(const int p_line, const int p_character) {
+ lsp::Position p;
+ p.line = p_line;
+ p.character = p_character;
+ return p;
+}
+
+lsp::Range range(const lsp::Position p_start, const lsp::Position p_end) {
+ lsp::Range r;
+ r.start = p_start;
+ r.end = p_end;
+ return r;
+}
+
+lsp::TextDocumentPositionParams pos_in(const lsp::DocumentUri &p_uri, const lsp::Position p_pos) {
+ lsp::TextDocumentPositionParams params;
+ params.textDocument.uri = p_uri;
+ params.position = p_pos;
+ return params;
+}
+
+const lsp::DocumentSymbol *test_resolve_symbol_at(const String &p_uri, const lsp::Position p_pos, const String &p_expected_uri, const String &p_expected_name, const lsp::Range &p_expected_range) {
+ Ref<GDScriptWorkspace> workspace = GDScriptLanguageProtocol::get_singleton()->get_workspace();
+
+ lsp::TextDocumentPositionParams params = pos_in(p_uri, p_pos);
+ const lsp::DocumentSymbol *symbol = workspace->resolve_symbol(params);
+ CHECK(symbol);
+
+ if (symbol) {
+ CHECK_EQ(symbol->uri, p_expected_uri);
+ CHECK_EQ(symbol->name, p_expected_name);
+ CHECK_EQ(symbol->selectionRange, p_expected_range);
+ }
+
+ return symbol;
+}
+
+struct InlineTestData {
+ lsp::Range range;
+ String text;
+ String name;
+ String ref;
+
+ static bool try_parse(const Vector<String> &p_lines, const int p_line_number, InlineTestData &r_data) {
+ String line = p_lines[p_line_number];
+
+ RegEx regex = RegEx("^\\t*#[ |]*(?<range>(?<left><)?\\^+)(\\s+(?<name>(?!->)\\S+))?(\\s+->\\s+(?<ref>\\S+))?");
+ Ref<RegExMatch> match = regex.search(line);
+ if (match.is_null()) {
+ return false;
+ }
+
+ // Find first line without leading comment above current line.
+ int target_line = p_line_number;
+ while (target_line >= 0) {
+ String dedented = p_lines[target_line].lstrip("\t");
+ if (!dedented.begins_with("#")) {
+ break;
+ }
+ target_line--;
+ }
+ if (target_line < 0) {
+ return false;
+ }
+ r_data.range.start.line = r_data.range.end.line = target_line;
+
+ String marker = match->get_string("range");
+ int i = line.find(marker);
+ REQUIRE(i >= 0);
+ r_data.range.start.character = i;
+ if (!match->get_string("left").is_empty()) {
+ // Include `#` (comment char) in range.
+ r_data.range.start.character--;
+ }
+ r_data.range.end.character = i + marker.length();
+
+ String target = p_lines[target_line];
+ r_data.text = target.substr(r_data.range.start.character, r_data.range.end.character - r_data.range.start.character);
+
+ r_data.name = match->get_string("name");
+ r_data.ref = match->get_string("ref");
+
+ return true;
+ }
+};
+
+Vector<InlineTestData> read_tests(const String &p_path) {
+ Error err;
+ String source = FileAccess::get_file_as_string(p_path, &err);
+ REQUIRE_MESSAGE(err == OK, vformat("Cannot read '%s'", p_path));
+
+ // Format:
+ // ```gdscript
+ // var foo = bar + baz
+ // # | | | | ^^^ name -> ref
+ // # | | ^^^ -> ref
+ // # ^^^ name
+ //
+ // func my_func():
+ // # ^^^^^^^ name
+ // var value = foo + 42
+ // # ^^^^^ name
+ // print(value)
+ // # ^^^^^ -> ref
+ // ```
+ //
+ // * `^`: Range marker.
+ // * `name`: Unique name. Can contain any characters except whitespace chars.
+ // * `ref`: Reference to unique name.
+ //
+ // Notes:
+ // * If range should include first content-char (which is occupied by `#`): use `<` for next marker.
+ // -> Range expands 1 to left (-> includes `#`).
+ // * Note: Means: Range cannot be single char directly marked by `#`, but must be at least two chars (marked with `#<`).
+ // * Comment must start at same ident as line its marked (-> because of tab alignment...).
+ // * Use spaces to align after `#`! -> for correct alignment
+ // * Between `#` and `^` can be spaces or `|` (to better visualize what's marked below).
+ PackedStringArray lines = source.split("\n");
+
+ PackedStringArray names;
+ Vector<InlineTestData> data;
+ for (int i = 0; i < lines.size(); i++) {
+ InlineTestData d;
+ if (InlineTestData::try_parse(lines, i, d)) {
+ if (!d.name.is_empty()) {
+ // Safety check: names must be unique.
+ if (names.find(d.name) != -1) {
+ FAIL(vformat("Duplicated name '%s' in '%s'. Names must be unique!", d.name, p_path));
+ }
+ names.append(d.name);
+ }
+
+ data.append(d);
+ }
+ }
+
+ return data;
+}
+
+void test_resolve_symbol(const String &p_uri, const InlineTestData &p_test_data, const Vector<InlineTestData> &p_all_data) {
+ if (p_test_data.ref.is_empty()) {
+ return;
+ }
+
+ SUBCASE(vformat("Can resolve symbol '%s' at %s to '%s'", p_test_data.text, p_test_data.range.to_string(), p_test_data.ref).utf8().get_data()) {
+ const InlineTestData *target = nullptr;
+ for (int i = 0; i < p_all_data.size(); i++) {
+ if (p_all_data[i].name == p_test_data.ref) {
+ target = &p_all_data[i];
+ break;
+ }
+ }
+ REQUIRE_MESSAGE(target, vformat("No target for ref '%s'", p_test_data.ref));
+
+ Ref<GDScriptWorkspace> workspace = GDScriptLanguageProtocol::get_singleton()->get_workspace();
+ lsp::Position pos = p_test_data.range.start;
+
+ SUBCASE("start of identifier") {
+ pos.character = p_test_data.range.start.character;
+ test_resolve_symbol_at(p_uri, pos, p_uri, target->text, target->range);
+ }
+
+ SUBCASE("inside identifier") {
+ pos.character = (p_test_data.range.end.character + p_test_data.range.start.character) / 2;
+ test_resolve_symbol_at(p_uri, pos, p_uri, target->text, target->range);
+ }
+
+ SUBCASE("end of identifier") {
+ pos.character = p_test_data.range.end.character;
+ test_resolve_symbol_at(p_uri, pos, p_uri, target->text, target->range);
+ }
+ }
+}
+
+Vector<InlineTestData> filter_ref_towards(const Vector<InlineTestData> &p_data, const String &p_name) {
+ Vector<InlineTestData> res;
+
+ for (const InlineTestData &d : p_data) {
+ if (d.ref == p_name) {
+ res.append(d);
+ }
+ }
+
+ return res;
+}
+
+void test_resolve_symbols(const String &p_uri, const Vector<InlineTestData> &p_test_data, const Vector<InlineTestData> &p_all_data) {
+ for (const InlineTestData &d : p_test_data) {
+ test_resolve_symbol(p_uri, d, p_all_data);
+ }
+}
+
+void assert_no_errors_in(const String &p_path) {
+ Error err;
+ String source = FileAccess::get_file_as_string(p_path, &err);
+ REQUIRE_MESSAGE(err == OK, vformat("Cannot read '%s'", p_path));
+
+ GDScriptParser parser;
+ err = parser.parse(source, p_path, true);
+ REQUIRE_MESSAGE(err == OK, vformat("Errors while parsing '%s'", p_path));
+
+ GDScriptAnalyzer analyzer(&parser);
+ err = analyzer.analyze();
+ REQUIRE_MESSAGE(err == OK, vformat("Errors while analyzing '%s'", p_path));
+}
+
+inline lsp::Position lsp_pos(int line, int character) {
+ lsp::Position p;
+ p.line = line;
+ p.character = character;
+ return p;
+}
+
+void test_position_roundtrip(lsp::Position p_lsp, GodotPosition p_gd, const PackedStringArray &p_lines) {
+ GodotPosition actual_gd = GodotPosition::from_lsp(p_lsp, p_lines);
+ CHECK_EQ(p_gd, actual_gd);
+ lsp::Position actual_lsp = p_gd.to_lsp(p_lines);
+ CHECK_EQ(p_lsp, actual_lsp);
+}
+
+// Note:
+// * Cursor is BETWEEN chars
+// * `va|r` -> cursor between `a`&`r`
+// * `var`
+// ^
+// -> Character on `r` -> cursor between `a`&`r`s for tests:
+// * Line & Char:
+// * LSP: both 0-based
+// * Godot: both 1-based
+TEST_SUITE("[Modules][GDScript][LSP]") {
+ TEST_CASE("Can convert positions to and from Godot") {
+ String code = R"(extends Node
+
+var member := 42
+
+func f():
+ var value := 42
+ return value + member)";
+ PackedStringArray lines = code.split("\n");
+
+ SUBCASE("line after end") {
+ lsp::Position lsp = lsp_pos(7, 0);
+ GodotPosition gd(8, 1);
+ test_position_roundtrip(lsp, gd, lines);
+ }
+ SUBCASE("first char in first line") {
+ lsp::Position lsp = lsp_pos(0, 0);
+ GodotPosition gd(1, 1);
+ test_position_roundtrip(lsp, gd, lines);
+ }
+
+ SUBCASE("with tabs") {
+ // On `v` in `value` in `var value := ...`.
+ lsp::Position lsp = lsp_pos(5, 6);
+ GodotPosition gd(6, 13);
+ test_position_roundtrip(lsp, gd, lines);
+ }
+
+ SUBCASE("doesn't fail with column outside of character length") {
+ lsp::Position lsp = lsp_pos(2, 100);
+ GodotPosition::from_lsp(lsp, lines);
+
+ GodotPosition gd(3, 100);
+ gd.to_lsp(lines);
+ }
+
+ SUBCASE("doesn't fail with line outside of line length") {
+ lsp::Position lsp = lsp_pos(200, 100);
+ GodotPosition::from_lsp(lsp, lines);
+
+ GodotPosition gd(300, 100);
+ gd.to_lsp(lines);
+ }
+
+ SUBCASE("special case: negative line for root class") {
+ GodotPosition gd(-1, 0);
+ lsp::Position expected = lsp_pos(0, 0);
+ lsp::Position actual = gd.to_lsp(lines);
+ CHECK_EQ(actual, expected);
+ }
+ SUBCASE("special case: lines.length() + 1 for root class") {
+ GodotPosition gd(lines.size() + 1, 0);
+ lsp::Position expected = lsp_pos(lines.size(), 0);
+ lsp::Position actual = gd.to_lsp(lines);
+ CHECK_EQ(actual, expected);
+ }
+ }
+ TEST_CASE("[workspace][resolve_symbol]") {
+ GDScriptLanguageProtocol *proto = initialize(root);
+ REQUIRE(proto);
+ Ref<GDScriptWorkspace> workspace = GDScriptLanguageProtocol::get_singleton()->get_workspace();
+
+ {
+ String path = "res://lsp/local_variables.notest.gd";
+ assert_no_errors_in(path);
+ String uri = workspace->get_file_uri(path);
+ Vector<InlineTestData> all_test_data = read_tests(path);
+ SUBCASE("Can get correct ranges for public variables") {
+ Vector<InlineTestData> test_data = filter_ref_towards(all_test_data, "member");
+ test_resolve_symbols(uri, test_data, all_test_data);
+ }
+ SUBCASE("Can get correct ranges for local variables") {
+ Vector<InlineTestData> test_data = filter_ref_towards(all_test_data, "test");
+ test_resolve_symbols(uri, test_data, all_test_data);
+ }
+ SUBCASE("Can get correct ranges for local parameters") {
+ Vector<InlineTestData> test_data = filter_ref_towards(all_test_data, "arg");
+ test_resolve_symbols(uri, test_data, all_test_data);
+ }
+ }
+
+ SUBCASE("Can get correct ranges for indented variables") {
+ String path = "res://lsp/indentation.notest.gd";
+ assert_no_errors_in(path);
+ String uri = workspace->get_file_uri(path);
+ Vector<InlineTestData> all_test_data = read_tests(path);
+ test_resolve_symbols(uri, all_test_data, all_test_data);
+ }
+
+ SUBCASE("Can get correct ranges for scopes") {
+ String path = "res://lsp/scopes.notest.gd";
+ assert_no_errors_in(path);
+ String uri = workspace->get_file_uri(path);
+ Vector<InlineTestData> all_test_data = read_tests(path);
+ test_resolve_symbols(uri, all_test_data, all_test_data);
+ }
+
+ SUBCASE("Can get correct ranges for lambda") {
+ String path = "res://lsp/lambdas.notest.gd";
+ assert_no_errors_in(path);
+ String uri = workspace->get_file_uri(path);
+ Vector<InlineTestData> all_test_data = read_tests(path);
+ test_resolve_symbols(uri, all_test_data, all_test_data);
+ }
+
+ SUBCASE("Can get correct ranges for inner class") {
+ String path = "res://lsp/class.notest.gd";
+ assert_no_errors_in(path);
+ String uri = workspace->get_file_uri(path);
+ Vector<InlineTestData> all_test_data = read_tests(path);
+ test_resolve_symbols(uri, all_test_data, all_test_data);
+ }
+
+ SUBCASE("Can get correct ranges for inner class") {
+ String path = "res://lsp/enums.notest.gd";
+ assert_no_errors_in(path);
+ String uri = workspace->get_file_uri(path);
+ Vector<InlineTestData> all_test_data = read_tests(path);
+ test_resolve_symbols(uri, all_test_data, all_test_data);
+ }
+
+ SUBCASE("Can get correct ranges for shadowing & shadowed variables") {
+ String path = "res://lsp/shadowing_initializer.notest.gd";
+ assert_no_errors_in(path);
+ String uri = workspace->get_file_uri(path);
+ Vector<InlineTestData> all_test_data = read_tests(path);
+ test_resolve_symbols(uri, all_test_data, all_test_data);
+ }
+
+ SUBCASE("Can get correct ranges for properties and getter/setter") {
+ String path = "res://lsp/properties.notest.gd";
+ assert_no_errors_in(path);
+ String uri = workspace->get_file_uri(path);
+ Vector<InlineTestData> all_test_data = read_tests(path);
+ test_resolve_symbols(uri, all_test_data, all_test_data);
+ }
+
+ memdelete(proto);
+ finish_language();
+ }
+}
+
+} // namespace GDScriptTests
+
+#endif // TOOLS_ENABLED
+
+#endif // TEST_LSP_H