gdscript_extend_parser.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857
  1. /*************************************************************************/
  2. /* gdscript_extend_parser.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "gdscript_extend_parser.h"
  31. #include "../gdscript.h"
  32. #include "../gdscript_analyzer.h"
  33. #include "gdscript_language_protocol.h"
  34. #include "gdscript_workspace.h"
  35. void ExtendGDScriptParser::update_diagnostics() {
  36. diagnostics.clear();
  37. const List<ParserError> &errors = get_errors();
  38. for (const ParserError &error : errors) {
  39. lsp::Diagnostic diagnostic;
  40. diagnostic.severity = lsp::DiagnosticSeverity::Error;
  41. diagnostic.message = error.message;
  42. diagnostic.source = "gdscript";
  43. diagnostic.code = -1;
  44. lsp::Range range;
  45. lsp::Position pos;
  46. const PackedStringArray lines = get_lines();
  47. int line = CLAMP(LINE_NUMBER_TO_INDEX(error.line), 0, lines.size() - 1);
  48. const String &line_text = lines[line];
  49. pos.line = line;
  50. pos.character = line_text.length() - line_text.strip_edges(true, false).length();
  51. range.start = pos;
  52. range.end = range.start;
  53. range.end.character = line_text.strip_edges(false).length();
  54. diagnostic.range = range;
  55. diagnostics.push_back(diagnostic);
  56. }
  57. const List<GDScriptWarning> &warnings = get_warnings();
  58. for (const GDScriptWarning &warning : warnings) {
  59. lsp::Diagnostic diagnostic;
  60. diagnostic.severity = lsp::DiagnosticSeverity::Warning;
  61. diagnostic.message = "(" + warning.get_name() + "): " + warning.get_message();
  62. diagnostic.source = "gdscript";
  63. diagnostic.code = warning.code;
  64. lsp::Range range;
  65. lsp::Position pos;
  66. int line = LINE_NUMBER_TO_INDEX(warning.start_line);
  67. const String &line_text = get_lines()[line];
  68. pos.line = line;
  69. pos.character = line_text.length() - line_text.strip_edges(true, false).length();
  70. range.start = pos;
  71. range.end = pos;
  72. range.end.character = line_text.strip_edges(false).length();
  73. diagnostic.range = range;
  74. diagnostics.push_back(diagnostic);
  75. }
  76. }
  77. void ExtendGDScriptParser::update_symbols() {
  78. members.clear();
  79. const GDScriptParser::Node *head = get_tree();
  80. if (const GDScriptParser::ClassNode *gdclass = dynamic_cast<const GDScriptParser::ClassNode *>(head)) {
  81. parse_class_symbol(gdclass, class_symbol);
  82. for (int i = 0; i < class_symbol.children.size(); i++) {
  83. const lsp::DocumentSymbol &symbol = class_symbol.children[i];
  84. members.insert(symbol.name, &symbol);
  85. // cache level one inner classes
  86. if (symbol.kind == lsp::SymbolKind::Class) {
  87. ClassMembers inner_class;
  88. for (int j = 0; j < symbol.children.size(); j++) {
  89. const lsp::DocumentSymbol &s = symbol.children[j];
  90. inner_class.insert(s.name, &s);
  91. }
  92. inner_classes.insert(symbol.name, inner_class);
  93. }
  94. }
  95. }
  96. }
  97. void ExtendGDScriptParser::update_document_links(const String &p_code) {
  98. document_links.clear();
  99. GDScriptTokenizer tokenizer;
  100. Ref<FileAccess> fs = FileAccess::create(FileAccess::ACCESS_RESOURCES);
  101. tokenizer.set_source_code(p_code);
  102. while (true) {
  103. GDScriptTokenizer::Token token = tokenizer.scan();
  104. if (token.type == GDScriptTokenizer::Token::TK_EOF) {
  105. break;
  106. } else if (token.type == GDScriptTokenizer::Token::LITERAL) {
  107. const Variant &const_val = token.literal;
  108. if (const_val.get_type() == Variant::STRING) {
  109. String path = const_val;
  110. bool exists = fs->file_exists(path);
  111. if (!exists) {
  112. path = get_path().get_base_dir() + "/" + path;
  113. exists = fs->file_exists(path);
  114. }
  115. if (exists) {
  116. String value = const_val;
  117. lsp::DocumentLink link;
  118. link.target = GDScriptLanguageProtocol::get_singleton()->get_workspace()->get_file_uri(path);
  119. link.range.start.line = LINE_NUMBER_TO_INDEX(token.start_line);
  120. link.range.end.line = LINE_NUMBER_TO_INDEX(token.end_line);
  121. link.range.start.character = LINE_NUMBER_TO_INDEX(token.start_column);
  122. link.range.end.character = LINE_NUMBER_TO_INDEX(token.end_column);
  123. document_links.push_back(link);
  124. }
  125. }
  126. }
  127. }
  128. }
  129. void ExtendGDScriptParser::parse_class_symbol(const GDScriptParser::ClassNode *p_class, lsp::DocumentSymbol &r_symbol) {
  130. const String uri = get_uri();
  131. r_symbol.uri = uri;
  132. r_symbol.script_path = path;
  133. r_symbol.children.clear();
  134. r_symbol.name = p_class->identifier != nullptr ? String(p_class->identifier->name) : String();
  135. if (r_symbol.name.is_empty()) {
  136. r_symbol.name = path.get_file();
  137. }
  138. r_symbol.kind = lsp::SymbolKind::Class;
  139. r_symbol.deprecated = false;
  140. r_symbol.range.start.line = p_class->start_line;
  141. r_symbol.range.start.character = p_class->start_column;
  142. r_symbol.range.end.line = lines.size();
  143. r_symbol.selectionRange.start.line = r_symbol.range.start.line;
  144. r_symbol.detail = "class " + r_symbol.name;
  145. bool is_root_class = &r_symbol == &class_symbol;
  146. r_symbol.documentation = parse_documentation(is_root_class ? 0 : LINE_NUMBER_TO_INDEX(p_class->start_line), is_root_class);
  147. for (int i = 0; i < p_class->members.size(); i++) {
  148. const ClassNode::Member &m = p_class->members[i];
  149. switch (m.type) {
  150. case ClassNode::Member::VARIABLE: {
  151. lsp::DocumentSymbol symbol;
  152. symbol.name = m.variable->identifier->name;
  153. symbol.kind = m.variable->property == VariableNode::PROP_NONE ? lsp::SymbolKind::Variable : lsp::SymbolKind::Property;
  154. symbol.deprecated = false;
  155. symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.variable->start_line);
  156. symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.variable->start_column);
  157. symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.variable->end_line);
  158. symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.variable->end_column);
  159. symbol.selectionRange.start.line = symbol.range.start.line;
  160. if (m.variable->exported) {
  161. symbol.detail += "@export ";
  162. }
  163. symbol.detail += "var " + m.variable->identifier->name;
  164. if (m.get_datatype().is_hard_type()) {
  165. symbol.detail += ": " + m.get_datatype().to_string();
  166. }
  167. if (m.variable->initializer != nullptr && m.variable->initializer->is_constant) {
  168. symbol.detail += " = " + m.variable->initializer->reduced_value.to_json_string();
  169. }
  170. symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.variable->start_line));
  171. symbol.uri = uri;
  172. symbol.script_path = path;
  173. r_symbol.children.push_back(symbol);
  174. } break;
  175. case ClassNode::Member::CONSTANT: {
  176. lsp::DocumentSymbol symbol;
  177. symbol.name = m.constant->identifier->name;
  178. symbol.kind = lsp::SymbolKind::Constant;
  179. symbol.deprecated = false;
  180. symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.constant->start_line);
  181. symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.constant->start_column);
  182. symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.constant->end_line);
  183. symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.constant->start_column);
  184. symbol.selectionRange.start.line = LINE_NUMBER_TO_INDEX(m.constant->start_line);
  185. symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.constant->start_line));
  186. symbol.uri = uri;
  187. symbol.script_path = path;
  188. symbol.detail = "const " + symbol.name;
  189. if (m.constant->get_datatype().is_hard_type()) {
  190. symbol.detail += ": " + m.constant->get_datatype().to_string();
  191. }
  192. const Variant &default_value = m.constant->initializer->reduced_value;
  193. String value_text;
  194. if (default_value.get_type() == Variant::OBJECT) {
  195. Ref<Resource> res = default_value;
  196. if (res.is_valid() && !res->get_path().is_empty()) {
  197. value_text = "preload(\"" + res->get_path() + "\")";
  198. if (symbol.documentation.is_empty()) {
  199. if (HashMap<String, ExtendGDScriptParser *>::Iterator S = GDScriptLanguageProtocol::get_singleton()->get_workspace()->scripts.find(res->get_path())) {
  200. symbol.documentation = S->value->class_symbol.documentation;
  201. }
  202. }
  203. } else {
  204. value_text = default_value.to_json_string();
  205. }
  206. } else {
  207. value_text = default_value.to_json_string();
  208. }
  209. if (!value_text.is_empty()) {
  210. symbol.detail += " = " + value_text;
  211. }
  212. r_symbol.children.push_back(symbol);
  213. } break;
  214. case ClassNode::Member::ENUM_VALUE: {
  215. lsp::DocumentSymbol symbol;
  216. symbol.name = m.enum_value.identifier->name;
  217. symbol.kind = lsp::SymbolKind::EnumMember;
  218. symbol.deprecated = false;
  219. symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.enum_value.line);
  220. symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.enum_value.leftmost_column);
  221. symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.enum_value.line);
  222. symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.enum_value.rightmost_column);
  223. symbol.selectionRange.start.line = LINE_NUMBER_TO_INDEX(m.enum_value.line);
  224. symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.enum_value.line));
  225. symbol.uri = uri;
  226. symbol.script_path = path;
  227. symbol.detail = symbol.name + " = " + itos(m.enum_value.value);
  228. r_symbol.children.push_back(symbol);
  229. } break;
  230. case ClassNode::Member::SIGNAL: {
  231. lsp::DocumentSymbol symbol;
  232. symbol.name = m.signal->identifier->name;
  233. symbol.kind = lsp::SymbolKind::Event;
  234. symbol.deprecated = false;
  235. symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.signal->start_line);
  236. symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.signal->start_column);
  237. symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.signal->end_line);
  238. symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.signal->end_column);
  239. symbol.selectionRange.start.line = symbol.range.start.line;
  240. symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.signal->start_line));
  241. symbol.uri = uri;
  242. symbol.script_path = path;
  243. symbol.detail = "signal " + String(m.signal->identifier->name) + "(";
  244. for (int j = 0; j < m.signal->parameters.size(); j++) {
  245. if (j > 0) {
  246. symbol.detail += ", ";
  247. }
  248. symbol.detail += m.signal->parameters[j]->identifier->name;
  249. }
  250. symbol.detail += ")";
  251. r_symbol.children.push_back(symbol);
  252. } break;
  253. case ClassNode::Member::ENUM: {
  254. lsp::DocumentSymbol symbol;
  255. symbol.kind = lsp::SymbolKind::Enum;
  256. symbol.range.start.line = LINE_NUMBER_TO_INDEX(m.m_enum->start_line);
  257. symbol.range.start.character = LINE_NUMBER_TO_INDEX(m.m_enum->start_column);
  258. symbol.range.end.line = LINE_NUMBER_TO_INDEX(m.m_enum->end_line);
  259. symbol.range.end.character = LINE_NUMBER_TO_INDEX(m.m_enum->end_column);
  260. symbol.selectionRange.start.line = symbol.range.start.line;
  261. symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(m.m_enum->start_line));
  262. symbol.uri = uri;
  263. symbol.script_path = path;
  264. symbol.detail = "enum " + String(m.m_enum->identifier->name) + "{";
  265. for (int j = 0; j < m.m_enum->values.size(); j++) {
  266. if (j > 0) {
  267. symbol.detail += ", ";
  268. }
  269. symbol.detail += String(m.m_enum->values[j].identifier->name) + " = " + itos(m.m_enum->values[j].value);
  270. }
  271. symbol.detail += "}";
  272. r_symbol.children.push_back(symbol);
  273. } break;
  274. case ClassNode::Member::FUNCTION: {
  275. lsp::DocumentSymbol symbol;
  276. parse_function_symbol(m.function, symbol);
  277. r_symbol.children.push_back(symbol);
  278. } break;
  279. case ClassNode::Member::CLASS: {
  280. lsp::DocumentSymbol symbol;
  281. parse_class_symbol(m.m_class, symbol);
  282. r_symbol.children.push_back(symbol);
  283. } break;
  284. case ClassNode::Member::GROUP:
  285. break; // No-op, but silences warnings.
  286. case ClassNode::Member::UNDEFINED:
  287. break; // Unreachable.
  288. }
  289. }
  290. }
  291. void ExtendGDScriptParser::parse_function_symbol(const GDScriptParser::FunctionNode *p_func, lsp::DocumentSymbol &r_symbol) {
  292. const String uri = get_uri();
  293. r_symbol.name = p_func->identifier->name;
  294. r_symbol.kind = p_func->is_static ? lsp::SymbolKind::Function : lsp::SymbolKind::Method;
  295. r_symbol.detail = "func " + String(p_func->identifier->name) + "(";
  296. r_symbol.deprecated = false;
  297. r_symbol.range.start.line = LINE_NUMBER_TO_INDEX(p_func->start_line);
  298. r_symbol.range.start.character = LINE_NUMBER_TO_INDEX(p_func->start_column);
  299. r_symbol.range.end.line = LINE_NUMBER_TO_INDEX(p_func->start_line);
  300. r_symbol.range.end.character = LINE_NUMBER_TO_INDEX(p_func->end_column);
  301. r_symbol.selectionRange.start.line = r_symbol.range.start.line;
  302. r_symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(p_func->start_line));
  303. r_symbol.uri = uri;
  304. r_symbol.script_path = path;
  305. String parameters;
  306. for (int i = 0; i < p_func->parameters.size(); i++) {
  307. const ParameterNode *parameter = p_func->parameters[i];
  308. lsp::DocumentSymbol symbol;
  309. symbol.kind = lsp::SymbolKind::Variable;
  310. symbol.name = parameter->identifier->name;
  311. symbol.range.start.line = LINE_NUMBER_TO_INDEX(parameter->start_line);
  312. symbol.range.start.character = LINE_NUMBER_TO_INDEX(parameter->start_line);
  313. symbol.range.end.line = LINE_NUMBER_TO_INDEX(parameter->end_line);
  314. symbol.range.end.character = LINE_NUMBER_TO_INDEX(parameter->end_column);
  315. symbol.uri = uri;
  316. symbol.script_path = path;
  317. r_symbol.children.push_back(symbol);
  318. if (i > 0) {
  319. parameters += ", ";
  320. }
  321. parameters += String(parameter->identifier->name);
  322. if (parameter->get_datatype().is_hard_type()) {
  323. parameters += ": " + parameter->get_datatype().to_string();
  324. }
  325. if (parameter->default_value != nullptr) {
  326. parameters += " = " + parameter->default_value->reduced_value.to_json_string();
  327. }
  328. }
  329. r_symbol.detail += parameters + ")";
  330. if (p_func->get_datatype().is_hard_type()) {
  331. r_symbol.detail += " -> " + p_func->get_datatype().to_string();
  332. }
  333. List<GDScriptParser::SuiteNode *> function_nodes;
  334. List<GDScriptParser::Node *> node_stack;
  335. node_stack.push_back(p_func->body);
  336. while (!node_stack.is_empty()) {
  337. GDScriptParser::Node *node = node_stack[0];
  338. node_stack.pop_front();
  339. switch (node->type) {
  340. case GDScriptParser::TypeNode::IF: {
  341. GDScriptParser::IfNode *if_node = (GDScriptParser::IfNode *)node;
  342. node_stack.push_back(if_node->true_block);
  343. if (if_node->false_block) {
  344. node_stack.push_back(if_node->false_block);
  345. }
  346. } break;
  347. case GDScriptParser::TypeNode::FOR: {
  348. GDScriptParser::ForNode *for_node = (GDScriptParser::ForNode *)node;
  349. node_stack.push_back(for_node->loop);
  350. } break;
  351. case GDScriptParser::TypeNode::WHILE: {
  352. GDScriptParser::WhileNode *while_node = (GDScriptParser::WhileNode *)node;
  353. node_stack.push_back(while_node->loop);
  354. } break;
  355. case GDScriptParser::TypeNode::MATCH_BRANCH: {
  356. GDScriptParser::MatchBranchNode *match_node = (GDScriptParser::MatchBranchNode *)node;
  357. node_stack.push_back(match_node->block);
  358. } break;
  359. case GDScriptParser::TypeNode::SUITE: {
  360. GDScriptParser::SuiteNode *suite_node = (GDScriptParser::SuiteNode *)node;
  361. function_nodes.push_back(suite_node);
  362. for (int i = 0; i < suite_node->statements.size(); ++i) {
  363. node_stack.push_back(suite_node->statements[i]);
  364. }
  365. } break;
  366. default:
  367. continue;
  368. }
  369. }
  370. for (List<GDScriptParser::SuiteNode *>::Element *N = function_nodes.front(); N; N = N->next()) {
  371. const GDScriptParser::SuiteNode *suite_node = N->get();
  372. for (int i = 0; i < suite_node->locals.size(); i++) {
  373. const SuiteNode::Local &local = suite_node->locals[i];
  374. lsp::DocumentSymbol symbol;
  375. symbol.name = local.name;
  376. symbol.kind = local.type == SuiteNode::Local::CONSTANT ? lsp::SymbolKind::Constant : lsp::SymbolKind::Variable;
  377. symbol.range.start.line = LINE_NUMBER_TO_INDEX(local.start_line);
  378. symbol.range.start.character = LINE_NUMBER_TO_INDEX(local.start_column);
  379. symbol.range.end.line = LINE_NUMBER_TO_INDEX(local.end_line);
  380. symbol.range.end.character = LINE_NUMBER_TO_INDEX(local.end_column);
  381. symbol.uri = uri;
  382. symbol.script_path = path;
  383. symbol.detail = local.type == SuiteNode::Local::CONSTANT ? "const " : "var ";
  384. symbol.detail += symbol.name;
  385. if (local.get_datatype().is_hard_type()) {
  386. symbol.detail += ": " + local.get_datatype().to_string();
  387. }
  388. symbol.documentation = parse_documentation(LINE_NUMBER_TO_INDEX(local.start_line));
  389. r_symbol.children.push_back(symbol);
  390. }
  391. }
  392. }
  393. String ExtendGDScriptParser::parse_documentation(int p_line, bool p_docs_down) {
  394. ERR_FAIL_INDEX_V(p_line, lines.size(), String());
  395. List<String> doc_lines;
  396. if (!p_docs_down) { // inline comment
  397. String inline_comment = lines[p_line];
  398. int comment_start = inline_comment.find("#");
  399. if (comment_start != -1) {
  400. inline_comment = inline_comment.substr(comment_start, inline_comment.length()).strip_edges();
  401. if (inline_comment.length() > 1) {
  402. doc_lines.push_back(inline_comment.substr(1, inline_comment.length()));
  403. }
  404. }
  405. }
  406. int step = p_docs_down ? 1 : -1;
  407. int start_line = p_docs_down ? p_line : p_line - 1;
  408. for (int i = start_line; true; i += step) {
  409. if (i < 0 || i >= lines.size()) {
  410. break;
  411. }
  412. String line_comment = lines[i].strip_edges(true, false);
  413. if (line_comment.begins_with("#")) {
  414. line_comment = line_comment.substr(1, line_comment.length());
  415. if (p_docs_down) {
  416. doc_lines.push_back(line_comment);
  417. } else {
  418. doc_lines.push_front(line_comment);
  419. }
  420. } else {
  421. break;
  422. }
  423. }
  424. String doc;
  425. for (const String &E : doc_lines) {
  426. doc += E + "\n";
  427. }
  428. return doc;
  429. }
  430. String ExtendGDScriptParser::get_text_for_completion(const lsp::Position &p_cursor) const {
  431. String longthing;
  432. int len = lines.size();
  433. for (int i = 0; i < len; i++) {
  434. if (i == p_cursor.line) {
  435. longthing += lines[i].substr(0, p_cursor.character);
  436. longthing += String::chr(0xFFFF); //not unicode, represents the cursor
  437. longthing += lines[i].substr(p_cursor.character, lines[i].size());
  438. } else {
  439. longthing += lines[i];
  440. }
  441. if (i != len - 1) {
  442. longthing += "\n";
  443. }
  444. }
  445. return longthing;
  446. }
  447. String ExtendGDScriptParser::get_text_for_lookup_symbol(const lsp::Position &p_cursor, const String &p_symbol, bool p_func_required) const {
  448. String longthing;
  449. int len = lines.size();
  450. for (int i = 0; i < len; i++) {
  451. if (i == p_cursor.line) {
  452. String line = lines[i];
  453. String first_part = line.substr(0, p_cursor.character);
  454. String last_part = line.substr(p_cursor.character + 1, lines[i].length());
  455. if (!p_symbol.is_empty()) {
  456. String left_cursor_text;
  457. for (int c = p_cursor.character - 1; c >= 0; c--) {
  458. left_cursor_text = line.substr(c, p_cursor.character - c);
  459. if (p_symbol.begins_with(left_cursor_text)) {
  460. first_part = line.substr(0, c);
  461. first_part += p_symbol;
  462. break;
  463. }
  464. }
  465. }
  466. longthing += first_part;
  467. longthing += String::chr(0xFFFF); //not unicode, represents the cursor
  468. if (p_func_required) {
  469. longthing += "("; // tell the parser this is a function call
  470. }
  471. longthing += last_part;
  472. } else {
  473. longthing += lines[i];
  474. }
  475. if (i != len - 1) {
  476. longthing += "\n";
  477. }
  478. }
  479. return longthing;
  480. }
  481. String ExtendGDScriptParser::get_identifier_under_position(const lsp::Position &p_position, Vector2i &p_offset) const {
  482. ERR_FAIL_INDEX_V(p_position.line, lines.size(), "");
  483. String line = lines[p_position.line];
  484. if (line.is_empty()) {
  485. return "";
  486. }
  487. ERR_FAIL_INDEX_V(p_position.character, line.size(), "");
  488. int start_pos = p_position.character;
  489. for (int c = p_position.character; c >= 0; c--) {
  490. start_pos = c;
  491. char32_t ch = line[c];
  492. bool valid_char = is_ascii_identifier_char(ch);
  493. if (!valid_char) {
  494. break;
  495. }
  496. }
  497. int end_pos = p_position.character;
  498. for (int c = p_position.character; c < line.length(); c++) {
  499. char32_t ch = line[c];
  500. bool valid_char = is_ascii_identifier_char(ch);
  501. if (!valid_char) {
  502. break;
  503. }
  504. end_pos = c;
  505. }
  506. if (start_pos < end_pos) {
  507. p_offset.x = start_pos - p_position.character;
  508. p_offset.y = end_pos - p_position.character;
  509. return line.substr(start_pos + 1, end_pos - start_pos);
  510. }
  511. return "";
  512. }
  513. String ExtendGDScriptParser::get_uri() const {
  514. return GDScriptLanguageProtocol::get_singleton()->get_workspace()->get_file_uri(path);
  515. }
  516. const lsp::DocumentSymbol *ExtendGDScriptParser::search_symbol_defined_at_line(int p_line, const lsp::DocumentSymbol &p_parent) const {
  517. const lsp::DocumentSymbol *ret = nullptr;
  518. if (p_line < p_parent.range.start.line) {
  519. return ret;
  520. } else if (p_parent.range.start.line == p_line) {
  521. return &p_parent;
  522. } else {
  523. for (int i = 0; i < p_parent.children.size(); i++) {
  524. ret = search_symbol_defined_at_line(p_line, p_parent.children[i]);
  525. if (ret) {
  526. break;
  527. }
  528. }
  529. }
  530. return ret;
  531. }
  532. Error ExtendGDScriptParser::get_left_function_call(const lsp::Position &p_position, lsp::Position &r_func_pos, int &r_arg_index) const {
  533. ERR_FAIL_INDEX_V(p_position.line, lines.size(), ERR_INVALID_PARAMETER);
  534. int bracket_stack = 0;
  535. int index = 0;
  536. bool found = false;
  537. for (int l = p_position.line; l >= 0; --l) {
  538. String line = lines[l];
  539. int c = line.length() - 1;
  540. if (l == p_position.line) {
  541. c = MIN(c, p_position.character - 1);
  542. }
  543. while (c >= 0) {
  544. const char32_t &character = line[c];
  545. if (character == ')') {
  546. ++bracket_stack;
  547. } else if (character == '(') {
  548. --bracket_stack;
  549. if (bracket_stack < 0) {
  550. found = true;
  551. }
  552. }
  553. if (bracket_stack <= 0 && character == ',') {
  554. ++index;
  555. }
  556. --c;
  557. if (found) {
  558. r_func_pos.character = c;
  559. break;
  560. }
  561. }
  562. if (found) {
  563. r_func_pos.line = l;
  564. r_arg_index = index;
  565. return OK;
  566. }
  567. }
  568. return ERR_METHOD_NOT_FOUND;
  569. }
  570. const lsp::DocumentSymbol *ExtendGDScriptParser::get_symbol_defined_at_line(int p_line) const {
  571. if (p_line <= 0) {
  572. return &class_symbol;
  573. }
  574. return search_symbol_defined_at_line(p_line, class_symbol);
  575. }
  576. const lsp::DocumentSymbol *ExtendGDScriptParser::get_member_symbol(const String &p_name, const String &p_subclass) const {
  577. if (p_subclass.is_empty()) {
  578. const lsp::DocumentSymbol *const *ptr = members.getptr(p_name);
  579. if (ptr) {
  580. return *ptr;
  581. }
  582. } else {
  583. if (const ClassMembers *_class = inner_classes.getptr(p_subclass)) {
  584. const lsp::DocumentSymbol *const *ptr = _class->getptr(p_name);
  585. if (ptr) {
  586. return *ptr;
  587. }
  588. }
  589. }
  590. return nullptr;
  591. }
  592. const List<lsp::DocumentLink> &ExtendGDScriptParser::get_document_links() const {
  593. return document_links;
  594. }
  595. const Array &ExtendGDScriptParser::get_member_completions() {
  596. if (member_completions.is_empty()) {
  597. for (const KeyValue<String, const lsp::DocumentSymbol *> &E : members) {
  598. const lsp::DocumentSymbol *symbol = E.value;
  599. lsp::CompletionItem item = symbol->make_completion_item();
  600. item.data = JOIN_SYMBOLS(path, E.key);
  601. member_completions.push_back(item.to_json());
  602. }
  603. for (const KeyValue<String, ClassMembers> &E : inner_classes) {
  604. const ClassMembers *inner_class = &E.value;
  605. for (const KeyValue<String, const lsp::DocumentSymbol *> &F : *inner_class) {
  606. const lsp::DocumentSymbol *symbol = F.value;
  607. lsp::CompletionItem item = symbol->make_completion_item();
  608. item.data = JOIN_SYMBOLS(path, JOIN_SYMBOLS(E.key, F.key));
  609. member_completions.push_back(item.to_json());
  610. }
  611. }
  612. }
  613. return member_completions;
  614. }
  615. Dictionary ExtendGDScriptParser::dump_function_api(const GDScriptParser::FunctionNode *p_func) const {
  616. Dictionary func;
  617. ERR_FAIL_NULL_V(p_func, func);
  618. func["name"] = p_func->identifier->name;
  619. func["return_type"] = p_func->get_datatype().to_string();
  620. func["rpc_config"] = p_func->rpc_config;
  621. Array parameters;
  622. for (int i = 0; i < p_func->parameters.size(); i++) {
  623. Dictionary arg;
  624. arg["name"] = p_func->parameters[i]->identifier->name;
  625. arg["type"] = p_func->parameters[i]->get_datatype().to_string();
  626. if (p_func->parameters[i]->default_value != nullptr) {
  627. arg["default_value"] = p_func->parameters[i]->default_value->reduced_value;
  628. }
  629. parameters.push_back(arg);
  630. }
  631. if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(p_func->start_line))) {
  632. func["signature"] = symbol->detail;
  633. func["description"] = symbol->documentation;
  634. }
  635. func["arguments"] = parameters;
  636. return func;
  637. }
  638. Dictionary ExtendGDScriptParser::dump_class_api(const GDScriptParser::ClassNode *p_class) const {
  639. Dictionary class_api;
  640. ERR_FAIL_NULL_V(p_class, class_api);
  641. class_api["name"] = p_class->identifier != nullptr ? String(p_class->identifier->name) : String();
  642. class_api["path"] = path;
  643. Array extends_class;
  644. for (int i = 0; i < p_class->extends.size(); i++) {
  645. extends_class.append(String(p_class->extends[i]));
  646. }
  647. class_api["extends_class"] = extends_class;
  648. class_api["extends_file"] = String(p_class->extends_path);
  649. class_api["icon"] = String(p_class->icon_path);
  650. if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(p_class->start_line))) {
  651. class_api["signature"] = symbol->detail;
  652. class_api["description"] = symbol->documentation;
  653. }
  654. Array nested_classes;
  655. Array constants;
  656. Array members;
  657. Array signals;
  658. Array methods;
  659. Array static_functions;
  660. for (int i = 0; i < p_class->members.size(); i++) {
  661. const ClassNode::Member &m = p_class->members[i];
  662. switch (m.type) {
  663. case ClassNode::Member::CLASS:
  664. nested_classes.push_back(dump_class_api(m.m_class));
  665. break;
  666. case ClassNode::Member::CONSTANT: {
  667. Dictionary api;
  668. api["name"] = m.constant->identifier->name;
  669. api["value"] = m.constant->initializer->reduced_value;
  670. api["data_type"] = m.constant->get_datatype().to_string();
  671. if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.constant->start_line))) {
  672. api["signature"] = symbol->detail;
  673. api["description"] = symbol->documentation;
  674. }
  675. constants.push_back(api);
  676. } break;
  677. case ClassNode::Member::ENUM_VALUE: {
  678. Dictionary api;
  679. api["name"] = m.enum_value.identifier->name;
  680. api["value"] = m.enum_value.value;
  681. api["data_type"] = m.get_datatype().to_string();
  682. if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.enum_value.line))) {
  683. api["signature"] = symbol->detail;
  684. api["description"] = symbol->documentation;
  685. }
  686. constants.push_back(api);
  687. } break;
  688. case ClassNode::Member::ENUM: {
  689. Dictionary enum_dict;
  690. for (int j = 0; j < m.m_enum->values.size(); j++) {
  691. enum_dict[m.m_enum->values[j].identifier->name] = m.m_enum->values[j].value;
  692. }
  693. Dictionary api;
  694. api["name"] = m.m_enum->identifier->name;
  695. api["value"] = enum_dict;
  696. api["data_type"] = m.get_datatype().to_string();
  697. if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.m_enum->start_line))) {
  698. api["signature"] = symbol->detail;
  699. api["description"] = symbol->documentation;
  700. }
  701. constants.push_back(api);
  702. } break;
  703. case ClassNode::Member::VARIABLE: {
  704. Dictionary api;
  705. api["name"] = m.variable->identifier->name;
  706. api["data_type"] = m.variable->get_datatype().to_string();
  707. api["default_value"] = m.variable->initializer != nullptr ? m.variable->initializer->reduced_value : Variant();
  708. api["setter"] = m.variable->setter ? ("@" + String(m.variable->identifier->name) + "_setter") : (m.variable->setter_pointer != nullptr ? String(m.variable->setter_pointer->name) : String());
  709. api["getter"] = m.variable->getter ? ("@" + String(m.variable->identifier->name) + "_getter") : (m.variable->getter_pointer != nullptr ? String(m.variable->getter_pointer->name) : String());
  710. api["export"] = m.variable->exported;
  711. if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.variable->start_line))) {
  712. api["signature"] = symbol->detail;
  713. api["description"] = symbol->documentation;
  714. }
  715. members.push_back(api);
  716. } break;
  717. case ClassNode::Member::SIGNAL: {
  718. Dictionary api;
  719. api["name"] = m.signal->identifier->name;
  720. Array pars;
  721. for (int j = 0; j < m.signal->parameters.size(); j++) {
  722. pars.append(String(m.signal->parameters[i]->identifier->name));
  723. }
  724. api["arguments"] = pars;
  725. if (const lsp::DocumentSymbol *symbol = get_symbol_defined_at_line(LINE_NUMBER_TO_INDEX(m.signal->start_line))) {
  726. api["signature"] = symbol->detail;
  727. api["description"] = symbol->documentation;
  728. }
  729. signals.push_back(api);
  730. } break;
  731. case ClassNode::Member::FUNCTION: {
  732. if (m.function->is_static) {
  733. static_functions.append(dump_function_api(m.function));
  734. } else {
  735. methods.append(dump_function_api(m.function));
  736. }
  737. } break;
  738. case ClassNode::Member::GROUP:
  739. break; // No-op, but silences warnings.
  740. case ClassNode::Member::UNDEFINED:
  741. break; // Unreachable.
  742. }
  743. }
  744. class_api["sub_classes"] = nested_classes;
  745. class_api["constants"] = constants;
  746. class_api["members"] = members;
  747. class_api["signals"] = signals;
  748. class_api["methods"] = methods;
  749. class_api["static_functions"] = static_functions;
  750. return class_api;
  751. }
  752. Dictionary ExtendGDScriptParser::generate_api() const {
  753. Dictionary api;
  754. const GDScriptParser::Node *head = get_tree();
  755. if (const GDScriptParser::ClassNode *gdclass = dynamic_cast<const GDScriptParser::ClassNode *>(head)) {
  756. api = dump_class_api(gdclass);
  757. }
  758. return api;
  759. }
  760. Error ExtendGDScriptParser::parse(const String &p_code, const String &p_path) {
  761. path = p_path;
  762. lines = p_code.split("\n");
  763. Error err = GDScriptParser::parse(p_code, p_path, false);
  764. if (err == OK) {
  765. GDScriptAnalyzer analyzer(this);
  766. err = analyzer.analyze();
  767. }
  768. update_diagnostics();
  769. update_symbols();
  770. update_document_links(p_code);
  771. return err;
  772. }