Basic functionalities for LSP Server #31937

ankitpriyarup · 2019-09-03T19:20:10Z

This PR provides functionality for: Function Signature, Markdown documentation & Document Link. I will create another PR later on covering rename functionality very soon.

abstracted description parsing docs signals, methods and members anchor added docs visal improvements

Completion Item insert text placement fixed Rename Symbol capability removed (functionality not implemented yet) Doc update bug fixed

Geequlim

The signatureHelper looks ok.
The documentLink should not resolve more than one files.

For documentations of builtin symbols

I'm not sure this is a good way to implement the builtin documentation support.

You dumping the documentaions of builtin symbols to markdown files from the DocData on the server side and display them in the client side. There would be a lot of markdown files in the output folders so we have to manage the versions and make sure they are not deleted by users. That is not so reliable IMO.

I suggest you send documentations in realtime from the server side every time the client request the documentation display (maybe format them to markdown before send). The the client decide how to display the recived data (may caching and open them as markdown file like you did or something else).

You'd better seperate the signatureHelp and documentLink from the markdown documentation code to different PRs.

Geequlim · 2019-09-05T05:11:46Z

modules/gdscript/language_server/gdscript_workspace.h

@@ -75,9 +75,12 @@ class GDScriptWorkspace : public Reference {

 	String get_file_path(const String &p_uri) const;
 	String get_file_uri(const String &p_path) const;
+	String simplify_file_uri(const String &p_path) const;


This method seems only called in get_file_uri so you can put the implementation inside get_file_uri

Geequlim · 2019-09-05T05:21:54Z

modules/gdscript/language_server/gdscript_extend_parser.cpp

+			String value = lines[i].substr(start_pos + 1, end_pos - start_pos - 1);
+
+			if (!value.begins_with("res://")) {
+				value = "res://" + value;


I don't think this is the right way to handle relative file paths.

How about this situation:
res://enermys/wolf.gd

extends 'enermy.gd'

'enermy.gd' should link to res://enermys/enermy.gd instead of res://enermy.gd.

Geequlim · 2019-09-05T05:23:27Z

modules/gdscript/language_server/gdscript_extend_parser.cpp

+
+			value = GDScriptLanguageProtocol::get_singleton()->get_workspace()->get_file_uri(value);
+			// File is not outside project scope && exists
+			if (value.find(root_uri) != -1 && FileAccess::exists(value.replace(root_uri + "/", "res://"))) {


Why not call workspace->get_file_path here ?

Geequlim · 2019-09-05T05:27:14Z

modules/gdscript/language_server/gdscript_workspace.h


 	void publish_diagnostics(const String &p_path);
 	void completion(const lsp::CompletionParams &p_params, List<ScriptCodeCompletionOption> *r_options);
+	Error get_signature_help(const lsp::TextDocumentPositionParams &p_params, String *r_signature_name, String *r_signature_doc, List<String> *r_signature_parameter, int *r_cur_active_parameter);
+	Error get_document_link(const lsp::DocumentLinkParams &p_params, List<lsp::DocumentLink> *r_links_parameter);


~~I don't think a path can link to more than one file so why need this function returns multi-values?~~

Oh I'm wrong.
The LSP require us to return a DocumentLink[] so we have to search all the strings in scripts.

Geequlim · 2019-09-05T05:29:16Z

modules/gdscript/language_server/lsp.hpp

@@ -1467,7 +1621,7 @@ struct ServerCapabilities {
 		dict["signatureHelpProvider"] = signatureHelpProvider.to_json();
 		dict["codeLensProvider"] = false; // codeLensProvider.to_json();
 		dict["documentOnTypeFormattingProvider"] = documentOnTypeFormattingProvider.to_json();
-		dict["renameProvider"] = renameProvider.to_json();
+		// dict["renameProvider"] = renameProvider.to_json();


Do't commit unused code

akien-mga · 2019-09-30T07:33:27Z

editor/doc/doc_data.cpp

@@ -1161,6 +1161,267 @@ Error DocData::save_classes(const String &p_default_path, const Map<String, Stri
 	return OK;
 }

+String DocData::parse_description(String p_description) {


Should have a more explicit name, like convert_description_to_markdown.

akien-mga · 2019-09-30T07:35:40Z

main/main.cpp

@@ -284,7 +283,7 @@ void Main::print_help(const char *p_binary) {
 #ifdef TOOLS_ENABLED
 	OS::get_singleton()->print("  --export <target>                Export the project using the given export target. Export only main pack if path ends with .pck or .zip.\n");
 	OS::get_singleton()->print("  --export-debug <target>          Like --export, but use debug template.\n");
-	OS::get_singleton()->print("  --doctool <path>                 Dump the engine API reference to the given <path> in XML format, merging if existing files are found.\n");
+	OS::get_singleton()->print("  --doctool <path>                 Dump the engine API reference to the given <bool: inMarkdown> <path> in XML format, merging if existing files are found.\n");


This shouldn't change doctool, just add a new option, e.g. --dump-markdown-docs.

akien-mga · 2019-09-30T07:36:58Z

Commits should be squashed together eventually (with an appropriate description for the squashed commits to describe the overall changes).

Geequlim · 2020-01-03T02:02:38Z

@ankitpriyarup Are you going to continue the work for the signature implementation ?

ankitpriyarup · 2020-01-03T05:14:15Z

@ankitpriyarup Are you going to continue the work for the signature implementation ?

No I won't be able to continue

aaronfranke · 2020-07-01T03:19:59Z

The documentation part of this PR is superceded by #39359, the rest may still be relevant but I'm not sure. In any case, this PR is not good as-is, since it's still incomplete, has conflicts, and needs squashing. Therefore, I'm closing and adding "salvageable".

ankitpriyarup added 11 commits August 20, 2019 22:05

Function signature implemented

1ba3064

Documentation markdown dump implemented

15caf9b

Markdown Documentation Improvements

9095ecc

Update dumped document when version outdates

8e8bcd8

Document Link Added

856693b

Markdowndoc now relies on version hash for updates

c618e91

Major markdown doc updates

bfeee2e

abstracted description parsing docs signals, methods and members anchor added docs visal improvements

Bug fixes

f0ff7ee

Completion Item insert text placement fixed Rename Symbol capability removed (functionality not implemented yet) Doc update bug fixed

Document link bug fixes, resolved relative paths

aed8e4a

Minor code style fixes

f39873a

code review fixes

1491805

ankitpriyarup requested review from bojidar-bg and vnen as code owners September 3, 2019 19:20

Geequlim suggested changes Sep 5, 2019

View reviewed changes

akien-mga added enhancement topic:editor topic:gdscript labels Sep 24, 2019

akien-mga added this to the 3.2 milestone Sep 24, 2019

akien-mga reviewed Sep 30, 2019

View reviewed changes

akien-mga modified the milestones: 3.2, 4.0 Nov 7, 2019

Geequlim mentioned this pull request Dec 20, 2019

No parameters suggestions after method or constructor godotengine/godot-vscode-plugin#132

Closed

aaronfranke closed this Jul 1, 2020

aaronfranke added archived and removed enhancement labels Jul 1, 2020

aaronfranke added feature proposal salvageable labels Jul 1, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Basic functionalities for LSP Server #31937

Basic functionalities for LSP Server #31937

ankitpriyarup commented Sep 3, 2019

Geequlim left a comment

Geequlim Sep 5, 2019

Geequlim Sep 5, 2019

Geequlim Sep 5, 2019

Geequlim Sep 5, 2019 •

edited

Loading

Geequlim Sep 25, 2019

Geequlim Sep 5, 2019

akien-mga Sep 30, 2019

akien-mga Sep 30, 2019

akien-mga commented Sep 30, 2019

Geequlim commented Jan 3, 2020

ankitpriyarup commented Jan 3, 2020

aaronfranke commented Jul 1, 2020

Basic functionalities for LSP Server #31937

Basic functionalities for LSP Server #31937

Conversation

ankitpriyarup commented Sep 3, 2019

Geequlim left a comment

Choose a reason for hiding this comment

Geequlim Sep 5, 2019

Choose a reason for hiding this comment

Geequlim Sep 5, 2019

Choose a reason for hiding this comment

Geequlim Sep 5, 2019

Choose a reason for hiding this comment

Geequlim Sep 5, 2019 • edited Loading

Choose a reason for hiding this comment

Geequlim Sep 25, 2019

Choose a reason for hiding this comment

Geequlim Sep 5, 2019

Choose a reason for hiding this comment

akien-mga Sep 30, 2019

Choose a reason for hiding this comment

akien-mga Sep 30, 2019

Choose a reason for hiding this comment

akien-mga commented Sep 30, 2019

Geequlim commented Jan 3, 2020

ankitpriyarup commented Jan 3, 2020

aaronfranke commented Jul 1, 2020

Geequlim Sep 5, 2019 •

edited

Loading