123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871 |
- /**************************************************************************/
- /* gdscript_extend_parser.cpp */
- /**************************************************************************/
- /* 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. */
- /**************************************************************************/
- #include "gdscript_extend_parser.h"
- #include "../gdscript.h"
- #include "../gdscript_analyzer.h"
- #include "gdscript_language_protocol.h"
- #include "gdscript_workspace.h"
- void ExtendGDScriptParser::update_diagnostics() {
- diagnostics.clear();
- const List<ParserError> &parser_errors = get_errors();
- for (const ParserError &error : parser_errors) {
- lsp::Diagnostic diagnostic;
- diagnostic.severity = lsp::DiagnosticSeverity::Error;
- diagnostic.message = error.message;
- diagnostic.source = "gdscript";
- diagnostic.code = -1;
- lsp::Range range;
- lsp::Position pos;
- const PackedStringArray line_array = get_lines();
- int line = CLAMP(LINE_NUMBER_TO_INDEX(error.line), 0, line_array.size() - 1);
- const String &line_text = line_array[line];
- pos.line = line;
- pos.character = line_text.length() - line_text.strip_edges(true, false).length();
- range.start = pos;
- range.end = range.start;
- range.end.character = line_text.strip_edges(false).length();
- diagnostic.range = range;
- diagnostics.push_back(diagnostic);
- }
- const List<GDScriptWarning> &parser_warnings = get_warnings();
- for (const GDScriptWarning &warning : parser_warnings) {
- lsp::Diagnostic diagnostic;
- diagnostic.severity = lsp::DiagnosticSeverity::Warning;
- diagnostic.message = "(" + warning.get_name() + "): " + warning.get_message();
- diagnostic.source = "gdscript";
- diagnostic.code = warning.code;
- lsp::Range range;
- lsp::Position pos;
- int line = LINE_NUMBER_TO_INDEX(warning.start_line);
- const String &line_text = get_lines()[line];
- pos.line = line;
- pos.character = line_text.length() - line_text.strip_edges(true, false).length();
- range.start = pos;
- range.end = pos;
- range.end.character = line_text.strip_edges(false).length();
- diagnostic.range = range;
- diagnostics.push_back(diagnostic);
- }
- }
- void ExtendGDScriptParser::update_symbols() {
- members.clear();
- if (const GDScriptParser::ClassNode *gdclass = dynamic_cast<const GDScriptParser::ClassNode *>(get_tree())) {
- parse_class_symbol(gdclass, class_symbol);
- for (int i = 0; i < class_symbol.children.size(); i++) {
- const lsp::DocumentSymbol &symbol = class_symbol.children[i];
- members.insert(symbol.name, &symbol);
- // cache level one inner classes
- if (symbol.kind == lsp::SymbolKind::Class) {
- ClassMembers inner_class;
- for (int j = 0; j < symbol.children.size(); j++) {
- const lsp::DocumentSymbol &s = symbol.children[j];
- inner_class.insert(s.name, &s);
- }
- inner_classes.insert(symbol.name, inner_class);
- }
- }
- }
- }
- void ExtendGDScriptParser::update_document_links(const String &p_code) {
- document_links.clear();
- GDScriptTokenizer scr_tokenizer;
- Ref<FileAccess> fs = FileAccess::create(FileAccess::ACCESS_RESOURCES);
- scr_tokenizer.set_source_code(p_code);
- while (true) {
- GDScriptTokenizer::Token token = scr_tokenizer.scan();
- if (token.type == GDScriptTokenizer::Token::TK_EOF) {
- break;
- } else if (token.type == GDScriptTokenizer::Token::LITERAL) {
- const Variant &const_val = token.literal;
- if (const_val.get_type() == Variant::STRING) {
- String scr_path = const_val;
- bool exists = fs->file_exists(scr_path);
- if (!exists) {
- scr_path = get_path().get_base_dir() + "/" + scr_path;
- exists = fs->file_exists(scr_path);
- }
- if (exists) {
- 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);
- document_links.push_back(link);
- }
- }
- }
- }
- }
- void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p_class, lsp::DocumentSymbol &r_symbol) {
- const String uri = get_uri();
- r_symbol.uri = uri;
- r_symbol.script_path = path;
- r_symbol.children.clear();
- r_symbol.name = p_class->identifier != nullptr ? String(p_class->identifier->name) : String();
- if (r_symbol.name.is_empty()) {
- r_symbol.name = path.get_file();
- }
- 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.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);
- for (int i = 0; i < p_class->members.size(); i++) {
- const ClassNode::Member &m = p_class->members[i];
- switch (m.type) {
- case ClassNode::Member::VARIABLE: {
- lsp::DocumentSymbol symbol;
- 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;
- if (m.variable->exported) {
- symbol.detail += "@export ";
- }
- symbol.detail += "var " + m.variable->identifier->name;
- if (m.get_datatype().is_hard_type()) {
- symbol.detail += ": " + m.get_datatype().to_string();
- }
- if (m.variable->initializer != nullptr && m.variable->initializer->is_constant) {
- symbol.detail += " = " + m.variable->initializer->reduced_value.to_json_string();
- }
- symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.variable->start_line));
- symbol.uri = uri;
- symbol.script_path = path;
- r_symbol.children.push_back(symbol);
- } break;
- case ClassNode::Member::CONSTANT: {
- lsp::DocumentSymbol symbol;
- 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.uri = uri;
- symbol.script_path = path;
- symbol.detail = "const " + symbol.name;
- if (m.constant->get_datatype().is_hard_type()) {
- symbol.detail += ": " + m.constant->get_datatype().to_string();
- }
- const Variant &default_value = m.constant->initializer->reduced_value;
- String value_text;
- if (default_value.get_type() == Variant::OBJECT) {
- Ref<Resource> res = default_value;
- if (res.is_valid() && !res->get_path().is_empty()) {
- value_text = "preload(\"" + res->get_path() + "\")";
- if (symbol.documentation.is_empty()) {
- if (HashMap<String, ExtendGDScriptParser *>::Iterator S = GDScriptLanguageProtocol::get_singleton()->get_workspace()->scripts.find(res->get_path())) {
- symbol.documentation = S->value->class_symbol.documentation;
- }
- }
- } else {
- value_text = default_value.to_json_string();
- }
- } else {
- value_text = default_value.to_json_string();
- }
- if (!value_text.is_empty()) {
- symbol.detail += " = " + value_text;
- }
- 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.uri = uri;
- symbol.script_path = path;
- symbol.detail = "signal " + String(m.signal->identifier->name) + "(";
- for (int j = 0; j < m.signal->parameters.size(); j++) {
- if (j > 0) {
- symbol.detail += ", ";
- }
- symbol.detail += m.signal->parameters[j]->identifier->name;
- }
- symbol.detail += ")";
- r_symbol.children.push_back(symbol);
- } break;
- case ClassNode::Member::ENUM: {
- lsp::DocumentSymbol symbol;
- 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.uri = uri;
- symbol.script_path = path;
- symbol.detail = "enum " + String(m.m_enum->identifier->name) + "{";
- for (int j = 0; j < m.m_enum->values.size(); j++) {
- if (j > 0) {
- symbol.detail += ", ";
- }
- symbol.detail += String(m.m_enum->values[j].identifier->name) + " = " + itos(m.m_enum->values[j].value);
- }
- symbol.detail += "}";
- r_symbol.children.push_back(symbol);
- } break;
- case ClassNode::Member::FUNCTION: {
- lsp::DocumentSymbol symbol;
- parse_function_symbol(m.function, symbol);
- r_symbol.children.push_back(symbol);
- } break;
- case ClassNode::Member::CLASS: {
- lsp::DocumentSymbol symbol;
- parse_class_symbol(m.m_class, symbol);
- r_symbol.children.push_back(symbol);
- } break;
- case ClassNode::Member::GROUP:
- break; // No-op, but silences warnings.
- case ClassNode::Member::UNDEFINED:
- break; // Unreachable.
- }
- }
- }
- 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) + "(";
- 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.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 += ", ";
- }
- parameters += String(parameter->identifier->name);
- if (parameter->get_datatype().is_hard_type()) {
- parameters += ": " + parameter->get_datatype().to_string();
- }
- if (parameter->initializer != nullptr) {
- parameters += " = " + parameter->initializer->reduced_value.to_json_string();
- }
- }
- r_symbol.detail += parameters + ")";
- if (p_func->get_datatype().is_hard_type()) {
- r_symbol.detail += " -> " + p_func->get_datatype().to_string();
- }
- List<GDScriptParser::SuiteNode *> function_nodes;
- List<GDScriptParser::Node *> node_stack;
- node_stack.push_back(p_func->body);
- while (!node_stack.is_empty()) {
- GDScriptParser::Node *node = node_stack[0];
- node_stack.pop_front();
- switch (node->type) {
- case GDScriptParser::TypeNode::IF: {
- GDScriptParser::IfNode *if_node = (GDScriptParser::IfNode *)node;
- node_stack.push_back(if_node->true_block);
- if (if_node->false_block) {
- node_stack.push_back(if_node->false_block);
- }
- } break;
- case GDScriptParser::TypeNode::FOR: {
- GDScriptParser::ForNode *for_node = (GDScriptParser::ForNode *)node;
- node_stack.push_back(for_node->loop);
- } break;
- case GDScriptParser::TypeNode::WHILE: {
- GDScriptParser::WhileNode *while_node = (GDScriptParser::WhileNode *)node;
- node_stack.push_back(while_node->loop);
- } break;
- case GDScriptParser::TypeNode::MATCH_BRANCH: {
- GDScriptParser::MatchBranchNode *match_node = (GDScriptParser::MatchBranchNode *)node;
- node_stack.push_back(match_node->block);
- } break;
- case GDScriptParser::TypeNode::SUITE: {
- GDScriptParser::SuiteNode *suite_node = (GDScriptParser::SuiteNode *)node;
- function_nodes.push_back(suite_node);
- for (int i = 0; i < suite_node->statements.size(); ++i) {
- node_stack.push_back(suite_node->statements[i]);
- }
- } 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;
- }
- }
- for (List<GDScriptParser::SuiteNode *>::Element *N = function_nodes.front(); N; N = N->next()) {
- const GDScriptParser::SuiteNode *suite_node = N->get();
- for (int i = 0; i < suite_node->locals.size(); i++) {
- const SuiteNode::Local &local = suite_node->locals[i];
- 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);
- symbol.uri = uri;
- symbol.script_path = path;
- symbol.detail = local.type == SuiteNode::Local::CONSTANT ? "const " : "var ";
- symbol.detail += symbol.name;
- 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()));
- }
- }
- }
- 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 {
- String longthing;
- int len = lines.size();
- 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 += lines[i].substr(p_cursor.character, lines[i].size());
- } else {
- longthing += lines[i];
- }
- if (i != len - 1) {
- longthing += "\n";
- }
- }
- return longthing;
- }
- String ExtendGDScriptParser::get_text_for_lookup_symbol(const lsp::Position &p_cursor, const String &p_symbol, bool p_func_required) const {
- String longthing;
- int len = lines.size();
- for (int i = 0; i < len; i++) {
- 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());
- if (!p_symbol.is_empty()) {
- String left_cursor_text;
- for (int c = p_cursor.character - 1; c >= 0; c--) {
- left_cursor_text = line.substr(c, p_cursor.character - c);
- if (p_symbol.begins_with(left_cursor_text)) {
- first_part = line.substr(0, c);
- first_part += p_symbol;
- break;
- }
- }
- }
- longthing += first_part;
- longthing += String::chr(0xFFFF); //not unicode, represents the cursor
- if (p_func_required) {
- longthing += "("; // tell the parser this is a function call
- }
- longthing += last_part;
- } else {
- longthing += lines[i];
- }
- if (i != len - 1) {
- longthing += "\n";
- }
- }
- return longthing;
- }
- String ExtendGDScriptParser::get_identifier_under_position(const lsp::Position &p_position, Vector2i &p_offset) const {
- ERR_FAIL_INDEX_V(p_position.line, lines.size(), "");
- String line = lines[p_position.line];
- if (line.is_empty()) {
- return "";
- }
- ERR_FAIL_INDEX_V(p_position.character, line.size(), "");
- int start_pos = p_position.character;
- for (int c = p_position.character; c >= 0; c--) {
- start_pos = c;
- char32_t ch = line[c];
- bool valid_char = is_ascii_identifier_char(ch);
- if (!valid_char) {
- break;
- }
- }
- int end_pos = p_position.character;
- for (int c = p_position.character; c < line.length(); c++) {
- char32_t ch = line[c];
- bool valid_char = is_ascii_identifier_char(ch);
- if (!valid_char) {
- break;
- }
- end_pos = c;
- }
- if (start_pos < end_pos) {
- p_offset.x = start_pos - p_position.character;
- p_offset.y = end_pos - p_position.character;
- return line.substr(start_pos + 1, end_pos - start_pos);
- }
- return "";
- }
- 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 *ret = nullptr;
- if (p_line < p_parent.range.start.line) {
- return ret;
- } else if (p_parent.range.start.line == p_line) {
- 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]);
- if (ret) {
- break;
- }
- }
- }
- return ret;
- }
- Error ExtendGDScriptParser::get_left_function_call(const lsp::Position &p_position, lsp::Position &r_func_pos, int &r_arg_index) const {
- ERR_FAIL_INDEX_V(p_position.line, lines.size(), ERR_INVALID_PARAMETER);
- int bracket_stack = 0;
- int index = 0;
- bool found = false;
- for (int l = p_position.line; l >= 0; --l) {
- String line = lines[l];
- int c = line.length() - 1;
- if (l == p_position.line) {
- c = MIN(c, p_position.character - 1);
- }
- while (c >= 0) {
- const char32_t &character = line[c];
- if (character == ')') {
- ++bracket_stack;
- } else if (character == '(') {
- --bracket_stack;
- if (bracket_stack < 0) {
- found = true;
- }
- }
- if (bracket_stack <= 0 && character == ',') {
- ++index;
- }
- --c;
- if (found) {
- r_func_pos.character = c;
- break;
- }
- }
- if (found) {
- r_func_pos.line = l;
- r_arg_index = index;
- return OK;
- }
- }
- return ERR_METHOD_NOT_FOUND;
- }
- const lsp::DocumentSymbol *ExtendGDScriptParser::get_symbol_defined_at_line(int p_line) const {
- if (p_line <= 0) {
- return &class_symbol;
- }
- return search_symbol_defined_at_line(p_line, class_symbol);
- }
- const lsp::DocumentSymbol *ExtendGDScriptParser::get_member_symbol(const String &p_name, const String &p_subclass) const {
- if (p_subclass.is_empty()) {
- const lsp::DocumentSymbol *const *ptr = members.getptr(p_name);
- if (ptr) {
- return *ptr;
- }
- } else {
- if (const ClassMembers *_class = inner_classes.getptr(p_subclass)) {
- const lsp::DocumentSymbol *const *ptr = _class->getptr(p_name);
- if (ptr) {
- return *ptr;
- }
- }
- }
- return nullptr;
- }
- const List<lsp::DocumentLink> &ExtendGDScriptParser::get_document_links() const {
- return document_links;
- }
- const Array &ExtendGDScriptParser::get_member_completions() {
- if (member_completions.is_empty()) {
- for (const KeyValue<String, const lsp::DocumentSymbol *> &E : members) {
- const lsp::DocumentSymbol *symbol = E.value;
- lsp::CompletionItem item = symbol->make_completion_item();
- item.data = JOIN_SYMBOLS(path, E.key);
- member_completions.push_back(item.to_json());
- }
- for (const KeyValue<String, ClassMembers> &E : inner_classes) {
- const ClassMembers *inner_class = &E.value;
- for (const KeyValue<String, const lsp::DocumentSymbol *> &F : *inner_class) {
- const lsp::DocumentSymbol *symbol = F.value;
- lsp::CompletionItem item = symbol->make_completion_item();
- item.data = JOIN_SYMBOLS(path, JOIN_SYMBOLS(E.key, F.key));
- member_completions.push_back(item.to_json());
- }
- }
- }
- return member_completions;
- }
- Dictionary ExtendGDScriptParser::dump_function_api(const GDScriptParser::FunctionNode *p_func) const {
- Dictionary func;
- ERR_FAIL_NULL_V(p_func, func);
- func["name"] = p_func->identifier->name;
- func["return_type"] = p_func->get_datatype().to_string();
- func["rpc_config"] = p_func->rpc_config;
- Array parameters;
- for (int i = 0; i < p_func->parameters.size(); i++) {
- Dictionary arg;
- arg["name"] = p_func->parameters[i]->identifier->name;
- arg["type"] = p_func->parameters[i]->get_datatype().to_string();
- if (p_func->parameters[i]->initializer != nullptr) {
- arg["default_value"] = p_func->parameters[i]->initializer->reduced_value;
- }
- parameters.push_back(arg);
- }
- if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(p_func->start_line))) {
- func["signature"] = symbol->detail;
- func["description"] = symbol->documentation;
- }
- func["arguments"] = parameters;
- return func;
- }
- Dictionary ExtendGDScriptParser::dump_class_api(const GDScriptParser::ClassNode *p_class) const {
- Dictionary class_api;
- ERR_FAIL_NULL_V(p_class, class_api);
- class_api["name"] = p_class->identifier != nullptr ? String(p_class->identifier->name) : String();
- class_api["path"] = path;
- Array extends_class;
- for (int i = 0; i < p_class->extends.size(); i++) {
- extends_class.append(String(p_class->extends[i]->name));
- }
- class_api["extends_class"] = extends_class;
- class_api["extends_file"] = String(p_class->extends_path);
- class_api["icon"] = String(p_class->icon_path);
- if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(p_class->start_line))) {
- class_api["signature"] = symbol->detail;
- class_api["description"] = symbol->documentation;
- }
- Array nested_classes;
- Array constants;
- Array class_members;
- Array signals;
- Array methods;
- Array static_functions;
- for (int i = 0; i < p_class->members.size(); i++) {
- const ClassNode::Member &m = p_class->members[i];
- switch (m.type) {
- case ClassNode::Member::CLASS:
- nested_classes.push_back(dump_class_api(m.m_class));
- break;
- case ClassNode::Member::CONSTANT: {
- Dictionary api;
- api["name"] = m.constant->identifier->name;
- api["value"] = m.constant->initializer->reduced_value;
- api["data_type"] = m.constant->get_datatype().to_string();
- if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.constant->start_line))) {
- api["signature"] = symbol->detail;
- api["description"] = symbol->documentation;
- }
- constants.push_back(api);
- } break;
- case ClassNode::Member::ENUM_VALUE: {
- Dictionary api;
- api["name"] = m.enum_value.identifier->name;
- api["value"] = m.enum_value.value;
- api["data_type"] = m.get_datatype().to_string();
- if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.enum_value.line))) {
- api["signature"] = symbol->detail;
- api["description"] = symbol->documentation;
- }
- constants.push_back(api);
- } break;
- case ClassNode::Member::ENUM: {
- Dictionary enum_dict;
- for (int j = 0; j < m.m_enum->values.size(); j++) {
- enum_dict[m.m_enum->values[j].identifier->name] = m.m_enum->values[j].value;
- }
- Dictionary api;
- api["name"] = m.m_enum->identifier->name;
- api["value"] = enum_dict;
- api["data_type"] = m.get_datatype().to_string();
- if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.m_enum->start_line))) {
- api["signature"] = symbol->detail;
- api["description"] = symbol->documentation;
- }
- constants.push_back(api);
- } break;
- case ClassNode::Member::VARIABLE: {
- Dictionary api;
- api["name"] = m.variable->identifier->name;
- api["data_type"] = m.variable->get_datatype().to_string();
- api["default_value"] = m.variable->initializer != nullptr ? m.variable->initializer->reduced_value : Variant();
- api["setter"] = m.variable->setter ? ("@" + String(m.variable->identifier->name) + "_setter") : (m.variable->setter_pointer != nullptr ? String(m.variable->setter_pointer->name) : String());
- api["getter"] = m.variable->getter ? ("@" + String(m.variable->identifier->name) + "_getter") : (m.variable->getter_pointer != nullptr ? String(m.variable->getter_pointer->name) : String());
- api["export"] = m.variable->exported;
- if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.variable->start_line))) {
- api["signature"] = symbol->detail;
- api["description"] = symbol->documentation;
- }
- class_members.push_back(api);
- } break;
- case ClassNode::Member::SIGNAL: {
- Dictionary api;
- api["name"] = m.signal->identifier->name;
- Array pars;
- for (int j = 0; j < m.signal->parameters.size(); j++) {
- pars.append(String(m.signal->parameters[j]->identifier->name));
- }
- api["arguments"] = pars;
- if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.signal->start_line))) {
- api["signature"] = symbol->detail;
- api["description"] = symbol->documentation;
- }
- signals.push_back(api);
- } break;
- case ClassNode::Member::FUNCTION: {
- if (m.function->is_static) {
- static_functions.append(dump_function_api(m.function));
- } else {
- methods.append(dump_function_api(m.function));
- }
- } break;
- case ClassNode::Member::GROUP:
- break; // No-op, but silences warnings.
- case ClassNode::Member::UNDEFINED:
- break; // Unreachable.
- }
- }
- class_api["sub_classes"] = nested_classes;
- class_api["constants"] = constants;
- class_api["members"] = class_members;
- class_api["signals"] = signals;
- class_api["methods"] = methods;
- class_api["static_functions"] = static_functions;
- return class_api;
- }
- Dictionary ExtendGDScriptParser::generate_api() const {
- Dictionary api;
- if (const GDScriptParser::ClassNode *gdclass = dynamic_cast<const GDScriptParser::ClassNode *>(get_tree())) {
- api = dump_class_api(gdclass);
- }
- return api;
- }
- Error ExtendGDScriptParser::parse(const String &p_code, const String &p_path) {
- path = p_path;
- lines = p_code.split("\n");
- Error err = GDScriptParser::parse(p_code, p_path, false);
- GDScriptAnalyzer analyzer(this);
- if (err == OK) {
- err = analyzer.analyze();
- }
- update_diagnostics();
- update_symbols();
- update_document_links(p_code);
- return err;
- }
|